OSB_LIB::MappedCp Struct Reference

Collaboration diagram for OSB_LIB::MappedCp:

[legend]List of all members.

---

Detailed Description

Time period of a mapped connection point.

The structure stores the release period of ConnectionPt. The main purpose is to provide a single, consistent definition when a given timestamp is considered within this period or not.

The structure is used in class that support the mapping of real objects to connection points.

Remarks:

All constructors, assignment and destructor by compiler.

Definition at line 312 of file cpmapper.h.

Public Member Functions

• MappedCp ()

  Empty default constructor.
  

• MappedCp (const ConnectionPt &cp)

  Construct from connection point.
  

• bool withinPeriod (const DateTime &ts) const

  Assignment from a connection point.Connection point released at a given time?
  

Public Attributes

• Id< ConnectionPt > cpId_

  Connection point id.
  

• DateTime cpStart_

  Start of released period.
  

• DateTime cpEnd_

  End of released period.
  

---

Constructor & Destructor Documentation

OSB_LIB::MappedCp::MappedCp

(

)

Empty default constructor.

OSB_LIB::MappedCp::MappedCp

(

const ConnectionPt &

cp

)

Construct from connection point.

---

Member Function Documentation

bool OSB_LIB::MappedCp::withinPeriod

(

const DateTime &

ts

)

const

Assignment from a connection point.Connection point released at a given time?

The function checks if a given timestamp ts is within the time period [start, end[ of a mapped connection point. The function returns true if either

• ts is not set OR
• start <= ts or start is not set AND
• end > ts or end is not set.

Parameters:

ts

Timestamp to check.

Returns:

True if `ts' is within the time period, else false.

---

Member Data Documentation

DateTime OSB_LIB::MappedCp::cpEnd_

End of released period.

Definition at line 315 of file cpmapper.h.

Id<ConnectionPt> OSB_LIB::MappedCp::cpId_

Connection point id.

Definition at line 313 of file cpmapper.h.

DateTime OSB_LIB::MappedCp::cpStart_

Start of released period.

Definition at line 314 of file cpmapper.h.

---

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

• cpmapper.h

---