Basic input port class. More...

#include <AftNode.h>

Inheritance diagram for AftInputPort:

Public Types
typedef std::shared_ptr < AftInputPort >	Ptr
	Pointer type for input ports.

Public Member Functions
	AftInputPort (const AftInputPort &node)
	Copy constructor for an input port. More...

	AftInputPort (const std::string newPortType, const AftIndex newPortIndex, const AftNodeToken newPortNext)
	Construct an input port. More...

virtual const bool	nodeIsValid (const AftValidatorPtr &validator, std::ostream &os)
	@ returns true if node is valid

virtual const std::string	nodeType () const

Public Member Functions inherited from AftPort
	AftPort (const AftPort &node)
	Copy constructor for a port. More...

	AftPort (const std::string newPortType, const AftIndex newPortIndex, const AftNodeToken newPortNext)
	Construct a port. More...

const std::string	portType () const

const AftIndex	portIndex () const

const AftNodeToken	portNext () 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 void	nextNodes (AftTokenVector &nextTokens)

Static Public Member Functions
static AftInputPort::Ptr	create (const AftInputPort &newPort)
	Factory generate an input port. More...

static AftInputPort::Ptr	create (const std::string newPortType, const AftIndex newPortIndex, const AftNodeToken newPortNext)
	Factory generate an input port. 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...

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...

Protected Attributes inherited from AftPort
std::string	_portType
	Type of the port.

AftIndex	_portIndex
	Index of the port.

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.

Detailed Description

Basic input port class.

Constructor & Destructor Documentation

AftInputPort::AftInputPort ( const AftInputPort & node )

inline

Copy constructor for an input port.

Parameters

[in] node Input port node to copy

AftInputPort::AftInputPort	(	const std::string	newPortType,
		const AftIndex	newPortIndex,
		const AftNodeToken	newPortNext
	)

inline

Construct an input port.

Parameters

[in]	newPortType	Type of input port (e.g. "Host")
[in]	newPortIndex	Index of input port
[in]	newPortNext	Token of next node for input port

Member Function Documentation

static AftInputPort::Ptr AftInputPort::create ( const AftInputPort & newPort )

inlinestatic

Factory generate an input port.

Parameters

[in] newPort Reference to port object to copy

static AftInputPort::Ptr AftInputPort::create	(	const std::string	newPortType,
		const AftIndex	newPortIndex,
		const AftNodeToken	newPortNext
	)

inlinestatic

Factory generate an input port.

Parameters

[in]	newPortType	Type of input port (e.g. "Host")
[in]	newPortIndex	Index of input port
[in]	newPortNext	Token of next node for input port

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

inlinevirtual

Returns: Printable class type of node

Reimplemented from AftPort.

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

AftNode.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation