AftList Class Reference

Simple list class. More...

#include <AftNode.h>

Inheritance diagram for AftList:

Public Types
typedef std::shared_ptr< AftList >	Ptr
	Pointer type for lists.

Public Member Functions
	AftList (const AftList &node)
	Copy constructor for a list. More...
	AftList (const AftTokenVector newListNodes)
	Construct a list. More...
const AftTokenVector &	listNodes () const
virtual const bool	nodeIsValid (const AftValidatorPtr &validator, std::ostream &os)
	@ returns true if node is valid
virtual const std::string	nodeType () const
virtual void	nextNodes (AftTokenVector &nextTokens)
virtual std::ostream &	description (std::ostream &os) const
	Append a description of the node to an output stream. More...
Public Member Functions inherited from AftNode
	AftNode (const AftNode &node)
	Copy constructor for a basic node. More...
	AftNode (const AftNodeToken newToken=AFT_NODE_TOKEN_NONE, const AftNodeToken newNext=AFT_NODE_TOKEN_NONE, const std::string newName="")
	Construct an entry for a basic node. More...
	operator const AftNodeToken () const
const AftNodeToken	nodeToken () const
const std::string	nodeName () const
const AftTypeIndex	nodeTypeIndex () const
void	setNodeNext (AftNodeToken newNext)
	Set the (optional) next node. More...
const AftNodeToken	nodeNext () const
void	setNodeParameters (const AftParameters::Ptr &newParams)
	Set the optional parameters of the node. More...
const AftParameters::Ptr	nodeParameters () const
template<class T >
std::shared_ptr< T >	nodeParameter (const std::string &name)
	Convenience parameter access template. Use this to access node parameters. More...
void	setNodeParameter (const std::string &name, const AftDataPtr &data)
	Convenience parameter setter. Use this to set node parameters. More...
virtual const bool	nodeIsContainer () const
	@ returns true if node can take entries
virtual const bool	nodeIsDelete () const
	@ returns true if node is a delete

Static Public Member Functions
static AftList::Ptr	create (const AftTokenVector newListNodes)
	Factory generate a list. More...
Static Public Member Functions inherited from AftNode
template<class T >
static std::shared_ptr< T >	downcast (const AftNodePtr &node)
	Convenience downcast template. Use this instead of manual casting if required. More...

Protected Attributes
AftTokenVector	_listNodes
	List of node tokens.
Protected Attributes inherited from AftNode
friend	AftInsert
	AftInsert accesses the setNodeName and setNodeToken methods.
friend	AftSandbox
	AftSandbox accesses the setNodeName and setNodeToken methods.
friend	AfiNodeRpc
	AfiNodeRpc accesses the setNodeName and setNodeToken methods.
AftNodeToken	_nodeToken
	Unique token value for node.
AftNodeToken	_nodeNext
	Optional value of next node.
std::string	_nodeName
	Optional name of node.
AftParameters::Ptr	_nodeParams
	Optional node parameters.
AftTypeIndex	_nodeTypeIndex
	Scalar index type for node.

Additional Inherited Members
Protected Member Functions inherited from AftNode
void	setNodeName (std::string newName)
	Set the name of the node. More...
void	setNodeToken (AftNodeToken newToken)
	Set the token value of the node. More...
void	setNodeTypeIndex (AftTypeIndex newTypeIndex)
	Set the sandbox node type index. More...

Detailed Description

Simple list class.

The basic list node allows a sequence of nodes to be listed by their token values. This allows sequential operations to be defined. In the example below, it's used to insert a counter into a flow of operations. When the list is executed, the counter will be incremented and the execution flow handed to the node referenced by the nextToken value.

Constructor & Destructor Documentation

AftList::AftList ( const AftList &  node )

inline

Copy constructor for a list.

Parameters

[in]

node

AftList node to copy

AftList::AftList ( const AftTokenVector  newListNodes )

inline

Construct a list.

Parameters

[in]

newListNodes

Vector of node tokens for list

Member Function Documentation

static AftList::Ptr AftList::create ( const AftTokenVector  newListNodes )

inlinestatic

Factory generate a list.

Parameters

[in]

newListNodes

Vector of node tokens for list

virtual std::ostream& AftList::description ( std::ostream &  os ) const

inlinevirtual

Append a description of the node to an output stream.

Parameters

[in]

os

Reference to output stream to append description to

Returns

Reference to output stream with text description of node appended

Reimplemented from AftNode.

const AftTokenVector& AftList::listNodes ( ) const

inline

Returns

Reference to list of node tokens

virtual void AftList::nextNodes ( AftTokenVector &  nextTokens )

inlinevirtual

Returns

Appends valid next tokens to token vector

Reimplemented from AftNode.

virtual const std::string AftList::nodeType ( ) const

inlinevirtual

Returns

Printable class type of node

Reimplemented from AftNode.

---

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

• AftNode.h