onboardapi  9.10.0
by Rheinmetall
M_BuiltInTestCtrl::IService Class Reference

Public Member Functions

virtual ~IService ()
 
virtual void ConfigAllowTest (bool IsAllowed)
 
virtual void CmdStartTest (std::string const &Action)
 
virtual void CmdCancelTest ()
 Cmd to stop a currently running test. More...
 
virtual void RequestHistoricalRecords (M_BuiltInTestCtrl::HistoricalBitRecordParamsType const &RecordParams, uint16_t MaxNoRecords)
 

Detailed Description

Service interface. Contains operations that a client can command the BITE Control Service to perform.

Constructor & Destructor Documentation

◆ ~IService()

M_BuiltInTestCtrl::IService::~IService ( )
virtual

Member Function Documentation

◆ CmdCancelTest()

void M_BuiltInTestCtrl::IService::CmdCancelTest ( )
virtual

Cmd to stop a currently running test.

◆ CmdStartTest()

void M_BuiltInTestCtrl::IService::CmdStartTest ( std::string const &  Action)
virtual

Start a test from the list of supported actions reported by the service.

Parameters
ActionName of which supported action to start.

◆ ConfigAllowTest()

void M_BuiltInTestCtrl::IService::ConfigAllowTest ( bool  IsAllowed)
virtual

Configure if tests should be allowed to be started.

Parameters
IsAllowedIndicates if tests should be allowed to be started (true) or not (false).

◆ RequestHistoricalRecords()

void M_BuiltInTestCtrl::IService::RequestHistoricalRecords ( M_BuiltInTestCtrl::HistoricalBitRecordParamsType const &  RecordParams,
uint16_t  MaxNoRecords 
)
virtual

Request historical records from the service.

Parameters
RecordParamsParameters of the requested records.
MaxNoRecordsMaximum number of records the service should respond with. Note: No more than 100 records can be requested at one time. Range 1 - 100