LDRaction Class Reference

#include <ldrtypes.h>

Inheritance diagram for LDRaction:

Public Member Functions
	LDRaction ()
	LDRaction (bool init_state, const STD_string &name="")
	LDRaction (const LDRaction &ja)
LDRaction &	operator= (const LDRaction &ja)
	operator bool () const
LDRaction &	trigger_action ()
bool	parsevalstring (const STD_string &parstring, const LDRserBase *ser=0)
STD_string	printvalstring (const LDRserBase *ser=0) const
STD_string	get_typeInfo (bool parx_equivtype=false) const
LDRbase *	create_copy () const
Public Member Functions inherited from LDRbase
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 bool	parse (STD_string &parstring, const LDRserBase &serializer=LDRserJDX())
virtual int	load (const STD_string &filename, const LDRserBase &serializer=LDRserJDX())
virtual double	get_minval () const
virtual double	get_maxval () const
bool	has_minmax () const
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)

Detailed Description

Labeled Data Record (LDR) class to trigger actions from the GUI

Definition at line 316 of file ldrtypes.h.

Constructor & Destructor Documentation

LDRaction() [1/3]

LDRaction::LDRaction ( )

inline

Default constructor

Definition at line 323 of file ldrtypes.h.

LDRaction() [2/3]

LDRaction::LDRaction	(	bool	init_state,
		const STD_string &	name = ""
	)

Constructor with the following arguments:

• init_state: Initial value for the action
• name: The label of the parameter

LDRaction() [3/3]

LDRaction::LDRaction ( const LDRaction &  ja )

inline

Copy constructor

Definition at line 335 of file ldrtypes.h.

Member Function Documentation

create_copy()

LDRbase* LDRaction::create_copy ( ) const

inlinevirtual

Returns a deep copy of the parameter

Implements LDRbase.

Definition at line 356 of file ldrtypes.h.

get_typeInfo()

STD_string LDRaction::get_typeInfo ( bool  parx_equivtype = false ) const

inlinevirtual

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

Implements LDRbase.

Definition at line 355 of file ldrtypes.h.

operator bool()

LDRaction::operator bool

(

)

const

Returns whether an action should be triggered and resets the action flag

operator=()

LDRaction& LDRaction::operator=

(

const LDRaction &

ja

)

Copy assignment

parsevalstring()

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

virtual

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

Implements LDRbase.

printvalstring()

STD_string LDRaction::printvalstring ( const LDRserBase *  ser = 0 ) const

virtual

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

Implements LDRbase.

trigger_action()

LDRaction& LDRaction::trigger_action ( )

inline

After calling this function, the next type conversion to bool will return true

Definition at line 350 of file ldrtypes.h.

---

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

• ldrtypes.h