libvisiontransfer  10.8.0
Classes | Public Types | Public Member Functions | List of all members
visiontransfer::param::ParameterValue Class Reference

Detailed Description

A raw castable variant value for parameters, used for several things internally in Parameter

Definition at line 59 of file parametervalue.h.

#include <visiontransfer/parametervalue.h>

Classes

class  Pimpl
 

Public Types

enum  ParameterType {
  TYPE_INT, TYPE_DOUBLE, TYPE_BOOL, TYPE_STRING,
  TYPE_SAFESTRING, TYPE_TENSOR, TYPE_COMMAND, TYPE_UNDEFINED
}
 

Public Member Functions

VT_EXPORT ParameterValue (const ParameterValue &other)
 
VT_EXPORT ParameterValue & operator= (const ParameterValue &other)
 
VT_EXPORT ParameterValue & setType (ParameterType t)
 
VT_EXPORT ParameterValue & setTensorShape (const std::vector< unsigned int > &shape)
 
VT_EXPORT bool isDefined () const
 
VT_EXPORT bool isUndefined () const
 
VT_EXPORT bool isTensor () const
 
VT_EXPORT bool isScalar () const
 
VT_EXPORT bool isCommand () const
 
VT_EXPORT unsigned int getTensorDimension () const
 
VT_EXPORT std::vector< unsigned int > getTensorShape () const
 
VT_EXPORT std::vector< double > getTensorData () const
 Return a copy of the internal tensor data. More...
 
VT_EXPORT std::vector< double > & getTensorDataReference ()
 Return a reference to the internal tensor data (caution) More...
 
VT_EXPORT ParameterValue & setTensorData (const std::vector< double > &data)
 
VT_EXPORT unsigned int getTensorNumElements () const
 
VT_EXPORT unsigned int getTensorCurrentDataSize () const
 
VT_EXPORT ParameterType getType () const
 
VT_EXPORT double & tensorElementAt (unsigned int x)
 
VT_EXPORT double & tensorElementAt (unsigned int y, unsigned int x)
 
VT_EXPORT double & tensorElementAt (unsigned int z, unsigned int y, unsigned int x)
 
template<typename T >
VT_EXPORT ParameterValue & setValue (T t)
 
template<typename T >
VT_EXPORT T getValue () const
 
template<typename T >
VT_EXPORT T getWithDefault (const T &deflt) const
 
template<>
VT_EXPORT int getValue () const
 
template<>
VT_EXPORT ParameterValue & setValue (int t)
 
template<>
VT_EXPORT ParameterValue & setValue (bool t)
 
template<>
VT_EXPORT ParameterValue & setValue (double t)
 
template<>
VT_EXPORT ParameterValue & setValue (const char *t)
 
template<>
VT_EXPORT ParameterValue & setValue (const std::string &t)
 
template<>
VT_EXPORT ParameterValue & setValue (std::string t)
 

Member Function Documentation

◆ getTensorData()

std::vector< double > visiontransfer::param::ParameterValue::getTensorData ( ) const

Return a copy of the internal tensor data.

Definition at line 508 of file parametervalue.cpp.

◆ getTensorDataReference()

std::vector< double > & visiontransfer::param::ParameterValue::getTensorDataReference ( )

Return a reference to the internal tensor data (caution)

Definition at line 512 of file parametervalue.cpp.

The documentation for this class was generated from the following files:
Allied Vision