msl 1.1.0
 
Loading...
Searching...
No Matches
msl::Sequence Class Reference

Graph-based sequence class. More...

#include <Sequence.h>

Inheritance diagram for msl::Sequence:

Public Member Functions

 Sequence ()
 
 Sequence (Sequence const &)=delete
 
 Sequence (Sequence &&)=delete
 
Sequenceoperator= (Sequence const &)=delete
 
Sequenceoperator= (Sequence &&)=delete
 
 ~Sequence () override=default
 
NLSStatus check (MrProt &protocol, SeqLim &limits, SeqExpo &exports, SEQCheckMode *) override
 Store the check mask as "indices" in the root node registry and run the root node.
 
NLSStatus run (MrProt &protocol, SeqLim &limits, SeqExpo &exports) override
 Store the run mask as "indices" in the root node registry and run the root node.
 
NLS_STATUS runKernel (MrProt &, SeqLim &, SeqExpo &, long, long, long, long) override
 Do nothing.
 
template<typename T>
T const & get (std::string const &key) const
 Return an object stored in the dictionary.
 
template<typename T>
T & get (std::string const &key)
 Return an object stored in the dictionary.
 

Protected Types

using PointsConstIterator = msl::ConstIterator<msl::Mask::Points>
 

Protected Attributes

msl::graph::Node::Pointer _root
 
msl::Mask _runMask
 
msl::Mask _checkMask
 

Detailed Description

Graph-based sequence class.

This class provides a default implementation of a graph-based top-level sequence class. It encapsulates a root Node, and two masks, one for the k-space indices to be run, one for the k-space indices to be checked.

Member Typedef Documentation

◆ PointsConstIterator

Constructor & Destructor Documentation

◆ Sequence() [1/3]

msl::Sequence::Sequence ( )

◆ Sequence() [2/3]

msl::Sequence::Sequence ( Sequence const & )
delete

◆ Sequence() [3/3]

msl::Sequence::Sequence ( Sequence && )
delete

◆ ~Sequence()

msl::Sequence::~Sequence ( )
overridedefault

Member Function Documentation

◆ operator=() [1/2]

Sequence & msl::Sequence::operator= ( Sequence const & )
delete

◆ operator=() [2/2]

Sequence & msl::Sequence::operator= ( Sequence && )
delete

◆ check()

NLSStatus msl::Sequence::check ( MrProt & protocol,
SeqLim & limits,
SeqExpo & exports,
SEQCheckMode *  )
override

Store the check mask as "indices" in the root node registry and run the root node.

◆ run()

NLSStatus msl::Sequence::run ( MrProt & protocol,
SeqLim & limits,
SeqExpo & exports )
override

Store the run mask as "indices" in the root node registry and run the root node.

◆ runKernel()

NLS_STATUS msl::Sequence::runKernel ( MrProt & ,
SeqLim & ,
SeqExpo & ,
long ,
long ,
long ,
long  )
override

Do nothing.

◆ get() [1/2]

template<typename T>
T const & msl::Sequence::get ( std::string const & key) const
inline

Return an object stored in the dictionary.

◆ get() [2/2]

template<typename T>
T & msl::Sequence::get ( std::string const & key)
inline

Return an object stored in the dictionary.

Member Data Documentation

◆ _root

msl::graph::Node::Pointer msl::Sequence::_root
protected

◆ _runMask

msl::Mask msl::Sequence::_runMask
protected

◆ _checkMask

msl::Mask msl::Sequence::_checkMask
protected

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