beliefstate::UtilityBase Class Reference

#include <UtilityBase.h>

Inheritance diagram for beliefstate::UtilityBase:

List of all members.

Public Member Functions
void	coloredText (std::string strText, std::string strColorValue, bool bBold=false, bool bImportant=false)
virtual void	fail (std::string strMessage, bool bImportant=false)
bool	fileExists (std::string strFileName)
int	getTimeStamp ()
std::string	getTimeStampStr ()
virtual void	info (std::string strMessage, bool bImportant=false)
std::string	messagePrefixLabel ()
bool	onlyDisplayImportant ()
void	outputColoredStatusMessage (StatusMessage msgStatus)
void	replaceStringInPlace (string &subject, const std::string &search, const std::string &replace)
	Partial string replace function.
void	setMessagePrefixLabel (std::string strMessagePrefixLabel)
void	setOnlyDisplayImportant (bool bOnly)
void	setRedirectOutput (bool bRedirect)
std::string	str (float fValue)
std::string	str (double dValue)
std::string	str (int nValue)
std::string	stripPostfix (std::string strString, std::string strPostfix)
virtual void	success (std::string strMessage, bool bImportant=false)
	UtilityBase ()
virtual void	warn (std::string strMessage, bool bImportant=false)
	~UtilityBase ()
Private Attributes
bool	m_bOnlyDisplayImportant
std::string	m_strMessagePrefixLabel
Static Private Attributes
static bool	m_bRedirectOutput

---

Detailed Description

Definition at line 55 of file UtilityBase.h.

---

Constructor & Destructor Documentation

beliefstate::UtilityBase::UtilityBase

(

)

Definition at line 47 of file UtilityBase.cpp.

beliefstate::UtilityBase::~UtilityBase

(

)

Definition at line 53 of file UtilityBase.cpp.

---

Member Function Documentation

void beliefstate::UtilityBase::coloredText	(	std::string	strText,
		std::string	strColorValue,
		bool	bBold = false,
		bool	bImportant = false
	)

Definition at line 64 of file UtilityBase.cpp.

void beliefstate::UtilityBase::fail	(	std::string	strMessage,
		bool	bImportant = false
	)		[virtual]

Reimplemented in beliefstate::plugins::Plugin.

Definition at line 86 of file UtilityBase.cpp.

bool beliefstate::UtilityBase::fileExists

(

std::string

strFileName

)

Definition at line 90 of file UtilityBase.cpp.

int beliefstate::UtilityBase::getTimeStamp

(

)

Definition at line 131 of file UtilityBase.cpp.

std::string beliefstate::UtilityBase::getTimeStampStr

(

)

Definition at line 135 of file UtilityBase.cpp.

void beliefstate::UtilityBase::info	(	std::string	strMessage,
		bool	bImportant = false
	)		[virtual]

Reimplemented in beliefstate::plugins::Plugin.

Definition at line 74 of file UtilityBase.cpp.

std::string beliefstate::UtilityBase::messagePrefixLabel

(

)

Definition at line 60 of file UtilityBase.cpp.

bool beliefstate::UtilityBase::onlyDisplayImportant

(

)

Definition at line 170 of file UtilityBase.cpp.

void beliefstate::UtilityBase::outputColoredStatusMessage

(

StatusMessage

msgStatus

)

Definition at line 113 of file UtilityBase.cpp.

void beliefstate::UtilityBase::replaceStringInPlace	(	string &	subject,
		const std::string &	search,
		const std::string &	replace
	)

Partial string replace function.

Replaces 'search' by 'replace' in string 'subject'.

Parameters:

subject	The string to search in
search	The string to search for
replace	The string to use as a replacement

Definition at line 122 of file UtilityBase.cpp.

void beliefstate::UtilityBase::setMessagePrefixLabel

(

std::string

strMessagePrefixLabel

)

Definition at line 56 of file UtilityBase.cpp.

void beliefstate::UtilityBase::setOnlyDisplayImportant

(

bool

bOnly

)

Definition at line 166 of file UtilityBase.cpp.

void beliefstate::UtilityBase::setRedirectOutput

(

bool

bRedirect

)

Definition at line 118 of file UtilityBase.cpp.

std::string beliefstate::UtilityBase::str

(

float

fValue

)

Definition at line 139 of file UtilityBase.cpp.

std::string beliefstate::UtilityBase::str

(

double

dValue

)

Definition at line 148 of file UtilityBase.cpp.

std::string beliefstate::UtilityBase::str

(

int

nValue

)

Definition at line 157 of file UtilityBase.cpp.

std::string beliefstate::UtilityBase::stripPostfix	(	std::string	strString,
		std::string	strPostfix
	)

Definition at line 103 of file UtilityBase.cpp.

void beliefstate::UtilityBase::success	(	std::string	strMessage,
		bool	bImportant = false
	)		[virtual]

Reimplemented in beliefstate::plugins::Plugin.

Definition at line 78 of file UtilityBase.cpp.

void beliefstate::UtilityBase::warn	(	std::string	strMessage,
		bool	bImportant = false
	)		[virtual]

Reimplemented in beliefstate::plugins::Plugin.

Definition at line 82 of file UtilityBase.cpp.

---

Member Data Documentation

bool beliefstate::UtilityBase::m_bOnlyDisplayImportant [private]

Reimplemented in beliefstate::Beliefstate.

Definition at line 59 of file UtilityBase.h.

bool beliefstate::UtilityBase::m_bRedirectOutput [static, private]

Definition at line 57 of file UtilityBase.h.

std::string beliefstate::UtilityBase::m_strMessagePrefixLabel [private]

Definition at line 58 of file UtilityBase.h.

---

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

• UtilityBase.h
• UtilityBase.cpp