QuantityVector Class Reference

real vector variable More...

#include <QuantityVector.h>

Inheritance diagram for QuantityVector:

Public Member Functions

 QuantityVector (const std::string &tag, const std::string &description, int count, const Value &value, Persistent *parent=nullptr)
 
 QuantityVector (QuantityVector &&other)
 move constructor More...
 
QuantityVectoroperator= (QuantityVector &&other)
 move assignment More...
 
const std::string & type () const override
 
void set (double v, const std::string &u="")
 
bool input () const
 
bool output () const
 
void setInput ()
 
void setOutput ()
 
const std::string unit () const
 
void resize (std::size_t count) override
 resizes the number of elements contained to count More...
 
- Public Member Functions inherited from TypeVector< Value >
 TypeVector (const std::string &tag, const std::string &description, Persistent *parent, int count, const Value &value)
 main constructor More...
 
 TypeVector (TypeVector &&other)
 move constructor More...
 
TypeVectoroperator= (TypeVector &&other)
 move assignment More...
 
Valueoperator[] (std::size_t index)
 
const Valueat (std::size_t index) const
 
std::size_t size (void) const
 
virtual void resize (std::size_t count)
 resizes the number of elements contained to count More...
 
void set (const Value &value)
 sets the value for all elements More...
 
- Public Member Functions inherited from Type< std::vector< Value > >
 Type (const std::string &tag, const std::string &description, Persistent *parent, const std::vector< Value > &value)
 main constructor More...
 
 Type (Type &&other)
 move constructor More...
 
Typeoperator= (Type &&other)
 move assignment More...
 
std::vector< Value > & value (void)
 Type value getter. More...
 
const std::vector< Value > & value (void) const
 
bool operator!= (const Type &rhs) const
 
bool operator== (const Type &rhs) const
 
- Public Member Functions inherited from Item
 Item (const Item &other)
 copy constructor copies all elements but parent which is set to nullptr More...
 
Itemoperator= (const Item &other)
 copy assignment operator copies all elements but parent which is set to nullptr More...
 
 Item (const std::string &tag, const std::string &description, Persistent *parent)
 
 Item (Item &&other)
 move constructor More...
 
Itemoperator= (Item &&other)
 move assignment operator More...
 
virtual ~Item ()
 
const std::string & tag () const
 
const std::string & description () const
 
std::string fullTag () const
 
const Persistentparent () const
 
virtual const std::string & type () const =0
 
void setTag (const std::string &tag)
 
void setDescription (const std::string &description)
 
void setWideTag (const std::wstring &tag)
 wide-character variant, More...
 
void setWideDescription (const std::wstring &description)
 wide-character variant, More...
 
bool operator!= (const Item &rhs) const
 
bool operator== (const Item &rhs) const
 

Additional Inherited Members

- Public Types inherited from Type< std::vector< Value > >
typedef std::vector< ValueValueType
 name the value type to make it possible for function templates acting on Type<T> to access T properties and methods More...
 
- Protected Attributes inherited from Type< std::vector< Value > >
std::vector< Valuevalue_
 
- Protected Attributes inherited from Item
Persistentparent_
 pointer to the parent Persistent; set to this by the constructor if Item is self-standing or a root Persistent of a tree More...
 

Detailed Description

real vector variable

used for vectors

#include <libpf/persistency/QuantityVector.h>

Remarks
empty vectors can only be created for adimensional Values
Warning
Thread safe:
Extendable:
Platform dependencies:

Constructor & Destructor Documentation

◆ QuantityVector() [1/2]

QuantityVector::QuantityVector ( const std::string &  tag,
const std::string &  description,
int  count,
const Value value,
Persistent parent = nullptr 
)

main constructor

Parameters
tagUTF-8 encoded human-readable label, unique among siblings
descriptionUTF-8 encoded description
countnumber of elements
valueinitialization value for all elements
parentpointer to the parent Persistent; set to this by the constructor if Item is self-standing or a root Persistent of a tree

◆ QuantityVector() [2/2]

QuantityVector::QuantityVector ( QuantityVector &&  other)

move constructor

Member Function Documentation

◆ input()

bool QuantityVector::input ( ) const

◆ operator=()

QuantityVector & QuantityVector::operator= ( QuantityVector &&  other)

move assignment

◆ output()

bool QuantityVector::output ( ) const

◆ resize()

void QuantityVector::resize ( std::size_t  count)
overridevirtual

resizes the number of elements contained to count

Reimplemented from TypeVector< Value >.

◆ set()

void QuantityVector::set ( double  v,
const std::string &  u = "" 
)
inline

◆ setInput()

void QuantityVector::setInput ( )

◆ setOutput()

void QuantityVector::setOutput ( )

◆ type()

const std::string & QuantityVector::type ( ) const
overridevirtual
Returns
the C++ name of the class the instance belongs to
Note
it is the responsibility of the caller to not access this reference after the lifecycle of the Item

Implements Item.

◆ unit()

const std::string QuantityVector::unit ( ) const

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