AftPort Class Reference

Base class for all port classes in Aft. More...

#include <AftNode.h>

Inheritance diagram for AftPort:

Public Member Functions
	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 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)

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

Additional Inherited Members
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 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

Base class for all port classes in Aft.

Constructor & Destructor Documentation

AftPort::AftPort ( const AftPort &  node )

inline

Copy constructor for a port.

Parameters

[in]

node

Port node to copy

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

inline

Construct a port.

Parameters

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

Member Function Documentation

virtual std::ostream& AftPort::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 AftPort::nodeType ( ) const

inlinevirtual

Returns

Printable class type of node

Reimplemented from AftNode.

Reimplemented in AftOutputPort, and AftInputPort.

const AftIndex AftPort::portIndex ( ) const

inline

Returns

Index of port in port table

const AftNodeToken AftPort::portNext ( ) const

inline

Returns

Token of next node for port

const std::string AftPort::portType ( ) const

inline

Returns

String description of the port type

---

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

• AftNode.h