msl 1.1.0
 
Loading...
Searching...
No Matches
msl::graph::IteratorTemplate< T > Class Template Reference

Node encapsulating an msl::Iterator. More...

#include <Iterator.h>

Inheritance diagram for msl::graph::IteratorTemplate< T >:
msl::graph::Node msl::graph::AbstractNode

Public Member Functions

virtual ~IteratorTemplate ()=default
 
NLSStatus prepare (MrProt &protocol, SeqLim &limits, SeqExpo &exports) override
 Prepare the children.
 
NLSStatus run (MrProt &protocol, SeqLim &limits, SeqExpo &exports) override
 Run the children for each item of the iterator range.
 
uint64_t duration () const override
 Return the sum of the duration of the children times the number of items of the iterator range.
 
MrProtocolData::SeqExpoRFInfo rfInfo () const override
 Return the sum of the RF information of the children times the number of items of the iterator range.
 
- Public Member Functions inherited from msl::graph::Node
 DECLARE_POINTERS (Node)
 
virtual ~Node ()=default
 
NLSStatus prepare (MrProt &protocol, SeqLim &limits, SeqExpo &exports) override
 Prepare all children in order.
 
NLSStatus run (MrProt &protocol, SeqLim &limits, SeqExpo &exports) override
 Run all children in order.
 
NodesetRegistry (Dictionary::Pointer registry) override
 Set the registry to this node and its children.
 
uint64_t duration () const override
 Return the sum of the duration of the children.
 
MrProtocolData::SeqExpoRFInfo rfInfo () const override
 Return the sum of the RF information of the children.
 
bool empty () const
 Check whether this node has children.
 
std::size_t size () const
 Return the number of children.
 
template<typename T>
T & appendChild (std::shared_ptr< T > const &child)
 Append a child in last position, return the child.
 
NodedeleteChild (std::size_t index)
 Remove a child.
 
NodeclearChildren ()
 Remove all children.
 
AbstractNode::ConstPointer child (std::size_t index) const
 Return a child at given position.
 
AbstractNode::Pointer child (std::size_t index)
 Return a child at given position.
 
- Public Member Functions inherited from msl::graph::AbstractNode
 DECLARE_POINTERS (AbstractNode)
 
virtual ~AbstractNode ()=default
 
Dictionary::ConstPointer registry () const
 Return the registry.
 
Dictionary::Pointer registry ()
 Return the registry.
 
template<typename T>
T const & get (std::string const &key) const
 Return an object from the dictionary.
 
template<typename T>
T & get (std::string const &key)
 Return an object from the dictionary.
 
boost::typeindex::type_info const & type (std::string const &key) const
 Return the type of an object in the dictionary.
 

Static Public Member Functions

static Pointer New (std::string const &key, Dictionary::Pointer registry={})
 Create an iterator with no child.
 
template<typename Child>
static Pointer New (std::string const &key, Child const &child, Dictionary::Pointer registry={})
 Create an iterator with a single child.
 
static Pointer New (std::string const &key, Siblings const &siblings, Dictionary::Pointer registry={})
 Create an iterator with multiple children.
 
- Static Public Member Functions inherited from msl::graph::Node
static Pointer New (Dictionary::Pointer registry={})
 Create a node with no child.
 
template<typename T>
static Pointer New (T const &child, Dictionary::Pointer registry={})
 Create a node with a single child.
 
static Pointer New (Siblings const &siblings, Dictionary::Pointer registry={})
 Create a node with multiple children.
 

Additional Inherited Members

- Public Types inherited from msl::graph::Node
using Siblings = std::vector<AbstractNode::Pointer>
 
- Protected Member Functions inherited from msl::graph::Node
 Node (Dictionary::Pointer registry={})
 
template<typename T>
 Node (T const &child, Dictionary::Pointer registry={})
 
 Node (Siblings const &siblings, Dictionary::Pointer registry={})
 
 Node (Node const &)=default
 
 Node (Node &&)=default
 
Nodeoperator= (Node const &)=default
 
Nodeoperator= (Node &&)=default
 
- Protected Member Functions inherited from msl::graph::AbstractNode
 AbstractNode (Dictionary::Pointer registry={})
 
 AbstractNode (AbstractNode const &)=default
 
 AbstractNode (AbstractNode &&)=default
 
AbstractNodeoperator= (AbstractNode const &)=default
 
AbstractNodeoperator= (AbstractNode &&)=default
 
- Protected Attributes inherited from msl::graph::Node
Siblings _children
 
- Protected Attributes inherited from msl::graph::AbstractNode
Dictionary::Pointer _registry
 

Detailed Description

template<typename T>
class msl::graph::IteratorTemplate< T >

Node encapsulating an msl::Iterator.

Constructor & Destructor Documentation

◆ ~IteratorTemplate()

template<typename T>
virtual msl::graph::IteratorTemplate< T >::~IteratorTemplate ( )
virtualdefault

Member Function Documentation

◆ New() [1/3]

template<typename T>
static Pointer msl::graph::IteratorTemplate< T >::New ( std::string const & key,
Dictionary::Pointer registry = {} )
inlinestatic

Create an iterator with no child.

◆ New() [2/3]

template<typename T>
template<typename Child>
static Pointer msl::graph::IteratorTemplate< T >::New ( std::string const & key,
Child const & child,
Dictionary::Pointer registry = {} )
inlinestatic

Create an iterator with a single child.

◆ New() [3/3]

template<typename T>
static Pointer msl::graph::IteratorTemplate< T >::New ( std::string const & key,
Siblings const & siblings,
Dictionary::Pointer registry = {} )
inlinestatic

Create an iterator with multiple children.

◆ prepare()

template<typename T>
NLSStatus msl::graph::IteratorTemplate< T >::prepare ( MrProt & protocol,
SeqLim & limits,
SeqExpo & exports )
inlineoverridevirtual

Prepare the children.

Implements msl::graph::AbstractNode.

◆ run()

template<typename T>
NLSStatus msl::graph::IteratorTemplate< T >::run ( MrProt & protocol,
SeqLim & limits,
SeqExpo & exports )
inlineoverridevirtual

Run the children for each item of the iterator range.

Implements msl::graph::AbstractNode.

◆ duration()

template<typename T>
uint64_t msl::graph::IteratorTemplate< T >::duration ( ) const
inlineoverridevirtual

Return the sum of the duration of the children times the number of items of the iterator range.

Implements msl::graph::AbstractNode.

◆ rfInfo()

template<typename T>
MrProtocolData::SeqExpoRFInfo msl::graph::IteratorTemplate< T >::rfInfo ( ) const
inlineoverridevirtual

Return the sum of the RF information of the children times the number of items of the iterator range.

Implements msl::graph::AbstractNode.


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