onboardapi  9.10.0
by Rheinmetall
M_BuiltInTest::ReportIBitStatus Struct Reference

Public Member Functions

 ReportIBitStatus ()
 
 ReportIBitStatus (std::string const &KeyIBitName, M_BuiltInTest::BitStatusType const &Status, bool IsRemoved)
 

Public Attributes

std::string KeyIBitName
 
M_BuiltInTest::BitStatusType Status
 Current status/result of IBIT. More...
 
bool IsRemoved
 

Detailed Description

Reports the IBIT (Initiated Built-In Test) BITE status. This status is reported for the potential errors that can be detected from a IBIT routine that has been started by a Client with the CmdStartIBitRoutine command.

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.

Constructor & Destructor Documentation

◆ ReportIBitStatus() [1/2]

M_BuiltInTest::ReportIBitStatus::ReportIBitStatus ( )

◆ ReportIBitStatus() [2/2]

M_BuiltInTest::ReportIBitStatus::ReportIBitStatus ( std::string const &  KeyIBitName,
M_BuiltInTest::BitStatusType const &  Status,
bool  IsRemoved 
)

Member Data Documentation

◆ IsRemoved

bool M_BuiltInTest::ReportIBitStatus::IsRemoved

Indicates if the status is no longer available. Note: This will always be set to True when a Service has been shut down. After this has been set to True, the status will no longer be available to late joiners.

◆ KeyIBitName

std::string M_BuiltInTest::ReportIBitStatus::KeyIBitName

Name identifying the currently reported status. Note: The specific string names are defined separately for each implementing Service and are reported in ReportBitSettings in the SupportedIBitNames settings element.

◆ Status

M_BuiltInTest::BitStatusType M_BuiltInTest::ReportIBitStatus::Status

Current status/result of IBIT.