SeqGradChanList Class Reference

#include <seqgradchanlist.h>

Inheritance diagram for SeqGradChanList:

Public Member Functions
	SeqGradChanList (const STD_string &object_label="unnamedSeqGradChanList")
	SeqGradChanList (const SeqGradChanList &sgcl)
	~SeqGradChanList ()
SeqGradChanList &	operator= (const SeqGradChanList &sgcl)
double	get_duration () const
STD_string	get_properties () const
unsigned int	event (eventContext &context) const
void	query (queryContext &context) const
SeqGradInterface &	set_strength (float gradstrength)
SeqGradInterface &	invert_strength ()
float	get_strength () const
fvector	get_gradintegral () const
double	get_gradduration () const
SeqGradInterface &	set_gradrotmatrix (const RotMatrix &matrix)
direction	get_channel () const
SeqGradChanList &	operator+= (SeqGradChanList &sgcl)
SeqGradChanList &	operator+= (SeqGradChan &sgc)
Public Member Functions inherited from List< SeqGradChan, SeqGradChan *, SeqGradChan & >
	List ()
	~List ()
List &	operator= (const List &l)
List &	clear ()
List &	append (SeqGradChan & item)
List &	remove (SeqGradChan & item)
unsigned int	size () const
iter	get_begin ()
iter	get_end ()
constiter	get_const_begin () const
constiter	get_const_end () const
Public Member Functions inherited from SeqGradInterface
float	get_gradintegral_norm () 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 SeqTreeObj
virtual STD_string	get_program (programContext &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

Friends
class	SeqGradChanParallel

Additional Inherited Members
Public Types inherited from List< SeqGradChan, SeqGradChan *, SeqGradChan & >
typedef STD_list< SeqGradChan * >::iterator	iter
typedef STD_list< SeqGradChan * >::const_iterator	constiter
Protected Member Functions inherited from SeqClass
void	marshall_error () const
virtual bool	prep ()
Static Protected Member Functions inherited from SeqClass
static void	clear_temporary ()
static void	clear_containers ()

Detailed Description

This class represents a list of gradient channel objects (i.e. those derived from SeqGradChan) It is suitable to hold a gradient train for ONE gradient channel

Definition at line 33 of file seqgradchanlist.h.

Constructor & Destructor Documentation

SeqGradChanList() [1/2]

SeqGradChanList::SeqGradChanList

(

const STD_string &

object_label = "unnamedSeqGradChanList"

)

Construct an empty gradient channel list with the given label

SeqGradChanList() [2/2]

SeqGradChanList::SeqGradChanList

(

const SeqGradChanList &

sgcl

)

Constructs a copy of 'sgcl'

~SeqGradChanList()

SeqGradChanList::~SeqGradChanList

(

)

Destructor

Member Function Documentation

event()

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

virtual

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

Reimplemented from SeqTreeObj.

get_channel()

direction SeqGradChanList::get_channel

(

)

const

Returns the occupied channel

get_duration()

double SeqGradChanList::get_duration ( ) const

virtual

Returns the duration of the sequence object.

Implements SeqTreeObj.

get_gradduration()

double SeqGradChanList::get_gradduration ( ) const

virtual

Returns the duration of the gradient object. This function returns only the effective duration during whichthe gradient is active, any delays before and after the gradient are omitted.

Implements SeqGradInterface.

Reimplemented in SeqGradTrapez.

get_gradintegral()

fvector SeqGradChanList::get_gradintegral ( ) const

virtual

Returns the integral vector of the gradient course

Implements SeqGradInterface.

get_properties()

STD_string SeqGradChanList::get_properties ( ) const

virtual

Returns a string describing the object

Reimplemented from SeqTreeObj.

get_strength()

float SeqGradChanList::get_strength ( ) const

virtual

Returns the strength of the gradient object

Implements SeqGradInterface.

Reimplemented in SeqGradTrapez.

invert_strength()

SeqGradInterface& SeqGradChanList::invert_strength ( )

virtual

Changes the polarity of the gradient, i.e. inverts the sign of the gradient strength

Implements SeqGradInterface.

operator+=() [1/2]

SeqGradChanList& SeqGradChanList::operator+=

(

SeqGradChan &

sgc

)

Appends 'sgc' to this

operator+=() [2/2]

SeqGradChanList& SeqGradChanList::operator+=

(

SeqGradChanList &

sgcl

)

Appends the elements of 'sgcl' to this

operator=()

SeqGradChanList& SeqGradChanList::operator=

(

const SeqGradChanList &

sgcl

)

Assignment operator that makes this gradient sequence object become a copy of 'sgcl'

query()

void SeqGradChanList::query ( queryContext &  context ) const

virtual

Query the sequence tree recursively

Reimplemented from SeqTreeObj.

set_gradrotmatrix()

SeqGradInterface& SeqGradChanList::set_gradrotmatrix ( const RotMatrix &  matrix )

virtual

This function can be used to specify a rotation of the gradient object in the spatial domain, the rotation will be applied to this object only rather than to the whole sequence.

Implements SeqGradInterface.

set_strength()

SeqGradInterface& SeqGradChanList::set_strength ( float  gradstrength )

virtual

Changes the strength of the gradient object

Implements SeqGradInterface.

Reimplemented in SeqGradVectorPulse, and SeqGradConstPulse.

---

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

• seqgradchanlist.h