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

#include <opentrep/bom/World.hpp>

+ Inheritance diagram for OPENTREP::World:

Public Member Functions

const PlaceOrderedList_TgetSimplePlaceList () const
 
void toStream (std::ostream &) const
 
void fromStream (std::istream &)
 
std::string toString () const
 
std::string describeKey () const
 
std::string describeShortKey () const
 
std::string display () const
 
std::string shortDisplay () const
 
GenericBom_T getGenericBom (const XapianDocID_T &iDocID) const
 

Friends

class FacWorld
 
class DbaWorld
 

Detailed Description

Structure modelling an world.

Definition at line 20 of file World.hpp.

Member Function Documentation

const PlaceOrderedList_T& OPENTREP::World::getSimplePlaceList ( ) const
inline

Get the list of Place objects. const PlaceDirectList_T& getPlaceList () const { return _placeList; }Get the list of Place objects.

Definition at line 32 of file World.hpp.

void OPENTREP::World::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 44 of file World.cpp.

References toString().

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

Read a Business Object from an input stream.

Parameters
istream&the input stream.

Implements OPENTREP::BomAbstract.

Definition at line 49 of file World.cpp.

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

Get the serialised version of the World object.

Implements OPENTREP::BomAbstract.

Definition at line 39 of file World.cpp.

References describeKey().

Referenced by toStream().

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

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

Implements OPENTREP::BomAbstract.

Definition at line 34 of file World.cpp.

References describeShortKey().

Referenced by OPENTREP::FacWorld::linkPlaceToWorld(), shortDisplay(), and toString().

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

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

Implements OPENTREP::BomAbstract.

Definition at line 28 of file World.cpp.

Referenced by describeKey().

std::string OPENTREP::World::display ( ) const

Display the full World context.

Definition at line 60 of file World.cpp.

References OPENTREP::Place::display(), and shortDisplay().

Referenced by OPENTREP::OPENTREP_ServiceContext::display().

std::string OPENTREP::World::shortDisplay ( ) const

Display a short World context.

Definition at line 53 of file World.cpp.

References describeKey().

Referenced by display().

GenericBom_T OPENTREP::World::getGenericBom ( const XapianDocID_T iDocID) const

Retrieve a generic BOM object from the dedicated list.

Definition at line 77 of file World.cpp.

References OPENTREP::BomType::LAST_VALUE.

Friends And Related Function Documentation

friend class FacWorld
friend

Definition at line 21 of file World.hpp.

friend class DbaWorld
friend

Definition at line 22 of file World.hpp.


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