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
AftFilterTerm Class Reference

Base entry for all Aft filter terms. More...

#include <AftFilter.h>

Inheritance diagram for AftFilterTerm:
AftEntry

Public Types

typedef std::shared_ptr
< AftFilterTerm
Ptr
 

Public Member Functions

 AftFilterTerm (const AftNodeToken newTermFilter, const std::string newTermName, const uint32_t newFilterIndex, const AftDataPrefix::Ptr newTermTLV)
 
const AftNodeToken termFilter () const
 
const std::string termName () const
 
const uint32_t filterIndex () const
 
const AftDataPrefix::Ptr termTLV () const
 
virtual const std::string entryType () const
 
- Public Member Functions inherited from AftEntry
 AftEntry (const AftNodeToken newParentNode, const AftKey newKey, const AftNodeToken newEntryNode)
 Construct an entry for a container node. More...
 
 _entryNode (newEntryNode)
 
 AftEntry (const AftNodeToken newParentNode, const AftKeyVector newKeys, const AftNodeToken newEntryNode)
 Construct an entry for a container node. More...
 
 AftEntry (const AftNodeToken newParentNode, const AftIndex newEntryIndex, const AftNodeToken newEntryNode)
 Construct an indexed entry. More...
 
const AftNodeToken parentNode () const
 
const AftKeyVectorentryKeys () const
 
const AftNodeToken entryNode () const
 
void setEntryParameters (const AftParameters::Ptr &newParams)
 Set the optional parameters of the entry. More...
 
const AftParameters::Ptr entryParameters () const
 
template<class T >
std::shared_ptr< T > entryParameter (const std::string &name)
 Convenience parameter access template. Use this to access entry parameters. More...
 
void setEntryParameter (const std::string &name, const AftDataPtr &data)
 Convenience parameter setter. Use this to set entry parameters. More...
 
virtual const bool entryIsDelete () const
 @ returns true if entry is a delete
 
virtual const bool entryIsValid (const AftValidatorPtr &validator, std::ostream &os)
 @ returns true if entry is valid
 
virtual void nextNodes (AftTokenVector &nextTokens)
 
virtual std::ostream & description (std::ostream &os) const
 Append a description of the entry to an output stream. More...
 

Static Public Member Functions

static AftFilterTerm::Ptr create (const AftNodeToken newTermFilter, const std::string newTermName, const uint32_t newFilterIndex, const AftDataPrefix::Ptr newTermTLV)
 Factory constructor for AftFilterTerm.
 
- Static Public Member Functions inherited from AftEntry
static AftEntryPtr create (const AftNodeToken newParentNode, const AftKeyVector newKeys, const AftNodeToken newEntryNode)
 Factory generator for an entry for a container node. More...
 
static AftEntryPtr create (const AftNodeToken newParentNode, const AftKey newKey, const AftNodeToken newEntryNode)
 Factory generator for an entry for a container node. More...
 
static AftEntryPtr create (const AftNodeToken newParentNode, const AftIndex newEntryIndex, const AftNodeToken newEntryNode)
 Factory generator for an indexed entry. More...
 

Protected Attributes

AftNodeToken _termFilter
 Token of parent filter.
 
std::string _termName
 Name of filter term.
 
uint32_t _filterIndex
 Index of filter term.
 
AftDataPrefix::Ptr _termTLV
 TLV data for filter term.
 
- Protected Attributes inherited from AftEntry
AftNodeToken _parentNode
 Node token of the container for the entry.
 
AftKeyVector _entryKeys
 Unique key values for the entry.
 
AftNodeToken _entryNode
 Token for the first node to execute on a match.
 
AftParameters::Ptr _entryParams
 Optional parameters for the entry.
 

Detailed Description

Base entry for all Aft filter terms.

Member Function Documentation

virtual const std::string AftFilterTerm::entryType ( ) const
inlinevirtual
Returns
entry type for AftFilterTerm

Reimplemented from AftEntry.


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