COptLogItem Class Reference

#include <COptLogItem.h>

Public Types
enum	MsgID {   STD_start , STD_start_nodoc , STD_early_stop , STD_finish ,   STD_finish_x_of_max_iter , STD_finish_x_of_max_gener , STD_finish_temp_info , STD_initial_point_out_of_domain ,   PS_usrdef_error_swarm_size , PS_info_informants , PS_no_particle_improved , PS_stddev_lower_than_tol_termination ,   SA_steps_per_temp , SA_fval_progress_lower_than_tol , SA_fval_tol_termination , DE_usrdef_error_pop_size ,   DE_fittest_not_changed_x_random_generated , GA_fittest_not_changed_x_random_generated , GASR_usrdef_error_pf , GASR_fittest_not_changed_x_random_generated ,   HJ_steplength_lower_than_tol , LM_hess_pos_def , LM_hess_not_pos_def , LM_fval_and_param_change_lower_than_tol ,   LM_fval_and_param_change_lower_than_tol_termination , LM_lambda_max_termination , LM_inc_lambda , LM_count_edge_of_param_domain ,   CW_min_step_size , NM_fval_change_lower_than_tol , NM_local_min_termination , NM_no_local_min_reducing_simplex ,   SRES_usrdef_error_pf , SRES_fittest_not_changed_x_random_generated , TN_next_repeat }

Public Member Functions
	COptLogItem (MsgID id, const std::string &statusDump="")
std::string	getHeader () const
MsgID	getMsgId () const
std::string	getStatusDetails () const
std::string	getSubtext () const
time_t	getTimestamp () const
COptLogItem &	iter (size_t val)
template<class T >
COptLogItem &	with (T arg)
virtual	~COptLogItem ()

Static Public Attributes
static const std::string	MsgIDHeader []
static const std::string	MsgIDSubtext []

Protected Member Functions
unsigned C_INT32	countVars (const std::string &str) const
std::string	fillString (const std::string &str, unsigned C_INT32 varOffset=0) const

Protected Attributes
MsgID	mID
size_t	mIteration
std::vector< std::string >	mMsgVars
std::string	mStatusDump
time_t	mTimestamp
unsigned C_INT32	mVarCount

Member Enumeration Documentation

MsgID

enum COptLogItem::MsgID

Enumeration of IDs for all messages

Enumerator
STD_start
STD_start_nodoc
STD_early_stop
STD_finish
STD_finish_x_of_max_iter
STD_finish_x_of_max_gener
STD_finish_temp_info
STD_initial_point_out_of_domain
PS_usrdef_error_swarm_size
PS_info_informants
PS_no_particle_improved
PS_stddev_lower_than_tol_termination
SA_steps_per_temp
SA_fval_progress_lower_than_tol
SA_fval_tol_termination
DE_usrdef_error_pop_size
DE_fittest_not_changed_x_random_generated
GA_fittest_not_changed_x_random_generated
GASR_usrdef_error_pf
GASR_fittest_not_changed_x_random_generated
HJ_steplength_lower_than_tol
LM_hess_pos_def
LM_hess_not_pos_def
LM_fval_and_param_change_lower_than_tol
LM_fval_and_param_change_lower_than_tol_termination
LM_lambda_max_termination
LM_inc_lambda
LM_count_edge_of_param_domain
CW_min_step_size
NM_fval_change_lower_than_tol
NM_local_min_termination
NM_no_local_min_reducing_simplex
SRES_usrdef_error_pf
SRES_fittest_not_changed_x_random_generated
TN_next_repeat

Constructor & Destructor Documentation

COptLogItem()

COptLogItem::COptLogItem	(	MsgID	id,
		const std::string &	statusDump = ""
	)

Constructor.

References countVars(), mID, MsgIDHeader, MsgIDSubtext, and mVarCount.

~COptLogItem()

COptLogItem::~COptLogItem ( )

virtual

Destructor

Member Function Documentation

countVars()

unsigned C_INT32 COptLogItem::countVars ( const std::string &  str ) const

protected

References C_INT32.

Referenced by COptLogItem(), and getSubtext().

fillString()

std::string COptLogItem::fillString ( const std::string &  str, unsigned C_INT32  varOffset = 0  ) const

protected

Replace s%, _timestamp% and _iteration% in strings.

Parameters

const	std::string & string template
unsigned	C_Int32 * offset in mMsgVars

Returns

std::string filledString

References ISODateTime(), mIteration, mMsgVars, and mTimestamp.

Referenced by getHeader(), and getSubtext().

getHeader()

std::string COptLogItem::getHeader

(

)

const

References fillString(), mID, and MsgIDHeader.

getMsgId()

COptLogItem::MsgID COptLogItem::getMsgId

(

)

const

References mID.

getStatusDetails()

std::string COptLogItem::getStatusDetails

(

)

const

References mStatusDump.

getSubtext()

std::string COptLogItem::getSubtext

(

)

const

References countVars(), fillString(), mID, MsgIDHeader, and MsgIDSubtext.

getTimestamp()

time_t COptLogItem::getTimestamp

(

)

const

References mTimestamp.

iter()

COptLogItem & COptLogItem::iter

(

size_t

val

)

Enter iteration value for this log item.

Parameters

unsigned

C_INT32 iteration

Returns

COptLogItem & logItem

References mIteration.

with()

template<class T >

COptLogItem& COptLogItem::with ( T  arg )

inline

Enter further values for this log item.

Parameters

<T>

value

Returns

COptLogItem & logItem

References mMsgVars, and mVarCount.

Member Data Documentation

mID

MsgID COptLogItem::mID

protected

Message ID for this log item.

Referenced by COptLogItem(), getHeader(), getMsgId(), and getSubtext().

mIteration

size_t COptLogItem::mIteration

protected

Iteration that this log item was created at (optional).

Referenced by fillString(), and iter().

mMsgVars

std::vector<std::string> COptLogItem::mMsgVars

protected

All further variables fed into this log item (optional).

Referenced by fillString(), and with().

MsgIDHeader

const std::string COptLogItem::MsgIDHeader

static

Vector of message headers for all defined MsgIDs

COptLogItem class Container for a log message created by the copasi optimization methods. Stores various variable for later compilation of a message string.

Created for COPASI by Jonas F�rster 2013

Referenced by COptLogItem(), getHeader(), and getSubtext().

MsgIDSubtext

const std::string COptLogItem::MsgIDSubtext

static

Vector of message subtexts for all defined MsgIDs

Referenced by COptLogItem(), and getSubtext().

mStatusDump

std::string COptLogItem::mStatusDump

protected

A string containing further detailed information of the current state of the optimization method (optional).

Referenced by getStatusDetails().

mTimestamp

time_t COptLogItem::mTimestamp

protected

Timestamp for this log item.

Referenced by fillString(), and getTimestamp().

mVarCount

unsigned C_INT32 COptLogItem::mVarCount

protected

Amount of variables for this log item.

Referenced by COptLogItem(), and with().

---

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

• COptLogItem.h
• COptLogItem.cpp