Syntalos::ControlCommand

A control command to a module. More…

#include <datatypes.h>

Public Functions

	Name
	ControlCommand() Custom command name, if in custom mode.
	ControlCommand(ControlCommandKind ckind)
void	setDuration(ulong value)
ulong	getDurationAsInt() const
virtual bool	toBytes(ByteVector & output) const override Serialize the data to a byte array.
ControlCommand	fromMemory(const void * memory, size_t size)

	Name
ControlCommandKind	kind
milliseconds_t	duration The command type.
std::string	command Duration of the command before resetting to the previous state (zero for infinite)

Public Types inherited from Syntalos::BaseDataType

	Name
enum	TypeId { Unknown, ControlCommand, TableRow, Frame, FirmataControl, FirmataData, IntSignalBlock, FloatSignalBlock, Last} The TypeId enum.

Public Functions inherited from Syntalos::BaseDataType

	Name
virtual	~BaseDataType() =default
virtual TypeId	typeId() const =0
virtual ssize_t	memorySize() const Calculate the size of the data in memory.
virtual bool	writeToMemory(void * memory, ssize_t size =-1) const Write the data to a memory block.
std::string	typeIdToString(int value)
std::string	typeIdToString(TypeId value)
TypeId	typeIdFromString(const std::string & str)

struct Syntalos::ControlCommand;

A control command to a module.

Generic data type to stream commands to other modules.

inline explicit ControlCommand()

Custom command name, if in custom mode.

inline explicit ControlCommand(
    ControlCommandKind ckind
)

inline void setDuration(
    ulong value
)

inline ulong getDurationAsInt() const

inline virtual bool toBytes(
    ByteVector & output
) const override

Serialize the data to a byte array.

Reimplements: Syntalos::BaseDataType::toBytes

Serialize the data to a byte array for local transmission.

static inline ControlCommand fromMemory(
    const void * memory,
    size_t size
)

ControlCommandKind kind {ControlCommandKind::UNKNOWN};

milliseconds_t duration;

The command type.

std::string command;

Duration of the command before resetting to the previous state (zero for infinite)

Updated on 2026-03-16 at 19:16:01 +0000