openfluid::core::VectorValue Class Reference

#include <core/VectorValue.hpp>

Inheritance diagram for openfluid::core::VectorValue:

Public Member Functions
	VectorValue ()
	VectorValue (const VectorValue &Val)
	VectorValue (unsigned long Size)
	VectorValue (unsigned long Size, double InitValue)
	VectorValue (double *Data, unsigned long Size)
Value &	operator= (const Value &Other)
virtual	~VectorValue ()
Type	getType () const
Value *	clone () const
void	writeToStream (std::ostream &OutStm) const
Public Member Functions inherited from openfluid::core::CompoundValue
bool	isSimple () const
bool	isCompound () const
Public Member Functions inherited from openfluid::core::Value
	Value ()
	Value (const Value &)
virtual	~Value ()
bool	isDoubleValue () const
const DoubleValue &	asDoubleValue () const
DoubleValue &	asDoubleValue ()
bool	isIntegerValue () const
const IntegerValue &	asIntegerValue () const
IntegerValue &	asIntegerValue ()
bool	isBooleanValue () const
const BooleanValue &	asBooleanValue () const
BooleanValue &	asBooleanValue ()
bool	isStringValue () const
const StringValue &	asStringValue () const
StringValue &	asStringValue ()
bool	isNullValue () const
const NullValue &	asNullValue () const
NullValue &	asNullValue ()
bool	isVectorValue () const
const VectorValue &	asVectorValue () const
VectorValue &	asVectorValue ()
bool	isMatrixValue () const
const MatrixValue &	asMatrixValue () const
MatrixValue &	asMatrixValue ()
bool	isMapValue () const
const MapValue &	asMapValue () const
MapValue &	asMapValue ()
std::string	toString () const
Public Member Functions inherited from openfluid::core::Vector< double >
	Vector ()
	Vector (const Vector &Vector)
	Vector (unsigned long Size)
	Vector (unsigned long Size, doubleInitValue)
	Vector (double *Data, unsigned long Size)
	~Vector ()
unsigned long	getSize () const
unsigned long	size () const
double *	getData () const
void	setData (double *Data, unsigned long Size)
double	getElement (unsigned long Index) const
double	at (unsigned long Index) const
double	get (unsigned long Index) const
void	setElement (unsigned long Index, doubleElement)
void	set (unsigned long Index, doubleElement)
double &	operator[] (unsigned long Index)
Vector< double > &	operator= (const Vector &A)
void	fill (const double &Val)
void	clear ()

Additional Inherited Members
Public Types inherited from openfluid::core::CompoundValue
typedef std::vector< std::string >	SeparatorsByLevels_t
Public Types inherited from openfluid::core::Value
enum	Type {   NONE, BOOLEAN, INTEGER, DOUBLE,   STRING, VECTOR, MATRIX, MAP,   NULLL }
Static Public Member Functions inherited from openfluid::core::CompoundValue
static std::string	getStreamSeparator (const unsigned int &Level)
static void	setStreamSeparator (const unsigned int &Level, const std::string &Sep)
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)
Protected Member Functions inherited from openfluid::core::Vector< double >
bool	allocate (unsigned long Size)
void	init ()
Static Protected Member Functions inherited from openfluid::core::Vector< double >
static void	copy (const Vector &Source, Vector &Dest)
Protected Attributes inherited from openfluid::core::Vector< double >
double *	m_Data
unsigned long	m_Size
Static Protected Attributes inherited from openfluid::core::CompoundValue
static SeparatorsByLevels_t	m_StreamSeparators

Detailed Description

VectorValue is a container for a 1D vector of signed double precision floating point values.

See Also

Value

Vector

Example : declaration

// declaration of a VectorValue, empty by default
openfluid::core::VectorValue Val1;

// declaration of a VectorValue of 7 elements, with values initialized to 0.0
openfluid::core::VectorValue Val2(7);

// declaration of a VectorValue of 7 elements, with values initialized to 1.99
openfluid::core::VectorValue Val3(7,1.99);

Example : getting the contained values

double Tmp1;

// using the get method
Tmp1 = Val1.get(2);

// or using the [] operator
Tmp1 = Val1[2];

Example : getting all values as a c-style array of double

double DblArrayVal[];

DblArrayVal = Val1.getData();

Example : setting the contained values

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

// or using the [] operator
Val1[0] = 101.99;

Example : conversion from string

openfluid::core::StringValue StringVal;
openfluid::core::VectorValue Val2;

// to VectorValue, using a string values separator
StringVal.set("3;5;2.8;6;17.999923;1;1;1;1;1;2.11;2.12;2.13;2.14;2.15");
StringVal.toVectorValue(";",Val2);

Example : conversion to string

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

Constructor & Destructor Documentation

openfluid::core::VectorValue::VectorValue ( )

inline

Default constructor

openfluid::core::VectorValue::VectorValue ( const VectorValue &  Val )

inline

Copy constructor

openfluid::core::VectorValue::VectorValue ( unsigned long  Size )

inline

Constructor, creates a vector containing Size elements

openfluid::core::VectorValue::VectorValue ( unsigned long  Size, double  InitValue  )

inline

Constructor, creates a vector containing Size elements, initialized with value InitValue

openfluid::core::VectorValue::VectorValue ( double *  Data, unsigned long  Size  )

inline

Constructor, creates a vector of size Size, containing Data

virtual openfluid::core::VectorValue::~VectorValue ( )

inlinevirtual

Member Function Documentation

Value* openfluid::core::VectorValue::clone ( ) const

inlinevirtual

Reimplemented from openfluid::core::Value.

Type openfluid::core::VectorValue::getType ( ) const

inlinevirtual

Implements openfluid::core::Value.

Value& openfluid::core::VectorValue::operator= ( const Value &  )

virtual

Assignment operator

Reimplemented from openfluid::core::Value.

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

virtual

Implements openfluid::core::Value.

---

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

• core/VectorValue.hpp