JDXnumber< T > Class Template Reference
[JCAMP-DX implementation (odinpara library)]

#include <jdxnumbers.h>

Inheritance diagram for JDXnumber< T >:

Inheritance graph
[legend]

List of all members.

Public Member Functions

 JDXnumber ()
 JDXnumber (T v, const STD_string &name="", bool userParameter=true, compatMode mode=notBroken, parameterMode parameter_mode=edit, const STD_string &parx_equivalent="", float parx_assign_factor=1.0, float parx_assign_offset=0.0)
 JDXnumber (const JDXnumber< T > &bi)
JDXnumber< T > & operator= (T v)
JDXnumber< T > & operator= (const JDXnumber< T > &bi)
JDXnumber< T > & set_minmaxval (double min, double max)
STD_string printvalstring () const
bool parsevalstring (const STD_string &parstring)
STD_string get_parx_code (parxCodeType type, const ParxEquiv &equiv) const
ParxEquiv get_parx_equiv () const
double get_minval () const
double get_maxval () const
const char * get_typeInfo () const
JcampDxClasscreate_copy () const


Detailed Description

template<class T>
class JDXnumber< T >

JCAMP-DX template class for representing built-in numbers

Definition at line 37 of file jdxnumbers.h.


Constructor & Destructor Documentation

template<class T>
JDXnumber< T >::JDXnumber (  )  [inline]

Default constructor

Definition at line 44 of file jdxnumbers.h.

template<class T>
JDXnumber< T >::JDXnumber ( v,
const STD_string &  name = "",
bool  userParameter = true,
compatMode  mode = notBroken,
parameterMode  parameter_mode = edit,
const STD_string &  parx_equivalent = "",
float  parx_assign_factor = 1.0,
float  parx_assign_offset = 0.0 
)

Constructor with the following arguments:

  • v: Initial value for the number
  • name: The label of the JCAMP-DX parameter
  • userParameter: Whether this is a user defined JCAMP-DX parameter
  • mode: Mode for ASCII representation of strings or arrays of strings
  • parameter_mode: Mode for GUI accesibility of the parameter
  • parx_equivalent: Equivalent parameter in PARX to which this parameter will be assigned
  • parx_assign_factor: Scaling factor when assigning to the equivalent parameter in PARX
  • parx_assign_offset: Offset when assigning to the equivalent parameter in PARX

template<class T>
JDXnumber< T >::JDXnumber ( const JDXnumber< T > &  bi  )  [inline]

Copy constructor

Definition at line 66 of file jdxnumbers.h.


Member Function Documentation

template<class T>
JDXnumber<T>& JDXnumber< T >::operator= ( v  )  [inline]

Assignment operator from a built-in number

Definition at line 71 of file jdxnumbers.h.

template<class T>
JDXnumber<T>& JDXnumber< T >::operator= ( const JDXnumber< T > &  bi  ) 

Copy assignment

template<class T>
JDXnumber<T>& JDXnumber< T >::set_minmaxval ( double  min,
double  max 
) [inline]

Specifies the minimum and maximum allowed value for this number. Only useful when editing the parameter in a GUI

Definition at line 93 of file jdxnumbers.h.

template<class T>
STD_string JDXnumber< T >::printvalstring (  )  const [virtual]

Returns the value of the parameter as a string

Implements JcampDxClass.

template<class T>
bool JDXnumber< T >::parsevalstring ( const STD_string &   )  [virtual]

Parses and assigns the value in the given string

Implements JcampDxClass.

template<class T>
STD_string JDXnumber< T >::get_parx_code ( parxCodeType  type,
const ParxEquiv equiv 
) const [virtual]

Returns C code that can be used together with the PARX(Bruker) compiler.

Reimplemented from JcampDxClass.

template<class T>
ParxEquiv JDXnumber< T >::get_parx_equiv (  )  const [inline, virtual]

Returns the name and scaling of an equivalent parameter in PARX. Code for automatic mapping to the PARX parameter space can be generated using the function get_parx_code().

Reimplemented from JcampDxClass.

Definition at line 99 of file jdxnumbers.h.

template<class T>
double JDXnumber< T >::get_minval (  )  const [inline, virtual]

Returns the minimum allowed value of the parameter. Only used when editing the parameter in a GUI

Reimplemented from JcampDxClass.

Definition at line 100 of file jdxnumbers.h.

template<class T>
double JDXnumber< T >::get_maxval (  )  const [inline, virtual]

Returns the maximum allowed value of the parameter Only used when editing the parameter in a GUI

Reimplemented from JcampDxClass.

Definition at line 101 of file jdxnumbers.h.

template<class T>
const char* JDXnumber< T >::get_typeInfo (  )  const [inline, virtual]

Returns a string describing the type of the parameter

Implements JcampDxClass.

Definition at line 102 of file jdxnumbers.h.

template<class T>
JcampDxClass* JDXnumber< T >::create_copy (  )  const [inline, virtual]

Returns a deep copy of the parameter

Implements JcampDxClass.

Definition at line 103 of file jdxnumbers.h.


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

Generated on Wed Sep 30 15:33:07 2009 by  doxygen 1.5.6