corba::nwmgr::nw::Network Interface Reference

Inheritance diagram for corba::nwmgr::nw::Network:

[legend]List of all members.

---

Detailed Description

Definition of network interface.

This interface defines readonly access to network and its network elements.

Definition at line 47 of file network.idl.

Public Member Functions

• NetworkId id () raises (common::OsbCorbaException)

  Unique id of network.
  

• common::Utf8String name () raises (common::OsbCorbaException)

  Name of the network.
  

• common::Utf8String desc () raises (common::OsbCorbaException)

  Description of the network.
  

• tcat::cp::ConnectionPtId connectionPt () raises (common::OsbCorbaException)

  Assigned Connection point of the network.
  

• NwAddrInfo addrInfo () raises (common::OsbCorbaException)

  Network address information of the netowk.
  

• nwmgr::TimeZoneId tzId () raises (common::OsbCorbaException)

  Time zone information of the netowk.
  

• nwmgr::nwe::NetworkElement getElement (in nwmgr::nwe::NetworkElementId id) raises (common::OsbCorbaException)

  Gets a network element by id.
  

• nwmgr::nwe::NetworkElementSeq getElements () raises (common::OsbCorbaException)

  Gets all network elements of this network.
  

• NetworkWriter getWriter () raises (common::OsbCorbaException)

  Gets a network writer instance of this network.
  

---

Member Function Documentation

NwAddrInfo corba::nwmgr::nw::Network::addrInfo

(

)

raises (common::OsbCorbaException)

Network address information of the netowk.

tcat::cp::ConnectionPtId corba::nwmgr::nw::Network::connectionPt

(

)

raises (common::OsbCorbaException)

Assigned Connection point of the network.

common::Utf8String corba::nwmgr::nw::Network::desc

(

)

raises (common::OsbCorbaException)

Description of the network.

nwmgr::nwe::NetworkElement corba::nwmgr::nw::Network::getElement

(

in nwmgr::nwe::NetworkElementId

id

)

raises (common::OsbCorbaException)

Gets a network element by id.

Parameters:

id

The unique id of network element.

Returns:

The network element instance.

Exceptions:

OsbCorbaException

in case readlock network fails in case the network element can not be found

nwmgr::nwe::NetworkElementSeq corba::nwmgr::nw::Network::getElements

(

)

raises (common::OsbCorbaException)

Gets all network elements of this network.

Returns:

A list of network elements in this network.

Exceptions:

OsbCorbaException

in case readlock network fails

NetworkWriter corba::nwmgr::nw::Network::getWriter

(

)

raises (common::OsbCorbaException)

Gets a network writer instance of this network.

This method returns a network writer object for the corresponding netwrok. A network writer is needed whenever a network shall be modified.

Returns:

The correspoding network writer object.

Exceptions:

OsbCorbaException

in case readlock network fails

NetworkId corba::nwmgr::nw::Network::id

(

)

raises (common::OsbCorbaException)

Unique id of network.

common::Utf8String corba::nwmgr::nw::Network::name

(

)

raises (common::OsbCorbaException)

Name of the network.

nwmgr::TimeZoneId corba::nwmgr::nw::Network::tzId

(

)

raises (common::OsbCorbaException)

Time zone information of the netowk.

---

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

• network.idl

---