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

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

#include <RangedObject.h>

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

Public Member Functions

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

Constructor & Destructor Documentation

◆ RangedString() [1/2]

OpenTestSystem::Otx::Runtime::Api::DataTypes::RangedString::RangedString ( const std::string &  value,
std::vector< std::shared_ptr< StringInterval >>  interval,
bool  isValueWritten 
)

Initializes a new instance of the RangedString class.

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

◆ RangedString() [2/2]

OpenTestSystem::Otx::Runtime::Api::DataTypes::RangedString::RangedString ( const std::string &  value,
std::vector< std::shared_ptr< StringInterval >>  interval 
)

Initializes a new instance of the RangedString class.

Parameters
valueThe value
intervalThe List of StringInterval

Member Function Documentation

◆ GetInterval()

std::vector<std::shared_ptr<StringInterval> >& OpenTestSystem::Otx::Runtime::Api::DataTypes::RangedString::GetInterval ( )

Gets List of StringIntervalLiteral of the RangedString.

Returns
List of StringInterval

◆ GetValue()

std::string OpenTestSystem::Otx::Runtime::Api::DataTypes::RangedString::GetValue ( ) const

Gets the String value of the RangedString.

Returns
The value

◆ IsInRange()

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