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

Individual entry in the port table. More...

#include <AftPortTable.h>

Public Member Functions

 AftPortEntry (const std::string newName, const std::string newPortType, const AftIndex newPortIndex, const AftNodeToken newPortNext, const AftNodeToken newNodeToken)
 Constructor for token entries. More...
 
const std::string portName () const
 
const std::string portType () const
 
const AftIndex portIndex () const
 
const AftNodeToken portNext () const
 
void setPortNext (AftNodeToken newPortNext)
 
const AftNodeToken nodeToken () const
 
void setNodeToken (AftNodeToken newNodeToken)
 

Static Public Member Functions

static std::shared_ptr
< AftPortEntry
create (const std::string newName, const std::string newPortType, const AftIndex newPortIndex, const AftNodeToken newPortNext, const AftNodeToken newNodeToken)
 Factory constructor for port entries. More...
 

Protected Attributes

const std::string _portName
 Name of port.
 
const std::string _portType
 Type of port as a string.
 
const AftIndex _portIndex
 Index of port in port table.
 
AftNodeToken _portNext
 Token of next node from port.
 
AftNodeToken _nodeToken
 Token of port itself.
 

Detailed Description

Individual entry in the port table.

Constructor & Destructor Documentation

AftPortEntry::AftPortEntry ( const std::string  newName,
const std::string  newPortType,
const AftIndex  newPortIndex,
const AftNodeToken  newPortNext,
const AftNodeToken  newNodeToken 
)
inline

Constructor for token entries.

Factory constructor for port entries

param [in] newName Name of port param [in] newPortType Type of port as a string param [in] NewPortIndex Index of port in port table param [in] newPortNext Token of next node from port param [in] newNodeToken Token of port itself

Member Function Documentation

static std::shared_ptr<AftPortEntry> AftPortEntry::create ( const std::string  newName,
const std::string  newPortType,
const AftIndex  newPortIndex,
const AftNodeToken  newPortNext,
const AftNodeToken  newNodeToken 
)
inlinestatic

Factory constructor for port entries.

param [in] newName Name of port param [in] newPortType Type of port as a string param [in] NewPortIndex Index of port in port table param [in] newPortNext Token of next node from port param [in] newNodeToken Token of port itself

const AftNodeToken AftPortEntry::nodeToken ( ) const
inline
Returns
Token of port node
const AftIndex AftPortEntry::portIndex ( ) const
inline
Returns
Index of port
const std::string AftPortEntry::portName ( ) const
inline
Returns
Name of port
const AftNodeToken AftPortEntry::portNext ( ) const
inline
Returns
Next token of port
const std::string AftPortEntry::portType ( ) const
inline
Returns
Type of port
void AftPortEntry::setNodeToken ( AftNodeToken  newNodeToken)
inline
Parameters
[in]newNodeTokenSet the node token of the port
void AftPortEntry::setPortNext ( AftNodeToken  newPortNext)
inline
Parameters
[in]newPortNextSet the node token of the port

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