ODIN
Public Member Functions | List of all members

Timing delay. More...

#include <seqdelay.h>

Inheritance diagram for SeqDelay:
Inheritance graph
[legend]

Public Member Functions

 SeqDelay (const STD_string &object_label="unnamedSeqDelay", float delayduration=0.0, const STD_string &command="", const STD_string &durationVariable="")
 
 SeqDelay (const SeqDelay &sd)
 
SeqDelayoperator= (const SeqDelay &sd)
 
SeqDelayoperator= (float dur)
 
SeqDelayset_command (const STD_string &command)
 
STD_string get_program (programContext &context) const
 
- Public Member Functions inherited from SeqTreeObj
virtual STD_string get_properties () const
 
virtual unsigned int event (eventContext &context) 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)
 
- Public Member Functions inherited from SeqDur
 SeqDur (const STD_string &object_label, float duration)
 
 SeqDur (const STD_string &object_label="unnamedSeqDur")
 
 SeqDur (const SeqDur &sd)
 
SeqDurset_duration (float duration)
 
double get_duration () const
 
SeqDuroperator= (const SeqDur &sd)
 

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 ()
 
virtual bool prep ()
 
- Static Protected Member Functions inherited from SeqClass
static void clear_temporary ()
 
static void clear_containers ()
 

Detailed Description

Timing delay.

This class represents a delay with an optional command.

Definition at line 54 of file seqdelay.h.

Constructor & Destructor Documentation

◆ SeqDelay() [1/2]

SeqDelay::SeqDelay ( const STD_string &  object_label = "unnamedSeqDelay",
float  delayduration = 0.0,
const STD_string &  command = "",
const STD_string &  durationVariable = "" 
)

Constructs a delay labeled 'object_label' with the following properties:

  • delayduration: The duration of the delay.
  • command: An optional command that will be issued during the delay in the pulse program.
  • durationVariable: If the the command that specifies the delay duration in the pulse program should differ from the default, it can be overwritten by this string.

◆ SeqDelay() [2/2]

SeqDelay::SeqDelay ( const SeqDelay sd)

Constructs a delay which is a copy of 'sd'

Member Function Documentation

◆ get_program()

STD_string SeqDelay::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=() [1/2]

SeqDelay& SeqDelay::operator= ( const SeqDelay sd)

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

◆ operator=() [2/2]

SeqDelay& SeqDelay::operator= ( float  dur)

This assignment operator can be used to specify the duration of the delay

◆ set_command()

SeqDelay& SeqDelay::set_command ( const STD_string &  command)

Specifies the extra command for the delay


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