OSB_LIB::MappedPartInfo Class Reference

Collaboration diagram for OSB_LIB::MappedPartInfo:

Collaboration graph
[legend]
List of all members.

Detailed Description

An object that keep the validity period of a cgi (cgi's part) and the corresponding connection point.

Definition at line 354 of file cpmapper.h.

Public Member Functions

Private Attributes

Friends


Constructor & Destructor Documentation

OSB_LIB::MappedPartInfo::MappedPartInfo ( const ConnectionPt cp,
const DateTime startTs,
const DateTime endTs 
)

The only constructor.

Parameters:
cp Connection point for this mapped part info.
startTs Start timestamp of the mapped part.
endTs End timestamp of the mapped part.


Member Function Documentation

void OSB_LIB::MappedPartInfo::print ( std::ostream &  os,
std::string  spacer 
) const

Print for testing purposes.

bool OSB_LIB::MappedPartInfo::withinPeriod ( const DateTime ts  )  const

Is a valid mapped part info at a given time?

This function will compare the timestamp passed in with the start and end date of this part info. Thus, it can tell whether the mapped part info is valid at the given time or not.

Parameters:
ts Time stamp when the validity of the part info is to be checked.
Returns:
true if within the validity period else false.


Friends And Related Function Documentation

friend class MappedPartInfoList [friend]

MappedPartInfoList needs to access private members.

Definition at line 358 of file cpmapper.h.


Member Data Documentation

DateTime OSB_LIB::MappedPartInfo::endTs_ [private]

Ending date of the valid period of this part info.

Definition at line 397 of file cpmapper.h.

MappedCp OSB_LIB::MappedPartInfo::mappedCp_ [private]

Connection point corresponding to this mapped part info.

Definition at line 393 of file cpmapper.h.

DateTime OSB_LIB::MappedPartInfo::startTs_ [private]

Starting date of the valid period of this part info.

Definition at line 395 of file cpmapper.h.


The documentation for this class was generated from the following file:
Generated on Sat Sep 2 14:15:29 2006 for OSB Library by  doxygen 1.4.7