OpenTREP Logo  0.6.0
C++ Open Travel Request Parsing Library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
OPENTREP::PlaceHolder Class Reference

#include <opentrep/bom/PlaceHolder.hpp>

+ Inheritance diagram for OPENTREP::PlaceHolder:

Public Member Functions

const PlaceList_TgetPlaceList () const
 
void createLocations (LocationList_T &) const
 
void toStream (std::ostream &ioOut) const
 
void fromStream (std::istream &ioIn)
 
std::string toString () const
 
std::string toShortString () const
 
std::string describeKey () const
 
std::string describeShortKey () const
 

Friends

class FacPlaceHolder
 

Detailed Description

Class wrapping functions on a list of Place objects.

Definition at line 16 of file PlaceHolder.hpp.

Member Function Documentation

const PlaceList_T& OPENTREP::PlaceHolder::getPlaceList ( ) const
inline

Retrieve the list of place objects.

Definition at line 21 of file PlaceHolder.hpp.

void OPENTREP::PlaceHolder::createLocations ( LocationList_T ioLocationList) const

Create the list of Location structures, which are light copies of the Place objects. Those (Location) structures are passed back to the caller of the service.

Definition at line 82 of file PlaceHolder.cpp.

References OPENTREP::Place::completeLocation().

void OPENTREP::PlaceHolder::toStream ( std::ostream &  ioOut) const
virtual

Dump a Business Object into an output stream.

Parameters
ostream&the output stream.

Implements OPENTREP::BomAbstract.

Definition at line 73 of file PlaceHolder.cpp.

References toString().

void OPENTREP::PlaceHolder::fromStream ( std::istream &  ioIn)
virtual

Read a Business Object from an input stream.

Parameters
istream&the input stream.

Implements OPENTREP::BomAbstract.

Definition at line 78 of file PlaceHolder.cpp.

std::string OPENTREP::PlaceHolder::toString ( ) const
virtual

Get the serialised version of the Business Object.

Implements OPENTREP::BomAbstract.

Definition at line 41 of file PlaceHolder.cpp.

References describeShortKey(), and OPENTREP::Place::toString().

Referenced by toStream().

std::string OPENTREP::PlaceHolder::toShortString ( ) const

Get a short display of the Business Object.

Definition at line 57 of file PlaceHolder.cpp.

References describeShortKey(), and OPENTREP::Place::toShortString().

std::string OPENTREP::PlaceHolder::describeKey ( ) const
virtual

Get a string describing the whole key (differentiating two objects at any level).

Implements OPENTREP::BomAbstract.

Definition at line 36 of file PlaceHolder.cpp.

References describeShortKey().

std::string OPENTREP::PlaceHolder::describeShortKey ( ) const
virtual

Get a string describing the short key (differentiating two objects at the same level).

Implements OPENTREP::BomAbstract.

Definition at line 30 of file PlaceHolder.cpp.

Referenced by describeKey(), toShortString(), and toString().

Friends And Related Function Documentation

friend class FacPlaceHolder
friend

Definition at line 17 of file PlaceHolder.hpp.


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