Public Member Functions | Friends | List of all members

#include <jdxtypes.h>

Inheritance diagram for JDXstring:
Inheritance graph
[legend]

Public Member Functions

 JDXstring ()
 JDXstring (const STD_string &ss, const STD_string &name="", bool userParameter=true, compatMode mode=notBroken, parameterMode parameter_mode=edit, const STD_string &parx_equivalent="")
 JDXstring (int i, const char c=' ')
 JDXstring (const char *charptr)
 JDXstring (const JDXstring &str)
JDXstringoperator= (const STD_string &ss)
JDXstringoperator= (const char *charptr)
JDXstringoperator= (const JDXstring &ss)
bool parsevalstring (const STD_string &parstring)
STD_string printvalstring () const
STD_string get_parx_code (parxCodeType type, const ParxEquiv &equiv) const
ParxEquiv get_parx_equiv () const
const char * get_typeInfo () const
JcampDxClasscreate_copy () const
- Public Member Functions inherited from JcampDxClass
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 JcampDxClassset_compatmode (compatMode compat_mode)
virtual compatMode get_compatmode () const
virtual double get_minval () const
virtual double get_maxval () const
bool has_minmax () const
JcampDxClassset_userDefParameter (bool userDef)
bool isUserDefParameter () const
const STD_string & get_description () const
JcampDxClassset_description (const STD_string &descr)
virtual svector get_alternatives () const
const STD_string & get_unit () const
JcampDxClassset_unit (const STD_string &un)
virtual parameterMode get_parmode () const
virtual JcampDxClassset_parmode (parameterMode parameter_mode)
virtual fileMode get_filemode () const
virtual JcampDxClassset_filemode (fileMode file_mode)
virtual GuiProps get_gui_props () const
virtual JcampDxClassset_gui_props (const GuiProps &)
- 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)

Friends

STD_ostream & operator<< (STD_ostream &s, const JDXstring &t)

Detailed Description

JCAMP-DX class for representing strings

Definition at line 36 of file jdxtypes.h.

Constructor & Destructor Documentation

JDXstring::JDXstring ( )
inline

Default constructor

Definition at line 43 of file jdxtypes.h.

JDXstring::JDXstring ( const STD_string &  ss,
const STD_string &  name = "",
bool  userParameter = true,
compatMode  mode = notBroken,
parameterMode  parameter_mode = edit,
const STD_string &  parx_equivalent = "" 
)

Constructor with the following arguments:

  • ss: Initial value for the string
  • 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
JDXstring::JDXstring ( int  i,
const char  c = ' ' 
)
inline

Constructs a string of length i with c as their initial content

Definition at line 62 of file jdxtypes.h.

JDXstring::JDXstring ( const char *  charptr)
inline

Copy constructor from a C-string

Definition at line 67 of file jdxtypes.h.

JDXstring::JDXstring ( const JDXstring str)
inline

Copy constructor

Definition at line 72 of file jdxtypes.h.

Member Function Documentation

JcampDxClass* JDXstring::create_copy ( ) const
inlinevirtual

Returns a deep copy of the parameter

Implements JcampDxClass.

Reimplemented in JDXformula, and JDXfileName.

Definition at line 101 of file jdxtypes.h.

STD_string JDXstring::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.

ParxEquiv JDXstring::get_parx_equiv ( ) const
inlinevirtual

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 jdxtypes.h.

const char* JDXstring::get_typeInfo ( ) const
inlinevirtual

Returns a string describing the type of the parameter

Implements JcampDxClass.

Reimplemented in JDXformula, and JDXfileName.

Definition at line 100 of file jdxtypes.h.

JDXstring& JDXstring::operator= ( const STD_string &  ss)
inline

Assigns the string ss to the parameter

Reimplemented in JDXformula, and JDXfileName.

Definition at line 77 of file jdxtypes.h.

JDXstring& JDXstring::operator= ( const char *  charptr)
inline

Assigns the C-string charptr to the parameter

Definition at line 82 of file jdxtypes.h.

JDXstring& JDXstring::operator= ( const JDXstring ss)

Copy assignment

bool JDXstring::parsevalstring ( const STD_string &  )
virtual

Parses and assigns the value in the given string

Implements JcampDxClass.

Reimplemented in JDXfileName.

STD_string JDXstring::printvalstring ( ) const
virtual

Returns the value of the parameter as a string

Implements JcampDxClass.

Friends And Related Function Documentation

STD_ostream& operator<< ( STD_ostream &  s,
const JDXstring t 
)
friend

Final overrider for stream output

Definition at line 92 of file jdxtypes.h.


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