JDXbool Class Reference

#include <jdxtypes.h>

Inheritance diagram for JDXbool:

Public Member Functions
	JDXbool ()
	JDXbool (bool flag, const STD_string &name="", bool userParameter=true, compatMode mode=notBroken, parameterMode parameter_mode=edit, const STD_string &parx_equivalent="")
	JDXbool (const JDXbool &jb)
JDXbool &	operator= (bool flag)
JDXbool &	operator= (const STD_string &s)
JDXbool &	operator= (const JDXbool &jb)
	operator bool () const
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
JcampDxClass *	create_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 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 Boolean values

Definition at line 117 of file jdxtypes.h.

Constructor & Destructor Documentation

JDXbool::JDXbool ( )

inline

Default constructor

Definition at line 124 of file jdxtypes.h.

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

Constructor with the following arguments:

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

JDXbool::JDXbool ( const JDXbool &  jb )

inline

Copy constructor

Definition at line 143 of file jdxtypes.h.

Member Function Documentation

JcampDxClass* JDXbool::create_copy ( ) const

inlinevirtual

Returns a deep copy of the parameter

Implements JcampDxClass.

Definition at line 172 of file jdxtypes.h.

STD_string JDXbool::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 JDXbool::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 170 of file jdxtypes.h.

const char* JDXbool::get_typeInfo ( ) const

inlinevirtual

Returns a string describing the type of the parameter

Implements JcampDxClass.

Definition at line 171 of file jdxtypes.h.

JDXbool::operator bool ( ) const

inline

type conversion operator of the current value of the parameter

Definition at line 164 of file jdxtypes.h.

JDXbool& JDXbool::operator= ( bool  flag )

inline

Assigns the value of flag to the parameter

Definition at line 148 of file jdxtypes.h.

JDXbool& JDXbool::operator= ( const STD_string &  s )

inline

Assigns the value of s to the parameter, s may contain "yes" or "true" (upper- or lowercase) to indicate a value of true, otherwise false

Definition at line 154 of file jdxtypes.h.

JDXbool& JDXbool::operator=

(

const JDXbool &

jb

)

Copy assignment

bool JDXbool::parsevalstring ( const STD_string &  )

virtual

Parses and assigns the value in the given string

Implements JcampDxClass.

STD_string JDXbool::printvalstring ( ) const

virtual

Returns the value of the parameter as a string

Implements JcampDxClass.

---

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

• jdxtypes.h