OSB_LIB::ToNameOnly Class Reference

Inheritance diagram for OSB_LIB::ToNameOnly:

[legend]Collaboration diagram for OSB_LIB::ToNameOnly:

[legend]List of all members.

---

Detailed Description

Base class for tariff objects with name only.

The main purpose of this class is to define a unique interface for all tariff objects without description.

See TariffObject about object ids."

Definition at line 380 of file tariffobject.h.

Public Member Functions

• const std::string & name () const

  Name of tariff object.
  

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

  Set the name.
  

Protected Member Functions

• ToNameOnly ()

  Default constructor.
  

• virtual ~ToNameOnly ()=0

  Virtual empty destructor.
  

• ToNameOnly & operator= (const ToNameOnly &rhs)

  Prevent assignment through base class.
  

• long objVs () const

  Get object version.
  

Protected Attributes

• std::string name_

  Name of tariff object.
  

• long objVs_

  Object version: set by the gateways during database operations.
  

---

Constructor & Destructor Documentation

OSB_LIB::ToNameOnly::ToNameOnly

(

)

[protected]

Default constructor.

Note:

Derived classes should provide a default constructor with optional object id (see class description).

virtual OSB_LIB::ToNameOnly::~ToNameOnly

(

)

[protected, pure virtual]

Virtual empty destructor.

---

Member Function Documentation

const std::string& OSB_LIB::ToNameOnly::name

(

)

const

Name of tariff object.

long OSB_LIB::ToNameOnly::objVs

(

)

const [protected]

Get object version.

ToNameOnly& OSB_LIB::ToNameOnly::operator=

(

const ToNameOnly &

rhs

)

[protected]

Prevent assignment through base class.

void OSB_LIB::ToNameOnly::setName

(

const std::string &

name

)

Set the name.

Parameters:

name

Name for tariff object.

Exceptions:

	OsbException	if name is empty.
	OsbException	if name is too long.

---

Member Data Documentation

std::string OSB_LIB::ToNameOnly::name_ [protected]

Name of tariff object.

Definition at line 410 of file tariffobject.h.

long OSB_LIB::ToNameOnly::objVs_ [protected]

Object version: set by the gateways during database operations.

Definition at line 412 of file tariffobject.h.

---

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

• tariffobject.h

---