OpenTREP Logo  0.07.18
C++ Open Travel Request Parsing Library
Loading...
Searching...
No Matches
OPENTREP::BomAbstract Class Referenceabstract

Base class for the Business Object Model (BOM) layer. More...

#include <opentrep/bom/BomAbstract.hpp>

+ Inheritance diagram for OPENTREP::BomAbstract:

Public Member Functions

virtual void toStream (std::ostream &) const =0
 
virtual void fromStream (std::istream &)=0
 
virtual std::string toString () const =0
 
virtual std::string describeKey () const =0
 
virtual std::string describeShortKey () const =0
 

Protected Member Functions

 BomAbstract ()
 
 BomAbstract (const BomAbstract &)
 
virtual ~BomAbstract ()
 

Friends

class FacBomAbstract
 

Detailed Description

Base class for the Business Object Model (BOM) layer.

Definition at line 17 of file BomAbstract.hpp.

Constructor & Destructor Documentation

◆ BomAbstract() [1/2]

OPENTREP::BomAbstract::BomAbstract ( )
inlineprotected

Protected Default Constructor to ensure this class is abtract.

Definition at line 57 of file BomAbstract.hpp.

Referenced by BomAbstract(), and OPENTREP::World::getGenericBom().

◆ BomAbstract() [2/2]

OPENTREP::BomAbstract::BomAbstract ( const BomAbstract & )
inlineprotected

Definition at line 58 of file BomAbstract.hpp.

References BomAbstract().

◆ ~BomAbstract()

virtual OPENTREP::BomAbstract::~BomAbstract ( )
inlineprotectedvirtual

Destructor.

Definition at line 63 of file BomAbstract.hpp.

Member Function Documentation

◆ toStream()

virtual void OPENTREP::BomAbstract::toStream ( std::ostream & ) const
pure virtual

Dump a Business Object into an output stream.

Parameters
ostream&the output stream.

Implemented in OPENTREP::Place, OPENTREP::PlaceHolder, OPENTREP::Result, OPENTREP::ResultCombination, OPENTREP::ResultHolder, and OPENTREP::World.

◆ fromStream()

virtual void OPENTREP::BomAbstract::fromStream ( std::istream & )
pure virtual

Read a Business Object from an input stream.

Parameters
istream&the input stream.

Implemented in OPENTREP::Place, OPENTREP::PlaceHolder, OPENTREP::Result, OPENTREP::ResultCombination, OPENTREP::ResultHolder, and OPENTREP::World.

Referenced by operator>>().

◆ toString()

virtual std::string OPENTREP::BomAbstract::toString ( ) const
pure virtual

Get the serialised version of the Business Object.

Implemented in OPENTREP::Place, OPENTREP::PlaceHolder, OPENTREP::Result, OPENTREP::ResultCombination, OPENTREP::ResultHolder, and OPENTREP::World.

◆ describeKey()

virtual std::string OPENTREP::BomAbstract::describeKey ( ) const
pure virtual

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

Implemented in OPENTREP::Place, OPENTREP::PlaceHolder, OPENTREP::Result, OPENTREP::ResultCombination, OPENTREP::ResultHolder, and OPENTREP::World.

◆ describeShortKey()

virtual std::string OPENTREP::BomAbstract::describeShortKey ( ) const
pure virtual

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

Implemented in OPENTREP::Place, OPENTREP::PlaceHolder, OPENTREP::Result, OPENTREP::ResultCombination, OPENTREP::ResultHolder, and OPENTREP::World.

Friends And Related Symbol Documentation

◆ FacBomAbstract

friend class FacBomAbstract
friend

Definition at line 18 of file BomAbstract.hpp.

References FacBomAbstract.

Referenced by FacBomAbstract.


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