Base class for all Dawn objects (IOs, Programs, Protocols). More...

#include <object.hxx>

Inheritance diagram for dawn::CObject:

Public Types
enum	{ CMD_RESET = 0 , CMD_TRIGGER1 = 1 , CMD_TRIGGER2 = 2 , CMD_TRIGGER3 = 3 }
	Control command identifiers for control() More...

enum
	Default descriptor validation failure codes. More...

enum	EObjectState { STATE_STOPPED = 0 , STATE_RUNNING = 1 }
	Object operational state returned by getState() More...

Public Member Functions
	CObject (CDescObject &desc)
	Construct a CObject from a descriptor.

virtual int	configure ()
	Configure object from descriptor data.

virtual int	deinit ()
	De-initialize object.

bool	getCfgFlag () const
	Check if configuration flag is set.

uint16_t	getCls () const
	Get object class field.

CDescObject &	getDesc ()
	Get descriptor object for this object.

uint8_t	getDtype () const
	Get data type field.

size_t	getDtypeSize () const
	Get size of this object's data type.

uint8_t	getFlags () const
	Get type-specific flags field.

SObjectId::UObjectId	getId () const
	Get object identifier as union structure.

SObjectId::ObjectId	getIdV () const
	Get object identifier as raw 32-bit value.

int	getObjConfig (SObjectCfg::ObjectCfgId objcfg, uint32_t *data, size_t len)
	Get object configuration item.

uint16_t	getPriv () const
	Get instance/private data field.

virtual EObjectState	getState () const
	Get current operational state.

uint8_t	getType () const
	Get object type field.

virtual bool	hasThread () const
	Check if a background thread is active.

virtual int	init ()
	One-time initialize object after bindings are resolved.

int	setObjConfig (SObjectCfg::ObjectCfgId objcfg, uint32_t *data, size_t len)
	Set object configuration item.

int	start ()
	Start object.

int	stop ()
	Stop object.

virtual int	trigger (uint8_t cmd)
	Execute a trigger command.

Static Public Member Functions
static int	descValidDefault (const uint32_t *data, size_t len)
	Default descriptor validation method.

static int	validateDesc (const uint32_t *desc, size_t len)
	Validate entire descriptor.

Protected Member Functions
virtual int	doStart ()
	Start implementation hook.

virtual int	doStop ()
	Stop implementation hook.

virtual int	onSetObjConfig (SObjectCfg::ObjectCfgId objcfg, uint32_t *data, size_t len)
	Pre-update hook for runtime configuration writes.

Detailed Description

Base class for all Dawn objects (IOs, Programs, Protocols).

This class must be inherited by all other Dawn objects.

Definition at line 27 of file object.hxx.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Control command identifiers for control()

Enumerator
CMD_RESET	Reset object internal state.
CMD_TRIGGER1	Object-specific trigger slot 1.
CMD_TRIGGER2	Object-specific trigger slot 2.
CMD_TRIGGER3	Object-specific trigger slot 3.

Definition at line 40 of file object.hxx.

◆ anonymous enum

anonymous enum

Default descriptor validation failure codes.

Negative values identify which length check failed in descValidDefault().

Definition at line 314 of file object.hxx.

◆ EObjectState

enum dawn::CObject::EObjectState

Object operational state returned by getState()

Enumerator
STATE_STOPPED	Object is stopped.
STATE_RUNNING	Object is running.

Definition at line 32 of file object.hxx.

Constructor & Destructor Documentation

◆ CObject()

dawn::CObject::CObject ( CDescObject & desc )

inlineexplicit

Construct a CObject from a descriptor.

Parameters

desc	Descriptor object defining this object's configuration.

Definition at line 54 of file object.hxx.

Member Function Documentation

◆ configure()

virtual int dawn::CObject::configure ( )

inlinevirtual

Configure object from descriptor data.

Called during framework setup before dependency binding. Implementations should parse/validate descriptor configuration and store object settings, but avoid one-time allocations that depend on bound objects.

Returns: OK on success, negative error code on failure.

Reimplemented in dawn::CIOAdcBase, dawn::CIOAdcStream, dawn::CIOAdcSync, dawn::CIOButtons, dawn::CIOCapabilities, dawn::CIOConfig, dawn::CIOControl, dawn::CIODac, dawn::CIODescriptor, dawn::CIODescSelector, dawn::CIODummy, dawn::CIODummyNotify, dawn::CIOEncoder, dawn::CIOEncoderIndex, dawn::CIOFile, dawn::CIOGpi, dawn::CIOGpo, dawn::CIOLeds, dawn::CIOPwm, dawn::CIORand, dawn::CIORgbLed, dawn::CIOSensor, dawn::CIOSensorProducer, dawn::CIOTimestamp, dawn::CIOTrigger, dawn::CIOVirt, dawn::CProgAdjust, dawn::CProgBitPack, dawn::CProgBitSplit, dawn::CProgBuffer, dawn::CProgCounter, dawn::CProgDummy, dawn::CProgExpression, dawn::CProgGateway, dawn::CProgIODemux, dawn::CProgIOMux, dawn::CProgManyToOne, dawn::CProgOneToMany, dawn::CProgProcess, dawn::CProgRedirect, dawn::CProgSampling, dawn::CProgSelector, dawn::CProgSequencer, dawn::CProgSwitch, dawn::CProgToggle, dawn::CProgVecPack, dawn::CProgVecSplit, dawn::CProtoCan, dawn::CProtoDummy, dawn::CProtoIpc, dawn::CProtoModbusRtu, dawn::CProtoModbusTcp, dawn::CProtoNimblePrph, dawn::CProtoNxscope, dawn::CProtoSerial, dawn::CProtoShellPretty, and dawn::CProtoUdp.

Definition at line 73 of file object.hxx.

◆ deinit()

virtual int dawn::CObject::deinit ( )

inlinevirtual

De-initialize object.

Clean up resources allocated during init().

Returns: OK on success, negative error code on failure.

Reimplemented in dawn::CIOAdcBase, dawn::CIOButtons, dawn::CIOCapabilities, dawn::CIOConfig, dawn::CIOControl, dawn::CIODac, dawn::CIODescriptor, dawn::CIODescSelector, dawn::CIODummy, dawn::CIODummyNotify, dawn::CIOEncoder, dawn::CIOEncoderIndex, dawn::CIOFile, dawn::CIOGpi, dawn::CIOGpo, dawn::CIOLeds, dawn::CIOPwm, dawn::CIORand, dawn::CIORgbLed, dawn::CIOSensor, dawn::CIOSensorProducer, dawn::CIOTimestamp, dawn::CIOTrigger, dawn::CIOVirt, dawn::CProgAdjust, dawn::CProgBitPack, dawn::CProgBitSplit, dawn::CProgBuffer, dawn::CProgCounter, dawn::CProgExpression, dawn::CProgGateway, dawn::CProgIODemux, dawn::CProgIOMux, dawn::CProgManyToOne, dawn::CProgOneToMany, dawn::CProgProcess, dawn::CProgRedirect, dawn::CProgSampling, dawn::CProgSelector, dawn::CProgSequencer, dawn::CProgSwitch, dawn::CProgToggle, dawn::CProgVecPack, dawn::CProgVecSplit, dawn::CProtoCan, dawn::CProtoIpc, dawn::CProtoModbusRtu, dawn::CProtoModbusTcp, dawn::CProtoNimblePrph, dawn::CProtoNxscope, dawn::CProtoSerial, and dawn::CProtoUdp.

Definition at line 100 of file object.hxx.

◆ descValidDefault()

int CObject::descValidDefault	(	const uint32_t *	data,
		size_t	len
	)

static

Default descriptor validation method.

Provides basic validation that only checks if descriptor lengths are correct.

Parameters

data	Descriptor data pointer.
len	Length of descriptor data in 32-bit words.

Returns: OK on success, negative error code indicating validation stage.

Definition at line 42 of file object.cxx.

References dawn::SObjectCfg::UObjectCfgId::s, dawn::SObjectCfg::UObjectCfgId::size, and dawn::SObjectCfg::UObjectCfgId::v.

Here is the caller graph for this function:

◆ doStart()

virtual int dawn::CObject::doStart ( )

inlineprotectedvirtual

Start implementation hook.

Override in derived classes instead of start().

Returns: OK on success, negative error code on failure.

Reimplemented in dawn::CIOAdcFetch, dawn::CIOAdcStream, dawn::CIOAdcSync, dawn::CIODummyNotify, dawn::CIOPwm, dawn::CIORand, dawn::CIOTimestamp, dawn::CProgAdjust, dawn::CProgBitPack, dawn::CProgBitSplit, dawn::CProgBuffer, dawn::CProgCounter, dawn::CProgExpression, dawn::CProgGateway, dawn::CProgIODemux, dawn::CProgIOMux, dawn::CProgManyToOne, dawn::CProgOneToMany, dawn::CProgProcess, dawn::CProgRedirect, dawn::CProgSampling, dawn::CProgSelector, dawn::CProgSequencer, dawn::CProgSwitch, dawn::CProgToggle, dawn::CProgVecPack, dawn::CProgVecSplit, dawn::CProtoCan, dawn::CProtoIpc, dawn::CProtoModbusRtu, dawn::CProtoModbusTcp, dawn::CProtoNimblePrph, dawn::CProtoNxscope, dawn::CProtoSerial, dawn::CProtoShellPretty, and dawn::CProtoUdp.

Definition at line 402 of file object.hxx.

Here is the caller graph for this function:

◆ doStop()

virtual int dawn::CObject::doStop ( )

inlineprotectedvirtual

Stop implementation hook.

Override in derived classes instead of stop().

Returns: OK on success, negative error code on failure.

Reimplemented in dawn::CIOAdcFetch, dawn::CIOAdcStream, dawn::CIOAdcSync, dawn::CIODummyNotify, dawn::CIOPwm, dawn::CIORand, dawn::CIOTimestamp, dawn::CProgBitPack, dawn::CProgBitSplit, dawn::CProgBuffer, dawn::CProgCounter, dawn::CProgExpression, dawn::CProgGateway, dawn::CProgIODemux, dawn::CProgIOMux, dawn::CProgManyToOne, dawn::CProgOneToMany, dawn::CProgProcess, dawn::CProgRedirect, dawn::CProgSampling, dawn::CProgSelector, dawn::CProgSequencer, dawn::CProgSwitch, dawn::CProgToggle, dawn::CProgVecPack, dawn::CProgVecSplit, dawn::CProtoCan, dawn::CProtoIpc, dawn::CProtoModbusRtu, dawn::CProtoModbusTcp, dawn::CProtoNimblePrph, dawn::CProtoNxscope, dawn::CProtoSerial, dawn::CProtoShellPretty, and dawn::CProtoUdp.

Definition at line 415 of file object.hxx.

Here is the caller graph for this function:

◆ getCfgFlag()

bool CObject::getCfgFlag ( ) const

Check if configuration flag is set.

Returns: True if this object has configuration data.

Definition at line 160 of file object.cxx.

References dawn::CDescObject::getSize().

Here is the call graph for this function:

◆ getCls()

uint16_t CObject::getCls ( ) const

Get object class field.

Returns: Object class identifier (0-511).

Definition at line 170 of file object.cxx.

References dawn::SObjectId::UObjectId::cls, and dawn::SObjectId::UObjectId::s.

Here is the caller graph for this function:

◆ getDesc()

CDescObject & CObject::getDesc ( )

Get descriptor object for this object.

Returns: Reference to associated CDescObject.

Definition at line 190 of file object.cxx.

◆ getDtype()

uint8_t CObject::getDtype ( ) const

Get data type field.

Returns: Data type (DTYPE_UINT32, DTYPE_FLOAT, etc.).

Definition at line 175 of file object.cxx.

References dawn::SObjectId::UObjectId::dtype, and dawn::SObjectId::UObjectId::s.

Here is the caller graph for this function:

◆ getDtypeSize()

size_t CObject::getDtypeSize ( ) const

Get size of this object's data type.

Returns: Size in bytes for the configured data type.

Definition at line 195 of file object.cxx.

References dawn::SObjectId::getDtypeSize_(), and dawn::CDescObject::getObjectDtype().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFlags()

uint8_t CObject::getFlags ( ) const

Get type-specific flags field.

Returns: Flags value (0-3).

Definition at line 180 of file object.cxx.

References dawn::SObjectId::UObjectId::flags, and dawn::SObjectId::UObjectId::s.

Here is the caller graph for this function:

◆ getId()

SObjectId::UObjectId CObject::getId ( ) const

Get object identifier as union structure.

Returns: Reference to UObjectId structure.

Definition at line 150 of file object.cxx.

◆ getIdV()

SObjectId::ObjectId CObject::getIdV ( ) const

Get object identifier as raw 32-bit value.

Returns: ObjectID as uint32_t.

Definition at line 155 of file object.cxx.

References dawn::SObjectId::UObjectId::v.

Here is the caller graph for this function:

◆ getObjConfig()

int CObject::getObjConfig	(	SObjectCfg::ObjectCfgId	objcfg,
		uint32_t *	data,
		size_t	len
	)

Get object configuration item.

Retrieves configuration data for this object.

Parameters

objcfg	Configuration ID specifying which config item to retrieve.
data	Pointer to buffer for configuration data.
len	Length of buffer in 32-bit words.

Returns: OK on success, negative error code on failure.

Definition at line 240 of file object.cxx.

References dawn::SObjectCfg::SObjectCfgItem::data, dawn::SObjectCfg::objectCfgGetSize(), and dawn::CDescObject::objectCfgItemId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPriv()

uint16_t CObject::getPriv ( ) const

Get instance/private data field.

Returns: Instance ID (0-16383).

Definition at line 185 of file object.cxx.

References dawn::SObjectId::UObjectId::priv, and dawn::SObjectId::UObjectId::s.

Here is the caller graph for this function:

◆ getState()

virtual EObjectState dawn::CObject::getState ( ) const

inlinevirtual

Get current operational state.

Default returns STATE_RUNNING after successful start(), STATE_STOPPED otherwise. Objects with richer states (e.g. paused) should override.

Returns: Current EObjectState value.

Definition at line 183 of file object.hxx.

References STATE_RUNNING, and STATE_STOPPED.

◆ getType()

uint8_t CObject::getType ( ) const

Get object type field.

Returns: Object type (OBJTYPE_IO, OBJTYPE_PROTO, OBJTYPE_PROG).

Definition at line 165 of file object.cxx.

References dawn::SObjectId::UObjectId::s, and dawn::SObjectId::UObjectId::type.

◆ hasThread()

virtual bool dawn::CObject::hasThread ( ) const

inlinevirtual

Check if a background thread is active.

Used by Dawn's main loop to detect when clean exit is possible. Objects without a background thread must return false. Independent of operational state tracked via getState().

Returns: True if a background thread is active, false otherwise.

Reimplemented in dawn::CProgBitPack, dawn::CProgBitSplit, dawn::CProgBuffer, dawn::CProgCounter, dawn::CProgExpression, dawn::CProgIODemux, dawn::CProgIOMux, dawn::CProgManyToOne, dawn::CProgOneToMany, dawn::CProgProcess, dawn::CProgRedirect, dawn::CProgSampling, dawn::CProgSelector, dawn::CProgSequencer, dawn::CProgSwitch, dawn::CProgToggle, dawn::CProgVecPack, dawn::CProgVecSplit, dawn::CProtoCan, dawn::CProtoIpc, dawn::CProtoModbusRtu, dawn::CProtoModbusTcp, dawn::CProtoNimblePrph, dawn::CProtoNxscope, dawn::CProtoSerial, dawn::CProtoShellPretty, and dawn::CProtoUdp.

Definition at line 169 of file object.hxx.

◆ init()

virtual int dawn::CObject::init ( )

inlinevirtual

One-time initialize object after bindings are resolved.

Called once during framework setup after dependency binding. Allocate lifetime resources here (buffers, register maps, etc.).

Returns: OK on success, negative error code on failure.

Reimplemented in dawn::CIOAdcBase, dawn::CIODummy, dawn::CIODummyNotify, dawn::CIOEncoder, dawn::CIOEncoderIndex, dawn::CIOGpi, dawn::CIOGpo, dawn::CIOLeds, dawn::CIOPwm, dawn::CIORgbLed, dawn::CIOSysinfo, dawn::CIOSystime, dawn::CIOUname, dawn::CIOUuid, dawn::CIOVirt, dawn::CProgAdjust, dawn::CProgBitPack, dawn::CProgBitSplit, dawn::CProgBuffer, dawn::CProgCounter, dawn::CProgExpression, dawn::CProgGateway, dawn::CProgIODemux, dawn::CProgIOMux, dawn::CProgManyToOne, dawn::CProgOneToMany, dawn::CProgProcess, dawn::CProgRedirect, dawn::CProgSampling, dawn::CProgSelector, dawn::CProgSequencer, dawn::CProgSwitch, dawn::CProgToggle, dawn::CProgVecPack, dawn::CProgVecSplit, dawn::CProtoCan, dawn::CProtoIpc, dawn::CProtoModbusRtu, dawn::CProtoModbusTcp, dawn::CProtoNxscope, dawn::CProtoSerial, and dawn::CProtoUdp.

Definition at line 87 of file object.hxx.

◆ onSetObjConfig()

virtual int dawn::CObject::onSetObjConfig	(	SObjectCfg::ObjectCfgId	objcfg,
		uint32_t *	data,
		size_t	len
	)

inlineprotectedvirtual

Pre-update hook for runtime configuration writes.

Called by setObjConfig() before descriptor-backed storage is updated. Derived classes may validate incoming data and prepare/apply runtime side effects. Returning a negative error rejects the update.

Parameters

objcfg	Configuration ID that will be updated.
data	Pointer to new config words.
len	Number of config words.

Returns: OK on success, or negative error code to reject update.

Reimplemented in dawn::CIOAdcStream, dawn::CIOAdcSync, and dawn::CIOPwm.

Definition at line 386 of file object.hxx.

Here is the caller graph for this function:

◆ setObjConfig()

int CObject::setObjConfig	(	SObjectCfg::ObjectCfgId	objcfg,
		uint32_t *	data,
		size_t	len
	)

Set object configuration item.

Updates a configuration item for this object.

Parameters

objcfg	Configuration ID specifying which config item to update.
data	Pointer to configuration data.
len	Length of configuration data in 32-bit words.

Returns: OK on success, negative error code on failure.

Definition at line 200 of file object.cxx.

References dawn::SObjectCfg::SObjectCfgItem::data, dawn::SObjectCfg::objectCfgGetRw(), dawn::SObjectCfg::objectCfgGetSize(), dawn::CDescObject::objectCfgItemId(), and onSetObjConfig().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ start()

int dawn::CObject::start ( )

inline

Start object.

Tracks operational state and calls doStart(). This phase may run many times during an object's lifetime and should not perform one-time allocation. Sets started on successful doStart() return.

Returns: OK on success, negative error code on failure.

Definition at line 116 of file object.hxx.

References doStart().

Here is the call graph for this function:

◆ stop()

int dawn::CObject::stop ( )

inline

Stop object.

Tracks operational state and calls doStop(). This phase may run many times during an object's lifetime and should not perform one-time deallocation. Always clears started regardless of doStop() return value.

Returns: OK on success, negative error code on failure.

Definition at line 145 of file object.hxx.

References doStop().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ trigger()

virtual int dawn::CObject::trigger ( uint8_t cmd )

inlinevirtual

Execute a trigger command.

Parameters

cmd	Command identifier (EObjectCmd value).

Returns: OK on success, -ENOTSUP if not supported.

Reimplemented in dawn::CIOAdcFetch, dawn::CIOAdcStream, dawn::CIOAdcSync, dawn::CIOEncoder, dawn::CIOEncoderIndex, dawn::CIOPwm, dawn::CProgBuffer, dawn::CProgCounter, dawn::CProgProcess, dawn::CProgSequencer, dawn::CProgThresholdBase, and dawn::CProgToggle.

Definition at line 195 of file object.hxx.

◆ validateDesc()

int CObject::validateDesc	(	const uint32_t *	desc,
		size_t	len
	)

static

Validate entire descriptor.

Validates a descriptor binary object-by-object using default checks.

Parameters

desc	Descriptor binary pointer.
len	Descriptor length in 32-bit words.

Returns: OK on success, negative error code indicating validation stage.

Definition at line 123 of file object.cxx.

References descValidDefault().

Here is the call graph for this function:

Here is the caller graph for this function:

The documentation for this class was generated from the following files:

dawn/include/dawn/common/object.hxx
dawn/src/common/object.cxx

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

◆ EObjectState

Constructor & Destructor Documentation

◆ CObject()

Member Function Documentation

◆ configure()

◆ deinit()

◆ descValidDefault()

◆ doStart()

◆ doStop()

◆ getCfgFlag()

◆ getCls()

◆ getDesc()

◆ getDtype()

◆ getDtypeSize()

◆ getFlags()

◆ getId()

◆ getIdV()

◆ getObjConfig()

◆ getPriv()

◆ getState()

◆ getType()

◆ hasThread()

◆ init()

◆ onSetObjConfig()

◆ setObjConfig()

◆ start()

◆ stop()

◆ trigger()

◆ validateDesc()