Struct IObjectControl#

Defined in File core.h

Inheritance Relationships#

Derived Types#

public CCANSilKit (Class CCANSilKit)
public CCANSimulation (Class CCANSimulation)
public CCANSockets (Class CCANSockets)
public CClient (Class CClient)
public CCommunicationControl (Class CCommunicationControl)
public CDispatchService (Class CDispatchService)
public CIsoMonitor (Class CIsoMonitor)
public CListener (Class CListener)
public CProcessControl (Class CProcessControl)
public CSharedMemChannelMgnt (Class CSharedMemChannelMgnt)
public CSimulationTaskTimerService (Class CSimulationTaskTimerService)
public CSocketsChannelMgnt (Class CSocketsChannelMgnt)
public CTaskTimerService (Class CTaskTimerService)

Struct Documentation#

struct IObjectControl#

Optional interface allowing for additional control of more complex SDVObjects. To be implemented if the object in question calls other SDVobjects via running threads or callbacks, requires configuration or performs other complex behavior during creation/shutdown.

Subclassed by CCANSilKit, CCANSimulation, CCANSockets, CClient, CCommunicationControl, CDispatchService, CIsoMonitor, CListener, CProcessControl, CSharedMemChannelMgnt, CSimulationTaskTimerService, CSocketsChannelMgnt, CTaskTimerService

Public Functions

virtual void Initialize(const sdv::u8string &ssObjectConfig) = 0#

Initialize the object.

Parameters:: ssObjectConfig – [in] Optional configuration string.

virtual EObjectStatus GetStatus() const = 0#

Get the current status of the object.

Returns:: Return the current status of the object.

virtual void SetOperationMode(EOperationMode eMode) = 0#

Set the component operation mode.

Parameters:: eMode – [in] The operation mode, the component should run in.

virtual void Shutdown() = 0#

Shutdown called before the object is destroyed.

Attention: Implement calls to other SDV objects here as this is no longer considered safe during the destructor of the object! After a call to shutdown any threads/callbacks/etc that could call other SDV objects need to have been stopped. The SDV object itself is to remain in a state where it can respond to calls to its interfaces as other objects may still call it during the shutdown sequence! Any subsequent call to GetStatus should return EObjectStatus::destruction_pending

void Initialize (in u8string ssObjectConfig)

Initialize the object.

Parameters:: ssObjectConfig – [in] Optional configuration string.

EObjectStatus GetStatus() const

Get the current status of the object.

Returns:: Return the current status of the object.

void SetOperationMode (in EOperationMode eMode)