ControlCommand

Helper function to get the type ID of a data type. 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 QByteArray	toBytes() 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.
QString	command Duration of the command before resetting to the previous state (zero for infinite)

Public Types inherited from BaseDataType

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

Public Functions inherited from BaseDataType

	Name
QString	typeIdToString(TypeId value)
QString	typeIdToString(int value)
TypeId	typeIdFromString(const QString & str)
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.

template <typename T >
struct ControlCommand;

Helper function to get the type ID of a data type.

Convenience function to deserialize a data type from memory

The ControlCommandKind enum

Basic operations to control a module from another module.

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 QByteArray toBytes() const override

Serialize the data to a byte array.

Reimplements: 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.

QString command;

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

Updated on 2024-09-05 at 17:39:59 +0000