JcampDxClass Class Reference
[JCAMP-DX implementation (odinpara library)]
#include <jdxbase.h>
Public Member Functions | |
| virtual STD_string | print () const |
| virtual STD_ostream & | print2stream (STD_ostream &os) const |
| virtual bool | parse (STD_string &parstring) |
| virtual int | load (const STD_string &filename) |
| virtual int | write (const STD_string &filename) const |
| virtual bool | parsevalstring (const STD_string &)=0 |
| virtual STD_string | printvalstring () const =0 |
| virtual JcampDxClass & | set_compatmode (compatMode compat_mode) |
| virtual compatMode | get_compatmode () const |
| virtual const char * | get_typeInfo () const =0 |
| virtual double | get_minval () const |
| virtual double | get_maxval () const |
| bool | has_minmax () const |
| virtual JcampDxClass * | create_copy () const =0 |
| JcampDxClass & | set_userDefParameter (bool userDef) |
| bool | isUserDefParameter () const |
| const STD_string & | get_description () const |
| JcampDxClass & | set_description (const STD_string &descr) |
| virtual svector | get_alternatives () const |
| const STD_string & | get_unit () const |
| JcampDxClass & | set_unit (const STD_string &un) |
| virtual parameterMode | get_parmode () const |
| virtual JcampDxClass & | set_parmode (parameterMode parameter_mode) |
| virtual fileMode | get_filemode () const |
| virtual JcampDxClass & | set_filemode (fileMode file_mode) |
| virtual GuiProps | get_gui_props () const |
| virtual JcampDxClass & | set_gui_props (const GuiProps &) |
| virtual STD_string | get_parx_code (parxCodeType type, const ParxEquiv &equiv=ParxEquiv()) const |
| virtual ParxEquiv | get_parx_equiv () const |
Friends | |
| class | JDXwidget |
| class | JcampDxBlock |
| STD_ostream & | operator<< (STD_ostream &s, const JcampDxClass &value) |
Detailed Description
This is the (virtual) base class that carries the JcampDx specific interface, i.e. all common functions that are specific to JcampDx. Most of the elements show a simple default behaviour that will be overwritten by a reasonable behaviour in the derived classes.Definition at line 264 of file jdxbase.h.
Member Function Documentation
| virtual STD_string JcampDxClass::print | ( | ) | const [virtual] |
This function returns the parameter in JcampDx-ASCII-format
Reimplemented in JcampDxBlock.
| virtual STD_ostream& JcampDxClass::print2stream | ( | STD_ostream & | os | ) | const [inline, virtual] |
Passes the parameter in ASCII format to the ostream 'os'
Reimplemented in JDXarray< A, J >, JcampDxBlock, JDXrecoValList, JDXarray< tjarray, JDXnumber< double > >, JDXarray< tjarray, JDXnumber< int > >, JDXarray< tjarray, JDXnumber >, and JDXarray< tjarray, JDXstring >.
| virtual bool JcampDxClass::parse | ( | STD_string & | parstring | ) | [virtual] |
Parses the JCAMP-DX parameter. Except for blocks, this is done by stripping the label (e.g. "##$MyParameter=" ) from the string and passing the result to the function 'parsevalstring' of the underlying data type. For blocks, a re-implemented 'parse' function is called. Returns 'true' if the parameter was parsed successfully.
Reimplemented in JcampDxBlock.
| virtual int JcampDxClass::load | ( | const STD_string & | filename | ) | [virtual] |
Loads the parameter(s) from a JCAMP-DX file. 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 ImageSet, JDXarray< A, J >, JcampDxBlock, Sample, OdinPulse, JDXarray< tjarray, JDXnumber< double > >, JDXarray< tjarray, JDXnumber< int > >, JDXarray< tjarray, JDXnumber >, and JDXarray< tjarray, JDXstring >.
| virtual int JcampDxClass::write | ( | const STD_string & | filename | ) | const [virtual] |
Writes the parameter(s) to a JCAMP-DX file. 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 JDXarray< A, J >, JcampDxBlock, OdinPulse, JDXarray< tjarray, JDXnumber< double > >, JDXarray< tjarray, JDXnumber< int > >, JDXarray< tjarray, JDXnumber >, and JDXarray< tjarray, JDXstring >.
| virtual bool JcampDxClass::parsevalstring | ( | const STD_string & | ) | [pure virtual] |
Parses and assigns the value in the given string
Implemented in JDXarray< A, J >, JcampDxBlock, JDXnumber< T >, JDXstring, JDXbool, JDXenum, JDXaction, JDXfileName, JDXrecoValList, JDXarray< tjarray, JDXnumber< double > >, JDXarray< tjarray, JDXnumber< int > >, JDXarray< tjarray, JDXnumber >, JDXarray< tjarray, JDXstring >, JDXnumber< double >, JDXnumber< float >, and JDXnumber< int >.
| virtual STD_string JcampDxClass::printvalstring | ( | ) | const [pure virtual] |
Returns the value of the parameter as a string
Implemented in JDXarray< A, J >, JcampDxBlock, JDXnumber< T >, JDXstring, JDXbool, JDXenum, JDXaction, JDXrecoValList, JDXarray< tjarray, JDXnumber< double > >, JDXarray< tjarray, JDXnumber< int > >, JDXarray< tjarray, JDXnumber >, JDXarray< tjarray, JDXstring >, JDXnumber< double >, JDXnumber< float >, and JDXnumber< int >.
| virtual JcampDxClass& JcampDxClass::set_compatmode | ( | compatMode | compat_mode | ) | [inline, virtual] |
Sets the compatability mode. See the documentation to 'compatMode'
Reimplemented in JcampDxBlock.
| virtual compatMode JcampDxClass::get_compatmode | ( | ) | const [inline, virtual] |
| virtual const char* JcampDxClass::get_typeInfo | ( | ) | const [pure virtual] |
Returns a string describing the type of the parameter
Implemented in JDXarray< A, J >, JDXtriple, JcampDxBlock, JDXnumber< T >, JDXstring, JDXbool, JDXenum, JDXaction, JDXfileName, JDXformula, JDXrecoValList, JDXarray< tjarray, JDXnumber< double > >, JDXarray< tjarray, JDXnumber< int > >, JDXarray< tjarray, JDXnumber >, JDXarray< tjarray, JDXstring >, JDXnumber< double >, JDXnumber< float >, and JDXnumber< int >.
| virtual double JcampDxClass::get_minval | ( | ) | const [inline, virtual] |
Returns the minimum allowed value of the parameter. Only used when editing the parameter in a GUI
Reimplemented in JDXnumber< T >, JDXnumber< double >, JDXnumber< float >, and JDXnumber< int >.
| virtual double JcampDxClass::get_maxval | ( | ) | const [inline, virtual] |
Returns the maximum allowed value of the parameter Only used when editing the parameter in a GUI
Reimplemented in JDXnumber< T >, JDXnumber< double >, JDXnumber< float >, and JDXnumber< int >.
| bool JcampDxClass::has_minmax | ( | ) | const [inline] |
| virtual JcampDxClass* JcampDxClass::create_copy | ( | ) | const [pure virtual] |
Returns a deep copy of the parameter
Implemented in JDXarray< A, J >, JDXtriple, JcampDxBlock, JDXnumber< T >, JDXstring, JDXbool, JDXenum, JDXaction, JDXfileName, JDXformula, JDXrecoValList, JDXarray< tjarray, JDXnumber< double > >, JDXarray< tjarray, JDXnumber< int > >, JDXarray< tjarray, JDXnumber >, JDXarray< tjarray, JDXstring >, JDXnumber< double >, JDXnumber< float >, and JDXnumber< int >.
| JcampDxClass& JcampDxClass::set_userDefParameter | ( | bool | userDef | ) | [inline] |
| bool JcampDxClass::isUserDefParameter | ( | ) | const [inline] |
| const STD_string& JcampDxClass::get_description | ( | ) | const [inline] |
| JcampDxClass& JcampDxClass::set_description | ( | const STD_string & | descr | ) | [inline] |
| virtual svector JcampDxClass::get_alternatives | ( | ) | const [inline, virtual] |
| const STD_string& JcampDxClass::get_unit | ( | ) | const [inline] |
| JcampDxClass& JcampDxClass::set_unit | ( | const STD_string & | un | ) | [inline] |
| virtual parameterMode JcampDxClass::get_parmode | ( | ) | const [inline, virtual] |
| virtual JcampDxClass& JcampDxClass::set_parmode | ( | parameterMode | parameter_mode | ) | [inline, virtual] |
| virtual fileMode JcampDxClass::get_filemode | ( | ) | const [inline, virtual] |
| virtual JcampDxClass& JcampDxClass::set_filemode | ( | fileMode | file_mode | ) | [inline, virtual] |
| virtual GuiProps JcampDxClass::get_gui_props | ( | ) | const [inline, virtual] |
Returns the properties of axis display in the GUI, only useful for JDXarrays
Reimplemented in JDXarray< A, J >, JDXarray< tjarray, JDXnumber< double > >, JDXarray< tjarray, JDXnumber< int > >, JDXarray< tjarray, JDXnumber >, and JDXarray< tjarray, JDXstring >.
| virtual JcampDxClass& JcampDxClass::set_gui_props | ( | const GuiProps & | ) | [inline, virtual] |
Sets the properties of axis display in the GUI, only useful for JDXarrays
Reimplemented in JDXarray< A, J >, JDXarray< tjarray, JDXnumber< double > >, JDXarray< tjarray, JDXnumber< int > >, JDXarray< tjarray, JDXnumber >, and JDXarray< tjarray, JDXstring >.
| virtual STD_string JcampDxClass::get_parx_code | ( | parxCodeType | type, | |
| const ParxEquiv & | equiv = ParxEquiv() | |||
| ) | const [virtual] |
Returns C code that can be used together with the PARX(Bruker) compiler.
Reimplemented in JDXarray< A, J >, JcampDxBlock, JDXnumber< T >, JDXstring, JDXbool, JDXenum, JDXarray< tjarray, JDXnumber< double > >, JDXarray< tjarray, JDXnumber< int > >, JDXarray< tjarray, JDXnumber >, JDXarray< tjarray, JDXstring >, JDXnumber< double >, JDXnumber< float >, and JDXnumber< int >.
| virtual ParxEquiv JcampDxClass::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 in JDXarray< A, J >, JDXnumber< T >, JDXstring, JDXbool, JDXenum, JDXarray< tjarray, JDXnumber< double > >, JDXarray< tjarray, JDXnumber< int > >, JDXarray< tjarray, JDXnumber >, JDXarray< tjarray, JDXstring >, JDXnumber< double >, JDXnumber< float >, and JDXnumber< int >.
Friends And Related Function Documentation
| STD_ostream& operator<< | ( | STD_ostream & | s, | |
| const JcampDxClass & | value | |||
| ) | [friend] |
The documentation for this class was generated from the following file:
