SeqTrigger Class Reference
[Classes for sequence design (odinseq library)]
Output trigger.
More...
#include <seqtrigg.h>
Inheritance diagram for SeqTrigger:
Public Member Functions | |
| SeqTrigger (const STD_string &object_label, double duration) | |
| SeqTrigger (const STD_string &object_label="unnamedSeqTrigger") | |
| SeqTrigger (const SeqTrigger &st) | |
| SeqTrigger & | operator= (const SeqTrigger &st) |
| STD_string | get_program (programContext &context) const |
| double | get_duration () const |
| unsigned int | event (eventContext &context) const |
Detailed Description
Output trigger.Insert triggers for external devices into the sequence.
Definition at line 69 of file seqtrigg.h.
Constructor & Destructor Documentation
| SeqTrigger::SeqTrigger | ( | const STD_string & | object_label, | |
| double | duration | |||
| ) |
Constructs a trigger labeled 'object_label' with the following properties:
- duration: The duration of the trigger pulse
| SeqTrigger::SeqTrigger | ( | const STD_string & | object_label = "unnamedSeqTrigger" |
) |
Default Constructor
| SeqTrigger::SeqTrigger | ( | const SeqTrigger & | st | ) |
Constructs a trigger which is a copy of 'st'
Member Function Documentation
| SeqTrigger& SeqTrigger::operator= | ( | const SeqTrigger & | st | ) |
This assignment operator will make this object become an exact copy of 'st'.
| STD_string SeqTrigger::get_program | ( | programContext & | context | ) | const [virtual] |
Returns the part in the pulse/gradient program of this sequence object. 'context' holds data about how the program should be generated, e.g. type of program and formatting.
Reimplemented from SeqTreeObj.
| double SeqTrigger::get_duration | ( | ) | const [virtual] |
Returns the duration of the sequence object.
Implements SeqTreeObj.
| unsigned int SeqTrigger::event | ( | eventContext & | context | ) | const [virtual] |
Queries the sequence tree for events, returns the number of events executed
Reimplemented from SeqTreeObj.
The documentation for this class was generated from the following file:
