OspfArea Class Reference

OspfArea handles and manipulates OSPF areas. More...

Public Member Functions
ip	getAreaId ()
	Returns the OSPF area ID. More...
void	setAuthentication (OspfAuthType)
	Sets the OSPF authentication type. More...
OspfAuthType	getAuthentication ()
	Returns the OSPF authentication type. More...
int	getConfiguredPortCount ()
	Returns the number of configured ports. More...
int	getConfiguredNetworkCount ()
	Returns the number of configured networks. More...
pair< ip, ip >	getConfiguredNetworkAt (int)
	Returns the network address and subnet mask at the specified index. More...
OspfNeighborTable	getNeighborTable (string)
	Returns the OSPF neighbor table of the specifed port. More...
OspfDatabase	getDatabase ()
	Return the OSPF database. More...
int	getFloodLength (string)
	Returns the flood length of the specified port. More...
int	getLastFloodLength (string)
	Returns the last flood length of the specified port. More...
int	getLastFloodTime (string)
	Returns the last flood time of the specified port. More...
int	getMaxFloodLength (string)
	Returns the maximum flood length of the specified port. More...
int	getMaxFloodTime (string)
	Returns the maximum flood time of the specified port. More...
int	getSpfCount ()
	Returns the number of shortest paths. More...

Detailed Description

OspfArea handles and manipulates OSPF areas.

Member Function Documentation

getAreaId()

ip OspfArea::getAreaId

(

)

Returns the OSPF area ID.

Parameters

ip,the

OSPF area ID.

getAuthentication()

OspfAuthType OspfArea::getAuthentication

(

)

Returns the OSPF authentication type.

Returns

enum<OspfAuthType>, the OSPF authentication type. Authentication types: eNoAuth = 0, eAuth = 1, eMD5Auth = 2

getConfiguredNetworkAt()

pair< ip, ip > OspfArea::getConfiguredNetworkAt

(

int

)

Returns the network address and subnet mask at the specified index.

Parameters

index,the

index of the network address and subnet mask of interest.

Returns

pair<ip, ip>, the network address and subnet mask at the specified index.

getConfiguredNetworkCount()

int OspfArea::getConfiguredNetworkCount

(

)

Returns the number of configured networks.

Returns

int, the number of configured networks.

getConfiguredPortCount()

int OspfArea::getConfiguredPortCount

(

)

Returns the number of configured ports.

Returns

int, the number of configured ports.

getDatabase()

OspfDatabase OspfArea::getDatabase

(

)

Return the OSPF database.

Returns

OspfDatabase, the OspfDatabase object.

getFloodLength()

int OspfArea::getFloodLength

(

string

)

Returns the flood length of the specified port.

Parameters

portName

portName can be one of the following plus a port number where appropriate: Console, Aux, Ethernet, FastEthernet, GigabitEthernet, Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async. Example: FastEthernet0/0

Returns

int, the flood length of the specified port.

getLastFloodLength()

int OspfArea::getLastFloodLength

(

string

)

Returns the last flood length of the specified port.

Parameters

portName

portName can be one of the following plus a port number where appropriate: Console, Aux, Ethernet, FastEthernet, GigabitEthernet, Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async. Example: FastEthernet0/0

Returns

int, the last flood length of the specified port.

getLastFloodTime()

int OspfArea::getLastFloodTime

(

string

)

Returns the last flood time of the specified port.

Parameters

portName

portName can be one of the following plus a port number where appropriate: Console, Aux, Ethernet, FastEthernet, GigabitEthernet, Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async. Example: FastEthernet0/0

Returns

int, the last flood time of the specified port.

getMaxFloodLength()

int OspfArea::getMaxFloodLength

(

string

)

Returns the maximum flood length of the specified port.

Parameters

portName

portName can be one of the following plus a port number where appropriate: Console, Aux, Ethernet, FastEthernet, GigabitEthernet, Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async. Example: FastEthernet0/0

Returns

int, the maximum flood length of the specified port.

getMaxFloodTime()

int OspfArea::getMaxFloodTime

(

string

)

Returns the maximum flood time of the specified port.

Parameters

portName

portName can be one of the following plus a port number where appropriate: Console, Aux, Ethernet, FastEthernet, GigabitEthernet, Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async. Example: FastEthernet0/0

Returns

int, the maximum flood time of the specified port.

getNeighborTable()

OspfNeighborTable OspfArea::getNeighborTable

(

string

)

Returns the OSPF neighbor table of the specifed port.

Parameters

portName,portName

can be one of the following plus a port number where appropriate: Console, Aux, Ethernet, FastEthernet, GigabitEthernet, Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async. Example: FastEthernet0/0

Returns

OspfNeighborTable, the OspfNeighborTable object of the specifed port.

getSpfCount()

int OspfArea::getSpfCount

(

)

Returns the number of shortest paths.

Returns

int, the number of shortest paths.

setAuthentication()

void OspfArea::setAuthentication

(

OspfAuthType

)

Sets the OSPF authentication type.

Parameters

type,the

OSPF authentication type. Authentication types: eNoAuth = 0, eAuth = 1, eMD5Auth = 2

---

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

• COspfArea.pki