Public Member Functions | List of all members

Magnetization reset. More...

#include <seqtrigg.h>

Inheritance diagram for SeqMagnReset:
Inheritance graph
[legend]

Public Member Functions

 SeqMagnReset (const STD_string &object_label="unnamedSeqMagnReset")
 
 SeqMagnReset (const SeqMagnReset &smr)
 
SeqMagnResetoperator= (const SeqMagnReset &smr)
 
double get_duration () const
 
unsigned int event (eventContext &context) const
 
- Public Member Functions inherited from SeqTreeObj
virtual STD_string get_program (programContext &context) const
 
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

Magnetization reset.

This class is used to reset the current magnetization to its initial equilibrium state during simulation of the sequence.

Definition at line 215 of file seqtrigg.h.

Constructor & Destructor Documentation

§ SeqMagnReset() [1/2]

SeqMagnReset::SeqMagnReset ( const STD_string &  object_label = "unnamedSeqMagnReset")

Constructs a trigger labeled 'object_label'

§ SeqMagnReset() [2/2]

SeqMagnReset::SeqMagnReset ( const SeqMagnReset smr)
inline

Constructs a snapshot trigger which is a copy of 'smr'

Definition at line 227 of file seqtrigg.h.

Member Function Documentation

§ event()

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

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

Reimplemented from SeqTreeObj.

§ get_duration()

double SeqMagnReset::get_duration ( ) const
inlinevirtual

Returns the duration of the sequence object.

Implements SeqTreeObj.

Definition at line 235 of file seqtrigg.h.

§ operator=()

SeqMagnReset& SeqMagnReset::operator= ( const SeqMagnReset smr)

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


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