OSB_CORBA::TrunkGroup_i Class Reference

Inheritance diagram for OSB_CORBA::TrunkGroup_i:

[legend]Collaboration diagram for OSB_CORBA::TrunkGroup_i:

[legend]List of all members.

Detailed Description

Definition of the TrunkGroup_i interface.

This interface provides read access to the trunk group.

Definition at line 66 of file trunkgroup_i.h.

Public Member Functions

TrunkGroup_i (NetworkManager_i &nmgri, const OSB_LIB::NetworkElement::Oid &nweId, const OSB_LIB::TrunkGroup::Oid &trkId)
Constructor.
virtual ~TrunkGroup_i ()
Destructor.
virtual TrunkGroupWriter_ptr getWriter () throw (CORBA::SystemException, OsbCorbaException)
Get a writable interface for this TrunkGroup.

TrunkGroup_i member accessors.

These methods provide readonly access to the attributes of the trunk group interface, which TrunkGroup_i implements.

virtual TrunkGroupId id () throw (CORBA::SystemException, OsbCorbaException)
Id of the trunk group.
virtual NetworkElementId elementId () throw (CORBA::SystemException, OsbCorbaException)
Id of the network element the trunk group belongs to.
virtual Utf8String * name () throw (CORBA::SystemException, OsbCorbaException)
Name of the trunk group.
virtual corba::nwmgr::trk::Direction dir () throw (CORBA::SystemException, OsbCorbaException)
Direction of the trunk group.
virtual LinkType lkType () throw (CORBA::SystemException, OsbCorbaException)
LinkType of the trunk group.
virtual NetworkElementId extElementId () throw (CORBA::SystemException, OsbCorbaException)
Id of the external network.
virtual NumberAnalyzer_ptr getNumberAnalyzer () throw (CORBA::SystemException, OsbCorbaException)
Retrieve number analyzer of trunk group.

Static Public Attributes

static const std::string IFC
String representation for TrunkGroup_i.

Protected Member Functions

virtual OSB_LIB::NetworkManager::NetworkRg lockNetwork () throw (OsbCorbaException)
Readlocks the network this TrunkGroup belonging to.
virtual const OSB_LIB::TrunkGroup * getTrkGroup (const OSB_LIB::NetworkManager::NetworkRg &guard) const throw (OsbCorbaException)
Get a trunk group pointer.

Protected Attributes

NetworkManager_i & nmgri_
Reference to the network manager.

Private Attributes

const OSB_LIB::NetworkElement::Oid nweId_
The network element's oid.
const OSB_LIB::TrunkGroup::Oid trkId_
This trunk group's oid.

Constructor & Destructor Documentation

OSB_CORBA::TrunkGroup_i::TrunkGroup_i	(	NetworkManager_i &	nmgri,
		const OSB_LIB::NetworkElement::Oid &	nweId,
		const OSB_LIB::TrunkGroup::Oid &	trkId
	)

Constructor.

virtual OSB_CORBA::TrunkGroup_i::~TrunkGroup_i ( ) [virtual]

Destructor.

Member Function Documentation

virtual corba::nwmgr::trk::Direction OSB_CORBA::TrunkGroup_i::dir ( ) throw (CORBA::SystemException, OsbCorbaException) [virtual]

Direction of the trunk group.

virtual NetworkElementId OSB_CORBA::TrunkGroup_i::elementId ( ) throw (CORBA::SystemException, OsbCorbaException) [virtual]

Id of the network element the trunk group belongs to.

virtual NetworkElementId OSB_CORBA::TrunkGroup_i::extElementId ( ) throw (CORBA::SystemException, OsbCorbaException) [virtual]

Id of the external network.

This member is meaningful only if the LinkType is lkExternal, else it is not set. In the meaningful case, the network id of it is mandatory, element id is optional(may zero).

virtual NumberAnalyzer_ptr OSB_CORBA::TrunkGroup_i::getNumberAnalyzer ( ) throw (CORBA::SystemException, OsbCorbaException) [virtual]

Retrieve number analyzer of trunk group.

virtual const OSB_LIB::TrunkGroup* OSB_CORBA::TrunkGroup_i::getTrkGroup ( const OSB_LIB::NetworkManager::NetworkRg & guard ) const throw (OsbCorbaException) [protected, virtual]

Get a trunk group pointer.

Both TrunkGroup and TrunkGroupWriter must provide their own implementation of this method.

For TrunkGroup, the trunk group is searched from the network element by id, and the pointer is returned if found.
For TrunkGroupWriter, the pointer of local copy trunk group is returned.

Returns:: TrunkGroup pointer.

Exceptions:

OsbCorbaException

in case the trunk group can not be found from network element.

Reimplemented in OSB_CORBA::TrunkGroupWriter_i.

virtual TrunkGroupWriter_ptr OSB_CORBA::TrunkGroup_i::getWriter ( ) throw (CORBA::SystemException, OsbCorbaException) [virtual]

Get a writable interface for this TrunkGroup.

This method returns a reference to TrunkGroupWriter interface that belongs to the trunk group. Every CORBA client that wants to modify a trunk group must first call this method.

Returns:: The reference to the TrunkGroupWriter interface.

virtual TrunkGroupId OSB_CORBA::TrunkGroup_i::id ( ) throw (CORBA::SystemException, OsbCorbaException) [virtual]

Id of the trunk group.

virtual LinkType OSB_CORBA::TrunkGroup_i::lkType ( ) throw (CORBA::SystemException, OsbCorbaException) [virtual]

LinkType of the trunk group.

virtual OSB_LIB::NetworkManager::NetworkRg OSB_CORBA::TrunkGroup_i::lockNetwork ( ) throw (OsbCorbaException) [protected, virtual]

Readlocks the network this TrunkGroup belonging to.

Both TrunkGroup and TrunkGroupWriter must provide their own implementation of this method.

For TrunkGroup, the network this trunk group belonging to is readlocked and a readguard is returned.
For TrunkGroupWriter, a empty readguard is created with a netwrok pointer of null.