msl::graph::Action Class Reference

Detailed Description

Node calling a function when run is called.

#include <Action.h>

Public Types
using	Function = FlexibleFunction< void >
	Action function.
using	Pointer = std::shared_ptr< Action >
	Reference-counted pointer to Action
using	ConstPointer = std::shared_ptr< Action const >
	Reference-counted constant pointer to Action
Public Types inherited from msl::graph::AbstractNode
using	Pointer = std::shared_ptr< AbstractNode >
	Reference-counted pointer to AbstractNode
using	ConstPointer = std::shared_ptr< AbstractNode const >
	Reference-counted constant pointer to AbstractNode

Public Member Functions
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
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={})
	Create an action from a function and registry.

Member Typedef Documentation

Function

using msl::graph::Action::Function = FlexibleFunction<void>

Action function.

Pointer

using msl::graph::Action::Pointer = std::shared_ptr< Action >

Reference-counted pointer to Action

ConstPointer

using msl::graph::Action::ConstPointer = std::shared_ptr< Action const>

Reference-counted constant pointer to Action

Constructor & Destructor Documentation

~Action()

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

virtualdefault

Member Function Documentation

New()

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

static

Create an action from a function and registry.

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