svMultiPhysics
Public Member Functions | Public Attributes | List of all members
VectorParameter< T > Class Template Reference

The VectorParameter class template is used to store a named paramater and its vector of values as a basic type: bool, double, int and string. More...

#include <Parameters.h>

Public Member Functions

 VectorParameter (const std::string &name, const std::vector< T > &value, bool required, std::vector< T > range={})
 
std::string name () const
 
std::vector< T > value () const
 
bool defined () const
 
int size () const
 
std::vector< T > operator() () const
 
const double & operator[] (const int i) const
 
std::string svalue ()
 Get the string representation of the parameter value. More...
 
void set (const std::string &name, bool required, const std::vector< T > &value)
 Set the parameter name and value, and if it is required. More...
 
void set (const std::string &str_value)
 Set the parameter value from a string. More...
 
bool check_required_set ()
 

Public Attributes

std::vector< T > value_
 
std::string name_
 
bool required_ = false
 
bool value_set_ = false
 
std::vector< T > range_
 

Detailed Description

template<typename T>
class VectorParameter< T >

The VectorParameter class template is used to store a named paramater and its vector of values as a basic type: bool, double, int and string.

Member Function Documentation

◆ set() [1/2]

template<typename T >
void VectorParameter< T >::set ( const std::string &  name,
bool  required,
const std::vector< T > &  value 
)
inline

Set the parameter name and value, and if it is required.

◆ set() [2/2]

template<typename T >
void VectorParameter< T >::set ( const std::string &  str_value)
inline

Set the parameter value from a string.

◆ svalue()

template<typename T >
std::string VectorParameter< T >::svalue ( )
inline

Get the string representation of the parameter value.


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