EpcTools
An event based multi-threaded C++ development framework.
Public Member Functions | List of all members
EPCDNS::CanonicalNodeName Class Reference

Canonical node name. More...

#include <epcdns.h>

Inheritance diagram for EPCDNS::CanonicalNodeName:

Public Member Functions

 CanonicalNodeName ()
 Default constructor. More...
 
 CanonicalNodeName (const std::string &n)
 Class constructor. More...
 
Void setName (const std::string &n)
 Assigns the canonical node name. More...
 
Bool getTopon ()
 Determines if the "topon" feature is enabled for this object. More...
 
const EString getName () const
 Retrieves the canonical node name. More...
 
int topologicalCompare (const CanonicalNodeName &right)
 Performs a topological comparison with another CanonicalNodeName object. More...
 
Void dump (const char *prefix)
 Prints the contents of this object. More...
 

Detailed Description

Canonical node name.

Constructor & Destructor Documentation

◆ CanonicalNodeName() [1/2]

CanonicalNodeName::CanonicalNodeName ( )

Default constructor.

◆ CanonicalNodeName() [2/2]

CanonicalNodeName::CanonicalNodeName ( const std::string &  n)

Class constructor.

Parameters
nthe canonical node name.

Member Function Documentation

◆ dump()

Void EPCDNS::CanonicalNodeName::dump ( const char *  prefix)
inline

Prints the contents of this object.

Parameters
prefixa value to prepend to each line.

◆ getName()

const EString EPCDNS::CanonicalNodeName::getName ( ) const
inline

Retrieves the canonical node name.

Returns
the canonical node name.

◆ getTopon()

Bool EPCDNS::CanonicalNodeName::getTopon ( )
inline

Determines if the "topon" feature is enabled for this object.

Returns
True indicates "topon" is active, otherwise False.

◆ setName()

Void CanonicalNodeName::setName ( const std::string &  n)

Assigns the canonical node name.

Parameters
nthe canonical node name.

◆ topologicalCompare()

int CanonicalNodeName::topologicalCompare ( const CanonicalNodeName right)

Performs a topological comparison with another CanonicalNodeName object.

Parameters
rightthe other canonical node name object.
Returns
the comparison score.

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