Public Member Functions | List of all members
LDRarray< A, J > Class Template Reference

#include <ldrarrays.h>

Inheritance diagram for LDRarray< A, J >:
Inheritance graph
[legend]

Public Member Functions

 LDRarray ()
 
 LDRarray (const A &a, const STD_string &name="")
 
 LDRarray (const LDRarray< A, J > &ja)
 
LDRarray< A, J > & operator= (const A &a)
 
LDRarray< A, J > & operator= (const J &jv)
 
LDRarray< A, J > & operator= (const LDRarray< A, J > &ja)
 
STD_ostream & print2stream (STD_ostream &os, const LDRserBase &serializer) const
 
STD_string printvalstring (const LDRserBase *ser=0) const
 
bool parsevalstring (const STD_string &parstring, const LDRserBase *ser=0)
 
STD_string get_parx_code (parxCodeType type) const
 
GuiProps get_gui_props () const
 
LDRbaseset_gui_props (const GuiProps &gp)
 
STD_string get_typeInfo (bool parx_equivtype=false) const
 
LDRbasecreate_copy () const
 
int write (const STD_string &filename, const LDRserBase &serializer=LDRserJDX()) const
 
int load (const STD_string &filename, const LDRserBase &serializer=LDRserJDX())
 
- Public Member Functions inherited from LDRbase
virtual STD_string print (const LDRserBase &serializer=LDRserJDX()) const
 
virtual bool parse (STD_string &parstring, const LDRserBase &serializer=LDRserJDX())
 
virtual double get_minval () const
 
virtual double get_maxval () const
 
bool has_minmax () const
 
const STD_string & get_description () const
 
LDRbaseset_description (const STD_string &descr)
 
virtual svector get_alternatives () const
 
const STD_string & get_unit () const
 
LDRbaseset_unit (const STD_string &un)
 
virtual parameterMode get_parmode () const
 
virtual LDRbaseset_parmode (parameterMode parameter_mode)
 
virtual fileMode get_filemode () const
 
virtual LDRbaseset_filemode (fileMode file_mode)
 
JcampDxProps get_jdx_props () const
 
LDRbaseset_jdx_props (const JcampDxProps &jp)
 
- Public Member Functions inherited from Labeled
 Labeled (const STD_string &label="unnamed")
 
Labeledset_label (const STD_string &label)
 
const STD_string & get_label () const
 
Labeledoperator= (const Labeled &l)
 

Detailed Description

template<class A, class J>
class LDRarray< A, J >

Labeled Data Record (LDR) template class for representing multi-dimensional arrays

Definition at line 42 of file ldrarrays.h.

Constructor & Destructor Documentation

§ LDRarray() [1/3]

template<class A, class J>
LDRarray< A, J >::LDRarray ( )
inline

Default constructor

Definition at line 49 of file ldrarrays.h.

§ LDRarray() [2/3]

template<class A, class J>
LDRarray< A, J >::LDRarray ( const A &  a,
const STD_string &  name = "" 
)

Constructor with the following arguments:

  • a: Initial value for the array base class
  • name: The label of the parameter

§ LDRarray() [3/3]

template<class A, class J>
LDRarray< A, J >::LDRarray ( const LDRarray< A, J > &  ja)
inline

Assignment from scalar, i.e. fill all elements with this value Copy constructor

Definition at line 66 of file ldrarrays.h.

Member Function Documentation

§ create_copy()

template<class A, class J>
LDRbase* LDRarray< A, J >::create_copy ( ) const
inlinevirtual

Returns a deep copy of the parameter

Implements LDRbase.

Definition at line 92 of file ldrarrays.h.

§ get_gui_props()

template<class A, class J>
GuiProps LDRarray< A, J >::get_gui_props ( ) const
inlinevirtual

Returns the properties of axis display in the GUI, only useful for LDRarrays

Reimplemented from LDRbase.

Definition at line 89 of file ldrarrays.h.

§ get_parx_code()

template<class A, class J>
STD_string LDRarray< A, J >::get_parx_code ( parxCodeType  type) const
virtual

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

Reimplemented from LDRbase.

§ get_typeInfo()

template<class A, class J>
STD_string LDRarray< A, J >::get_typeInfo ( bool  parx_equivtype = false) const
virtual

Returns a string describing the type of the parameter. If 'parx_equivtype' is 'true', returns the equivalent PARX parameter type

Implements LDRbase.

§ load()

template<class A, class J>
int LDRarray< A, J >::load ( const STD_string &  filename,
const LDRserBase serializer = LDRserJDX() 
)
inlinevirtual

Loads the parameter(s) from a file using format 'serializer'. In case of calling this function of a single paramter, the file is searched for this parameter and the value is assigned. In case of a parameter block, all parameter values are taken from the file. The return value is the number of parameters which are successfully parsed. If an error occurs, -1 is returned.

Reimplemented from LDRbase.

Definition at line 99 of file ldrarrays.h.

§ operator=() [1/3]

template<class A, class J>
LDRarray<A,J>& LDRarray< A, J >::operator= ( const A &  a)

Assignment operator from an array

§ operator=() [2/3]

template<class A, class J>
LDRarray<A,J>& LDRarray< A, J >::operator= ( const J &  jv)
inline

Assignment operator from scalar, i.e. fill all elements with this value

Definition at line 76 of file ldrarrays.h.

§ operator=() [3/3]

template<class A, class J>
LDRarray<A,J>& LDRarray< A, J >::operator= ( const LDRarray< A, J > &  ja)

Copy assignment

§ parsevalstring()

template<class A, class J>
bool LDRarray< A, J >::parsevalstring ( const STD_string &  ,
const LDRserBase ser = 0 
)
virtual

Parses and assigns the value in the given string, optionally using format 'ser'

Implements LDRbase.

§ print2stream()

template<class A, class J>
STD_ostream& LDRarray< A, J >::print2stream ( STD_ostream &  os,
const LDRserBase serializer 
) const
virtual

Passes the parameter in ASCII format to the ostream 'os' using format 'serializer'

Reimplemented from LDRbase.

§ printvalstring()

template<class A, class J>
STD_string LDRarray< A, J >::printvalstring ( const LDRserBase ser = 0) const
virtual

Returns the value of the parameter as a string, optionally using format 'ser'

Implements LDRbase.

§ set_gui_props()

template<class A, class J>
LDRbase& LDRarray< A, J >::set_gui_props ( const GuiProps )
inlinevirtual

Sets the properties of axis display in the GUI, only useful for LDRarrays

Reimplemented from LDRbase.

Definition at line 90 of file ldrarrays.h.

§ write()

template<class A, class J>
int LDRarray< A, J >::write ( const STD_string &  filename,
const LDRserBase serializer = LDRserJDX() 
) const
inlinevirtual

Writes the parameter(s) to file using format 'serializer'. In case of calling this function of a single paramter, the file will consist of only this parameter. In case of a parameter block, all parameter values are written to the file. If an error occurs, -1 is returned.

Reimplemented from LDRbase.

Definition at line 98 of file ldrarrays.h.


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