xorp

PimScopeZoneId Class Reference

List of all members.

Public Member Functions

 PimScopeZoneId (const IPvXNet &scope_zone_prefix, bool is_scope_zone)
 PimScopeZoneId::PimScopeZoneId: : The scope zone address prefix.
const IPvXNetscope_zone_prefix () const
bool is_scope_zone () const
bool operator== (const PimScopeZoneId &other) const
 Equality Operator.
bool is_overlap (const PimScopeZoneId &other) const
 PimScopeZoneId::is_overlap:
bool contains (const IPvXNet &ipvxnet) const
 PimScopeZoneId::contains: : The subnet address to compare whether is contained within this scope zone.
bool contains (const IPvX &ipvx) const
 PimScopeZoneId::contains: : The address to compare whether is contained within this scope zone.
string str () const
 PimScopeZoneId::str:

Private Attributes

IPvXNet _scope_zone_prefix
bool _is_scope_zone

Constructor & Destructor Documentation

PimScopeZoneId::PimScopeZoneId ( const IPvXNet scope_zone_prefix,
bool  is_scope_zone 
)

PimScopeZoneId::PimScopeZoneId: : The scope zone address prefix.

: If true, this is administratively scoped zone, otherwise this is the global zone.

PimScopeZoneId constructor.


Member Function Documentation

bool PimScopeZoneId::contains ( const IPvXNet ipvxnet) const

PimScopeZoneId::contains: : The subnet address to compare whether is contained within this scope zone.

Test whether a scope zone contains a subnet address.

Return value: true if this scope zone contains , otherwise false.

bool PimScopeZoneId::contains ( const IPvX ipvx) const

PimScopeZoneId::contains: : The address to compare whether is contained within this scope zone.

Test whether a scope zone contains an address.

Return value: true if this scope zone contains , otherwise false.

bool PimScopeZoneId::is_overlap ( const PimScopeZoneId other) const

PimScopeZoneId::is_overlap:

Tehst whether a scope zone overlaps with another zone.

Parameters:
otherthe other scope zone ID to compare against.
Returns:
true if both zones are scoped and the the scope zone prefixes for this zone and do overlap.
bool PimScopeZoneId::operator== ( const PimScopeZoneId other) const

Equality Operator.

Parameters:
otherthe right-hand operand to compare against.
Returns:
true if the left-hand operand is numerically same as the right-hand operand.
string PimScopeZoneId::str ( ) const

PimScopeZoneId::str:

Convert this scope zone ID from binary for to presentation format.

Return value: C++ string with the human-readable ASCII representation of the scope zone ID.


The documentation for this class was generated from the following files:
 All Classes Namespaces Functions Variables Typedefs Enumerations