OSB_CORBA::TsPartWriter_i Class Reference

Inheritance diagram for OSB_CORBA::TsPartWriter_i:

[legend]Collaboration diagram for OSB_CORBA::TsPartWriter_i:

[legend]List of all members.

---

Detailed Description

Servant for a writable tariff system part.

This class provides write access to the OSB_LIB::TariffSystemItem of the part.

Definition at line 157 of file tspart_i.h.

Public Member Functions

• TsPartWriter_i (ProductWriter_i &prod, OSB_LIB::ProductNode &node, OSB_LIB::TariffSystemItem &tsItem)

  Constructor.
  

• ~TsPartWriter_i ()

  Destructor.
  

• virtual CORBA::Boolean addTs (const TariffSystemId &tsId) throw (CORBA::SystemException)

  Adds a tariff system to the list of available tariff systems.
  

• virtual CORBA::Boolean rmTs (const TariffSystemId &tsId) throw (CORBA::SystemException)

  Removes a tariff system from the list of available tariff systems.
  

• virtual void clear () throw (CORBA::SystemException)

  Delete all tariff systems from the list and clear the default tariff system.
  

• virtual void setDefaultTs (const TariffSystemId &tsId) throw (CORBA::SystemException)

  Sets a tariff system as the default tariff system.
  

• virtual void clearDefaultTs () throw (CORBA::SystemException)

  Clears the default tariff system.
  

Static Public Attributes

• static const std::string IFC

  String representation for TsPartWriter_i.
  

Private Member Functions

• const std::string & ifc () const

  String representation of the concrete interface.
  

• virtual OSB_LIB::ProductItem * pItem ()

  See OSB_CORBA::ProductPartWriter_i for documentation.
  

• virtual const OSB_LIB::ProductItem * pItem () const

  See OSB_CORBA::ProductPartWriter_i for documentation.
  

• virtual const OSB_LIB::TariffSystemItem * getTsItem (const ProductPartBase_i::NodeRg &guard, const std::string &ifc, const std::string &module) const throw (OsbCorbaException)

  Returns a const pointer to the tariff system item.
  

Private Attributes

• OSB_LIB::TariffSystemItem & tsItem_

  Private copy of the tariff system item.
  

---

Constructor & Destructor Documentation

OSB_CORBA::TsPartWriter_i::TsPartWriter_i	(	ProductWriter_i &	prod,
		OSB_LIB::ProductNode &	node,
		OSB_LIB::TariffSystemItem &	tsItem
	)

Constructor.

Parameters:

	prod	Used to construct the base class.
	node	Used to construct the base class.
	tsItem	Reference to the OSB library tariff system item.

The parameters prod and node are used to construct the base class ProductPartWriter_i, see there.

OSB_CORBA::TsPartWriter_i::~TsPartWriter_i

(

)

Destructor.

---

Member Function Documentation

virtual CORBA::Boolean OSB_CORBA::TsPartWriter_i::addTs

(

const TariffSystemId &

tsId

)

throw (CORBA::SystemException) [virtual]

Adds a tariff system to the list of available tariff systems.

Parameters:

tsId

Id of tariff system to add.

Returns:

True if tsId was not already in the list of tariff systems, false otherwise.

Remarks:

The method does not verify that the tariff system already exists.

virtual void OSB_CORBA::TsPartWriter_i::clear

(

)

throw (CORBA::SystemException) [virtual]

Delete all tariff systems from the list and clear the default tariff system.

virtual void OSB_CORBA::TsPartWriter_i::clearDefaultTs

(

)

throw (CORBA::SystemException) [virtual]

Clears the default tariff system.

Remarks:

The tariff system is not removed from the list.

virtual const OSB_LIB::TariffSystemItem* OSB_CORBA::TsPartWriter_i::getTsItem	(	const ProductPartBase_i::NodeRg &	guard,
		const std::string &	ifc,
		const std::string &	module
	)			const throw (OsbCorbaException) [private, virtual]

Returns a const pointer to the tariff system item.

Implements OSB_CORBA::TsPartBase_i.

const std::string& OSB_CORBA::TsPartWriter_i::ifc

(

)

const [private, virtual]

String representation of the concrete interface.

Implements OSB_CORBA::ProductPartBase_i.

virtual const OSB_LIB::ProductItem* OSB_CORBA::TsPartWriter_i::pItem

(

)

const [private, virtual]

See OSB_CORBA::ProductPartWriter_i for documentation.

Implements OSB_CORBA::ProductPartWriter_i.

virtual OSB_LIB::ProductItem* OSB_CORBA::TsPartWriter_i::pItem

(

)

[private, virtual]

See OSB_CORBA::ProductPartWriter_i for documentation.

Implements OSB_CORBA::ProductPartWriter_i.

virtual CORBA::Boolean OSB_CORBA::TsPartWriter_i::rmTs

(

const TariffSystemId &

tsId

)

throw (CORBA::SystemException) [virtual]

Removes a tariff system from the list of available tariff systems.

Parameters:

tsId

Id of tariff system to remove.

Returns:

True if tsId was in the list of tariff systems, false otherwise.

Remarks:

If the tariff system to remove is the default tariff system, the default tariff system is cleared.

virtual void OSB_CORBA::TsPartWriter_i::setDefaultTs

(

const TariffSystemId &

tsId

)

throw (CORBA::SystemException) [virtual]

Sets a tariff system as the default tariff system.

Parameters:

tsId

Id of the new default tariff system.

Remarks:

If the tsId does not exist in the list of tariff systems, it is automatically added to the list.

---

Member Data Documentation

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

String representation for TsPartWriter_i.

Definition at line 165 of file tspart_i.h.

OSB_LIB::TariffSystemItem& OSB_CORBA::TsPartWriter_i::tsItem_ [private]

Private copy of the tariff system item.

Definition at line 243 of file tspart_i.h.

---

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

• tspart_i.h

---