ADTF  3.15.3
ISignalRegistry::ISignalProviderabstract

Interface for a signal provider. More...

Inheritance diagram for ISignalRegistry::ISignalProvider:
[legend]

Classes

class  IEnabledSignals
 Callback interface for enabling and disabling signal generation. More...
 

Public Member Functions

 ADTF_IID (ISignalProvider, "signal_provider.signal_registry.ant.services.adtf.iid")
 Interface ID for the interface.
 
virtual tResult AddSignal (const tSignalAttributes &sSignal, IEnabledSignals *pEnableCallback=nullptr)=0
 Adds a new signal. More...
 
virtual tResult UpdateSignal (tSignalID nSignalID, const tSignalValue &sValue)=0
 Update the value of a signal. More...
 
virtual tResult RemoveSignal (tSignalID nSignalID)=0
 Removes a signal. More...
 
- Public Member Functions inherited from IObject
 ADTF_IID (IObject, "object.ant.ucom.adtf.iid")
 Marks the IObject to be castable with the ucom_cast() More...
 

Protected Member Functions

 ~ISignalProvider ()=default
 Protected destructor --> Use implemented Destroy() instead of delete!
 
- Protected Member Functions inherited from IObject
 ~IObject ()=default
 Protected destructor --> Use implemented Destroy() instead of delete!
 

Detailed Description

Interface for a signal provider.

Definition at line 68 of file signal_registry_intf.h.

Member Function Documentation

◆ AddSignal()

virtual tResult AddSignal ( const tSignalAttributes sSignal,
IEnabledSignals pEnableCallback = nullptr 
)
pure virtual

Adds a new signal.

Parameters
[in]sSignalThe attributes of the signal.
[in]pEnableCallbackOptional call back to enable disable signal generation.
Returns
Standard result.

◆ RemoveSignal()

virtual tResult RemoveSignal ( tSignalID  nSignalID)
pure virtual

Removes a signal.

Parameters
[in]nSignalIDThe id of the signal.
Returns
Standard result.

Implicitly called at the destruction of ISignalProvider for all signals which have not been removed yet.

◆ UpdateSignal()

virtual tResult UpdateSignal ( tSignalID  nSignalID,
const tSignalValue sValue 
)
pure virtual

Update the value of a signal.

Parameters
[in]nSignalIDThe id of the signal
[in]sValueThe new value of the signal.
Returns
Standard result.