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

#include <core/IndexedValue.hpp>

Public Member Functions

 IndexedValue ()
 
 IndexedValue (const TimeIndex_t &Ind, const Value &Val)
 
 IndexedValue (const IndexedValue &IndValue)
 
TimeIndex_t getIndex () const
 
Valuevalue () const
 
Valuevalue ()
 
ValuegetValue () const OPENFLUID_DEPRECATED
 
ValuegetValue () OPENFLUID_DEPRECATED
 
void clear ()
 

Friends

class ValuesBuffer
 

Constructor & Destructor Documentation

◆ IndexedValue() [1/3]

openfluid::core::IndexedValue::IndexedValue ( )
inline

Default constructor

◆ IndexedValue() [2/3]

openfluid::core::IndexedValue::IndexedValue ( const TimeIndex_t Ind,
const Value Val 
)
inline

Constructor from a time index and a value

◆ IndexedValue() [3/3]

openfluid::core::IndexedValue::IndexedValue ( const IndexedValue IndValue)
inline

Copy constructor

Member Function Documentation

◆ clear()

void openfluid::core::IndexedValue::clear ( )
inline

Clears the content of the indexed value. The time index is set to 0, and the value is set to an openfluid::core::NullValue.

◆ getIndex()

TimeIndex_t openfluid::core::IndexedValue::getIndex ( ) const
inline

Returns the time index of the indexed value

Returns
the time index

◆ getValue() [1/2]

Value* openfluid::core::IndexedValue::getValue ( ) const
inline

◆ getValue() [2/2]

Value* openfluid::core::IndexedValue::getValue ( )
inline
Deprecated:
Since version 2.1.0. Use openfluid::core::IndexedValue::value() instead

◆ value() [1/2]

Value* openfluid::core::IndexedValue::value ( ) const
inline

Returns a pointer to the value of the indexed value

Returns
a pointer to the value

◆ value() [2/2]

Value* openfluid::core::IndexedValue::value ( )
inline

Returns a pointer to the value of the indexed value

Returns
a pointer to the value

Friends And Related Function Documentation

◆ ValuesBuffer

friend class ValuesBuffer
friend

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