C++ API
Classes
Syntalos::LineCommand

Syntalos::LineCommand

Syntalos::LineCommand

Command issued to a hardware signal line / channel / pin. More…

#include <datatypes.h>

Inherits from Syntalos::BaseDataType

Public Functions

Name
LineCommand() =default
DeviceSpecific payload.
LineCommand(LineCommandKind k)
LineCommand(LineCommandKind k, uint16_t line)
LineCommand(LineCommandKind k, uint16_t line, uint32_t v)
virtual booltoBytes(ByteVector & output) const override
Serialize the data to a byte array.
LineCommandfromMemory(const void * memory, size_t size)

Public Attributes

Name
LineCommandKindkind
uint16_tlineId
uint32_tvalue
Hardware line/channel/pin number.
microseconds_tduration
Digital: 0/1; analog: DAC code.
LineModeFlagsflags
Pulse duration for *Pulse kinds.
ByteVectorextra
SetMode only.

Additional inherited members

Public Types inherited from Syntalos::BaseDataType

Name
enumTypeId { Unknown, ControlCommand, TableRow, Frame, LineCommand, LineReading, IntSignalBlock, FloatSignalBlock, Last}
The TypeId enum.

Public Functions inherited from Syntalos::BaseDataType

Name
virtual~BaseDataType() =default
virtual TypeIdtypeId() const =0
virtual ssize_tmemorySize() const
Calculate the size of the data in memory.
virtual boolwriteToMemory(void * memory, ssize_t size =-1) const
Write the data to a memory block.
booltypeIdIsValid(int value)
std::stringtypeIdToString(int value)
std::stringtypeIdToString(TypeId value)
TypeIdtypeIdFromString(const std::string & str)

Protected Functions inherited from Syntalos::BaseDataType

Name
BaseDataType() =default
BaseDataType(const BaseDataType & ) =default
BaseDataType &operator=(const BaseDataType & ) =default
BaseDataType(BaseDataType && ) =default
BaseDataType &operator=(BaseDataType && ) =default

Detailed Description 

struct Syntalos::LineCommand;

Command issued to a hardware signal line / channel / pin.

Generic, protocol-agnostic outbound control message.

Public Functions Documentation

function LineCommand 

explicit LineCommand() =default

DeviceSpecific payload.

function LineCommand 

inline explicit LineCommand(
    LineCommandKind k
)

function LineCommand 

inline LineCommand(
    LineCommandKind k,
    uint16_t line
)

function LineCommand 

inline LineCommand(
    LineCommandKind k,
    uint16_t line,
    uint32_t v
)

function toBytes 

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.

function fromMemory 

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

Public Attributes Documentation

variable kind 

LineCommandKind kind {LineCommandKind::UNKNOWN};

variable lineId 

uint16_t lineId {0};

variable value 

uint32_t value {0};

Hardware line/channel/pin number.

variable duration 

microseconds_t duration {};

Digital: 0/1; analog: DAC code.

variable flags 

LineModeFlags flags {LineModeFlag::NONE};

Pulse duration for *Pulse kinds.

variable extra 

ByteVector extra;

SetMode only.

Updated on 2026-05-13 at 01:40:12 +0000

Syntalos::IpcServiceTopologySyntalos::LineReading