OSB_LIB::ToCfgPeriodBase Class Reference

Inheritance diagram for OSB_LIB::ToCfgPeriodBase:

[legend]Collaboration diagram for OSB_LIB::ToCfgPeriodBase:

[legend]List of all members.

---

Detailed Description

Base class for tariff objects with a configuration status and a release period.

The main purpose of this class is to define a unique interface for all tariff objects that have a configuration status and a release start and end timestamp.

Definition at line 170 of file tariffobject.h.

Public Member Functions

• const DateTime & endTs () const

  Timestamp when the tariff object expires.
  

• virtual void setEndTs (const DateTime &ts)

  Set the expiration timestamp.
  

• bool contains (const DateTime &ts) const

  Check if a timestamp is within the validity period.
  

Protected Member Functions

• ToCfgPeriodBase (CfgStatus status=cfgEditable)

  Default constructor with optional configuration status.
  

• virtual ~ToCfgPeriodBase ()

  Empty virtual destructor.
  

• ToCfgPeriodBase & operator= (const ToCfgPeriodBase &rhs)

  Prevent assignment through base class.
  

Protected Attributes

• DateTime endTs_

  Expiry timestamp of the tariff object.
  

---

Constructor & Destructor Documentation

OSB_LIB::ToCfgPeriodBase::ToCfgPeriodBase

(

CfgStatus

status = cfgEditable

)

[explicit, protected]

Default constructor with optional configuration status.

virtual OSB_LIB::ToCfgPeriodBase::~ToCfgPeriodBase

(

)

[protected, virtual]

Empty virtual destructor.

---

Member Function Documentation

bool OSB_LIB::ToCfgPeriodBase::contains

(

const DateTime &

ts

)

const

Check if a timestamp is within the validity period.

const DateTime& OSB_LIB::ToCfgPeriodBase::endTs

(

)

const

Timestamp when the tariff object expires.

ToCfgPeriodBase& OSB_LIB::ToCfgPeriodBase::operator=

(

const ToCfgPeriodBase &

rhs

)

[protected]

Prevent assignment through base class.

virtual void OSB_LIB::ToCfgPeriodBase::setEndTs

(

const DateTime &

ts

)

[virtual]

Set the expiration timestamp.

Parameters:

ts

Timestamp when the tariff object expires.

Exceptions:

OsbException

if endTs is: not in the future earlier than the release timestamp.

---

Member Data Documentation

DateTime OSB_LIB::ToCfgPeriodBase::endTs_ [protected]

Expiry timestamp of the tariff object.

Definition at line 195 of file tariffobject.h.

---

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

• tariffobject.h

---