AftSandboxLink Class Reference

Node to allow output ports to jump to another AftSandbox. More...

#include <AftNode.h>

Inheritance diagram for AftSandboxLink:

Public Types
typedef std::shared_ptr < AftSandboxLink >	Ptr
	Pointer type for sandbox links.

Public Member Functions
	AftSandboxLink (const std::string newSandboxName, const AftIndex newSandboxPortIndex)
	Construct a variable node. More...
const std::string	sandboxName () const
const AftIndex	sandboxPortIndex () const
virtual const std::string	nodeType () const
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
virtual const bool	nodeIsValid (const AftValidatorPtr &validator, std::ostream &os)
	@ returns true if node is valid
virtual void	nextNodes (AftTokenVector &nextTokens)

Static Public Member Functions
static AftSandboxLink::Ptr	create (const std::string newSandboxName, const AftIndex newSandboxPortIndex)
	Factory generate a sandboxlink node. 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
std::string	_sandboxName
	Name of sandbox to jump to.
AftIndex	_sandboxPortIndex
	Index of port to use as input.
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

Node to allow output ports to jump to another AftSandbox.

Constructor & Destructor Documentation

AftSandboxLink::AftSandboxLink ( const std::string  newSandboxName, const AftIndex  newSandboxPortIndex  )

inline

Construct a variable node.

Parameters

[in]	newSandboxName	Name of sandbox to jump to
[in]	newSandboxPortIndex	Index of sandbox port to use as input

Member Function Documentation

static AftSandboxLink::Ptr AftSandboxLink::create ( const std::string  newSandboxName, const AftIndex  newSandboxPortIndex  )

inlinestatic

Factory generate a sandboxlink node.

Parameters

[in]	newSandboxName	Name of sandbox to jump to
[in]	newSandboxPortIndex	Index of sandbox port to use as input

virtual std::ostream& AftSandboxLink::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.

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

inlinevirtual

Returns

Printable class type of node

Reimplemented from AftNode.

const std::string AftSandboxLink::sandboxName ( ) const

inline

Returns

Name of sandbox to jump to

const AftIndex AftSandboxLink::sandboxPortIndex ( ) const

inline

Returns

Index of port to use as input

---

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

• AftNode.h