coco::termination_reason Class Reference
[Classes and types for basic data management]

This class holds the reason of termination of inference and management modules. More...

#include <termreason.h>

List of all members.

Public Member Functions

 termination_reason ()
 termination_reason (int termr_r, const std::string &termr_ref)
 termination_reason (const termination_reason &__t)
termination_reasonoperator= (const termination_reason &__t)
const std::string & get_message () const
int get_code () const


std::ostream & operator<< (std::ostream &o, const termination_reason &__x)
 C++ stream output operator for the termination_reason.

Detailed Description

This class is used to store the reason of termination of inference and management modules.

Definition at line 45 of file termreason.h.

Constructor & Destructor Documentation

coco::termination_reason::termination_reason (  )  [inline]

This is a map for message translation. Standard Constructor

Definition at line 58 of file termreason.h.

coco::termination_reason::termination_reason ( int  termr_r,
const std::string &  termr_ref 
) [inline]

Constructor, setting the return code to termr_r and the message string to termr_ref.

Definition at line 62 of file termreason.h.

coco::termination_reason::termination_reason ( const termination_reason __t  )  [inline]

Standard Copy Constructor

Definition at line 66 of file termreason.h.

Member Function Documentation

int coco::termination_reason::get_code (  )  const [inline]

This method return the termination code.

Definition at line 81 of file termreason.h.

const std::string& coco::termination_reason::get_message (  )  const [inline]

This method return the termination message.

Definition at line 78 of file termreason.h.

termination_reason& coco::termination_reason::operator= ( const termination_reason __t  )  [inline]

Standard Assignment Operator

Definition at line 70 of file termreason.h.

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  o,
const termination_reason __x 
) [friend]

This operator writes a termination_reason (the message) to an ostream.

Definition at line 90 of file termreason.h.

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

Generated on Tue Feb 9 14:50:06 2010 for COCONUT API by  doxygen 1.5.8