Public Member Functions | List of all members

#include <jdxtypes.h>

Inheritance diagram for JDXaction:
Inheritance graph
[legend]

Public Member Functions

 JDXaction ()
 JDXaction (bool init_state, const STD_string &name="", bool userParameter=true, compatMode mode=notBroken, parameterMode parameter_mode=edit)
 JDXaction (const JDXaction &ja)
JDXactionoperator= (const JDXaction &ja)
 operator bool () const
JDXactiontrigger_action ()
bool parsevalstring (const STD_string &parstring)
STD_string printvalstring () 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 &)
virtual STD_string get_parx_code (parxCodeType type, const ParxEquiv &equiv=ParxEquiv()) const
virtual ParxEquiv get_parx_equiv () const
- 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)

Detailed Description

JCAMP-DX class to trigger actions from the GUI

Definition at line 344 of file jdxtypes.h.

Constructor & Destructor Documentation

JDXaction::JDXaction ( )
inline

Default constructor

Definition at line 351 of file jdxtypes.h.

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

Constructor with the following arguments:

  • init_state: Initial value for the action
  • 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
JDXaction::JDXaction ( const JDXaction ja)
inline

Copy constructor

Definition at line 368 of file jdxtypes.h.

Member Function Documentation

JcampDxClass* JDXaction::create_copy ( ) const
inlinevirtual

Returns a deep copy of the parameter

Implements JcampDxClass.

Definition at line 389 of file jdxtypes.h.

const char* JDXaction::get_typeInfo ( ) const
inlinevirtual

Returns a string describing the type of the parameter

Implements JcampDxClass.

Definition at line 388 of file jdxtypes.h.

JDXaction::operator bool ( ) const

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

JDXaction& JDXaction::operator= ( const JDXaction ja)

Copy assignment

bool JDXaction::parsevalstring ( const STD_string &  )
virtual

Parses and assigns the value in the given string

Implements JcampDxClass.

STD_string JDXaction::printvalstring ( ) const
virtual

Returns the value of the parameter as a string

Implements JcampDxClass.

JDXaction& JDXaction::trigger_action ( )
inline

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

Definition at line 383 of file jdxtypes.h.


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