Sequence Loop. More...

#include <seqloop.h>

Inheritance diagram for SeqObjLoop:

[legend]

Public Member Functions
	SeqObjLoop (const STD_string &object_label="unnamedSeqObjLoop")

	SeqObjLoop (const SeqObjLoop &sl)

SeqObjLoop &	operator= (const SeqObjLoop &sl)

double	get_preduration () const

double	get_postduration () const

SeqObjLoop &	set_body (const SeqObjBase &so)

SeqObjLoop &	set_times (unsigned int t)

SeqObjLoop &	operator() (const SeqObjBase &embeddedBody)

SeqObjLoop &	operator[] (const SeqVector &seqvector)

SeqObjLoop &	operator[] (unsigned int t)

int	get_times () const

STD_string	get_program (programContext &context) const

double	get_duration () const

unsigned int	event (eventContext &context) const

SeqValList	get_freqvallist (freqlistAction action) const

SeqValList	get_delayvallist () const

double	get_rf_energy () const

void	query (queryContext &context) const

RecoValList	get_recovallist (unsigned int reptimes, LDRkSpaceCoords &coords) const

STD_string	get_properties () const

Public Member Functions inherited from SeqCounter
	SeqCounter (const STD_string &object_label="unnamedSeqCounter")

	SeqCounter (const SeqCounter &sc)

SeqCounter &	operator= (const SeqCounter &sc)

Public Member Functions inherited from SeqTreeObj
bool	contains (const SeqTreeObj *sto) const

void	tree (SeqTreeCallbackAbstract *display) const

Public Member Functions inherited from SeqClass
SeqClass &	set_temporary ()

Public Member Functions inherited from Labeled
	Labeled (const STD_string &label="unnamed")

Labeled &	set_label (const STD_string &label)

const STD_string &	get_label () const

Labeled &	operator= (const Labeled &l)

Public Member Functions inherited from SeqObjList
	SeqObjList (const STD_string &object_label="unnamedSeqObjList")

	SeqObjList (const SeqObjList &so)

SeqObjList &	operator= (const SeqObjList &so)

SeqObjList &	operator= (const SeqObjLoop &sl)

SeqObjList &	operator= (const SeqDecoupling &sd)

SeqObjList &	operator= (const SeqObjBase &soa)

SeqObjList &	operator= (SeqGradObjInterface &sgoa)

SeqObjList &	operator= (SeqGradChan &sgc)

SeqObjList &	operator= (SeqGradChanList &sgcl)

SeqObjList &	operator+= (const SeqObjBase &soa)

SeqObjList &	operator+= (SeqGradObjInterface &sgoa)

SeqObjList &	operator+= (SeqGradChan &sgc)

SeqObjList &	operator+= (SeqGradChanList &sgcl)

SeqObjList &	set_gradrotmatrixvector (const SeqRotMatrixVector &matrixVec)

Public Member Functions inherited from List< SeqObjBase, const SeqObjBase *, const SeqObjBase & >
	List ()

	~List ()

List &	operator= (const List &l)

List &	clear ()

List &	append (const SeqObjBase & item)

List &	remove (const SeqObjBase & item)

unsigned int	size () const

iter	get_begin ()

iter	get_end ()

constiter	get_const_begin () const

constiter	get_const_end () const

Additional Inherited Members
Public Types inherited from List< SeqObjBase, const SeqObjBase *, const SeqObjBase & >
typedef STD_list< const SeqObjBase * >::iterator	iter

typedef STD_list< const SeqObjBase * >::const_iterator	constiter

Protected Member Functions inherited from SeqClass
void	marshall_error () const

Static Protected Member Functions inherited from SeqClass
static void	clear_temporary ()

static void	clear_containers ()

Detailed Description

Sequence Loop.

This class represents a loop which is used to enclose other sequence objects so that they are repeatedely played out in the sequence

Definition at line 38 of file seqloop.h.

Constructor & Destructor Documentation

◆ SeqObjLoop() [1/2]

SeqObjLoop::SeqObjLoop ( const STD_string & object_label = "unnamedSeqObjLoop" )

Construct an empty loop object with the given label

◆ SeqObjLoop() [2/2]

SeqObjLoop::SeqObjLoop ( const SeqObjLoop & sl )

Constructs a copy of 'sl'

Member Function Documentation

◆ event()

unsigned int SeqObjLoop::event ( eventContext & context ) const

virtual

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

Reimplemented from SeqObjList.

◆ get_delayvallist()

SeqValList SeqObjLoop::get_delayvallist ( ) const

virtual

Returns the list of delay values in the objects branch of the sequence tree

Reimplemented from SeqObjList.

◆ get_duration()

double SeqObjLoop::get_duration ( ) const

virtual

Returns the duration of the sequence object.

Reimplemented from SeqObjList.

◆ get_freqvallist()

SeqValList SeqObjLoop::get_freqvallist ( freqlistAction action ) const

virtual

Returns the list of frequency values in the objects branch of the sequence tree

Reimplemented from SeqObjList.

◆ get_postduration()

double SeqObjLoop::get_postduration ( ) const

Duration the loop itself takes after its kernel is iterated

◆ get_preduration()

double SeqObjLoop::get_preduration ( ) const

Duration the loop itself takes before iteration is started

◆ get_program()

STD_string SeqObjLoop::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 SeqObjList.

◆ get_properties()

STD_string SeqObjLoop::get_properties ( ) const

virtual

Returns a string describing the object

Reimplemented from SeqObjList.

◆ get_recovallist()

RecoValList SeqObjLoop::get_recovallist	(	unsigned int	reptimes,
		LDRkSpaceCoords &	coords
	)		const

virtual

Appends the k-space coordinates in this branch of the sequence tree to 'coords' and returns their ordering

Reimplemented from SeqObjList.

◆ get_rf_energy()

double SeqObjLoop::get_rf_energy ( ) const

virtual

Returns the RF power deposition in the objects branch of the sequence tree. The physical unit is unspecified, it depends on the current platform.

Reimplemented from SeqObjList.

◆ get_times()

int SeqObjLoop::get_times ( ) const

virtual

The number of iterations of this counter object

Reimplemented from SeqCounter.

◆ operator()()

SeqObjLoop& SeqObjLoop::operator() ( const SeqObjBase & embeddedBody )

Generates and returns a new loop object that is a copy of this. The new loop will loop over 'embeddedBody'.

◆ operator=()

SeqObjLoop& SeqObjLoop::operator= ( const SeqObjLoop & sl )

Assignment operator that makes this loop object become a copy of 'sl'

◆ operator[]() [1/2]

SeqObjLoop& SeqObjLoop::operator[] ( const SeqVector & seqvector )

This operator will append 'seqvector' to the list of vectors the loop will iterate through

◆ operator[]() [2/2]

SeqObjLoop& SeqObjLoop::operator[] ( unsigned int t )

This operator specifies the number of times the body of the loop will be repeated

◆ query()

void SeqObjLoop::query ( queryContext & context ) const

virtual

Query the sequence tree recursively

Reimplemented from SeqObjList.

◆ set_body()

SeqObjLoop& SeqObjLoop::set_body ( const SeqObjBase & so )

Sets the inner part of loop, only useful for explicit setup of loops, i.e. in SeqEpiDriverDefault

◆ set_times()

SeqObjLoop& SeqObjLoop::set_times ( unsigned int t )

Specify the number of times the body of the loop will be repeated, only useful for explicit setup of loops, i.e. in SeqEpiDriverDefault

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

seqloop.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SeqObjLoop() [1/2]

◆ SeqObjLoop() [2/2]

Member Function Documentation

◆ event()

◆ get_delayvallist()

◆ get_duration()

◆ get_freqvallist()

◆ get_postduration()

◆ get_preduration()

◆ get_program()

◆ get_properties()

◆ get_recovallist()

◆ get_rf_energy()

◆ get_times()

◆ operator()()

◆ operator=()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ query()

◆ set_body()

◆ set_times()