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

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

#include <RangedObject.h>

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

Public Member Functions

 RangedQuantity (std::shared_ptr< Quantity > value, std::vector< std::shared_ptr< QuantityInterval >> interval)
 Initializes a new instance of the RangedQuantity class. More...
 
 RangedQuantity (std::shared_ptr< Quantity > value, std::vector< std::shared_ptr< QuantityInterval >> interval, bool isValueWritten)
 Initializes a new instance of the RangedQuantity class. More...
 
std::vector< std::shared_ptr< QuantityInterval > > & GetInterval ()
 Gets List of QuantityIntervalLiteral of the RangedQuantity. More...
 
std::shared_ptr< QuantityGetValue () const
 Gets the Quantity value of the RangedQuantity. 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 RangedQuantity is a RangedObject and represents a Quantity value which can have one or more intervals.

Constructor & Destructor Documentation

◆ RangedQuantity() [1/2]

OpenTestSystem::Otx::Runtime::Api::DataTypes::RangedQuantity::RangedQuantity ( std::shared_ptr< Quantity value,
std::vector< std::shared_ptr< QuantityInterval >>  interval,
bool  isValueWritten 
)

Initializes a new instance of the RangedQuantity class.

Parameters
valueThe value
intervalThe List of QuantityInterval
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.

◆ RangedQuantity() [2/2]

OpenTestSystem::Otx::Runtime::Api::DataTypes::RangedQuantity::RangedQuantity ( std::shared_ptr< Quantity value,
std::vector< std::shared_ptr< QuantityInterval >>  interval 
)

Initializes a new instance of the RangedQuantity class.

Parameters
valueThe value
intervalThe List of QuantityInterval

Member Function Documentation

◆ GetInterval()

std::vector<std::shared_ptr<QuantityInterval> >& OpenTestSystem::Otx::Runtime::Api::DataTypes::RangedQuantity::GetInterval ( )

Gets List of QuantityIntervalLiteral of the RangedQuantity.

Returns
List of QuantityInterval

◆ GetValue()

std::shared_ptr<Quantity> OpenTestSystem::Otx::Runtime::Api::DataTypes::RangedQuantity::GetValue ( ) const

Gets the Quantity value of the RangedQuantity.

Returns
The value

◆ IsInRange()

bool OpenTestSystem::Otx::Runtime::Api::DataTypes::RangedQuantity::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::RangedQuantity::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: