RMOL Logo Get Revenue Management Optimisation Library at SourceForge.net. Fast, secure and Free Open Source software downloads

RMOL::PartialSumHolderHolder Class Reference

#include <rmol/bom/PartialSumHolderHolder.hpp>

Inheritance diagram for RMOL::PartialSumHolderHolder:
RMOL::BomAbstract

List of all members.

Public Member Functions

const short getSize () const
PartialSumHoldergetPreviousPartialSumHolder () const
PartialSumHoldergetCurrentPartialSumHolder () const
void begin ()
void iterate ()
bool hasNotReachedEnd () const
void toStream (std::ostream &) const
void fromStream (std::istream &)
std::string toString () const
const std::string describeKey () const
const std::string describeShortKey () const
const std::string display () const
const std::string shortDisplay () const

Friends

class FacPartialSumHolderHolder

Detailed Description

Holder of a PartialSumHolder object (for memory allocation and recollection purposes).

Definition at line 17 of file PartialSumHolderHolder.hpp.


Member Function Documentation

const short RMOL::PartialSumHolderHolder::getSize (  )  const

Get the size of the internal list (i.e., number of partial sum lists).

Definition at line 75 of file PartialSumHolderHolder.cpp.

PartialSumHolder & RMOL::PartialSumHolderHolder::getPreviousPartialSumHolder (  )  const

Get the previous element (partial sum holder/list).

Definition at line 81 of file PartialSumHolderHolder.cpp.

Referenced by RMOL::MCOptimiser::optimalOptimisationByMCIntegration().

PartialSumHolder & RMOL::PartialSumHolderHolder::getCurrentPartialSumHolder (  )  const

Get the current element (partial sum holder/list).

Definition at line 89 of file PartialSumHolderHolder.cpp.

Referenced by RMOL::MCOptimiser::optimalOptimisationByMCIntegration().

void RMOL::PartialSumHolderHolder::begin (  ) 

Initialise the internal iterators on PartialSumHolder: The current iterator is set on the first PartialSumHolder, the next iterator is set on the second PartialSumHolder.

Definition at line 108 of file PartialSumHolderHolder.cpp.

Referenced by RMOL::MCOptimiser::optimalOptimisationByMCIntegration().

void RMOL::PartialSumHolderHolder::iterate (  ) 

Iterate for one element (partial sum holder/list): increment both internal iterators on PartialSumHolder.

Definition at line 114 of file PartialSumHolderHolder.cpp.

Referenced by RMOL::MCOptimiser::optimalOptimisationByMCIntegration().

bool RMOL::PartialSumHolderHolder::hasNotReachedEnd (  )  const

States whether or not the end of the (partial sum holder/list) list has been reached.

Definition at line 96 of file PartialSumHolderHolder.cpp.

void RMOL::PartialSumHolderHolder::toStream ( std::ostream &  ioOut  )  const [virtual]

Dump a Business Object into an output stream.

Parameters:
ostream& the output stream.

Implements RMOL::BomAbstract.

Definition at line 42 of file PartialSumHolderHolder.cpp.

References toString().

void RMOL::PartialSumHolderHolder::fromStream ( std::istream &  ioIn  )  [virtual]

Read a Business Object from an input stream.

Parameters:
istream& the input stream.

Implements RMOL::BomAbstract.

Definition at line 47 of file PartialSumHolderHolder.cpp.

std::string RMOL::PartialSumHolderHolder::toString (  )  const [virtual]

Get the serialised version of the Place object.

Implements RMOL::BomAbstract.

Definition at line 36 of file PartialSumHolderHolder.cpp.

Referenced by toStream().

const std::string RMOL::PartialSumHolderHolder::describeKey (  )  const [virtual]

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

Implements RMOL::BomAbstract.

Definition at line 31 of file PartialSumHolderHolder.cpp.

References describeShortKey().

Referenced by shortDisplay().

const std::string RMOL::PartialSumHolderHolder::describeShortKey (  )  const [virtual]

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

Implements RMOL::BomAbstract.

Definition at line 25 of file PartialSumHolderHolder.cpp.

Referenced by describeKey().

const std::string RMOL::PartialSumHolderHolder::display (  )  const

Display the full Place context.

Definition at line 58 of file PartialSumHolderHolder.cpp.

References RMOL::PartialSumHolder::display(), and shortDisplay().

const std::string RMOL::PartialSumHolderHolder::shortDisplay (  )  const

Display a short Place context.

Definition at line 51 of file PartialSumHolderHolder.cpp.

References describeKey().

Referenced by display().


Friends And Related Function Documentation

friend class FacPartialSumHolderHolder [friend]

Friend Classes
Those classes need to access the internal attributes of this object in order to construct and initialise it.

Definition at line 21 of file PartialSumHolderHolder.hpp.


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

Generated on Thu Jan 21 22:01:04 2010 for RMOL by Doxygen 1.6.2