#include <ldrbase.h>

Inheritance diagram for LDRbase:

[legend]

Public Member Functions
virtual STD_string	print (const LDRserBase &serializer=LDRserJDX()) const

virtual STD_ostream &	print2stream (STD_ostream &os, const LDRserBase &serializer) const

virtual int	write (const STD_string &filename, const LDRserBase &serializer=LDRserJDX()) const

virtual STD_string	printvalstring (const LDRserBase *ser=0) const =0

virtual bool	parse (STD_string &parstring, const LDRserBase &serializer=LDRserJDX())

virtual int	load (const STD_string &filename, const LDRserBase &serializer=LDRserJDX())

virtual bool	parsevalstring (const STD_string &, const LDRserBase *ser=0)=0

virtual STD_string	get_typeInfo (bool parx_equivtype=false) const =0

virtual double	get_minval () const

virtual double	get_maxval () const

bool	has_minmax () const

virtual LDRbase *	create_copy () const =0

const STD_string &	get_description () const

LDRbase &	set_description (const STD_string &descr)

virtual svector	get_alternatives () const

const STD_string &	get_unit () const

LDRbase &	set_unit (const STD_string &un)

virtual parameterMode	get_parmode () const

virtual LDRbase &	set_parmode (parameterMode parameter_mode)

virtual fileMode	get_filemode () const

virtual LDRbase &	set_filemode (fileMode file_mode)

virtual GuiProps	get_gui_props () const

virtual LDRbase &	set_gui_props (const GuiProps &)

virtual STD_string	get_parx_code (parxCodeType type) const

JcampDxProps	get_jdx_props () const

LDRbase &	set_jdx_props (const JcampDxProps &jp)

Public Member Functions inherited from Labeled
	Labeled (const STD_string &label="unnamed")

Labeled &	set_label (const STD_string &label)

const STD_string &	get_label () const

Labeled &	operator= (const Labeled &l)

Friends
class	LDRwidget

class	LDRblock

STD_ostream &	operator<< (STD_ostream &s, const LDRbase &value)

Detailed Description

This is the (virtual) base class that carries the Labeled Data Record (LDR) specific interface, i.e. all common functions that are specific to LDR. Most of the elements show a simple default behaviour that will be overwritten by a reasonable behaviour in the derived classes.

Definition at line 270 of file ldrbase.h.

Member Function Documentation

◆ create_copy()

virtual LDRbase* LDRbase::create_copy ( ) const

pure virtual

Returns a deep copy of the parameter

Implemented in LDRrecoValList, LDRformula, LDRfileName, LDRaction, LDRenum, LDRbool, LDRstring, LDRnumber< T >, LDRnumber< double >, LDRnumber< float >, LDRnumber< int >, LDRblock, LDRtriple, LDRarray< A, J >, LDRarray< iarray, LDRint >, LDRarray< carray, LDRcomplex >, LDRarray< sarray, LDRstring >, LDRarray< darray, LDRdouble >, and LDRarray< farray, LDRfloat >.

◆ get_alternatives()

virtual svector LDRbase::get_alternatives ( ) const

inlinevirtual

Returns possible alternative values of the parameter, i.e. the item strings of an enum

Reimplemented in LDRenum.

Definition at line 388 of file ldrbase.h.

◆ get_description()

const STD_string& LDRbase::get_description ( ) const

inline

Returns the description of the parameter, used in the text of tooltips in a GUI

Definition at line 376 of file ldrbase.h.

◆ get_filemode()

virtual fileMode LDRbase::get_filemode ( ) const

inlinevirtual

Returns the fileMode

Definition at line 420 of file ldrbase.h.

◆ get_gui_props()

virtual GuiProps LDRbase::get_gui_props ( ) const

inlinevirtual

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

Reimplemented in LDRarray< A, J >, LDRarray< iarray, LDRint >, LDRarray< carray, LDRcomplex >, LDRarray< sarray, LDRstring >, LDRarray< darray, LDRdouble >, and LDRarray< farray, LDRfloat >.

Definition at line 434 of file ldrbase.h.

◆ get_jdx_props()

JcampDxProps LDRbase::get_jdx_props ( ) const

inline

Returns the JCAMP-DX-specific properties of this parameter

Definition at line 455 of file ldrbase.h.

◆ get_maxval()

virtual double LDRbase::get_maxval ( ) const

inlinevirtual

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

Reimplemented in LDRnumber< T >, LDRnumber< double >, LDRnumber< float >, and LDRnumber< int >.

Definition at line 357 of file ldrbase.h.

◆ get_minval()

virtual double LDRbase::get_minval ( ) const

inlinevirtual

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

Reimplemented in LDRnumber< T >, LDRnumber< double >, LDRnumber< float >, and LDRnumber< int >.

Definition at line 350 of file ldrbase.h.

◆ get_parmode()

virtual parameterMode LDRbase::get_parmode ( ) const

inlinevirtual

Returns the parameterMode

Definition at line 408 of file ldrbase.h.

◆ get_parx_code()

virtual STD_string LDRbase::get_parx_code ( parxCodeType type ) const

virtual

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

Reimplemented in LDRstring, LDRnumber< T >, LDRnumber< double >, LDRnumber< float >, LDRnumber< int >, LDRblock, LDRarray< A, J >, LDRarray< iarray, LDRint >, LDRarray< carray, LDRcomplex >, LDRarray< sarray, LDRstring >, LDRarray< darray, LDRdouble >, and LDRarray< farray, LDRfloat >.

◆ get_typeInfo()

virtual STD_string LDRbase::get_typeInfo ( bool parx_equivtype = false ) const

pure virtual

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

Implemented in LDRrecoValList, LDRformula, LDRfileName, LDRaction, LDRenum, LDRbool, LDRstring, LDRnumber< T >, LDRnumber< double >, LDRnumber< float >, LDRnumber< int >, LDRblock, LDRtriple, LDRarray< A, J >, LDRarray< iarray, LDRint >, LDRarray< carray, LDRcomplex >, LDRarray< sarray, LDRstring >, LDRarray< darray, LDRdouble >, and LDRarray< farray, LDRfloat >.

◆ get_unit()

const STD_string& LDRbase::get_unit ( ) const

inline

Returns the physical unit of the parameter

Definition at line 395 of file ldrbase.h.

◆ has_minmax()

bool LDRbase::has_minmax ( ) const

inline

Returns whether the paramerer has a valid interval of allowed values. Only used when editing the parameter in a GUI

Definition at line 363 of file ldrbase.h.

◆ load()

virtual int LDRbase::load	(	const STD_string &	filename,
		const LDRserBase &	serializer = `LDRserJDX()`
	)

virtual

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 in OdinPulse, Sample, LDRblock, LDRarray< A, J >, LDRarray< iarray, LDRint >, LDRarray< carray, LDRcomplex >, LDRarray< sarray, LDRstring >, LDRarray< darray, LDRdouble >, LDRarray< farray, LDRfloat >, and ImageSet.

◆ parse()

virtual bool LDRbase::parse	(	STD_string &	parstring,
		const LDRserBase &	serializer = `LDRserJDX()`
	)

virtual

Parses the parameter using format 'serializer'. For blocks, a re-implemented 'parse' function is called. Returns 'true' if the parameter was parsed successfully.

Reimplemented in LDRblock.

◆ parsevalstring()

virtual bool LDRbase::parsevalstring	(	const STD_string &	,
		const LDRserBase *	ser = `0`
	)

pure virtual

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

Implemented in LDRrecoValList, LDRfileName, LDRaction, LDRenum, LDRbool, LDRstring, LDRnumber< T >, LDRnumber< double >, LDRnumber< float >, LDRnumber< int >, LDRarray< A, J >, LDRarray< iarray, LDRint >, LDRarray< carray, LDRcomplex >, LDRarray< sarray, LDRstring >, LDRarray< darray, LDRdouble >, LDRarray< farray, LDRfloat >, and LDRblock.

◆ print()

virtual STD_string LDRbase::print ( const LDRserBase & serializer = LDRserJDX() ) const

virtual

This function returns the parameter in ASCII using format 'serializer'

Reimplemented in LDRblock.

◆ print2stream()

virtual STD_ostream& LDRbase::print2stream	(	STD_ostream &	os,
		const LDRserBase &	serializer
	)		const

virtual

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

Reimplemented in LDRrecoValList, LDRblock, LDRarray< A, J >, LDRarray< iarray, LDRint >, LDRarray< carray, LDRcomplex >, LDRarray< sarray, LDRstring >, LDRarray< darray, LDRdouble >, and LDRarray< farray, LDRfloat >.

◆ printvalstring()

virtual STD_string LDRbase::printvalstring ( const LDRserBase * ser = 0 ) const

pure virtual

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

Implemented in LDRrecoValList, LDRaction, LDRenum, LDRbool, LDRstring, LDRnumber< T >, LDRnumber< double >, LDRnumber< float >, LDRnumber< int >, LDRblock, LDRarray< A, J >, LDRarray< iarray, LDRint >, LDRarray< carray, LDRcomplex >, LDRarray< sarray, LDRstring >, LDRarray< darray, LDRdouble >, and LDRarray< farray, LDRfloat >.

◆ set_description()

LDRbase& LDRbase::set_description ( const STD_string & descr )

inline

Sets the description of the parameter, used in the text of tooltips in a GUI

Definition at line 382 of file ldrbase.h.

◆ set_filemode()

virtual LDRbase& LDRbase::set_filemode ( fileMode file_mode )

inlinevirtual

Sets the fileMode

Reimplemented in LDRblock.

Definition at line 426 of file ldrbase.h.

◆ set_gui_props()

virtual LDRbase& LDRbase::set_gui_props ( const GuiProps & )

inlinevirtual

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

Reimplemented in LDRarray< A, J >, LDRarray< iarray, LDRint >, LDRarray< carray, LDRcomplex >, LDRarray< sarray, LDRstring >, LDRarray< darray, LDRdouble >, and LDRarray< farray, LDRfloat >.

Definition at line 440 of file ldrbase.h.

◆ set_jdx_props()

LDRbase& LDRbase::set_jdx_props ( const JcampDxProps & jp )

inline

Sets the JCAMP-DX-specific properties of this parameter

Definition at line 461 of file ldrbase.h.

◆ set_parmode()

virtual LDRbase& LDRbase::set_parmode ( parameterMode parameter_mode )

inlinevirtual

Sets the parameterMode

Reimplemented in LDRblock.

Definition at line 414 of file ldrbase.h.

◆ set_unit()

LDRbase& LDRbase::set_unit ( const STD_string & un )

inline

Sets the physical unit of the parameter

Definition at line 401 of file ldrbase.h.

◆ write()

virtual int LDRbase::write	(	const STD_string &	filename,
		const LDRserBase &	serializer = `LDRserJDX()`
	)		const

virtual

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 in LDRblock, LDRarray< A, J >, LDRarray< iarray, LDRint >, LDRarray< carray, LDRcomplex >, LDRarray< sarray, LDRstring >, LDRarray< darray, LDRdouble >, and LDRarray< farray, LDRfloat >.

Friends And Related Function Documentation

◆ operator<<

STD_ostream& operator<<	(	STD_ostream &	s,
		const LDRbase &	value
	)

friend

Stream operator

Definition at line 290 of file ldrbase.h.

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

ldrbase.h

Public Member Functions

Friends

Detailed Description

Member Function Documentation

◆ create_copy()

◆ get_alternatives()

◆ get_description()

◆ get_filemode()

◆ get_gui_props()

◆ get_jdx_props()

◆ get_maxval()

◆ get_minval()

◆ get_parmode()

◆ get_parx_code()

◆ get_typeInfo()

◆ get_unit()

◆ has_minmax()

◆ load()

◆ parse()

◆ parsevalstring()

◆ print()

◆ print2stream()

◆ printvalstring()

◆ set_description()

◆ set_filemode()

◆ set_gui_props()

◆ set_jdx_props()

◆ set_parmode()

◆ set_unit()

◆ write()

Friends And Related Function Documentation

◆ operator<<