Public Member Functions | List of all members

Magnetization snapshot. More...

#include <seqtrigg.h>

Inheritance diagram for SeqSnapshot:
Inheritance graph

Public Member Functions

 SeqSnapshot (const STD_string &object_label, const STD_string &snapshot_fname)
 SeqSnapshot (const STD_string &object_label="unnamedSeqSnapshot")
 SeqSnapshot (const SeqSnapshot &ss)
SeqSnapshotoperator= (const SeqSnapshot &ss)
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 snapshot.

This class is used to trigger a snapshot of the current magnetization during simulation of the sequence.

Definition at line 164 of file seqtrigg.h.

Constructor & Destructor Documentation

§ SeqSnapshot() [1/3]

SeqSnapshot::SeqSnapshot ( const STD_string &  object_label,
const STD_string &  snapshot_fname 

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

  • snapshot_fname: The file name where the magnetization will be stored consecutively in float format.

§ SeqSnapshot() [2/3]

SeqSnapshot::SeqSnapshot ( const STD_string &  object_label = "unnamedSeqSnapshot")

Default Constructor

§ SeqSnapshot() [3/3]

SeqSnapshot::SeqSnapshot ( const SeqSnapshot ss)

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

Definition at line 182 of file seqtrigg.h.

Member Function Documentation

§ event()

unsigned int SeqSnapshot::event ( eventContext context) const

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

Reimplemented from SeqTreeObj.

§ get_duration()

double SeqSnapshot::get_duration ( ) const

Returns the duration of the sequence object.

Implements SeqTreeObj.

Definition at line 190 of file seqtrigg.h.

§ operator=()

SeqSnapshot& SeqSnapshot::operator= ( const SeqSnapshot ss)

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

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