onboardapi  9.10.0
by Rheinmetall
M_SignalProcessing::IService Class Reference

Public Member Functions

virtual ~IService ()
 
virtual void ConfigHfComponent (std::string const &KeyId, M_SignalProcessing::HfComponentType const &HfComponent, bool IsRemoved)
 
virtual void ConfigSoi (std::string const &KeyId, M_SignalProcessing::SoiType const &Soi, bool IsRemoved)
 
virtual void ConfigBandScanSubscription (std::string const &KeyId, M_SignalProcessing::BandScanType const &BandScan, bool IsRemoved)
 

Detailed Description

Signal processing service interface. Contains operations that a client can command the signal processing service to perform.

Constructor & Destructor Documentation

◆ ~IService()

M_SignalProcessing::IService::~IService ( )
virtual

Member Function Documentation

◆ ConfigBandScanSubscription()

void M_SignalProcessing::IService::ConfigBandScanSubscription ( std::string const &  KeyId,
M_SignalProcessing::BandScanType const &  BandScan,
bool  IsRemoved 
)
virtual

Configure band scan parameters. Note: This operation does not automatically configure the HF component parameters accordingly.

Parameters
KeyIdIndicates which band scan to configure.
BandScanBand scan parameters.
IsRemovedIndicates if the band scan parameter set no longer exists. Note: After this has been set to true, the band scan parameters will no longer be available to late joiners.

◆ ConfigHfComponent()

void M_SignalProcessing::IService::ConfigHfComponent ( std::string const &  KeyId,
M_SignalProcessing::HfComponentType const &  HfComponent,
bool  IsRemoved 
)
virtual

Configure a high frequency component (transmitter/receiver).

Parameters
KeyIdIndicates which HF component to configure.
HfComponentHF component data.
IsRemovedIndicates if the payload is no longer available Note: This will always be set to true when the instance has been shut down After this has been set to true, the payload will no longer be available to late joiners.

◆ ConfigSoi()

void M_SignalProcessing::IService::ConfigSoi ( std::string const &  KeyId,
M_SignalProcessing::SoiType const &  Soi,
bool  IsRemoved 
)
virtual

Configure signal of interest.

Parameters
KeyIdIndicates which SOI to configure.
SoiSOI data.
IsRemovedIndicates if the SOI no longer exists. Note: After this has been set to true, the SOI will no longer be available to late joiners.