The diagnostic connection state describes conditions how a procedure can be executed. More...

#include <DiagConnectionState.h>

Public Member Functions
ClampState API_EXPORTS	GetBatteryState ()
	Returns the state of the battery. It returns ON, if the battery voltage, see GetBatteryVoltage is greater than the value in BatteryVoltageThreshold. More...

int API_EXPORTS	GetBatteryVoltageThreshold ()
	Get the voltage threshold in millivolt from which the battery voltage, see GetBatteryVoltage is enough for KL30 = On. The default value is 6000 mV. More...

ClampState API_EXPORTS	GetIgnitionState ()
	Returns the state of the ignition, see GetIgnitionState. More...

int API_EXPORTS	GetPollingTime ()
	Returns the time in milliseconds between the next check of the connection state during the procedure execution (Polling). The default value is 500 ms. More...

void API_EXPORTS	SetBatteryVoltageThreshold (int batteryVoltageThreshold)
	Set the voltage threshold in millivolt from which the battery voltage, see GetBatteryVoltage is enough for KL30 = On. More...

void API_EXPORTS	SetPollingTime (int pollingTime)
	Set the time in milliseconds between the next check of the connection state during the procedure execution (Polling). More...

Detailed Description

The diagnostic connection state describes conditions how a procedure can be executed.

Member Function Documentation

◆ GetBatteryState()

ClampState API_EXPORTS OpenTestSystem::Otx::Runtime::Api::DiagConnectionState::GetBatteryState ( )

Returns the state of the battery. It returns ON, if the battery voltage, see GetBatteryVoltage is greater than the value in BatteryVoltageThreshold.

◆ GetBatteryVoltageThreshold()

int API_EXPORTS OpenTestSystem::Otx::Runtime::Api::DiagConnectionState::GetBatteryVoltageThreshold ( )

Get the voltage threshold in millivolt from which the battery voltage, see GetBatteryVoltage is enough for KL30 = On. The default value is 6000 mV.

◆ GetIgnitionState()

ClampState API_EXPORTS OpenTestSystem::Otx::Runtime::Api::DiagConnectionState::GetIgnitionState ( )

Returns the state of the ignition, see GetIgnitionState.

◆ GetPollingTime()

int API_EXPORTS OpenTestSystem::Otx::Runtime::Api::DiagConnectionState::GetPollingTime ( )

Returns the time in milliseconds between the next check of the connection state during the procedure execution (Polling). The default value is 500 ms.

◆ SetBatteryVoltageThreshold()

void API_EXPORTS OpenTestSystem::Otx::Runtime::Api::DiagConnectionState::SetBatteryVoltageThreshold ( int batteryVoltageThreshold )

Set the voltage threshold in millivolt from which the battery voltage, see GetBatteryVoltage is enough for KL30 = On.

◆ SetPollingTime()

void API_EXPORTS OpenTestSystem::Otx::Runtime::Api::DiagConnectionState::SetPollingTime ( int pollingTime )

Set the time in milliseconds between the next check of the connection state during the procedure execution (Polling).

The documentation for this class was generated from the following file:

DiagConnectionState.h

Public Member Functions