nidas v1.2.3
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
nidas::core::ParameterT< T > Class Template Reference

A typed Parameter, with data of type T. More...

#include <Parameter.h>

Inheritance diagram for nidas::core::ParameterT< T >:
Inheritance graph
[legend]

Public Types

enum  parType { STRING_PARAM , FLOAT_PARAM , INT_PARAM , BOOL_PARAM }
 
typedef enum parType parType
 

Public Member Functions

 ParameterT ()
 
ParameterT * clone () const
 
void assign (const Parameter &x)
 A virtual assignment operator.
 
int getLength () const
 
const std::vector< T > getValues () const
 
void setValues (const std::vector< T > &vals)
 
void setValue (unsigned int i, const T &val)
 Set ith value.
 
void setValue (const T &val)
 For parameters of length one, set its value.
 
T getValue (int i) const
 
void fromDOMElement (const xercesc::DOMElement *)
 
void fromDOMElement (const xercesc::DOMElement *, const Dictionary *dict)
 
const std::string & getName () const
 
void setName (const std::string &val)
 
parType getType () const
 
virtual double getNumericValue (int i) const
 
virtual std::string getStringValue (int i) const
 

Static Public Member Functions

static Parameter * createParameter (const xercesc::DOMElement *, const Dictionary *d=0)
 

Protected Attributes

std::vector< T > _values
 Vector of values.
 
std::string _name
 
parType _type
 

Detailed Description

template<class T>
class nidas::core::ParameterT< T >

A typed Parameter, with data of type T.

Member Typedef Documentation

◆ parType

typedef enum parType nidas::core::Parameter::parType
inherited

Member Enumeration Documentation

◆ parType

enum nidas::core::Parameter::parType
inherited
Enumerator
STRING_PARAM 
FLOAT_PARAM 
INT_PARAM 
BOOL_PARAM 

Constructor & Destructor Documentation

◆ ParameterT()

template<class T >
nidas::core::ParameterT< T >::ParameterT ( )
inline

Member Function Documentation

◆ assign()

template<class T >
void ParameterT::assign ( const Parameter & x)
virtual

A virtual assignment operator.

Implements nidas::core::Parameter.

References nidas::core::getSample().

◆ clone()

template<class T >
ParameterT< T > * ParameterT::clone ( ) const
virtual

Implements nidas::core::Parameter.

References nidas::core::getSample().

◆ createParameter()

Parameter * Parameter::createParameter ( const xercesc::DOMElement * node,
const Dictionary * d = 0 )
staticinherited
Exceptions
nidas::util::InvalidParameterException

References nidas::core::Parameter::getLength(), and nidas::core::getSample().

Referenced by nidas::core::DSMSensor::fromDOMElement(), nidas::core::Project::fromDOMElement(), nidas::core::SampleTag::fromDOMElement(), nidas::core::Site::fromDOMElement(), nidas::core::Variable::fromDOMElement(), nidas::core::VariableConverter::fromDOMElement(), nidas::core::SampleIOProcessor::fromDOMElement(), and nidas::core::SampleOutputBase::fromDOMElement().

◆ fromDOMElement() [1/2]

template<class T >
void ParameterT::fromDOMElement ( const xercesc::DOMElement * node)
Exceptions
nidas::util::InvalidParameterException

◆ fromDOMElement() [2/2]

template<class T >
void ParameterT::fromDOMElement ( const xercesc::DOMElement * node,
const Dictionary * dict )
virtual
Exceptions
nidas::util::InvalidParameterException;

Implements nidas::core::Parameter.

References nidas::core::getSample().

◆ getLength()

template<class T >
int nidas::core::ParameterT< T >::getLength ( ) const
inlinevirtual

Implements nidas::core::Parameter.

References nidas::core::ParameterT< T >::_values.

◆ getName()

const std::string & nidas::core::Parameter::getName ( ) const
inlineinherited

References nidas::core::Parameter::_name.

Referenced by nidas::dynld::StatisticsProcessor::addRequestedSampleTag(), nidas::dynld::DSC_FreqCounter::readParams(), nidas::dynld::ParoSci_202BG_P::readParams(), and nidas::dynld::ParoSci_202BG_T::readParams().

◆ getNumericValue()

double Parameter::getNumericValue ( int i) const
virtualinherited

References nidas::core::Parameter::_type, nidas::core::Parameter::BOOL_PARAM, nidas::core::Parameter::FLOAT_PARAM, nidas::core::floatNAN, nidas::core::Parameter::INT_PARAM, and nidas::core::Parameter::STRING_PARAM.

Referenced by nidas::dynld::StatisticsProcessor::addRequestedSampleTag(), nidas::dynld::raf::LamsSensor::fromDOMElement(), nidas::dynld::raf::TwoD_USB::init(), nidas::dynld::raf::TwoDS::init(), nidas::dynld::raf::UHSAS_Serial::init(), nidas::dynld::raf::TwoD_USB::init_parameters(), nidas::dynld::raf::TwoDS::init_parameters(), nidas::dynld::raf::UHSAS_Serial::open(), nidas::dynld::DSC_FreqCounter::readParams(), nidas::dynld::ParoSci_202BG_P::readParams(), nidas::dynld::ParoSci_202BG_T::readParams(), nidas::dynld::raf::CDP_Serial::validate(), nidas::dynld::raf::PIP_Serial::validate(), nidas::dynld::raf::SPP100_Serial::validate(), nidas::dynld::raf::SPP200_Serial::validate(), nidas::dynld::raf::SPP300_Serial::validate(), nidas::dynld::raf::SppSerial::validate(), nidas::dynld::raf::UDPArincSensor::validate(), and nidas::dynld::raf::UDPiPMSensor::validate().

◆ getStringValue()

std::string Parameter::getStringValue ( int i) const
virtualinherited

References nidas::core::Parameter::_type, nidas::core::Parameter::BOOL_PARAM, nidas::core::Parameter::FLOAT_PARAM, nidas::core::getSample(), nidas::core::Parameter::INT_PARAM, and nidas::core::Parameter::STRING_PARAM.

Referenced by nidas::dynld::StatisticsProcessor::addRequestedSampleTag(), nidas::dynld::iss::WICORSensor::addSampleTag(), nidas::dynld::raf::UDPArincSensor::validate(), and nidas::dynld::raf::UDPiPMSensor::validate().

◆ getType()

parType nidas::core::Parameter::getType ( ) const
inlineinherited

References nidas::core::Parameter::_type.

Referenced by nidas::dynld::StatisticsProcessor::addRequestedSampleTag(), nidas::dynld::DSC_FreqCounter::readParams(), nidas::dynld::ParoSci_202BG_P::readParams(), and nidas::dynld::ParoSci_202BG_T::readParams().

◆ getValue()

template<class T >
T nidas::core::ParameterT< T >::getValue ( int i) const
inline

References nidas::core::ParameterT< T >::_values, and nidas::core::getSample().

◆ getValues()

template<class T >
const std::vector< T > nidas::core::ParameterT< T >::getValues ( ) const
inline

References nidas::core::ParameterT< T >::_values.

◆ setName()

void nidas::core::Parameter::setName ( const std::string & val)
inlineinherited

References nidas::core::Parameter::_name, and nidas::core::getSample().

◆ setValue() [1/2]

template<class T >
void nidas::core::ParameterT< T >::setValue ( const T & val)
inline

For parameters of length one, set its value.

References nidas::core::ParameterT< T >::_values.

◆ setValue() [2/2]

template<class T >
void nidas::core::ParameterT< T >::setValue ( unsigned int i,
const T & val )
inline

Set ith value.

References nidas::core::ParameterT< T >::_values, and nidas::core::getSample().

◆ setValues()

template<class T >
void nidas::core::ParameterT< T >::setValues ( const std::vector< T > & vals)
inline

References nidas::core::ParameterT< T >::_values, and nidas::core::getSample().

Member Data Documentation

◆ _name

std::string nidas::core::Parameter::_name
protectedinherited

Referenced by nidas::core::Parameter::getName(), and nidas::core::Parameter::setName().

◆ _type

parType nidas::core::Parameter::_type
protectedinherited

Referenced by nidas::core::Parameter::getNumericValue(), nidas::core::Parameter::getStringValue(), and nidas::core::Parameter::getType().

◆ _values

template<class T >
std::vector<T> nidas::core::ParameterT< T >::_values
protected

Vector of values.

Referenced by nidas::core::ParameterT< T >::getLength(), nidas::core::ParameterT< T >::getValue(), nidas::core::ParameterT< T >::getValues(), nidas::core::ParameterT< T >::setValue(), nidas::core::ParameterT< T >::setValue(), and nidas::core::ParameterT< T >::setValues().

The documentation for this class was generated from the following files:
Generated by doxygen 1.10.0