AFI
Advanced Forwarding Interface
 All Classes Functions Variables Typedefs Enumerations Enumerator Friends Groups
Public Types | Public Member Functions | Static Public Member Functions | List of all members
AftIndirect Class Reference

Indirect reference class. More...

#include <AftNode.h>

Inheritance diagram for AftIndirect:
AftNode

Public Types

typedef std::shared_ptr
< AftIndirect
Ptr
 Pointer type for indirects.
 

Public Member Functions

 AftIndirect (const AftIndirect &node)
 Copy constructor for an indirect. More...
 
 AftIndirect (const AftNodeToken newIndirectNode)
 Construct an indirect node. More...
 
const AftNodeToken indirectNode () const
 
virtual const bool nodeIsValid (const AftValidatorPtr &validator, std::ostream &os)
 @ returns true if node is valid
 
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 void nextNodes (AftTokenVector &nextTokens)
 

Static Public Member Functions

static AftIndirect::Ptr create (const AftNodeToken newIndirectNode)
 Factory generate an indirect 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...
 

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

Indirect reference class.

Constructor & Destructor Documentation

AftIndirect::AftIndirect ( const AftIndirect node)
inline

Copy constructor for an indirect.

Parameters
[in]nodeAftIndirect to copy
AftIndirect::AftIndirect ( const AftNodeToken  newIndirectNode)
inline

Construct an indirect node.

Parameters
[in]newIndirectNodeToken value of next node

Member Function Documentation

static AftIndirect::Ptr AftIndirect::create ( const AftNodeToken  newIndirectNode)
inlinestatic

Factory generate an indirect node.

Parameters
[in]newIndirectNodeToken value of next node
virtual std::ostream& AftIndirect::description ( std::ostream &  os) const
inlinevirtual

Append a description of the node to an output stream.

Parameters
[in]osReference to output stream to append description to
Returns
Reference to output stream with text description of node appended

Reimplemented from AftNode.

const AftNodeToken AftIndirect::indirectNode ( ) const
inline
Returns
Token value of next node
virtual const std::string AftIndirect::nodeType ( ) const
inlinevirtual
Returns
Printable class type of node

Reimplemented from AftNode.


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