JDXformula Class Reference

#include <jdxtypes.h>

Inheritance diagram for JDXformula:

Public Member Functions
	JDXformula ()
	JDXformula (const STD_string &formula, const STD_string &name="", bool userParameter=true, compatMode mode=notBroken, parameterMode parameter_mode=edit)
	JDXformula (const JDXformula &jf)
JDXformula &	operator= (const STD_string &formula)
JDXformula &	operator= (const JDXformula &jf)
JDXformula &	set_syntax (const STD_string &syn)
STD_string	get_syntax () const
const char *	get_typeInfo () const
JcampDxClass *	create_copy () const
Public Member Functions inherited from JDXstring
	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)
JDXstring &	operator= (const char *charptr)
JDXstring &	operator= (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
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 JcampDxClass &	set_compatmode (compatMode compat_mode)
virtual compatMode	get_compatmode () const
virtual double	get_minval () const
virtual double	get_maxval () const
bool	has_minmax () const
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 &)
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)

Detailed Description

JCAMP-DX class for representing mathematic formulas

Definition at line 537 of file jdxtypes.h.

Constructor & Destructor Documentation

JDXformula::JDXformula ( )

inline

Default constructor

Definition at line 544 of file jdxtypes.h.

JDXformula::JDXformula	(	const STD_string &	formula,
		const STD_string &	name = "",
		bool	userParameter = true,
		compatMode	mode = notBroken,
		parameterMode	parameter_mode = edit
	)

Constructor with the following arguments:

• formula: Initial value for the formula
• 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

JDXformula::JDXformula ( const JDXformula &  jf )

inline

Copy constructor

Definition at line 561 of file jdxtypes.h.

Member Function Documentation

JcampDxClass* JDXformula::create_copy ( ) const

inlinevirtual

Returns a deep copy of the parameter

Reimplemented from JDXstring.

Definition at line 585 of file jdxtypes.h.

STD_string JDXformula::get_syntax ( ) const

inline

Returns a string describing the formulas syntax

Definition at line 581 of file jdxtypes.h.

const char* JDXformula::get_typeInfo ( ) const

inlinevirtual

Returns a string describing the type of the parameter

Reimplemented from JDXstring.

Definition at line 584 of file jdxtypes.h.

JDXformula& JDXformula::operator= ( const STD_string &  formula )

inline

Assignment from a formula string

Reimplemented from JDXstring.

Definition at line 566 of file jdxtypes.h.

JDXformula& JDXformula::operator=

(

const JDXformula &

jf

)

Copy assignment

JDXformula& JDXformula::set_syntax ( const STD_string &  syn )

inline

Sets a string describing the formulas syntax

Definition at line 576 of file jdxtypes.h.

---

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

• jdxtypes.h