Description:

This is a job executed by the ThreadPool in class DoxygenXLinks. The job loads an index file. Only external tag-file are loaded by the thread pool. The main tag-file is loaded by the main thread.

Definition at line 26 of file jobs.hpp.

#include <jobs.hpp>

Inheritance diagram for dxl::IndexLoader:

Public Field Index:
Index &	index
	The index to load.
Public Field Index: inherited from dxl::DXLJob
DXLPoolWorker *	poolWorker
	The pool worker that executes this job.
Public Field Index: inherited from alib::threadmodel::Job
const std::type_info &	ID

Public Method Index:
	IndexLoader (Index &pIndex)
bool	Do () override
size_t	SizeOf () override
Public Method Index: inherited from alib::threadmodel::Job
	Job (const std::type_info &id)
TJob &	Cast ()
bool	Is ()
bool	IsNull ()
virtual void	PrepareDeferredDeletion ()

Field Details:

◆ index

Index& dxl::IndexLoader::index

The index to load.

Definition at line 28 of file jobs.hpp.

Constructor(s) / Destructor Details:

◆ IndexLoader()

dxl::IndexLoader::IndexLoader ( Index & pIndex )

inline

Constructor.

Parameters

pIndex The index to load.

Definition at line 32 of file jobs.hpp.

Method Details:

◆ Do()

bool dxl::IndexLoader::Do ( )

overridevirtual

Implements this job.

Returns: Constant true.

Reimplemented from alib::threadmodel::Job.

Definition at line 20 of file index.cpp.

◆ SizeOf()

size_t dxl::IndexLoader::SizeOf ( )

inlineoverridevirtual

Overrides the parent function as necessary.

Returns: The sizeof this derived type.

Reimplemented from alib::threadmodel::Job.

Definition at line 38 of file jobs.hpp.

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