OSB_LIB::IpGroupItem Class Reference

Inheritance diagram for OSB_LIB::IpGroupItem:

[legend]Collaboration diagram for OSB_LIB::IpGroupItem:

[legend]List of all members.

---

Detailed Description

Product item for IP group resources.

Definition at line 511 of file ipaddress.h.

Public Types

• typedef std::auto_ptr< IpGroupItem > AutoPtr

  Short-cut for an auto pointer.
  

Public Member Functions

• IpGroupItem (const Oid &oid, const std::string &name="", const std::string &des="")

  Constructor with object id, name and description.
  

• Type type () const

  The type of the product item.
  

• AutoPtr clone () const

  Virtual copy construction.
  

• ProductItem::CfgType canConfigure () const

  Configuration type.
  

• ProductItem::DefPersType canDefPers () const

  Default personalization type.
  

• CfgPersType canPersonalize () const

  The personalization type of PersIpGroup.
  

• const PersProductItem * defPersItem () const

  Pointer to the default personalized IP group.
  

• std::auto_ptr< PersProductItem > crePersProductItem () const

  Create a personalized IP group.
  

Static Public Attributes

• static const Type type_

  The product item type id: PiType::piIpGroup.
  

Private Member Functions

• ProductItem * clone_ () const

  Virtual copy construction.
  

Database operations:

IP group items do not have specific data. All I/O members just return true, the argument `session' is never used.

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

  No IP group item specific data to read.
  

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

  No IP group item specific data to insert.
  

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

  No IP group item specific data to update.
  

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

  No IP group item specific data to delete.
  

---

Member Typedef Documentation

typedef std::auto_ptr<IpGroupItem> OSB_LIB::IpGroupItem::AutoPtr

Short-cut for an auto pointer.

For details see quality manual, implementation patterns: Virtual copy construction.

Reimplemented from OSB_LIB::ResourceItem.

Definition at line 517 of file ipaddress.h.

---

Constructor & Destructor Documentation

OSB_LIB::IpGroupItem::IpGroupItem	(	const Oid &	oid,
		const std::string &	name = "",
		const std::string &	des = ""
	)

Constructor with object id, name and description.

Parameters:

	oid	Product item object id.
	name	Name of the resource item.
	des	Description of the resource item.

---

Member Function Documentation

ProductItem::CfgType OSB_LIB::IpGroupItem::canConfigure

(

)

const [virtual]

Configuration type.

Returns:

IP group items can not be configured: ProductItem::cfgNone.

Implements OSB_LIB::ProductItem.

ProductItem::DefPersType OSB_LIB::IpGroupItem::canDefPers

(

)

const [virtual]

Default personalization type.

Returns:

Default personalization of IP group items is not possible: ProductItem::defPersNone;

Implements OSB_LIB::ProductItem.

CfgPersType OSB_LIB::IpGroupItem::canPersonalize

(

)

const [virtual]

The personalization type of PersIpGroup.

Returns:

The personalization of IP group item is always needed;

Implements OSB_LIB::ProductItem.

AutoPtr OSB_LIB::IpGroupItem::clone

(

)

const

Virtual copy construction.

For details see quality manual, implementation patterns.

Reimplemented from OSB_LIB::ResourceItem.

ProductItem* OSB_LIB::IpGroupItem::clone_

(

)

const [private, virtual]

Virtual copy construction.

For details see quality manual, implementation patterns.

Implements OSB_LIB::ResourceItem.

std::auto_ptr<PersProductItem> OSB_LIB::IpGroupItem::crePersProductItem

(

)

const [virtual]

Create a personalized IP group.

Returns:

An auto pointer that contains a PersIpGroup without configuration, i.e., no personalization.

Implements OSB_LIB::ProductItem.

const PersProductItem* OSB_LIB::IpGroupItem::defPersItem

(

)

const [virtual]

Pointer to the default personalized IP group.

Implements OSB_LIB::ProductItem.

bool OSB_LIB::IpGroupItem::delSpecific

(

const OSB_DB::Session &

session

)

[private, virtual]

No IP group item specific data to delete.

Implements OSB_LIB::ProductItem.

bool OSB_LIB::IpGroupItem::insSpecific

(

const OSB_DB::Session &

session

)

[private, virtual]

No IP group item specific data to insert.

Implements OSB_LIB::ProductItem.

bool OSB_LIB::IpGroupItem::readSpecific

(

const OSB_DB::Session &

session

)

[private, virtual]

No IP group item specific data to read.

Implements OSB_LIB::ProductItem.

Type OSB_LIB::IpGroupItem::type

(

)

const [virtual]

The type of the product item.

The function returns the type of the product item. It is needed for only one reason: Corba clients must provide a configuration window that depends on the actual type.

No appropriate design can be provided: Unless on-line clients use the real product item type through-out the whole live cycle of an object, there must be a way to determine the actual type of a product item. No matter how clever we make our design, for on-line clients there will always be one step where they need to determine a product item's type in a switch-like statement. For this step I personally perfer to work with an enumeration type (and compiler warnings) rather than relying on dynamic casts (where errors can be detected only during run-time).

Remarks:

Derived classes declare the function private.

Implements OSB_LIB::ProductItemBase.

bool OSB_LIB::IpGroupItem::updSpecific

(

const OSB_DB::Session &

session

)

[private, virtual]

No IP group item specific data to update.

Implements OSB_LIB::ProductItem.

---

Member Data Documentation

const Type OSB_LIB::IpGroupItem::type_ [static]

The product item type id: PiType::piIpGroup.

Definition at line 514 of file ipaddress.h.

---

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

• ipaddress.h

---