State

class State

@brief A class representing unified states accross the Karabo system.

This class holds all states known to Karabo as static data members. States should always be accessed through this class. It's constructors are fully private, meaning that no additional States can be constructed outside of this class

Variables

Name	Description
INTERLOCKED

Operators

Name	Description
operator()	Implicit conversion to strings is allowed Return :
operator==	Check if two states are identical state : Return :
operator!=	Check if two states are not identical state : Return :

Functions

Name	Description
name	Return the name of the state Return :
parent	Return the states parent in the state hierarchy in case it is a derived state Return :
isDerivedFrom	Evaluate if this state is derived from another State s s : Return :
fromString	Create a state from its string representation state : Return :

Variable Details

INTERLOCKED

static const State INTERLOCKED

Operator Details

operator!=

bool operator!=(const State& state) const

Check if two states are not identical

state :

Return :

operator()

virtual const std::string& operator()() const

Implicit conversion to strings is allowed

Return :

operator==

bool operator==(const State& state) const

Check if two states are identical

state :

Return :

Function Details

fromString

static const State& fromString(const std::string& state)

Create a state from its string representation

state :

Return :

isDerivedFrom

bool isDerivedFrom(const State& s) const

Evaluate if this state is derived from another State s

s :

Return :

name

const std::string& name() const

Return the name of the state

Return :

parent

const State* parent() const

Return the states parent in the state hierarchy in case it is a derived state

Return :