AftEncap Class Reference

Packet encapsulation class. More...

#include <AftNode.h>

Inheritance diagram for AftEncap:

Public Types
typedef std::shared_ptr< AftEncap >	Ptr
	Pointer type for encaps.

Public Member Functions
	AftEncap (const std::string newEncapName, const AftKeyVector newEncapKeys)
	Construct an de-encapsulation node. More...
const std::string	encapName () const
const AftKeyVector &	encapKeys () const
virtual const bool	nodeIsValid (const AftValidatorPtr &validator, std::ostream &os)
	@ returns true if node is valid
virtual void	nextNodes (AftTokenVector &nextTokens)
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

Static Public Member Functions
static AftEncap::Ptr	create (const std::string newEncapName, const AftKeyVector newEncapKeys)
	Factory generate an de-encapsulation 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...

Protected Attributes
std::string	_encapName
	Name of encapsulation template to use.
AftKeyVector	_encapKeys
	Vector of key values to use as variables for template.
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

Packet encapsulation class.

Constructor & Destructor Documentation

AftEncap::AftEncap ( const std::string  newEncapName, const AftKeyVector  newEncapKeys  )

inline

Construct an de-encapsulation node.

Parameters

[in]	newEncapName	Name of encapsulation template from encap table to use
[in]	newEncapKeys	Vector of encapsulation keys to use to fill template

Member Function Documentation

static AftEncap::Ptr AftEncap::create ( const std::string  newEncapName, const AftKeyVector  newEncapKeys  )

inlinestatic

Factory generate an de-encapsulation node.

Parameters

[in]	newEncapName	Name of encapsulation template from encap table to use
[in]	newEncapKeys	Vector of encapsulation keys to use to fill template

virtual std::ostream& AftEncap::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.

const AftKeyVector& AftEncap::encapKeys ( ) const

inline

Returns

Reference to vector of encapsulation keys to use to fill template

const std::string AftEncap::encapName ( ) const

inline

Returns

Name of encapsulation template from encap table to use

virtual void AftEncap::nextNodes ( AftTokenVector &  nextTokens )

inlinevirtual

Returns

Appends valid next tokens to token vector

Reimplemented from AftNode.

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

inlinevirtual

Returns

Printable class type of node

Reimplemented from AftNode.

---

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

• AftNode.h