Public Member Functions | List of all members

Input trigger. More...

#include <seqtrigg.h>

Inheritance diagram for SeqHalt:
Inheritance graph
[legend]

Public Member Functions

 SeqHalt (const STD_string &object_label="unnamedSeqHalt")
 
 SeqHalt (const SeqHalt &sh)
 
SeqHaltoperator= (const SeqHalt &sh)
 
STD_string get_program (programContext &context) const
 
double get_duration () const
 
unsigned int event (eventContext &context) const
 
- Public Member Functions inherited from SeqTreeObj
virtual STD_string get_properties () const
 
virtual RecoValList get_recovallist (unsigned int reptimes, LDRkSpaceCoords &coords) const
 
bool contains (const SeqTreeObj *sto) const
 
void tree (SeqTreeCallbackAbstract *display) const
 
virtual SeqValList get_freqvallist (freqlistAction action) const
 
virtual SeqValList get_delayvallist () const
 
virtual double get_rf_energy () const
 
- Public Member Functions inherited from SeqClass
SeqClassset_temporary ()
 
- 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)
 

Additional Inherited Members

- Protected Member Functions inherited from SeqTreeObj
virtual void query (queryContext &context) const
 
- Protected Member Functions inherited from SeqClass
void marshall_error () const
 
virtual void clear_container ()
 
- Static Protected Member Functions inherited from SeqClass
static void clear_temporary ()
 
static void clear_containers ()
 

Detailed Description

Input trigger.

Halt sequence until an input trigger is received (e.g. cardiac gating).

Definition at line 121 of file seqtrigg.h.

Constructor & Destructor Documentation

§ SeqHalt() [1/2]

SeqHalt::SeqHalt ( const STD_string &  object_label = "unnamedSeqHalt")

Constructs a trigger labeled 'object_label'

§ SeqHalt() [2/2]

SeqHalt::SeqHalt ( const SeqHalt sh)
inline

Constructs a trigger which is a copy of 'sh'

Definition at line 133 of file seqtrigg.h.

Member Function Documentation

§ event()

unsigned int SeqHalt::event ( eventContext context) const
virtual

Queries the sequence tree for events, returns the number of events executed

Reimplemented from SeqTreeObj.

§ get_duration()

double SeqHalt::get_duration ( ) const
virtual

Returns the duration of the sequence object.

Implements SeqTreeObj.

§ get_program()

STD_string SeqHalt::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.

§ operator=()

SeqHalt& SeqHalt::operator= ( const SeqHalt sh)

This assignment operator will make this object become an exact copy of 'sh'.


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