OSB_LIB::TrunkGroup Class Reference

Collaboration diagram for OSB_LIB::TrunkGroup:

[legend]List of all members.

---

Detailed Description

Information about a trunk group.

Definition at line 149 of file network.h.

Direction.

• enum Direction { dirUnknown = '\0', dirIn = 'i', dirOut = 'o' }

  The direction of the trunk group. More...
  

• static char toChar (Direction dir)

  Convert a direction into a char.
  

• static Direction direction (char c)

  Convert a char to direction.
  

LinkType.

• enum LinkType { lkUnknown = '\0', lkExternal = 'e', lkInternal = 'i', lkTerminal = 't' }

  Link type of the trunk group. More...
  

• static char toChar (LinkType lt)

  Convert a link type into a char.
  

• static LinkType linkType (char c)

  Convert a char to link type.
  

Public Types

• typedef Id< TrunkGroup > Oid

  Unique object identifier, database link.
  

• dirUnknown = '\0'

  Unknown, illegal setting.
  

• dirIn = 'i'

  Incoming trunk group.
  

• dirOut = 'o'

  Outgoing trunk group.
  

• lkUnknown = '\0'

  Unknown, illegal setting.
  

• lkExternal = 'e'

  Trunk group points to an external network.
  

• lkInternal = 'i'

  Trunk group points to an internal network element.
  

• lkTerminal = 't'

  Trunk group points to an enduser terminal.
  

Public Member Functions

• TrunkGroup ()

  Default constructor.
  

• TrunkGroup (const Oid &oid, const Id2< NetworkElement > &elementId)

  Constructor with object id and network element id.
  

• TrunkGroup (const TrunkGroup &rhs)

  Copy constructor: clones the number analyser.
  

• TrunkGroup & operator= (const TrunkGroup &rhs)

  Assignment operator: clones the number analyser.
  

• ~TrunkGroup ()

  Destructor will delete the number analyzer assigned.
  

• bool read (const OSB_DB::Session &session)

  Read a trunk group from the database.
  

Read access to data members.

• const Oid & oid () const

  Object id.
  

• const Id2< NetworkElement > & networkElementId () const

  Id of the group's network element.
  

• Id< Network > networkId () const

  Get id of the network it belongs to.
  

• const std::string & name () const

  Name of the trunk group.
  

• Direction direction () const

  Direction of the trunk group.
  

• LinkType linkType () const

  LinkType of the trunk group.
  

• const Id2< NetworkElement > & extNetworkElementId () const

  Id of the external network.
  

• long objVs () const

  Object version of the trunk group.
  

• const NumberAnalyzer * numberAnalyzer () const

  Get the number analyzer assigned.
  

Modify data members

• void setName (const std::string &name)

  Set name of trunk group.
  

• void setDirection (Direction dir)

  Set direction of trunk group.
  

• void setLinkType (LinkType lType)

  Set link type of trunk group.
  

• void setExtNetworkElementId (const Id2< NetworkElement > &eNetElementId)

  Set external network and element id(optional) of trunk group.
  

• void setNumAnalyzer (NumberAnalyzer *numAnalyzer)

  Set the number analyzer applicable to this trunk group.
  

• void delNumAnalyzer ()

  Remove the number analyzer attached to this trunk group.
  

Private Member Functions

• void checkExternal ()

  Check the external network and element.
  

Database operations

• bool insert (const OSB_DB::Session &session)

  Insert a trunk group.
  

• bool update (const OSB_DB::Session &session)

  Update a trunk group to the database.
  

• bool remove (const OSB_DB::Session &session)

  Delete a trunk group.
  

Private Attributes

• Oid oid_

  Object id.
  

• Id2< NetworkElement > networkElementId_

  Id of the network element the trunk belongs to.
  

• long objVs_

  Object version.
  

• std::string name_

  Name of the trunk group.
  

• Direction direction_

  Direction of the trunk group.
  

• LinkType linkType_

  Link type of the trunk group.
  

• Id2< NetworkElement > extNetworkElementId_

  Id of the external network(mandatory) and element(optional).
  

• NumberAnalyzer * numAnalyzer_

  Pointer to a number analyzer object.
  

Friends

• class OSB_DB::TrunkGroupGw

  Allow NetworkGw to access private attributes.
  

• class NetworkElement

  Allow NetworkElement to access insert and delete.
  

---

Member Typedef Documentation

typedef Id<TrunkGroup> OSB_LIB::TrunkGroup::Oid

Unique object identifier, database link.

Each trunk group has a unique identifier. It does not contain the object id of the network element of the trunk group.

Definition at line 162 of file network.h.

---

Member Enumeration Documentation

enum OSB_LIB::TrunkGroup::Direction

The direction of the trunk group.

Direction does not describe the LinkType of the trunk group.

Enumerator:

dirUnknown	Unknown, illegal setting.
dirIn	Incoming trunk group.
dirOut	Outgoing trunk group.

Definition at line 171 of file network.h.

enum OSB_LIB::TrunkGroup::LinkType

Link type of the trunk group.

LinkType defines as to what kind of entity the trunk group is linked.

Enumerator:

lkUnknown	Unknown, illegal setting.
lkExternal	Trunk group points to an external network.
lkInternal	Trunk group points to an internal network element.
lkTerminal	Trunk group points to an enduser terminal.

Definition at line 202 of file network.h.

---

Constructor & Destructor Documentation

OSB_LIB::TrunkGroup::TrunkGroup

(

)

Default constructor.

OSB_LIB::TrunkGroup::TrunkGroup	(	const Oid &	oid,
		const Id2< NetworkElement > &	elementId
	)

Constructor with object id and network element id.

OSB_LIB::TrunkGroup::TrunkGroup

(

const TrunkGroup &

rhs

)

Copy constructor: clones the number analyser.

OSB_LIB::TrunkGroup::~TrunkGroup

(

)

Destructor will delete the number analyzer assigned.

---

Member Function Documentation

void OSB_LIB::TrunkGroup::checkExternal

(

)

[private]

Check the external network and element.

Check that the external network and element are not the same network and element this trunk group belongs to.

Exceptions:

OsbException

if they are the same.

void OSB_LIB::TrunkGroup::delNumAnalyzer

(

)

Remove the number analyzer attached to this trunk group.

Direction OSB_LIB::TrunkGroup::direction

(

)

const

Direction of the trunk group.

static Direction OSB_LIB::TrunkGroup::direction

(

char

c

)

[static]

Convert a char to direction.

Parameters:

c

Value to convert.

Returns:

The corresponding direction. Its value is dirUnknown if `c' is not supported.

const Id2<NetworkElement>& OSB_LIB::TrunkGroup::extNetworkElementId

(

)

const

Id of the external network.

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

ToDo: better descripiton.

bool OSB_LIB::TrunkGroup::insert

(

const OSB_DB::Session &

session

)

[private]

Insert a trunk group.

Add a trunk group entry to the database. The object id and object version of trunk group will be set if the insertion is successful.

Parameters:

session

Database session to use.

Returns:

True if it is successful.

Exceptions:

OsbException

if the external network and element are the same network and element this trunk group belongs to as specified by the gateway class (see there).

LinkType OSB_LIB::TrunkGroup::linkType

(

)

const

LinkType of the trunk group.

static LinkType OSB_LIB::TrunkGroup::linkType

(

char

c

)

[static]

Convert a char to link type.

Parameters:

c

Value to convert.

Returns:

The corresponding link type. Its value is lkUnknown if `c' is not supported.

const std::string& OSB_LIB::TrunkGroup::name

(

)

const

Name of the trunk group.

This is the name of the trunk group as configured in the network element and written to the generated usage records.

const Id2<NetworkElement>& OSB_LIB::TrunkGroup::networkElementId

(

)

const

Id of the group's network element.

Id<Network> OSB_LIB::TrunkGroup::networkId

(

)

const

Get id of the network it belongs to.

const NumberAnalyzer* OSB_LIB::TrunkGroup::numberAnalyzer

(

)

const

Get the number analyzer assigned.

long OSB_LIB::TrunkGroup::objVs

(

)

const

Object version of the trunk group.

const Oid& OSB_LIB::TrunkGroup::oid

(

)

const

Object id.

TrunkGroup& OSB_LIB::TrunkGroup::operator=

(

const TrunkGroup &

rhs

)

Assignment operator: clones the number analyser.

bool OSB_LIB::TrunkGroup::read

(

const OSB_DB::Session &

session

)

Read a trunk group from the database.

The function reads and sets the data members of the class.

Parameters:

session

Database session to use.

Returns:

True if the trunk group was read from the database.

Exceptions:

OsbException

as specified by the gateway class (see there).

bool OSB_LIB::TrunkGroup::remove

(

const OSB_DB::Session &

session

)

[private]

Delete a trunk group.

Delete a trunk group entry from the database.
Object id will be unset.

Parameters:

session

Database session to use.

Returns:

True if it is successful.

Exceptions:

OsbException

as specified by the gateway class (see there).

void OSB_LIB::TrunkGroup::setDirection

(

Direction

dir

)

Set direction of trunk group.

void OSB_LIB::TrunkGroup::setExtNetworkElementId

(

const Id2< NetworkElement > &

eNetElementId

)

Set external network and element id(optional) of trunk group.

void OSB_LIB::TrunkGroup::setLinkType

(

LinkType

lType

)

Set link type of trunk group.

void OSB_LIB::TrunkGroup::setName

(

const std::string &

name

)

Set name of trunk group.

void OSB_LIB::TrunkGroup::setNumAnalyzer

(

NumberAnalyzer *

numAnalyzer

)

Set the number analyzer applicable to this trunk group.

Parameters:

numAnalyzer

The number analyzer object to be assigned.

static char OSB_LIB::TrunkGroup::toChar

(

LinkType

lt

)

[static]

Convert a link type into a char.

Parameters:

lt

LinkType to convert.

Returns:

The corresponsing char value. Its value is (char)lkUnknown if `lt' is not supported.

static char OSB_LIB::TrunkGroup::toChar

(

Direction

dir

)

[static]

Convert a direction into a char.

Parameters:

dir

Direction to convert.

Returns:

The corresponsing char value. Its value is (char)dirUnknown if `dir' is not supported.

bool OSB_LIB::TrunkGroup::update

(

const OSB_DB::Session &

session

)

[private]

Update a trunk group to the database.

This function will also update the data member objVs.

Parameters:

session

Database session to use.

Returns:

True if the trunk group was updated to the database.

Exceptions:

OsbException

if the external network and element are the same network and element this trunk group belongs to as specified by the gateway class (see there).

---

Friends And Related Function Documentation

friend class NetworkElement [friend]

Allow NetworkElement to access insert and delete.

Definition at line 153 of file network.h.

friend class OSB_DB::TrunkGroupGw [friend]

Allow NetworkGw to access private attributes.

Definition at line 151 of file network.h.

---

Member Data Documentation

Direction OSB_LIB::TrunkGroup::direction_ [private]

Direction of the trunk group.

Definition at line 385 of file network.h.

Id2<NetworkElement> OSB_LIB::TrunkGroup::extNetworkElementId_ [private]

Id of the external network(mandatory) and element(optional).

Definition at line 389 of file network.h.

LinkType OSB_LIB::TrunkGroup::linkType_ [private]

Link type of the trunk group.

Definition at line 387 of file network.h.

std::string OSB_LIB::TrunkGroup::name_ [private]

Name of the trunk group.

Definition at line 383 of file network.h.

Id2<NetworkElement> OSB_LIB::TrunkGroup::networkElementId_ [private]

Id of the network element the trunk belongs to.

Definition at line 379 of file network.h.

NumberAnalyzer* OSB_LIB::TrunkGroup::numAnalyzer_ [private]

Pointer to a number analyzer object.

Definition at line 391 of file network.h.

long OSB_LIB::TrunkGroup::objVs_ [private]

Object version.

Definition at line 381 of file network.h.

Oid OSB_LIB::TrunkGroup::oid_ [private]

Object id.

Definition at line 377 of file network.h.

---

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

• network.h

---