OTX-Runtime for C++  
OpenTestSystem::Otx::Runtime::Api::DataTypes::RangedFloat Class Reference

A RangedFloat is a RangedObject and represents a Float value which can have one or more intervals. More...

#include <RangedObject.h>

Inheritance diagram for OpenTestSystem::Otx::Runtime::Api::DataTypes::RangedFloat:
Inheritance graph

Public Member Functions

 RangedFloat (double value, std::vector< std::shared_ptr< FloatInterval >> interval)
 Initializes a new instance of the RangedFloat class. More...
 
 RangedFloat (double value, std::vector< std::shared_ptr< FloatInterval >> interval, bool isValueWritten)
 Initializes a new instance of the RangedFloat class. More...
 
std::vector< std::shared_ptr< FloatInterval > > & GetInterval ()
 Gets List of FloatIntervalLiteral of the RangedFloat. More...
 
double GetValue () const
 Gets the Float value of the RangedFloat. More...
 
bool IsInRange () const override
 Checks if the value is in range. More...
 
std::string ToLiteralString () const override
 Gets literal string. More...
 
- Public Member Functions inherited from OpenTestSystem::Otx::Runtime::Api::DataTypes::RangedObject
virtual bool IsValueWritten () const
 A value is considered written if one of the set value actions is called. Overwriting with the same value as the current value counts as written. The initialization of the ranged object with a value does not count as written. More...
 

Detailed Description

A RangedFloat is a RangedObject and represents a Float value which can have one or more intervals.

Constructor & Destructor Documentation

◆ RangedFloat() [1/2]

OpenTestSystem::Otx::Runtime::Api::DataTypes::RangedFloat::RangedFloat ( double  value,
std::vector< std::shared_ptr< FloatInterval >>  interval,
bool  isValueWritten 
)

Initializes a new instance of the RangedFloat class.

Parameters
valueThe value
intervalThe List of FloatInterval
isValueWrittenA value is considered written if one of the set value actions is called. Overwriting with the same value as the current value counts as written. The initialization of the ranged object with a value does not count as written.

◆ RangedFloat() [2/2]

OpenTestSystem::Otx::Runtime::Api::DataTypes::RangedFloat::RangedFloat ( double  value,
std::vector< std::shared_ptr< FloatInterval >>  interval 
)

Initializes a new instance of the RangedFloat class.

Parameters
valueThe value
intervalThe List of FloatInterval

Member Function Documentation

◆ GetInterval()

std::vector<std::shared_ptr<FloatInterval> >& OpenTestSystem::Otx::Runtime::Api::DataTypes::RangedFloat::GetInterval ( )

Gets List of FloatIntervalLiteral of the RangedFloat.

Returns
List of FloatInterval

◆ GetValue()

double OpenTestSystem::Otx::Runtime::Api::DataTypes::RangedFloat::GetValue ( ) const

Gets the Float value of the RangedFloat.

Returns
The value

◆ IsInRange()

bool OpenTestSystem::Otx::Runtime::Api::DataTypes::RangedFloat::IsInRange ( ) const
overridevirtual

Checks if the value is in range.

Returns
True if the value of the ranged object is inside one of the intervals or if the ranged object has no intervals.

Implements OpenTestSystem::Otx::Runtime::Api::DataTypes::RangedObject.

◆ ToLiteralString()

std::string OpenTestSystem::Otx::Runtime::Api::DataTypes::RangedFloat::ToLiteralString ( ) const
overridevirtual

Gets literal string.

Returns
Literal string.

Reimplemented from OpenTestSystem::Otx::Runtime::Api::DataTypes::Object.


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