onboardapi  9.10.0
by Rheinmetall
M_BuiltInTest::IService Class Reference

Public Member Functions

virtual ~IService ()
 
virtual void CmdStartIBitRoutine (std::string const &RoutineName)
 
virtual void CmdCancelIBitRoutine (std::string const &RoutineName)
 

Detailed Description

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

Constructor & Destructor Documentation

◆ ~IService()

M_BuiltInTest::IService::~IService ( )
virtual

Member Function Documentation

◆ CmdCancelIBitRoutine()

void M_BuiltInTest::IService::CmdCancelIBitRoutine ( std::string const &  RoutineName)
virtual

Cmd to stop a currently running IBIT (Initiated Built-In Test) routine.

Parameters
RoutineNameName of the currently running IBIT routine to cancel.

◆ CmdStartIBitRoutine()

void M_BuiltInTest::IService::CmdStartIBitRoutine ( std::string const &  RoutineName)
virtual

Cmd to start offline IBIT (Initiated Built-In Test) routine.

Usually invoked following a failure, IBIT initiates tests to isolate a fault within a system or subsystem. In general, IBIT will halt the current application, run its tests, and either resume or restart the application.

Parameters
RoutineNameName of IBIT routine to execute. This name is used as an identifying key so that one Service can support multiple IBIT tests. Note: The specific string names are defined separately for each implementing Service.