Represents a set of events that must be executed serially in the specified sequence. More...

#include <wmsequencedgroup.h>

Inheritance diagram for WmSequencedGroup:

Detailed Description

Represents a set of events that must be executed serially in the specified sequence.

Public Types
typedef std::vector< std::string >::const_iterator	SequenceActionItr
	Iterator support funcions to access host actions.

Public Member Functions
virtual void	setup (const WxCryptSet &wxc)
	Setup the sequencedgroup using cryptset.

SequenceActionItr	begin () const

SequenceActionItr	end () const

const WmSolverBase &	getParent () const
	Get parent solver object.

Public Member Functions inherited from WxObject
virtual	~WxObject ()
	Dtor: destroy object.

void	setIo (WxIoBase &io)
	Set the I/O pointer for use in object.

void	setMsg (WxMsgBase &msg)
	Set the msg pointer for use in object.

WxIoBase &	getIo ()
	Return reference to I/O object.

const WxIoBase &	getIo () const
	Return constant reference to I/O object.

WxMsgBase &	getMsg ()
	Return reference to msg object.

const WxMsgBase &	getMsg () const
	Return const reference to msg object.

virtual void	setup (const WxCryptSet &wxc)
	Setup object using supplied crypset.

virtual void	init ()
	Initialize the object.

virtual void	finishBuild ()
	Finish building the object.

virtual void	load (WxIoBase &io, const WxIoNodeType &grpNode)
	Load object from file.

virtual void	dump (WxIoBase &io, WxIoNodeType &grpNode) const
	Dump object to file.

virtual std::string	name () const
	Get name of object.

void	setName (const std::string &nm)
	Set object's name.

Public Attributes
real	dtFrac
	Fraction of time-step to apply.

Protected Member Functions
	WmSequencedGroup (const WmConstOpaquePtr &parent_solver)
	Create new WmSequencedGroup.

Protected Member Functions inherited from WxObject
	WxObject ()
	Create object, that will be initialized subsequently.

	WxObject (const std::string &name)
	Create object with given name bypassing object setup phase Protected because there is no reason to have a WxObject directly, as it is meant to be a parent class.

Protected Attributes
std::vector< std::string >	hostActions
	host actions to apply

Member Typedef Documentation

◆ SequenceActionItr

typedef std::vector<std::string>::const_iterator WmSequencedGroup::SequenceActionItr

Iterator support funcions to access host actions.

Constructor & Destructor Documentation

◆ WmSequencedGroup()

WmSequencedGroup::WmSequencedGroup ( const WmConstOpaquePtr & parent_solver )

protected

Create new WmSequencedGroup.

Parameters

parent_solver type opaque wrapper to parent solver

Member Function Documentation

◆ begin()

SequenceActionItr WmSequencedGroup::begin ( ) const

inline

◆ end()

SequenceActionItr WmSequencedGroup::end ( ) const

inline

◆ getParent()

const WmSolverBase & WmSequencedGroup::getParent ( ) const

Get parent solver object.

Returns: reference to parent

◆ setup()

virtual void WmSequencedGroup::setup ( const WxCryptSet & wxc )

virtual

Setup the sequencedgroup using cryptset.

Parameters

wxc	Cryptset using which the object is set up.

Reimplemented from WxObject.

Reimplemented in WmHostSequencedGroup.

Member Data Documentation

◆ dtFrac

real WmSequencedGroup::dtFrac

Fraction of time-step to apply.

◆ hostActions

std::vector<std::string> WmSequencedGroup::hostActions

protected

host actions to apply

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

src/solver/wmsequencedgroup.h