M_BuiltInTest::IClient Class Reference

Public Member Functions
virtual	~IClient ()
virtual void	ReportBitSettings (M_BuiltInTest::BitSettingsType const &Settings)
virtual void	ReportIBitRoutineStatus (std::string const &KeyRoutineName, M_BuiltInTest::IBitRoutineState::Type RoutineState, bool IsRemoved)
virtual void	ReportIBitStatus (std::string const &KeyIBitName, M_BuiltInTest::BitStatusType const &Status, bool IsRemoved)
virtual void	ReportPBitStatus (std::string const &KeyPBitName, M_BuiltInTest::BitStatusType const &Status, bool IsRemoved)
virtual void	ReportCBitStatus (std::string const &KeyCBitName, M_BuiltInTest::BitStatusType const &Status, bool IsRemoved)

Detailed Description

BITE Client interface. Contains callback operations from the BITE Service to the Client.

Constructor & Destructor Documentation

~IClient()

M_BuiltInTest::IClient::~IClient ( )

virtual

Member Function Documentation

ReportBitSettings()

void M_BuiltInTest::IClient::ReportBitSettings ( M_BuiltInTest::BitSettingsType const &  Settings )

virtual

Report with BITE Service settings. This should be provided at startup and in the event of degraded functionality, e.g. due to an internal failure.

Parameters

Settings

BITE Service settings data.

ReportCBitStatus()

void M_BuiltInTest::IClient::ReportCBitStatus ( std::string const &  KeyCBitName, M_BuiltInTest::BitStatusType const &  Status, bool  IsRemoved  )

virtual

Reports the CBIT (Continuous Built-In Test) BITE status.

These are any tests performed while the application is active. They may be part of the application itself or might be supplied by the hardware module vendors to run periodically.

Parameters

KeyCBitName	Name identifying the currently reported status. This name is used as an identifying key so that one Service can report multiple status relevant for a device, such as the "Program Checksum" status and the "Temperature" status. Note: The specific string names are defined separately for each implementing Service and are reported in ReportBitSettings in the SupportedCBitNames settings element.
Status	Current status/result of CBIT.
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.

ReportIBitRoutineStatus()

void M_BuiltInTest::IClient::ReportIBitRoutineStatus ( std::string const &  KeyRoutineName, M_BuiltInTest::IBitRoutineState::Type  RoutineState, bool  IsRemoved  )

virtual

Reports the current status for an IBIT (Initiated Built-In Test) BITE test routine. This status is reported for the routines that are started by a Client with the CmdStartIBitRoutine command.

Parameters

KeyRoutineName	Name of IBIT routine of the currently reported status. Note: The specific string names are defined separately for each implementing Service and are reported in ReportBitSettings in the SupportedIBitRoutineNames settings element.
RoutineState	Current state of an IBIT routine.
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.

ReportIBitStatus()

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

virtual

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.

Parameters

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	Current status/result of IBIT.
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.

ReportPBitStatus()

void M_BuiltInTest::IClient::ReportPBitStatus ( std::string const &  KeyPBitName, M_BuiltInTest::BitStatusType const &  Status, bool  IsRemoved  )

virtual

Reports the PBIT (Power-up Built-In Test) BITE status.

Comprehensive tests of hardware functionality extending as close to the edge of a module as possible.

Parameters

KeyPBitName	Name identifying the currently reported status. This name is used as an identifying key so that one Service can report multiple status relevant for a device, such as the "Program Checksum" status and the "Temperature" status. Note: The specific string names are defined separately for each implementing Service and are reported in ReportBitSettings in the SupportedPBitNames settings element.
Status	Current status/result of PBIT.
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.