Skip to content

StateSignifier

struct StateSignifier

@brief The StateSignifier is used to evaluate the most significant State from a set of States

Functions

Name Description
StateSignifier Create a StateSignifier trumpList : if set use this list to deviate from the standard signification order staticMoreSignificant : identify if in the State::STATIC regime State::PASSIVE or State::ACTIVE is more significant changingMoreSignificant : identify if in the State::CHANGING regime State::INCREASING or State::DECREASING is more significant
StateSignifier Create a StateSignifier staticMoreSignificant : identify if in the State::STATIC regime State::PASSIVE or State::ACTIVE is more changingMoreSignificant : identify if in the State::CHANGING regime State::INCREASING or State::DECREASING is more significant
returnMostSignificant Return the most significant State from a list of States listOfStates : Return :
fillAncestorNames Fill full list of ancestors for state, starting from state name itself: state_name, parent_name, grand_parent_name, grand_grand_parent_name, ... s : input state all : vector for accumulating of output list of ancestors
completeChangingSubstates Completes a non default trump list with some substates of CHANGING if that list contains CHANGING.
completeStaticSubstates Completes a non default trump list with some substates of STATIC if that list contains STATIC.
completeKnownSubstates Completes a non default trump list with some substates of KNOWN if that list contains KNOWN.

Function Details

StateSignifier

StateSignifier(const std::vector<karabo::data::State>& trumpList = std::vector<karabo::data::State>(), const karabo::data::State& staticMoreSignificant = karabo::data::State::PASSIVE, const karabo::data::State& changingMoreSignificant = karabo::data::State::DECREASING)

Create a StateSignifier

trumpList : if set use this list to deviate from the standard signification order

staticMoreSignificant : identify if in the State::STATIC regime State::PASSIVE or State::ACTIVE is more significant

changingMoreSignificant : identify if in the State::CHANGING regime State::INCREASING or State::DECREASING is more significant

StateSignifier(const karabo::data::State& staticMoreSignificant, const karabo::data::State& changingMoreSignificant)

Create a StateSignifier

staticMoreSignificant : identify if in the State::STATIC regime State::PASSIVE or State::ACTIVE is more

changingMoreSignificant : identify if in the State::CHANGING regime State::INCREASING or State::DECREASING is more significant

completeChangingSubstates

void completeChangingSubstates(const karabo::data::State& changingMoreSignificant)

Completes a non default trump list with some substates of CHANGING if that list contains CHANGING.

changingMoreSignificant : which CHANGING substate is more significant between INCREASING and DECREASING?

completeKnownSubstates

void completeKnownSubstates(const karabo::data::State& staticMoreSignificant, const karabo::data::State& changingMoreSignificant)

Completes a non default trump list with some substates of KNOWN if that list contains KNOWN.

staticgMoreSignificant : which STATIC substate is more significant between ACTIVE and PASSIVE?

changingMoreSignificant : which CHANGING substate is more significant between INCREASING and DECREASING?

completeStaticSubstates

void completeStaticSubstates(const karabo::data::State& staticMoreSignificant)

Completes a non default trump list with some substates of STATIC if that list contains STATIC.

staticMoreSignificant : which STATIC substate is more significant between ACTIVE and PASSIVE?

fillAncestorNames

void fillAncestorNames(const karabo::data::State& s, std::vector<std::string>& all)

Fill full list of ancestors for state, starting from state name itself: state_name, parent_name, grand_parent_name, grand_grand_parent_name, ...

s : input state

all : vector for accumulating of output list of ancestors

returnMostSignificant

karabo::data::State returnMostSignificant(const std::vector<karabo::data::State>& listOfStates)

Return the most significant State from a list of States

listOfStates :

Return :