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

Base node for all Aft filter instances. More...

#include <AftFilter.h>

Inheritance diagram for AftFilter:
AftNode

Public Types

typedef std::shared_ptr
< AftFilter
Ptr
 

Public Member Functions

 AftFilter (const AftNodeToken newFilterTemplate, const AftNodeToken newFilterAccept, const AftNodeToken newFilterReject, const AftNodeToken newFilterDiscard)
 
const AftNodeToken filterTemplate () const
 
const AftNodeToken filterAccept () const
 
const AftNodeToken filterReject () const
 
const AftNodeToken filterDiscard () const
 
virtual const std::string nodeType () const
 
virtual void nextNodes (AftTokenVector &nextTokens)
 
- 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 std::ostream & description (std::ostream &os) const
 Append a description of the node to an output stream. More...
 

Static Public Member Functions

static AftFilter::Ptr create (const AftNodeToken newFilterTemplate, const AftNodeToken newFilterAccept, const AftNodeToken newFilterReject, const AftNodeToken newFilterDiscard)
 Factory constructor for AftFilter.
 
- 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

AftNodeToken _filterTemplate
 Token of filter template.
 
AftNodeToken _filterAccept
 Token of filter accept.
 
AftNodeToken _filterReject
 Token of filter reject.
 
AftNodeToken _filterDiscard
 Token of filter discard.
 
- 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

Base node for all Aft filter instances.

Member Function Documentation

virtual void AftFilter::nextNodes ( AftTokenVector nextTokens)
inlinevirtual
Returns
Appends valid next tokens to token vector

Reimplemented from AftNode.

virtual const std::string AftFilter::nodeType ( ) const
inlinevirtual
Returns
node type for AftFilter

Reimplemented from AftNode.


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