JDXaction Class Reference
[JCAMP-DX implementation (odinpara library)]
#include <jdxtypes.h>
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) | |
| JDXaction & | operator= (const JDXaction &ja) |
| operator bool () const | |
| JDXaction & | trigger_action () |
| bool | parsevalstring (const STD_string &parstring) |
| STD_string | printvalstring () const |
| const char * | get_typeInfo () const |
| JcampDxClass * | create_copy () const |
Detailed Description
JCAMP-DX class to trigger actions from the GUIDefinition 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
| JDXaction::operator bool | ( | ) | const |
Returns whether an action should be triggered and resets the action flag
| 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.
| 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.
| const char* JDXaction::get_typeInfo | ( | ) | const [inline, virtual] |
Returns a string describing the type of the parameter
Implements JcampDxClass.
Definition at line 388 of file jdxtypes.h.
| JcampDxClass* JDXaction::create_copy | ( | ) | const [inline, virtual] |
Returns a deep copy of the parameter
Implements JcampDxClass.
Definition at line 389 of file jdxtypes.h.
The documentation for this class was generated from the following file:
