#include <CCopasiMessage.h>

Public Types
enum	Type { RAW = 0, TRACE = 1, COMMANDLINE = 2, WARNING = 3, ERROR = 4, EXCEPTION = 5, RAW_FILTERED = 128, TRACE_FILTERED = 129, COMMANDLINE_FILTERED = 130, WARNING_FILTERED = 131, ERROR_FILTERED = 132, EXCEPTION_FILTERED = 133 }
Public Member Functions
	CCopasiMessage ()
	CCopasiMessage (const CCopasiMessage &src)
	CCopasiMessage (Type type, const char *format,...)
	CCopasiMessage (Type type, unsigned C_INT32 number,...)
	~CCopasiMessage ()
CCopasiMessage &	operator= (const CCopasiMessage &RHS)
const std::string &	getText () const
const CCopasiMessage::Type &	getType () const
const unsigned C_INT32 &	getNumber () const
Static Public Member Functions
static const CCopasiMessage &	peekFirstMessage ()
static const CCopasiMessage &	peekLastMessage ()
static CCopasiMessage	getFirstMessage ()
static CCopasiMessage	getLastMessage ()
static std::string	getAllMessageText (const bool &chronological=true)
static void	clearDeque ()
static unsigned C_INT32	size ()
static CCopasiMessage::Type	getHighestSeverity ()
static bool	checkForMessage (const unsigned C_INT32 &number)

Member Enumeration Documentation

enum CCopasiMessage::Type

Enumerator:

RAW
TRACE
COMMANDLINE
WARNING
ERROR
EXCEPTION
RAW_FILTERED
TRACE_FILTERED
COMMANDLINE_FILTERED
WARNING_FILTERED
ERROR_FILTERED
EXCEPTION_FILTERED

Constructor & Destructor Documentation

CCopasiMessage::CCopasiMessage ( void )

Default constructor. This creates a default error messages, which actually does nothing.

CCopasiMessage::CCopasiMessage ( const CCopasiMessage & src )

Copy constructor.

Parameters:

const CCopasiMessage & src

CCopasiMessage::CCopasiMessage	(	CCopasiMessage::Type	type,
		const char *	format,
			...
	)

Specified constructor. This creates a formated message.

Parameters:

CCopasiMessage::Type	type (RAW\|TRACE\|WARNING\|ERROR)
const	char * format (printf like format string)
...	arguments like in printf

CCopasiMessage::CCopasiMessage	(	CCopasiMessage::Type	type,
		unsigned C_INT32	number,
			...
	)

Specified constructor. This creates a formated message.

Parameters:

CCopasiMessage::Type	type (RAW\|TRACE\|WARNING\|ERROR)
unsigned	C_INT32 number (message number see message.h)
...	arguments like in printf

CCopasiMessage::~CCopasiMessage ( void )

Destructor.

Member Function Documentation

bool CCopasiMessage::checkForMessage ( const unsigned C_INT32 & number ) [static]

Check whether a message with the given number is in the dequeue

Parameters:

const unsigned C_INT32 & number

Returns:: bool found

void CCopasiMessage::clearDeque ( ) [static]

This function clears the message stack.

std::string CCopasiMessage::getAllMessageText ( const bool & chronological = true ) [static]

Retrieve the text of all messages in the dequeue in chronological or reverse chronological order. If more than on message is in the dequeue the messages are separated by an empty line.

Returns:: std::string messageTexts

CCopasiMessage CCopasiMessage::getFirstMessage ( ) [static]

This function retrieves the first message created in COPASI. Consecutive calls allow for the retrieval of all generated messages in chronological order. If no more messages are in the dequeue the message (MCCopasiMessage + 1, "Message (1): No more messages." is returned.

Returns:: CCopasiMessage message

CCopasiMessage::Type CCopasiMessage::getHighestSeverity ( ) [static]

Retrieve highest severity of the messages in the dequeue.

Returns:: const CCopasiMessage::Type & highestSeverity

CCopasiMessage CCopasiMessage::getLastMessage ( ) [static]

This function retrieves the last message created in COPASI. Consecutive calls allow for the retrieval of all generated messages in reverse chronological order. If no more messages are in the dequeue the message (MCCopasiMessage + 1, "Message (1): No more messages." is returned.

Returns:: CCopasiMessage message

const unsigned C_INT32 & CCopasiMessage::getNumber ( void ) const

Retrieves the number of the message.

Returns:: "const unsigned C_INT32 &" mNumber

const std::string & CCopasiMessage::getText ( void ) const

Retrieves the text of the message.

Returns:: "const string &" mMessage

const CCopasiMessage::Type & CCopasiMessage::getType ( void ) const

Retrieves the type of the message.

Returns:: "const CCopasiMessage::Type &" mType

CCopasiMessage & CCopasiMessage::operator= ( const CCopasiMessage & RHS )

Assignment operator.

const CCopasiMessage & CCopasiMessage::peekFirstMessage ( ) [static]

This function peeks at the first message created in COPASI. If no more messages are in the dequeue the message (MCCopasiMessage + 1, "Message (1): No more messages." is returned.

Returns:: const CCopasiMessage & message

const CCopasiMessage & CCopasiMessage::peekLastMessage ( ) [static]

This function peeks at the last message created in COPASI. If no more messages are in the dequeue the message (MCCopasiMessage + 1, "Message (1): No more messages." is returned.

Returns:: const CCopasiMessage & message

unsigned C_INT32 CCopasiMessage::size ( ) [static]

Retrieve the size of the dequeue

Returns:: unsigned C_INT32 size

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

copasi/utilities/CCopasiMessage.h
copasi/utilities/CCopasiMessage.cpp

Public Types

Public Member Functions

Static Public Member Functions

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation