Manual for OpenFLUID 2.1.11

Public Member Functions | List of all members
openfluid::core::DoubleValue Class Reference

Detailed Description

DoubleValue is a container for a signed double precision floating point value.

See also
Value

Example : declaration

// declaration of a DoubleValue, initialized to 0.0 by default
// declaration of a DoubleValue, initialized to 1.357

Example : getting the contained value

double Tmp1;
// using the get method
Tmp1 = Val1.get();
// or using the cast operator
Tmp1 = Val1;

Example : setting the contained value

// using the set method
Val1.set(101.99);

Example : conversion from string

openfluid::core::StringValue StringVal("57.33");
// to DoubleValue
StringVal.toDoubleValue(Val1);
// to double
double DblVal;
StringVal.toDouble(DblVal);

Example : conversion to string

std::string StdStrVal = Val1.toString();

#include <core/DoubleValue.hpp>

Public Member Functions

 DoubleValue () noexcept
 
 DoubleValue (const DoubleValue &Val) noexcept
 
 DoubleValue (DoubleValue &&Val) noexcept
 
 DoubleValue (const double &POD) noexcept
 
DoubleValueoperator= (const Value &Other) override
 
DoubleValueoperator= (Value &&Other) override
 
DoubleValueoperator= (const DoubleValue &)=default
 
DoubleValueoperator= (DoubleValue &&)=default
 
virtual ~DoubleValue ()=default
 
 operator double () const
 
Type getType () const override
 
Valueclone () const override
 
bool convert (Value &Val) const override
 
double get () const
 
void set (const double &Val)
 
void writeToStream (std::ostream &OutStm) const override
 
void writeQuotedToStream (std::ostream &OutStm) const override
 
- Public Member Functions inherited from openfluid::core::SimpleValue
bool isSimple () const override
 
bool isCompound () const override
 
- Public Member Functions inherited from openfluid::core::Value
 Value ()=default
 
 Value (const Value &)=default
 
 Value (Value &&)=default
 
virtual ~Value ()=default
 
bool isDoubleValue () const
 
const DoubleValueasDoubleValue () const
 
DoubleValueasDoubleValue ()
 
bool isIntegerValue () const
 
const IntegerValueasIntegerValue () const
 
IntegerValueasIntegerValue ()
 
bool isBooleanValue () const
 
const BooleanValueasBooleanValue () const
 
BooleanValueasBooleanValue ()
 
bool isStringValue () const
 
const StringValueasStringValue () const
 
StringValueasStringValue ()
 
bool isNullValue () const
 
const NullValueasNullValue () const
 
NullValueasNullValue ()
 
bool isVectorValue () const
 
const VectorValueasVectorValue () const
 
VectorValueasVectorValue ()
 
bool isMatrixValue () const
 
const MatrixValueasMatrixValue () const
 
MatrixValueasMatrixValue ()
 
bool isMapValue () const
 
const MapValueasMapValue () const
 
MapValueasMapValue ()
 
bool isTreeValue () const
 
const TreeValueasTreeValue () const
 
TreeValueasTreeValue ()
 
std::string toString () const
 

Additional Inherited Members

- Public Types inherited from openfluid::core::Value
enum  Type {
  NONE, BOOLEAN, INTEGER, DOUBLE,
  STRING, VECTOR, MATRIX, MAP,
  TREE, NULLL
}
 
- Static Public Member Functions inherited from openfluid::core::Value
static bool getValueTypeFromString (const std::string &ValueTypeString, Value::Type &ValueType)
 
static std::string getStringFromValueType (const Value::Type ValueType)
 
Inheritance diagram for openfluid::core::DoubleValue:
Inheritance graph
[legend]
Collaboration diagram for openfluid::core::DoubleValue:
Collaboration graph
[legend]

Constructor & Destructor Documentation

◆ DoubleValue() [1/4]

openfluid::core::DoubleValue::DoubleValue ( )
inlinenoexcept

Default constructor

◆ DoubleValue() [2/4]

openfluid::core::DoubleValue::DoubleValue ( const DoubleValue Val)
inlinenoexcept

Copy constructor

◆ DoubleValue() [3/4]

openfluid::core::DoubleValue::DoubleValue ( DoubleValue &&  Val)
inlinenoexcept

Move constructor

◆ DoubleValue() [4/4]

openfluid::core::DoubleValue::DoubleValue ( const double &  POD)
inlinenoexcept

Constructor from plain old type

◆ ~DoubleValue()

virtual openfluid::core::DoubleValue::~DoubleValue ( )
virtualdefault

Member Function Documentation

◆ clone()

Value* openfluid::core::DoubleValue::clone ( ) const
inlineoverridevirtual

Reimplemented from openfluid::core::Value.

◆ convert()

bool openfluid::core::DoubleValue::convert ( Value Val) const
overridevirtual

Reimplemented from openfluid::core::Value.

◆ get()

double openfluid::core::DoubleValue::get ( ) const
inline

Returns the double value as plain old type

Returns
the double value

◆ getType()

Type openfluid::core::DoubleValue::getType ( ) const
inlineoverridevirtual

◆ operator double()

openfluid::core::DoubleValue::operator double ( ) const
inline

Cast operator

◆ operator=() [1/4]

DoubleValue& openfluid::core::DoubleValue::operator= ( const DoubleValue )
default

◆ operator=() [2/4]

DoubleValue& openfluid::core::DoubleValue::operator= ( const Value )
overridevirtual

Assignment operator

Reimplemented from openfluid::core::Value.

◆ operator=() [3/4]

DoubleValue& openfluid::core::DoubleValue::operator= ( DoubleValue &&  )
default

◆ operator=() [4/4]

DoubleValue& openfluid::core::DoubleValue::operator= ( Value &&  )
overridevirtual

Move operator

Reimplemented from openfluid::core::Value.

◆ set()

void openfluid::core::DoubleValue::set ( const double &  Val)
inline

Sets the plain old type double value

Parameters
[in]Valthe double value

◆ writeQuotedToStream()

void openfluid::core::DoubleValue::writeQuotedToStream ( std::ostream &  OutStm) const
inlineoverridevirtual

◆ writeToStream()

void openfluid::core::DoubleValue::writeToStream ( std::ostream &  OutStm) const
overridevirtual

The documentation for this class was generated from the following file:
openfluid::core::Value::toString
std::string toString() const
openfluid::core::DoubleValue::get
double get() const
Definition: DoubleValue.hpp:147
openfluid::core::DoubleValue
Definition: DoubleValue.hpp:80
openfluid::core::DoubleValue::set
void set(const double &Val)
Definition: DoubleValue.hpp:156
openfluid::core::StringValue
Definition: StringValue.hpp:76