State

#include <icy/stateful.h>

class State

Defined in src/base/include/icy/stateful.h:31

Subclassed by: DiagnosticState, PacketStreamState, TransactionState, EncoderState, InstallationState, ClientState, ClientState

This class defines the state for a state machine, and should be extended and passed to implementations of the Stateful template.

For an example See also: PacketStreamState

Friends

Name	Description
`operator<<` inline

operator<<

inline

friend inline std::ostream & operator<<(std::ostream & os, const State & state)

Defined in src/base/include/icy/stateful.h:80

Public Methods

Return	Name	Description
	`State`
	`State`	Copy constructor.
`State` &	`operator=`	Copy assignment.
	`~State` virtual	Defaulted destructor.
`ID`	`id` const	Returns the current state ID.
`void`	`set`	Sets the state ID.
`std::string`	`str` virtual const	Returns a human-readable string for the given state ID. Override in derived classes to provide meaningful names.
`std::string`	`toString` virtual const	Returns a human-readable string for the current state ID.
`bool`	`equals` const	Returns true if the current state ID equals the given ID.
`bool`	`between` const	Returns true if the current state ID is in the inclusive range [lid, rid].
`bool`	`operator==` const inline
`bool`	`operator==` const inline

State(ID id = 0)

Defined in src/base/include/icy/stateful.h:37

Parameters

Parameter	Type	Description
`id`	`ID`	Initial state ID. Defaults to 0.

State

State(const State & that)

Defined in src/base/include/icy/stateful.h:41

Copy constructor.

Parameters

Parameter	Type	Description
`that`	const `State` &	State to copy from.

operator=

State & operator=(const State & that)

Defined in src/base/include/icy/stateful.h:45

Copy assignment.

Parameters

Parameter	Type	Description
`that`	const `State` &	State to assign from.

~State

virtual

virtual ~State() = default

Defined in src/base/include/icy/stateful.h:46

Defaulted destructor.

id

const

ID id() const

Defined in src/base/include/icy/stateful.h:50

Returns the current state ID.

Returns

Atomic state ID value.

set

void set(ID id)

Defined in src/base/include/icy/stateful.h:54

Sets the state ID.

Parameters

Parameter	Type	Description
`id`	`ID`	New state ID to assign.

str

virtual const

virtual std::string str(ID id) const

Defined in src/base/include/icy/stateful.h:60

Returns a human-readable string for the given state ID. Override in derived classes to provide meaningful names.

Returns

String representation of the state, or "undefined" by default.

Parameters

Parameter	Type	Description
`id`	`ID`	State ID to convert.

toString

virtual const

virtual std::string toString() const

Defined in src/base/include/icy/stateful.h:64

Returns a human-readable string for the current state ID.

Returns

Result of str(id()).

Reimplemented by

ClientState::toString

equals

const

bool equals(ID id) const

Defined in src/base/include/icy/stateful.h:69

Returns true if the current state ID equals the given ID.

Returns

True if IDs match.

Parameters

Parameter	Type	Description
`id`	`ID`	State ID to compare against.

between

const

bool between(ID lid, ID rid) const

Defined in src/base/include/icy/stateful.h:75

Returns true if the current state ID is in the inclusive range [lid, rid].

Returns

True if lid <= id() <= rid.

Parameters

Parameter	Type	Description
`lid`	`ID`	Lower bound state ID.
`rid`	`ID`	Upper bound state ID.

operator==

const inline

inline bool operator==(const State & that) const

Defined in src/base/include/icy/stateful.h:77

operator==

const inline

inline bool operator==(const State::ID & that) const

Defined in src/base/include/icy/stateful.h:78

Protected Attributes

Return	Name	Description
std::atomic< `ID` >	`_id`

_id

std::atomic< ID > _id

Type: std::atomic< ID >

Defined in src/base/include/icy/stateful.h:87

Public Types

Name	Description
`ID`

ID

using ID = uint32_t

Defined in src/base/include/icy/stateful.h:34