CSMTools::Tools Class Reference

#include <tools.hpp>

Inheritance diagram for CSMTools::Tools:

Collaboration diagram for CSMTools::Tools:

Signals
void	progress (int current, int max, int type)
void	done (int type, bool failed)
void	mergeDone (CSMDoc::Document *document)

Public Member Functions
	Tools (CSMDoc::Document &document, ToUTF8::FromType encoding)
virtual	~Tools ()
CSMWorld::UniversalId	runVerifier (const CSMWorld::UniversalId &reportId=CSMWorld::UniversalId())
CSMWorld::UniversalId	newSearch ()
	Return ID of the report for this search. More...
void	runSearch (const CSMWorld::UniversalId &searchId, const Search &search)
void	runMerge (std::unique_ptr< CSMDoc::Document > target)
void	abortOperation (int type)
int	getRunningOperations () const
ReportModel *	getReport (const CSMWorld::UniversalId &id)
	The ownership of the returned report is not transferred. More...

Private Slots
void	verifierMessage (const CSMDoc::Message &message, int type)

Private Member Functions
	Tools (const Tools &)
Tools &	operator= (const Tools &)
CSMDoc::OperationHolder *	getVerifier ()
CSMDoc::OperationHolder *	get (int type)
	Returns a 0-pointer, if operation hasn't been used yet. More...
const CSMDoc::OperationHolder *	get (int type) const
	Returns a 0-pointer, if operation hasn't been used yet. More...

Private Attributes
CSMDoc::Document &	mDocument
CSMWorld::Data &	mData
CSMDoc::Operation *	mVerifierOperation
CSMDoc::OperationHolder	mVerifier
SearchOperation *	mSearchOperation
CSMDoc::OperationHolder	mSearch
MergeOperation *	mMergeOperation
CSMDoc::OperationHolder	mMerge
std::map< int, ReportModel * >	mReports
int	mNextReportNumber
std::map< int, int >	mActiveReports
ToUTF8::FromType	mEncoding

Constructor & Destructor Documentation

CSMTools::Tools::Tools ( const Tools &  )

private

CSMTools::Tools::Tools	(	CSMDoc::Document &	document,
		ToUTF8::FromType	encoding
	)

Here is the call graph for this function:

CSMTools::Tools::~Tools ( )

virtual

Member Function Documentation

void CSMTools::Tools::abortOperation

(

int

type

)

Attention

The operation is not aborted immediately.

void CSMTools::Tools::done ( int  type, bool  failed  )

signal

Here is the caller graph for this function:

CSMDoc::OperationHolder * CSMTools::Tools::get ( int  type )

private

Returns a 0-pointer, if operation hasn't been used yet.

const CSMDoc::OperationHolder * CSMTools::Tools::get ( int  type ) const

private

Returns a 0-pointer, if operation hasn't been used yet.

CSMTools::ReportModel * CSMTools::Tools::getReport

(

const CSMWorld::UniversalId &

id

)

The ownership of the returned report is not transferred.

Here is the call graph for this function:

int CSMTools::Tools::getRunningOperations

(

)

const

CSMDoc::OperationHolder * CSMTools::Tools::getVerifier ( )

private

void CSMTools::Tools::mergeDone ( CSMDoc::Document *  document )

signal

Attention

When this signal is emitted, *this hands over the ownership of the document. This signal must be handled to avoid a leak.

CSMWorld::UniversalId CSMTools::Tools::newSearch

(

)

Return ID of the report for this search.

Tools& CSMTools::Tools::operator= ( const Tools &  )

private

void CSMTools::Tools::progress ( int  current, int  max, int  type  )

signal

Here is the caller graph for this function:

void CSMTools::Tools::runMerge

(

std::unique_ptr< CSMDoc::Document >

target

)

Here is the call graph for this function:

void CSMTools::Tools::runSearch	(	const CSMWorld::UniversalId &	searchId,
		const Search &	search
	)

Here is the call graph for this function:

CSMWorld::UniversalId CSMTools::Tools::runVerifier

(

const CSMWorld::UniversalId &

reportId = CSMWorld::UniversalId()

)

Parameters

reportId

If a valid VerificationResults ID, run verifier for the specified report instead of creating a new one.

Returns

ID of the report for this verification run

Here is the call graph for this function:

void CSMTools::Tools::verifierMessage ( const CSMDoc::Message &  message, int  type  )

privateslot

Here is the caller graph for this function:

Member Data Documentation

std::map<int, int> CSMTools::Tools::mActiveReports

private

CSMWorld::Data& CSMTools::Tools::mData

private

CSMDoc::Document& CSMTools::Tools::mDocument

private

ToUTF8::FromType CSMTools::Tools::mEncoding

private

CSMDoc::OperationHolder CSMTools::Tools::mMerge

private

MergeOperation* CSMTools::Tools::mMergeOperation

private

int CSMTools::Tools::mNextReportNumber

private

std::map<int, ReportModel *> CSMTools::Tools::mReports

private

CSMDoc::OperationHolder CSMTools::Tools::mSearch

private

SearchOperation* CSMTools::Tools::mSearchOperation

private

CSMDoc::OperationHolder CSMTools::Tools::mVerifier

private

CSMDoc::Operation* CSMTools::Tools::mVerifierOperation

private

---

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

• /home/travis/build/elsid/openmw/apps/opencs/model/tools/tools.hpp
• /home/travis/build/elsid/openmw/apps/opencs/model/tools/tools.cpp