Holds the status of an uncommitted value derived from a PIF analog input. More...

Collaboration diagram for optris::UncommittedValueStatus:

Public Member Functions
OTC_SDK_API	UncommittedValueStatus () noexcept
	Constructor.

const PifIndex &	getPifIndex () const noexcept
	Returns the index of the PIF analog input that generated the uncommitted value.

const std::string &	getName () const noexcept
	Returns the name of the uncommitted value.

const std::string &	getUnit () const noexcept
	Returns the unit of the uncommitted value.

float	getValue () const noexcept
	Returns the uncommitted value.

OTC_SDK_API void	update (const PifIndex &pifIndex, const std::string &name, const std::string &unit, float value) noexcept
	Updates the uncommitted value status.

Detailed Description

Holds the status of an uncommitted value derived from a PIF analog input.

Member Function Documentation

const std::string & optris::UncommittedValueStatus::getName ( ) const

inlinenoexcept

Returns the name of the uncommitted value.

const PifIndex & optris::UncommittedValueStatus::getPifIndex ( ) const

inlinenoexcept

Returns the index of the PIF analog input that generated the uncommitted value.

Returns: the index of the PIF analog input that generated the uncommitted value.

const std::string & optris::UncommittedValueStatus::getUnit ( ) const

inlinenoexcept

Returns the unit of the uncommitted value.

float optris::UncommittedValueStatus::getValue ( ) const

inlinenoexcept

Returns the uncommitted value.

OTC_SDK_API void optris::UncommittedValueStatus::update	(	const PifIndex &	pifIndex,
		const std::string &	name,
		const std::string &	unit,
		float	value )

noexcept

Updates the uncommitted value status.

Parameters

[in]	pifIndex	the index of the PIF analog input that generates the uncommitted value.
[in]	name	of the uncommitted value.
[in]	unit	of the uncommitted value.
[in]	value	of the uncommitted value.

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