msl::graph::Action Class Reference

Node calling a function when run is called. More...

#include <Action.h>

Inheritance diagram for msl::graph::Action:

Public Types
using	Function

Public Member Functions
	DECLARE_POINTERS (Action)
virtual	~Action ()=default
NLSStatus	prepare (MrProt &protocol, SeqLim &limits, SeqExpo &exports) override
	Prepare the node.
NLSStatus	run (MrProt &protocol, SeqLim &limits, SeqExpo &exports) override
	Run the node.
uint64_t	duration () const override
	Alway return 0.
MrProtocolData::SeqExpoRFInfo	rfInfo () const override
	Alway return 0.
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.
virtual AbstractNode &	setRegistry (Dictionary::Pointer registry)
	Set 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 (Function const &function, Dictionary::Pointer registry={})

Additional Inherited Members
Protected Member Functions inherited from msl::graph::AbstractNode
	AbstractNode (Dictionary::Pointer registry={})
	AbstractNode (AbstractNode const &)=default
	AbstractNode (AbstractNode &&)=default
AbstractNode &	operator= (AbstractNode const &)=default
AbstractNode &	operator= (AbstractNode &&)=default
Protected Attributes inherited from msl::graph::AbstractNode
Dictionary::Pointer	_registry

Detailed Description

Node calling a function when run is called.

Member Typedef Documentation

Function

using msl::graph::Action::Function

Initial value:

 boost::variant<
        std::function<void()>,
        std::function<void(Dictionary::Pointer)>,
        std::function<void(MrProt &)>,
        std::function<void(MrProt &, Dictionary::Pointer)>,
        std::function<void(MrProt &, SeqLim &, SeqExpo &)>,
        std::function<void(MrProt &, SeqLim &, SeqExpo &, Dictionary::Pointer)>>

Constructor & Destructor Documentation

~Action()

virtual msl::graph::Action::~Action ( )

virtualdefault

Member Function Documentation

DECLARE_POINTERS()

msl::graph::Action::DECLARE_POINTERS

(

Action

)

New()

static Pointer msl::graph::Action::New ( Function const & function, Dictionary::Pointer registry = {} )

static

prepare()

NLSStatus msl::graph::Action::prepare ( MrProt & protocol, SeqLim & limits, SeqExpo & exports )

overridevirtual

Prepare the node.

Implements msl::graph::AbstractNode.

run()

NLSStatus msl::graph::Action::run ( MrProt & protocol, SeqLim & limits, SeqExpo & exports )

overridevirtual

Run the node.

Implements msl::graph::AbstractNode.

duration()

uint64_t msl::graph::Action::duration ( ) const

overridevirtual

Alway return 0.

Implements msl::graph::AbstractNode.

rfInfo()

MrProtocolData::SeqExpoRFInfo msl::graph::Action::rfInfo ( ) const

overridevirtual

Alway return 0.

Implements msl::graph::AbstractNode.

---

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

• msl/graph/Action.h