OSB_CORBA::Network_i Class Reference

Inheritance diagram for OSB_CORBA::Network_i:

[legend]Collaboration diagram for OSB_CORBA::Network_i:

[legend]List of all members.

---

Detailed Description

Class definition of the Network_i interface.

This interface provides read access to the network.

Definition at line 69 of file network_i.h.

Public Member Functions

• Network_i (NetworkManager_i &nmgri, const OSB_LIB::Network::Oid &nwId)

  Constructor.
  

• virtual ~Network_i ()

  Destructor.
  

• virtual NetworkWriter_ptr getWriter () throw (CORBA::SystemException, OsbCorbaException)

  Get a writable interface for this Network.
  

Network_i member accessors.

These methods provide readonly access to the attributes of the network interface, which Network_i implements.

• virtual NetworkId id () throw (CORBA::SystemException, OsbCorbaException)

  Accessor for getting the id of Network_i.
  

• virtual Utf8String * name () throw (CORBA::SystemException, OsbCorbaException)

  Accessor for getting the name of Network_i.
  

• virtual Utf8String * desc () throw (CORBA::SystemException, OsbCorbaException)

  Accessor for getting the description of Network_i.
  

• virtual ConnectionPtId connectionPt () throw (CORBA::SystemException, OsbCorbaException)

  Accessor for getting the connection point.
  

• virtual NwAddrInfo * addrInfo () throw (CORBA::SystemException, OsbCorbaException)

  Accessor for getting the network address information.
  

• virtual TimeZoneId tzId () throw (CORBA::SystemException, OsbCorbaException)

  Accessor for getting the time zone information.
  

Methods for NetworkElement handling.

• virtual NetworkElement_ptr getElement (const NetworkElementId &id) throw (CORBA::SystemException, OsbCorbaException)

  Get network element by id.
  

• virtual NetworkElementSeq * getElements () throw (CORBA::SystemException, OsbCorbaException)

  Get network elements belonging to this network.
  

Static Public Attributes

• static const std::string IFC

  String representation of Network_i.
  

Protected Attributes

• NetworkManager_i & nmgri_

  Reference to the network manager.
  

Private Member Functions

• virtual OSB_LIB::NetworkManager::NetworkRg lockNetwork () throw (OsbCorbaException)

  Readlocks the network and returns a network readguard.
  

Private Attributes

• const OSB_LIB::Network::Oid nwId_

  This network's oid.
  

---

Constructor & Destructor Documentation

OSB_CORBA::Network_i::Network_i	(	NetworkManager_i &	nmgri,
		const OSB_LIB::Network::Oid &	nwId
	)

Constructor.

virtual OSB_CORBA::Network_i::~Network_i

(

)

[virtual]

Destructor.

---

Member Function Documentation

virtual NwAddrInfo* OSB_CORBA::Network_i::addrInfo

(

)

throw (CORBA::SystemException, OsbCorbaException) [virtual]

Accessor for getting the network address information.

virtual ConnectionPtId OSB_CORBA::Network_i::connectionPt

(

)

throw (CORBA::SystemException, OsbCorbaException) [virtual]

Accessor for getting the connection point.

virtual Utf8String* OSB_CORBA::Network_i::desc

(

)

throw (CORBA::SystemException, OsbCorbaException) [virtual]

Accessor for getting the description of Network_i.

virtual NetworkElement_ptr OSB_CORBA::Network_i::getElement

(

const NetworkElementId &

id

)

throw (CORBA::SystemException, OsbCorbaException) [virtual]

Get network element by id.

virtual NetworkElementSeq* OSB_CORBA::Network_i::getElements

(

)

throw (CORBA::SystemException, OsbCorbaException) [virtual]

Get network elements belonging to this network.

virtual NetworkWriter_ptr OSB_CORBA::Network_i::getWriter

(

)

throw (CORBA::SystemException, OsbCorbaException) [virtual]

Get a writable interface for this Network.

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

Returns:

The reference to the NetworkWriter interface.

virtual NetworkId OSB_CORBA::Network_i::id

(

)

throw (CORBA::SystemException, OsbCorbaException) [virtual]

Accessor for getting the id of Network_i.

virtual OSB_LIB::NetworkManager::NetworkRg OSB_CORBA::Network_i::lockNetwork

(

)

throw (OsbCorbaException) [private, virtual]

Readlocks the network and returns a network readguard.

Both Network and NetworkWriter must provide their own implementation of this method.

• For Network, the network in the networkmanager is readlocked and a network readguard is returned.
• For NetworkWriter, a network readguard with a pointer to its own copy of the network is issued without any locking.

Returns:

Network readguard of the (locked) network.

Exceptions:

OsbCorbaException

in case the locking fails.

Remarks:

This method must guarantee that the network pointer in the network readguard is not null.

Reimplemented in OSB_CORBA::NetworkWriter_i.

virtual Utf8String* OSB_CORBA::Network_i::name

(

)

throw (CORBA::SystemException, OsbCorbaException) [virtual]

Accessor for getting the name of Network_i.

virtual TimeZoneId OSB_CORBA::Network_i::tzId

(

)

throw (CORBA::SystemException, OsbCorbaException) [virtual]

Accessor for getting the time zone information.

---

Member Data Documentation

const std::string OSB_CORBA::Network_i::IFC [static]

String representation of Network_i.

Reimplemented in OSB_CORBA::NetworkWriter_i.

Definition at line 74 of file network_i.h.

NetworkManager_i& OSB_CORBA::Network_i::nmgri_ [protected]

Reference to the network manager.

Definition at line 168 of file network_i.h.

const OSB_LIB::Network::Oid OSB_CORBA::Network_i::nwId_ [private]

This network's oid.

Definition at line 172 of file network_i.h.

---

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

• network_i.h

---