This class manages the sequencing of tile requests across multiple threads. More...

#include <ossimMultiThreadSequencer.h>

Inheritance diagram for ossimMultiThreadSequencer:

Classes
class	ossimGetTileCallback
	Private class for getTile job callbacks. More...

class	ossimGetTileJob
	Private class representing a getTile job. More...

Public Member Functions
	ossimMultiThreadSequencer (ossimImageSource inputSource=NULL, ossim_uint32 num_threads=0, ossimObject owner=NULL)

virtual	~ossimMultiThreadSequencer ()

virtual void	setToStartOfSequence ()
	Overrides base class implementation. More...

virtual ossimRefPtr< ossimImageData >	getNextTile (ossim_uint32 resLevel=0)
	Overrides base class in order to implement multi-threaded tile requests. More...

void	setNumberOfThreads (ossim_uint32 num_threads)
	Specifies number of thread to support. More...

ossim_uint32	getNumberOfThreads () const
	Fetches the number of threads being used. Useful when this object decides the quantity. More...

ossim_uint32	maxCacheSize () const
	Accessed for performance logging. More...

bool	loadState (const ossimKeywordlist &kwl, const char *prefix)
	Method to the load (recreate) the state of an object from a keyword list. More...

void	setUseSharedHandlers (bool use_shared_handlers)

void	setCacheTileSize (ossim_uint32 cache_tile_size)

void	setUseCache (bool use_cache)

double	handlerGetTileT ()

Public Member Functions inherited from ossimImageSourceSequencer
	ossimImageSourceSequencer (ossimImageSource inputSource=NULL, ossimObject owner=NULL)

virtual	~ossimImageSourceSequencer ()

ossim_int64	getNumberOfTiles () const

ossim_int64	getNumberOfTilesHorizontal () const

ossim_int64	getNumberOfTilesVertical () const

virtual void	initialize ()

virtual void	setAreaOfInterest (const ossimIrect &areaOfInterest)

const ossimIrect &	getAreaOfInterest () const

virtual ossimRefPtr< ossimImageData >	getTile (const ossimIrect &rect, ossim_uint32 resLevel=0)

virtual bool	getNextTileStream (std::ostream &bos)

virtual bool	getTileOrigin (ossim_int64 id, ossimIpt &origin) const

bool	getTileRect (ossim_int64 tile_id, ossimIrect &rect) const
	Establishes a tile rect given tile ID. More...

virtual ossimRefPtr< ossimImageData >	getTile (ossim_int64 id, ossim_uint32 resLevel=0)

virtual ossimIrect	getBoundingRect (ossim_uint32 resLevel=0) const
	This will return the bounding rect of the source. More...

virtual void	getDecimationFactor (ossim_uint32 resLevel, ossimDpt &result) const
	Will return the decimation factor for the given resolution level. More...

virtual void	getDecimationFactors (vector< ossimDpt > &decimations) const

virtual ossim_uint32	getNumberOfDecimationLevels () const
	Will return the number of resolution levels. More...

virtual ossim_uint32	getNumberOfInputBands () const

virtual ossimScalarType	getOutputScalarType () const
	This will be used to query the output pixel type of the tile source. More...

virtual ossim_uint32	getTileWidth () const
	Returns the default processing tile width. More...

virtual ossim_uint32	getTileHeight () const
	Returns the default processing tile height. More...

virtual void	slaveProcessTiles ()

virtual bool	isMaster () const

virtual ossimIpt	getTileSize () const

virtual void	setTileSize (const ossimIpt &tileSize)

virtual void	setTileSize (ossim_int32 width, ossim_int32 height)

virtual void	connectInputEvent (ossimConnectionEvent &event)

virtual void	disconnectInputEvent (ossimConnectionEvent &event)

virtual bool	canConnectMyInputTo (ossim_int32 inputIndex, const ossimConnectableObject *object) const
	required to be overriden by derived classes More...

virtual double	getNullPixelValue (ossim_uint32 band=0) const
	Each band has a null pixel associated with it. More...

virtual double	getMinPixelValue (ossim_uint32 band=0) const
	Returns the min pixel of the band. More...

virtual double	getMaxPixelValue (ossim_uint32 band=0) const
	Returns the max pixel of the band. More...

void	setCreateHistogram (bool create_histogram)

void	getBinInformation (ossim_uint32 &numberOfBins, ossim_float64 &minValue, ossim_float64 &maxValue, ossimScalarType stype) const

Public Member Functions inherited from ossimImageSource
	ossimImageSource (ossimObject *owner=0)

	ossimImageSource (ossimObject *owner, ossim_uint32 inputListSize, ossim_uint32 outputListSize, bool inputListIsFixedFlag=true, bool outputListIsFixedFlag=true)

virtual	~ossimImageSource ()

virtual ossimRefPtr< ossimImageData >	getTile (const ossimIpt &origin, ossim_uint32 resLevel=0)

virtual bool	getTile (ossimImageData *result, ossim_uint32 resLevel=0)
	Method to get a tile. More...

virtual ossimObject *	getObject ()
	For RTTI support. More...

virtual const ossimObject *	getObject () const
	For RTTI support. More...

virtual void	getDecimationFactors (std::vector< ossimDpt > &decimations) const
	Will return an array of all decimations for each resolution level. More...

virtual ossim_uint32	getNumberOfOutputBands () const
	Returns the number of bands in a tile returned from this TileSource. More...

virtual void	getOutputBandList (std::vector< ossim_uint32 > &bandList) const
	Initializes bandList. More...

virtual void	getBoundingRect (ossimIrect &rect, ossim_uint32 resLevel=0) const
	Gets the bounding rectangle of the source. More...

virtual bool	saveState (ossimKeywordlist &kwl, const char *prefix=0) const
	Method to save the state of an object to a keyword list. More...

virtual void	getValidImageVertices (std::vector< ossimIpt > &validVertices, ossimVertexOrdering ordering=OSSIM_CLOCKWISE_ORDER, ossim_uint32 resLevel=0) const
	ordering specifies how the vertices should be arranged. More...

virtual ossimRefPtr< ossimImageGeometry >	getImageGeometry ()
	Returns the image geometry object associated with this tile source or NULL if not defined. More...

virtual void	setImageGeometry (const ossimImageGeometry *geom)
	Default implementation sets geometry of the first input to the geometry specified. More...

virtual void	saveImageGeometry () const
	Default method to call input's saveImageGeometry. More...

virtual void	saveImageGeometry (const ossimFilename &geometry_file) const
	Default method to call input's saveImageGeometry. More...

virtual ossimRefPtr< ossimProperty >	getProperty (const ossimString &name) const

virtual void	setProperty (ossimRefPtr< ossimProperty > property)

virtual void	getPropertyNames (std::vector< ossimString > &propertyNames) const

virtual bool	isIndexedData () const

Public Member Functions inherited from ossimSource
	ossimSource (ossimObject *owner=0)

	ossimSource (ossimObject *owner, ossim_uint32 inputListSize, ossim_uint32 outputListSize, bool inputListIsFixedFlag=true, bool outputListIsFixedFlag=true)

virtual	~ossimSource ()

virtual bool	isSourceEnabled () const

virtual void	enableSource ()

virtual void	disableSource ()

virtual bool	getEnableFlag () const

virtual void	setEnableFlag (bool flag)

virtual bool	isInitialized () const

virtual void	setInitializedFlag (bool flag)

virtual std::ostream &	print (std::ostream &out) const
	Outputs theErrorStatus as an ossimErrorCode and an ossimString. More...

Public Member Functions inherited from ossimConnectableObject
	ossimConnectableObject (ossimObject *owner=0)
	Base constructor of this object. More...

	ossimConnectableObject (ossimObject *owner, ossim_int32 inputListSize, ossim_int32 outputListSize, bool inputListIsFixedFlag=true, bool outputListIsFixedFlag=true)

virtual	~ossimConnectableObject ()

void	setId (const ossimId &id)
	All connectable objects will have id's. More...

const ossimId &	getId () const
	Will allow us to get this object's id. More...

const ossimObject *	getOwner () const
	Fetches the current owner, most likely a container but not limited to one. More...

virtual void	changeOwner (ossimObject *owner)
	Permits changing the object's owner. More...

virtual void	setDescription (const ossimString &description)

virtual ossimString	getDescription () const

virtual bool	isConnected (ossimConnectableObjectDirectionType direction=CONNECTABLE_DIRECTION_INPUT) const
	will check the direction specified to see if all slots are full. More...

	OSSIM_DEPRECATE_METHOD (virtual ossimConnectableObject *findConnectableObject(const ossimId &id))

	OSSIM_DEPRECATE_METHOD (virtual ossimConnectableObject *findObjectOfType(RTTItypeid typeId, ossimConnectableObjectDirectionType directionType, bool recurse=true))

	OSSIM_DEPRECATE_METHOD (virtual ossimConnectableObject *findObjectOfType(const ossimString &obj, ossimConnectableObjectDirectionType directionType, bool recurse=true))

	OSSIM_DEPRECATE_METHOD (virtual ossimConnectableObject *findInputObjectOfType(const ossimString &className))

virtual ossim_int32	findInputIndex (const ossimConnectableObject *object)
	Return a valid index of the input list if the passed in object is found else return -1. More...

virtual ossim_int32	findInputIndex (const ossimId &id)
	Return a valid index of the input list if the passed id is found else return -1. More...

virtual ossim_int32	findOutputIndex (const ossimConnectableObject *object)
	Return a valid index of the output list if the passed in object is found else return -1. More...

virtual ossim_int32	findOutputIndex (const ossimId &id)
	Return a valid index of the output list if the passed in object is found else return -1. More...

virtual ossim_int32	getMyInputIndexToConnectTo (ossimConnectableObject *object) const
	Should return the first available index to connect to. More...

virtual ossim_int32	getMyOutputIndexToConnectTo (ossimConnectableObject *object) const
	Should return the first available index to connect to. More...

virtual bool	canConnectMyOutputTo (ossim_int32 myOutputIndex, const ossimConnectableObject *object) const
	default implementation is to allow anyone to connect to us. More...

virtual void	disconnect (ossimConnectableObject *object=0)
	Will disconnect the object passed in. More...

virtual void	disconnect (const ossimId &id)
	Will disconnect the object passed in. More...

virtual ossimRefPtr< ossimConnectableObject >	disconnectMyInput (ossim_int32 inputIndex, bool disconnectOutputFlag=true, bool createEventFlag=true)
	Will disconnect the object at the given input index and generate a connection event. More...

virtual void	disconnectMyInput (ossimConnectableObject *input, bool disconnectOutputFlag=true, bool createEventFlag=true)
	Finds the index of the passed in input and calls disconnectMyInput(inputIndex, disconnectOutputFlag, createEventFlag);. More...

virtual void	disconnectMyInputs (ConnectableObjectList &inputList, bool disconnectOutputFlag=true, bool createEventFlag=true)

virtual ossimRefPtr< ossimConnectableObject >	disconnectMyOutput (ossim_int32 outputIndex, bool disconnectInputFlag=true, bool createEventFlag=true)
	Will disconnect the object at the given output index and generate a connection event. More...

virtual void	disconnectMyOutput (ossimConnectableObject *output, bool disconnectInputFlag=true, bool createEventFlag=true)
	Will disconnect the output object. More...

virtual void	disconnectMyOutputs (ConnectableObjectList &outputList, bool disconnectOutputFlag=true, bool createEventFlag=true)

virtual void	disconnectAllInputs ()
	Will disconnect all of the input objects. More...

virtual void	disconnectAllOutputs ()
	Will disconnect all of the output objects. More...

virtual ossim_int32	connectMyInputTo (ossimConnectableObject *inputObject, bool makeOutputConnection=true, bool createEventFlag=true)
	Will try to connect this objects input to the passed in object. More...

virtual ossim_int32	connectMyInputTo (ossim_int32 inputIndex, ossimConnectableObject *inputObject, bool makeOutputConnection=true, bool createEventFlag=true)
	Will connect the specified input to the passed in object. More...

virtual bool	connectMyInputTo (ConnectableObjectList &inputList, bool makeOutputConnection=true, bool createEventFlag=true)

virtual ossim_int32	connectMyOutputTo (ossimConnectableObject *outputObject, bool makeInputConnection=true, bool createEventFlag=true)
	Will try to connect this objects output to the passed in object. More...

virtual bool	connectMyOutputTo (ConnectableObjectList &outputList, bool makeInputConnection=true, bool createEventFlag=true)

virtual bool	connectInputList (ConnectableObjectList &inputList)
	Will disconnect itself from all inputs and reset to the passed in input list. More...

virtual bool	connectOutputList (ConnectableObjectList &outputList)
	Will disconnect itself from all outputs and reset to the passed in output list. More...

virtual ossim_uint32	getNumberOfInputs () const
	Returns the number of input objects. More...

virtual ossim_uint32	getNumberOfOutputs () const
	Return the number of output objects. More...

ossimConnectableObject *	getInput (ossim_uint32 index=0)
	returns the object at the specified index. More...

const ossimConnectableObject *	getInput (ossim_uint32 index=0) const
	returns the object at the specified index. More...

ossimConnectableObject *	getOutput (ossim_uint32 index=0)
	returns the object at the specified index. More...

const ossimConnectableObject *	getOutput (ossim_uint32 index=0) const
	returns the object at the specified index. More...

virtual void	setNumberOfInputs (ossim_int32 numberOfInputs)
	Will set the number of inputs. More...

virtual bool	getInputListIsFixedFlag () const

virtual bool	getOutputListIsFixedFlag () const

virtual void	setNumberOfOutputs (ossim_int32 numberOfInputs)
	Will set the number of outputs. More...

const ConnectableObjectList &	getInputList () const

const ConnectableObjectList &	getOutputList () const

ConnectableObjectList &	getInputList ()

ConnectableObjectList &	getOutputList ()

	OSSIM_DEPRECATE_METHOD (virtual void findAllObjectsOfType(ConnectableObjectList &result, const RTTItypeid &typeInfo, bool recurse=true))

	OSSIM_DEPRECATE_METHOD (virtual void findAllObjectsOfType(ConnectableObjectList &result, const ossimString &className, bool recurse=true))

virtual void	propagateEventToOutputs (ossimEvent &event)

virtual void	propagateEventToInputs (ossimEvent &event)

virtual void	setProperty (const ossimString &name, const ossimString &value)

virtual ossim_uint32	saveStateOfAllInputs (ossimKeywordlist &kwl, bool saveThisStateFlag=true, ossim_uint32 objectIndex=1, const char *prefix=0) const
	Save the state of all inputs to a keyword list. More...

virtual bool	fillContainer (ossimConnectableContainer &container)
	Inserts this object and all of its children and inputs into the container provided. More...

bool	moveInputUp (const ossimId &id)
	Moves the input connection matching id up one in the connection list. More...

bool	moveInputDown (const ossimId &id)
	Moves the input connection matching id down one in the connection list. More...

bool	moveInputToTop (const ossimId &id)
	Moves the input connection matching id to the top of the connection list. More...

bool	moveInputToBottom (const ossimId &id)
	Moves the input connection matching id to the bottom of the connection list. More...

virtual void	accept (ossimVisitor &visitor)
	We will add a visitor interface for all connectable objects. More...

Public Member Functions inherited from ossimObject
	ossimObject ()

virtual	~ossimObject ()

virtual ossimObject *	dup () const

virtual ossimString	getShortName () const

virtual ossimString	getLongName () const

virtual ossimString	getClassName () const

virtual RTTItypeid	getType () const

virtual bool	canCastTo (ossimObject *obj) const

virtual bool	canCastTo (const RTTItypeid &id) const

virtual bool	canCastTo (const ossimString &parentClassName) const

virtual bool	isEqualTo (const ossimObject &obj, ossimCompareType compareType=OSSIM_COMPARE_FULL) const

Public Member Functions inherited from ossimReferenced
	ossimReferenced ()

	ossimReferenced (const ossimReferenced &)

ossimReferenced &	operator= (const ossimReferenced &)

void	ref () const
	increment the reference count by one, indicating that this object has another pointer which is referencing it. More...

void	unref () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...

void	unref_nodelete () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...

int	referenceCount () const

Public Member Functions inherited from ossimListenerManager
	ossimListenerManager ()

virtual	~ossimListenerManager ()

virtual void	fireEvent (ossimEvent &event)

virtual bool	addListener (ossimListener *listener)

virtual bool	removeListener (ossimListener *listener)

virtual bool	findListener (ossimListener *listener)

Public Member Functions inherited from ossimPropertyInterface
	ossimPropertyInterface ()

virtual	~ossimPropertyInterface ()

virtual ossimString	getPropertyValueAsString (const ossimString &name) const

void	getPropertyList (std::vector< ossimRefPtr< ossimProperty > > &propertyList) const

void	setProperties (std::vector< ossimRefPtr< ossimProperty > > &propertyList)

Public Member Functions inherited from ossimErrorStatusInterface
	ossimErrorStatusInterface ()

virtual	~ossimErrorStatusInterface ()

virtual ossimErrorCode	getErrorStatus () const

virtual ossimString	getErrorStatusString () const

virtual void	setErrorStatus (ossimErrorCode error_status) const

virtual void	setErrorStatus () const

virtual void	clearErrorStatus () const

bool	hasError () const

Public Member Functions inherited from ossimConnectableObjectListener
	ossimConnectableObjectListener ()

virtual	~ossimConnectableObjectListener ()

virtual void	processEvent (ossimEvent &event)
	ProcessEvent. More...

virtual void	objectDestructingEvent (ossimObjectDestructingEvent &)

virtual void	connectionEvent (ossimConnectionEvent &)

virtual void	disconnectOutputEvent (ossimConnectionEvent &)

virtual void	connectOutputEvent (ossimConnectionEvent &)

virtual void	propertyEvent (ossimPropertyEvent &)

virtual void	addObjectEvent (ossimContainerEvent &)

virtual void	removeObjectEvent (ossimContainerEvent &)

virtual void	containerEvent (ossimContainerEvent &)

virtual void	refreshEvent (ossimRefreshEvent &)

Public Member Functions inherited from ossimListener
	ossimListener ()

virtual	~ossimListener ()

void	enableListener ()

void	disableListener ()

void	setListenerEnableFlag (bool flag)

bool	isListenerEnabled () const

bool	getListenerEnableFlag () const

Public Attributes
ossim_uint32	d_maxCacheUsed

ossim_uint32	d_cacheEmptyCount

double	d_idleTime1

double	d_idleTime2

double	d_idleTime3

double	d_idleTime4

double	d_idleTime5

double	d_idleTime6

double	d_jobGetTileT

bool	d_useSharedHandlers

ossim_uint32	d_cacheTileSize

bool	d_useCache

Protected Types
typedef std::map< ossim_uint32, ossimRefPtr< ossimImageData > >	TileCache

Protected Member Functions
void	initJobs ()
	Queues up the optimum amount of jobs given the availability of thread chains and space in the output tile cache. More...

void	setTileInCache (ossim_uint32 tile_id, ossimImageData *tile, ossim_uint32 chain_id, double dt)
	Access method to tile cache with scope lock to avoid multiple threads writing to the cache simultaneously. More...

void	nextJob (ossim_uint32 chain_id)
	Method to job queue with scope lock to avoid multiple threads modifying the queue simultaneously. More...

void	print (ostringstream &msg) const
	For debug – thread-safe console output. More...

Protected Member Functions inherited from ossimImageSourceSequencer
virtual void	updateTileDimensions ()

Protected Member Functions inherited from ossimImageSource
	ossimImageSource (const ossimImageSource &rhs)

const ossimImageSource &	operator= (const ossimImageSource &)

Protected Member Functions inherited from ossimSource
	ossimSource (const ossimSource &rhs)

const ossimSource &	operator= (const ossimSource &rhs)

Protected Member Functions inherited from ossimConnectableObject
ossimConnectableObject *	findObjectOfType (ConnectableObjectList *connectableList, ossimVisitor &visitor)

Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Protected Member Functions inherited from ossimListenerManager
	ossimListenerManager (const ossimListenerManager &rhs)

Protected Attributes
ossimRefPtr< ossimImageChainMtAdaptor >	m_inputChain
	Same as base class' theInputConnection. More...

std::shared_ptr< ossimJobMultiThreadQueue >	m_jobMtQueue

ossim_uint32	m_numThreads

std::shared_ptr< ossimGetTileCallback >	m_callback

ossim_uint32	m_nextTileID
	ID of next tile to be threaded, different from base class' theCurrentTileNumber. More...

TileCache	m_tileCache
	Saves tiles output by threaded jobs. More...

ossim_uint32	m_maxCacheSize

ossim_uint32	m_maxTileCacheFactor

std::mutex	m_cacheMutex

std::mutex	m_jobMutex

ossim_uint32	m_totalNumberOfTiles

ossim::Block	m_getTileBlock

ossim::Block	m_nextJobBlock

std::mutex	d_printMutex

std::mutex	d_timerMutex

bool	d_debugEnabled

ossim_uint32	d_timedBlocksDt

bool	d_timeMetricsEnabled

double	d_t1

Protected Attributes inherited from ossimImageSourceSequencer
ossimImageSource *	theInputConnection

ossimRefPtr< ossimImageData >	theBlankTile

ossimRefPtr< ossimMultiResLevelHistogram >	theHistogram

ossimIrect	theAreaOfInterest

ossimIpt	theTileSize

ossim_int64	theNumberOfTilesHorizontal

ossim_int64	theNumberOfTilesVertical

ossim_int64	theCurrentTileNumber

bool	theCreateHistogram

Protected Attributes inherited from ossimSource
bool	theEnableFlag

bool	theInitializedFlag

Protected Attributes inherited from ossimConnectableObject
ossimId	theId

ossimString	theDescription

ossimObject *	theOwner

bool	theInputListIsFixedFlag
	Indicates whether the theInputObjectList is fixed. More...

bool	theOutputListIsFixedFlag
	Indicates whether the theOutputObjectList is fixed. More...

ConnectableObjectList	theInputObjectList
	Holds a list of input objects. More...

ConnectableObjectList	theOutputObjectList
	Holds a list of output objects. More...

Protected Attributes inherited from ossimListenerManager
std::list< ossimListener * >	theListenerList

bool	theEnabledFlag

std::list< ossimListener * >	theDelayedAdd

std::list< ossimListener * >	theDelayedRemove

bool	theFireEventFlag

Protected Attributes inherited from ossimErrorStatusInterface
ossimErrorCode	theErrorStatus

Protected Attributes inherited from ossimListener
bool	theListenerEnableFlag

Friends
class	ossimGetTileJob

Additional Inherited Members
Public Types inherited from ossimConnectableObject
enum	ossimConnectableObjectDirectionType { CONNECTABLE_DIRECTION_NONE = 0, CONNECTABLE_DIRECTION_INPUT = 1, CONNECTABLE_DIRECTION_OUTPUT = 2 }

typedef std::vector< ossimRefPtr< ossimConnectableObject > >	ConnectableObjectList

Detailed Description

This class manages the sequencing of tile requests across multiple threads.

Note that multi- threading can only be achieved through the use of getNextTile() method for sequencing. Conventional getTiles will not be multi-threaded.

Definition at line 26 of file ossimMultiThreadSequencer.h.

Member Typedef Documentation

◆ TileCache

typedef std::map<ossim_uint32 , ossimRefPtr<ossimImageData> > ossimMultiThreadSequencer::TileCache

protected

Definition at line 75 of file ossimMultiThreadSequencer.h.

Constructor & Destructor Documentation

◆ ossimMultiThreadSequencer()

ossimMultiThreadSequencer::ossimMultiThreadSequencer	(	ossimImageSource *	inputSource = `NULL`,
		ossim_uint32	num_threads = `0`,
		ossimObject *	owner = `NULL`
	)

Definition at line 80 of file ossimMultiThreadSequencer.cpp.

    : ossimImageSourceSequencer(input, owner),
    d_maxCacheUsed(0),
    d_cacheEmptyCount(0), 
    d_idleTime1(0.0),     
    d_idleTime2(0.0),     
    d_idleTime3(0.0),     
    d_idleTime4(0.0),     
    d_idleTime5(0.0),     
    d_idleTime6(0.0),
    d_jobGetTileT(0.0),
    m_inputChain(0),
    m_jobMtQueue(0),
    m_numThreads (num_threads),
    m_callback(std::make_shared<ossimGetTileCallback>()),
    m_nextTileID (0),
    m_tileCache(),                       
    m_maxCacheSize (DEFAULT_MAX_TILE_CACHE_FACTOR * num_threads),
    m_maxTileCacheFactor (DEFAULT_MAX_TILE_CACHE_FACTOR),
    m_cacheMutex(),
    m_jobMutex(),
    m_totalNumberOfTiles(0),
    m_getTileBlock(),
    m_nextJobBlock(),
    d_printMutex(),
    d_timerMutex(),                                 
    d_debugEnabled(false),
    d_timedBlocksDt(0),
    d_timeMetricsEnabled(false),
    d_useSharedHandlers(true),
    d_cacheTileSize(1024),
    d_useCache(true),
    d_t1(0.0)                              
 {
    //###### DEBUG ############
    ossimMtDebug* mt_debug = ossimMtDebug::instance();
    if (mt_debug->maxTileCacheSize != 0)
       m_maxCacheSize =  mt_debug->maxTileCacheSize;
    d_debugEnabled = mt_debug->seqDebugEnabled;
    d_timedBlocksDt = mt_debug->seqTimedBlocksDt;
    d_timeMetricsEnabled = mt_debug->seqMetricsEnabled;
    //###### END DEBUG ############
 
    // The base-class' initialize() method should have been called by the base class constructor
    // unless somebody moved it!
    m_nextJobBlock.release();
    m_getTileBlock.release();
    ossimTimer::instance()->setStartTick();
 }

◆ ~ossimMultiThreadSequencer()

ossimMultiThreadSequencer::~ossimMultiThreadSequencer ( )

virtual

< Same as base class' theInputConnection

Definition at line 135 of file ossimMultiThreadSequencer.cpp.

References m_callback, m_inputChain, and m_jobMtQueue.

 {
    m_inputChain = 0; 
    m_jobMtQueue = 0;
    m_callback.reset();
 }

Member Function Documentation

◆ getNextTile()

ossimRefPtr< ossimImageData > ossimMultiThreadSequencer::getNextTile ( ossim_uint32 resLevel = 0 )

virtual

Overrides base class in order to implement multi-threaded tile requests.

The output tile should be available in the tile cache, otherwise, method waits until it becomes available.

Reimplemented from ossimImageSourceSequencer.

Definition at line 231 of file ossimMultiThreadSequencer.cpp.

References ossim::Block::block(), d_cacheEmptyCount, d_debugEnabled, d_idleTime1, d_idleTime2, d_idleTime3, d_t1, d_timedBlocksDt, d_timeMetricsEnabled, ossimTimer::instance(), m_cacheMutex, m_getTileBlock, m_inputChain, m_nextJobBlock, m_nextTileID, m_tileCache, m_totalNumberOfTiles, print(), ossim::Block::release(), ossim::Block::reset(), setToStartOfSequence(), ossimImageSourceSequencer::theCurrentTileNumber, ossimTimer::time_s(), and ossimRefPtr< T >::valid().

 {
    if (!m_inputChain.valid())
       return NULL;
 
    // May need to initiate the threaded sequencing if not already done:
    if (m_nextTileID == 0)
       setToStartOfSequence();
 
    // Terminate with null return if done:
    ossimRefPtr<ossimImageData> tile = 0;
    if (theCurrentTileNumber >= m_totalNumberOfTiles)
    {
       return tile;
    }
 
    // May need to wait until the corresponding job is finished if the tile is not in the cache:
    TileCache::iterator tile_iter = m_tileCache.begin();
    while (!tile.valid()) 
    {
       // If the tile is not yet copied into the cache, it means the job is still running. Let's 
       // block this thread and let the getTile jobs unlock as they finish. We'll exit this loop
       // when the job of interest finishes.
       if (d_timeMetricsEnabled)
          d_t1 = ossimTimer::instance()->time_s(); 
       m_cacheMutex.lock();
       if (d_timeMetricsEnabled)
          d_idleTime1 += ossimTimer::instance()->time_s() - d_t1; 
 
       // RP - Just grab the first tile for better performance, because order does not matter, we need
       // to process them all
       tile_iter = m_tileCache.begin(); //.find(theCurrentTileNumber);
       m_cacheMutex.unlock();
 
       if (tile_iter == m_tileCache.end())
       {
          if (d_debugEnabled)
          {
             ostringstream s1;
             s1<<"getNextTile() -- Waiting on tile #"<<theCurrentTileNumber;
             m_cacheMutex.lock();
             s1<<"\n   cache size = "<<m_tileCache.size();
             TileCache::iterator iter = m_tileCache.begin();
             while(iter != m_tileCache.end())
             {
                s1<<"\n   cache.tile_id = "<<iter->first;
                iter++;
             }
             m_cacheMutex.unlock();
             print(s1);
          }
 
          if (d_timedBlocksDt > 0)
             m_getTileBlock.block(d_timedBlocksDt); 
          else
          {
             m_getTileBlock.reset();
             if (d_timeMetricsEnabled)
                d_t1 = ossimTimer::instance()->time_s(); 
             m_getTileBlock.block();
             if (d_timeMetricsEnabled)
                d_idleTime2 += ossimTimer::instance()->time_s() - d_t1; 
          }
       }
       else
       {
          // A valid tile was found. Need to assign the output tile and free up the reference in the
          // cache:
          if (d_debugEnabled)
          {
             ostringstream s2;
             s2<<"getNextTile() -- Copying tile #"<<theCurrentTileNumber<<".  Cache size: "<<m_tileCache.size();
             print(s2);
          }
          tile = tile_iter->second;
          
          if (d_timeMetricsEnabled)
             d_t1 = ossimTimer::instance()->time_s(); 
          m_cacheMutex.lock();
          m_tileCache.erase(tile_iter);
          m_cacheMutex.unlock();
          if (d_timeMetricsEnabled)
             d_idleTime3 += ossimTimer::instance()->time_s() - d_t1; 
 
          if (m_tileCache.empty()) 
             ++d_cacheEmptyCount; 
          m_nextJobBlock.release(); // nextJob() may be blocked until cache space is freed
       }
    }
 
    // Advance the caller-requested tile ID. This is different from the last threaded getTile()'s
    // tile index maintained in m_nextTileID and advanced in initNextJob():
    ++theCurrentTileNumber;
    return tile;
 }

◆ getNumberOfThreads()

ossim_uint32 ossimMultiThreadSequencer::getNumberOfThreads ( ) const

inline

Fetches the number of threads being used. Useful when this object decides the quantity.

Definition at line 48 of file ossimMultiThreadSequencer.h.

Referenced by ossimIgen::outputProduct().

48 { return m_numThreads; }

ossimMultiThreadSequencer::m_numThreads

ossim_uint32 m_numThreads

Definition: ossimMultiThreadSequencer.h:129

◆ handlerGetTileT()

double ossimMultiThreadSequencer::handlerGetTileT ( )

Definition at line 465 of file ossimMultiThreadSequencer.cpp.

References ossimImageHandlerMtAdaptor::d_getTileT, m_inputChain, ossimImageChainMtAdaptor::m_sharedHandlers, and ossimRefPtr< T >::valid().

Referenced by ossimIgen::outputProduct().

 {
    if (m_inputChain->m_sharedHandlers.empty())
       return -1.0;
    ossimRefPtr<ossimImageHandlerMtAdaptor> ha = m_inputChain->m_sharedHandlers[0].get();
    if (ha.valid())
       return ha->d_getTileT;
    return -1;
 }

◆ initJobs()

void ossimMultiThreadSequencer::initJobs ( )

protected

Queues up the optimum amount of jobs given the availability of thread chains and space in the output tile cache.

◆ loadState()

bool ossimMultiThreadSequencer::loadState	(	const ossimKeywordlist &	kwl,
		const char *	prefix
	)

virtual

Method to the load (recreate) the state of an object from a keyword list.

Return true if ok or false on error.

Reimplemented from ossimImageSourceSequencer.

Definition at line 475 of file ossimMultiThreadSequencer.cpp.

References ossimKeywordlist::find(), ossimImageSourceSequencer::loadState(), setCacheTileSize(), setNumberOfThreads(), setUseCache(), setUseSharedHandlers(), status, ossimString::toBool(), and ossimString::toUInt32().

 {
    const char* lookup;
    lookup = kwl.find(prefix, "num_threads");
    if(lookup)
    {
       ossim_uint32 num_threads = ossimString(lookup).toUInt32();
       setNumberOfThreads(num_threads);
    }
    lookup = kwl.find(prefix, "use_shared_handlers");
    if(lookup)
    {
       bool use_shared_handlers = ossimString(lookup).toBool();
       setUseSharedHandlers(use_shared_handlers);
    }
    lookup = kwl.find(prefix, "cache_tile_size");
    if(lookup)
    {
       ossim_uint32 cache_tile_size = ossimString(lookup).toUInt32();
       setCacheTileSize(cache_tile_size);
    }
    lookup = kwl.find(prefix, "use_cache");
 
    if(lookup)
    {
       bool use_cache = ossimString(lookup).toBool();
       setUseCache(use_cache);
    }
 
    bool status = ossimImageSourceSequencer::loadState(kwl, prefix);
 
    return status;
 }

◆ maxCacheSize()

ossim_uint32 ossimMultiThreadSequencer::maxCacheSize ( ) const

inline

Accessed for performance logging.

Definition at line 51 of file ossimMultiThreadSequencer.h.

51 { return m_maxCacheSize; }

ossimMultiThreadSequencer::m_maxCacheSize

ossim_uint32 m_maxCacheSize

Definition: ossimMultiThreadSequencer.h:133

◆ nextJob()

void ossimMultiThreadSequencer::nextJob ( ossim_uint32 chain_id )

protected

Method to job queue with scope lock to avoid multiple threads modifying the queue simultaneously.

Definition at line 401 of file ossimMultiThreadSequencer.cpp.

References ossim::Block::block(), d_debugEnabled, d_idleTime5, d_idleTime6, d_t1, d_timedBlocksDt, d_timeMetricsEnabled, ossimTimer::instance(), m_cacheMutex, m_callback, m_jobMtQueue, m_jobMutex, m_maxCacheSize, m_nextJobBlock, m_nextTileID, m_tileCache, m_totalNumberOfTiles, print(), ossim::Block::reset(), and ossimTimer::time_s().

Referenced by ossimMultiThreadSequencer::ossimGetTileJob::run().

 {
    // Check for end of sequence:
    if (m_nextTileID >= m_totalNumberOfTiles)
       return;
 
    while (((ossim_uint32) m_tileCache.size()) >= m_maxCacheSize)
    {
       if (d_debugEnabled)
       {
          m_cacheMutex.lock();
          TileCache::const_iterator iter = m_tileCache.begin();
          ostringstream s1;
          s1<<"THREAD #"<<chain_id<<" -- nextJob() Waiting on cache before queuing tile/job #"
             <<m_nextTileID<<"using chain #"<<chain_id<<". Cache size: "<<m_tileCache.size();
          while(iter != m_tileCache.end())
          {
             s1<<"\n   cache.tile_id = "<<iter->first;
             iter++;
          }
          m_cacheMutex.unlock();
          print(s1);
       }
 
       if (d_timedBlocksDt > 0)
          m_nextJobBlock.block(d_timedBlocksDt);
       else
       {
          m_nextJobBlock.reset();
          if (d_timeMetricsEnabled)
             d_t1 = ossimTimer::instance()->time_s(); 
          m_nextJobBlock.block();
          if (d_timeMetricsEnabled)
          d_idleTime5 += ossimTimer::instance()->time_s() - d_t1; 
       }
    }
 
    if (d_debugEnabled)
    {
       ostringstream s2;
       s2<<"THREAD #"<<chain_id<<" -- nextJob() Queuing tile/job #"<<m_nextTileID;
       print(s2);
    }
 
    // Job queue will receive pointer into ossimRefPtr so no leak here:
    if (d_timeMetricsEnabled)
       d_t1 = ossimTimer::instance()->time_s(); 
    std::lock_guard<std::mutex> lock(m_jobMutex);
    if (d_timeMetricsEnabled)
       d_idleTime6 += ossimTimer::instance()->time_s() - d_t1; 
 
    std::shared_ptr<ossimGetTileJob> job = std::make_shared<ossimGetTileJob>(m_nextTileID++, chain_id, *this);
    job->setCallback(m_callback);
    m_jobMtQueue->getJobQueue()->add(job);
 }

◆ print()

void ossimMultiThreadSequencer::print ( ostringstream & msg ) const

protected

For debug – thread-safe console output.

Definition at line 460 of file ossimMultiThreadSequencer.cpp.

References d_printMutex.

Referenced by getNextTile(), nextJob(), ossimMultiThreadSequencer::ossimGetTileJob::run(), setTileInCache(), and setToStartOfSequence().

 {
    std::lock_guard<std::mutex> lock(d_printMutex);
    cerr << msg.str() << endl;
 }

◆ setCacheTileSize()

void ossimMultiThreadSequencer::setCacheTileSize ( ossim_uint32 cache_tile_size )

Definition at line 353 of file ossimMultiThreadSequencer.cpp.

References d_cacheTileSize, m_inputChain, ossimImageChainMtAdaptor::setCacheTileSize(), and ossimRefPtr< T >::valid().

Referenced by loadState().

 {
    d_cacheTileSize = cache_tile_size;
 
    if (m_inputChain.valid())
       m_inputChain->setCacheTileSize(cache_tile_size);
 }

◆ setNumberOfThreads()

void ossimMultiThreadSequencer::setNumberOfThreads ( ossim_uint32 num_threads )

Specifies number of thread to support.

Default behavior (if this method is never called) is to query the system for number of cores available.

Definition at line 331 of file ossimMultiThreadSequencer.cpp.

References m_inputChain, m_jobMtQueue, m_maxCacheSize, m_maxTileCacheFactor, m_nextTileID, m_numThreads, ossimImageChainMtAdaptor::setNumberOfThreads(), and ossimRefPtr< T >::valid().

Referenced by loadState().

 {
    m_numThreads = num_threads;
    m_maxCacheSize = m_maxTileCacheFactor * m_numThreads;
 
    if (m_inputChain.valid())
       m_inputChain->setNumberOfThreads(num_threads);
 
    if (m_jobMtQueue && m_jobMtQueue->hasJobsToProcess())
       m_jobMtQueue->getJobQueue()->clear();
 
    m_nextTileID = 0; // effectively resets this sequencer
 }

◆ setTileInCache()

void ossimMultiThreadSequencer::setTileInCache	(	ossim_uint32	tile_id,
		ossimImageData *	tile,
		ossim_uint32	chain_id,
		double	dt
	)

protected

Access method to tile cache with scope lock to avoid multiple threads writing to the cache simultaneously.

NOTE: chain_id being passed only for debug. To be removed.

Definition at line 373 of file ossimMultiThreadSequencer.cpp.

References d_debugEnabled, d_idleTime4, d_jobGetTileT, d_maxCacheUsed, d_t1, d_timeMetricsEnabled, ossimTimer::instance(), m_cacheMutex, m_tileCache, print(), and ossimTimer::time_s().

Referenced by ossimMultiThreadSequencer::ossimGetTileJob::run().

 {
    if (d_timeMetricsEnabled)
       d_t1 = ossimTimer::instance()->time_s(); 
    std::lock_guard<std::mutex> lock(m_cacheMutex);
    if (d_timeMetricsEnabled)
       d_idleTime4 += ossimTimer::instance()->time_s() - d_t1; 
 
    d_jobGetTileT += dt;
 
    m_tileCache[tile_id] = tile;
    if (d_debugEnabled)
    {
       ostringstream s2;
       s2<<"THREAD #"<<chain_id<<" -- setTileInCache() Wrote tile #"<<tile_id;
       print(s2);
    }
    if (d_maxCacheUsed < m_tileCache.size())
       d_maxCacheUsed = (ossim_uint32) m_tileCache.size();
 }

◆ setToStartOfSequence()

void ossimMultiThreadSequencer::setToStartOfSequence ( )

virtual

Overrides base class implementation.

Overrides base class in order to implement multi-threaded tile requests.

This call initiates the multi-threaded getTile jobs for the first N tiles.

The base class should have successfully assigned its input:

Reimplemented from ossimImageSourceSequencer.

Definition at line 145 of file ossimMultiThreadSequencer.cpp.

References ossimImageChain::add(), d_cacheTileSize, d_debugEnabled, d_useCache, d_useSharedHandlers, ossimConnectableObject::disconnectAllOutputs(), ossim::getNumberOfThreads(), m_callback, m_inputChain, m_jobMtQueue, m_maxCacheSize, m_maxTileCacheFactor, m_nextTileID, m_numThreads, m_totalNumberOfTiles, print(), ossimImageChainMtAdaptor::setCacheTileSize(), ossimImageChainMtAdaptor::setNumberOfThreads(), ossimImageChainMtAdaptor::setUseCache(), ossimImageChainMtAdaptor::setUseSharedHandlers(), ossimImageSourceSequencer::theCurrentTileNumber, ossimImageSourceSequencer::theInputConnection, ossimImageSourceSequencer::theNumberOfTilesHorizontal, ossimImageSourceSequencer::theNumberOfTilesVertical, and ossimRefPtr< T >::valid().

Referenced by getNextTile().

 {
    // Reset important indices:
    theCurrentTileNumber = 0;
    m_nextTileID = 0;
    m_totalNumberOfTiles = theNumberOfTilesHorizontal * theNumberOfTilesVertical;
 
    if (theInputConnection ==  NULL)
       return;
 
    // Check if this param was already set externally. Query the system capability if not:
    if (m_numThreads == 0)
    {
       m_numThreads = 2 * ossim::getNumberOfThreads();
       m_maxCacheSize = m_maxTileCacheFactor * m_numThreads;
    }
 
    // Adapt the input source to be an ossimImageChainMtAdaptor since we can only work
    // with this type:
    m_inputChain = dynamic_cast<ossimImageChainMtAdaptor*>(theInputConnection);
    if (m_inputChain.valid())
    {
       m_inputChain->setNumberOfThreads(m_numThreads);
       m_inputChain->setUseSharedHandlers(d_useSharedHandlers);
       m_inputChain->setCacheTileSize(d_cacheTileSize);
       m_inputChain->setUseCache(d_useCache);
    }
    else
    {
       // Need to adapt input. First, is it a chain?
       ossimImageChain* chain = dynamic_cast<ossimImageChain*>(theInputConnection);
       if (chain == NULL)
       {
          // The input is just a common image source. Make it a chain:
          chain = new ossimImageChain;
          chain->add(theInputConnection);
       }
 
       // This instantiation creates a set of cloned image chains, one per thread, that will be
       // accessed in parallel for the getTile() operation:
       m_inputChain = new ossimImageChainMtAdaptor(chain, m_numThreads, d_useSharedHandlers, d_useCache, d_cacheTileSize);
    }
 
    // Set the output of the chain to be this sequencer:
    m_inputChain->disconnectAllOutputs();
    //connectMyInputTo(m_inputChain.get());
    //setAreaOfInterest(m_inputChain->getBoundingRect());
 
    for (ossim_uint32 i=0; i<m_numThreads; ++i)
    {
       std::shared_ptr<ossimGetTileJob> job = std::make_shared<ossimGetTileJob>(m_nextTileID++, i, *this);
       job->setCallback(m_callback);
       job->t_launchNewJob = false;
       job->start();
    }
 
    // Set up the job queue and fill it with first N jobs:
    ossim_uint32 num_jobs_to_launch =  min<ossim_uint32>(m_numThreads, m_totalNumberOfTiles);
    std::shared_ptr<ossimJobQueue> jobQueue = std::make_shared<ossimJobQueue>();
    for (ossim_uint32 chain_id=0; chain_id<num_jobs_to_launch; ++chain_id)
    {
       if (d_debugEnabled)
       {
          ostringstream s;
          s<<"setToStartOfSequence() -- Creating tile/job #"<<m_nextTileID;
          print(s);
       }
 
       std::shared_ptr<ossimGetTileJob> job = std::make_shared<ossimGetTileJob>(m_nextTileID++, chain_id, *this);
       job->setCallback(m_callback);
       jobQueue->add(job, false);
    }
 
    // Initialize the multi-thread queue. Note the setJobQueue is done after construction as it was 
    // crashing do to jobs being launched during init:
    m_jobMtQueue = std::make_shared<ossimJobMultiThreadQueue>(nullptr, num_jobs_to_launch);
    m_jobMtQueue->setJobQueue(jobQueue);
 }

◆ setUseCache()

void ossimMultiThreadSequencer::setUseCache ( bool use_cache )

Definition at line 361 of file ossimMultiThreadSequencer.cpp.

References d_useCache, m_inputChain, ossimImageChainMtAdaptor::setUseCache(), and ossimRefPtr< T >::valid().

Referenced by loadState().

 {
    d_useCache = use_cache;
 
    if (m_inputChain.valid())
       m_inputChain->setUseCache(use_cache);
 }

◆ setUseSharedHandlers()

void ossimMultiThreadSequencer::setUseSharedHandlers ( bool use_shared_handlers )

Definition at line 345 of file ossimMultiThreadSequencer.cpp.

References d_useSharedHandlers, m_inputChain, ossimImageChainMtAdaptor::setUseSharedHandlers(), and ossimRefPtr< T >::valid().

Referenced by loadState().

 {
    d_useSharedHandlers = use_shared_handlers;
 
    if (m_inputChain.valid())
       m_inputChain->setUseSharedHandlers(use_shared_handlers);
 }

Friends And Related Function Documentation

◆ ossimGetTileJob

friend class ossimGetTileJob

friend

Definition at line 97 of file ossimMultiThreadSequencer.h.

Member Data Documentation

◆ d_cacheEmptyCount

ossim_uint32 ossimMultiThreadSequencer::d_cacheEmptyCount

Definition at line 59 of file ossimMultiThreadSequencer.h.

Referenced by getNextTile(), and ossimIgen::outputProduct().

◆ d_cacheTileSize

ossim_uint32 ossimMultiThreadSequencer::d_cacheTileSize

Definition at line 69 of file ossimMultiThreadSequencer.h.

Referenced by setCacheTileSize(), and setToStartOfSequence().

◆ d_debugEnabled

bool ossimMultiThreadSequencer::d_debugEnabled

protected

Definition at line 144 of file ossimMultiThreadSequencer.h.

Referenced by getNextTile(), nextJob(), ossimMultiThreadSequencer::ossimGetTileJob::run(), setTileInCache(), and setToStartOfSequence().

◆ d_idleTime1

double ossimMultiThreadSequencer::d_idleTime1

Definition at line 60 of file ossimMultiThreadSequencer.h.

Referenced by getNextTile().

◆ d_idleTime2

double ossimMultiThreadSequencer::d_idleTime2

Definition at line 61 of file ossimMultiThreadSequencer.h.

Referenced by getNextTile(), and ossimIgen::outputProduct().

◆ d_idleTime3

double ossimMultiThreadSequencer::d_idleTime3

Definition at line 62 of file ossimMultiThreadSequencer.h.

Referenced by getNextTile().

◆ d_idleTime4

double ossimMultiThreadSequencer::d_idleTime4

Definition at line 63 of file ossimMultiThreadSequencer.h.

Referenced by setTileInCache().

◆ d_idleTime5

double ossimMultiThreadSequencer::d_idleTime5

Definition at line 64 of file ossimMultiThreadSequencer.h.

Referenced by nextJob(), and ossimIgen::outputProduct().

◆ d_idleTime6

double ossimMultiThreadSequencer::d_idleTime6

Definition at line 65 of file ossimMultiThreadSequencer.h.

Referenced by nextJob().

◆ d_jobGetTileT

double ossimMultiThreadSequencer::d_jobGetTileT

Definition at line 66 of file ossimMultiThreadSequencer.h.

Referenced by ossimIgen::outputProduct(), and setTileInCache().

◆ d_maxCacheUsed

ossim_uint32 ossimMultiThreadSequencer::d_maxCacheUsed

Definition at line 58 of file ossimMultiThreadSequencer.h.

Referenced by ossimIgen::outputProduct(), and setTileInCache().

◆ d_printMutex

std::mutex ossimMultiThreadSequencer::d_printMutex

mutableprotected

Definition at line 142 of file ossimMultiThreadSequencer.h.

Referenced by print().

◆ d_t1

double ossimMultiThreadSequencer::d_t1

protected

Definition at line 147 of file ossimMultiThreadSequencer.h.

Referenced by getNextTile(), nextJob(), and setTileInCache().

◆ d_timedBlocksDt

ossim_uint32 ossimMultiThreadSequencer::d_timedBlocksDt

protected

Definition at line 145 of file ossimMultiThreadSequencer.h.

Referenced by getNextTile(), and nextJob().

◆ d_timeMetricsEnabled

bool ossimMultiThreadSequencer::d_timeMetricsEnabled

protected

Definition at line 146 of file ossimMultiThreadSequencer.h.

Referenced by getNextTile(), nextJob(), and setTileInCache().

◆ d_timerMutex

std::mutex ossimMultiThreadSequencer::d_timerMutex

mutableprotected

Definition at line 143 of file ossimMultiThreadSequencer.h.

◆ d_useCache

bool ossimMultiThreadSequencer::d_useCache

Definition at line 70 of file ossimMultiThreadSequencer.h.

Referenced by setToStartOfSequence(), and setUseCache().

◆ d_useSharedHandlers

bool ossimMultiThreadSequencer::d_useSharedHandlers

Definition at line 68 of file ossimMultiThreadSequencer.h.

Referenced by setToStartOfSequence(), and setUseSharedHandlers().

◆ m_cacheMutex

std::mutex ossimMultiThreadSequencer::m_cacheMutex

mutableprotected

Definition at line 135 of file ossimMultiThreadSequencer.h.

Referenced by getNextTile(), nextJob(), and setTileInCache().

◆ m_callback

std::shared_ptr<ossimGetTileCallback> ossimMultiThreadSequencer::m_callback

protected

Definition at line 130 of file ossimMultiThreadSequencer.h.

Referenced by nextJob(), setToStartOfSequence(), and ~ossimMultiThreadSequencer().

◆ m_getTileBlock

ossim::Block ossimMultiThreadSequencer::m_getTileBlock

protected

Definition at line 138 of file ossimMultiThreadSequencer.h.

Referenced by getNextTile(), and ossimMultiThreadSequencer::ossimGetTileJob::run().

◆ m_inputChain

ossimRefPtr<ossimImageChainMtAdaptor> ossimMultiThreadSequencer::m_inputChain

protected

Same as base class' theInputConnection.

Definition at line 127 of file ossimMultiThreadSequencer.h.

Referenced by getNextTile(), handlerGetTileT(), ossimMultiThreadSequencer::ossimGetTileJob::run(), setCacheTileSize(), setNumberOfThreads(), setToStartOfSequence(), setUseCache(), setUseSharedHandlers(), and ~ossimMultiThreadSequencer().

◆ m_jobMtQueue

std::shared_ptr<ossimJobMultiThreadQueue> ossimMultiThreadSequencer::m_jobMtQueue

protected

Definition at line 128 of file ossimMultiThreadSequencer.h.

Referenced by nextJob(), setNumberOfThreads(), setToStartOfSequence(), and ~ossimMultiThreadSequencer().

◆ m_jobMutex

std::mutex ossimMultiThreadSequencer::m_jobMutex

mutableprotected

Definition at line 136 of file ossimMultiThreadSequencer.h.

Referenced by nextJob().

◆ m_maxCacheSize

ossim_uint32 ossimMultiThreadSequencer::m_maxCacheSize

protected

Definition at line 133 of file ossimMultiThreadSequencer.h.

Referenced by nextJob(), setNumberOfThreads(), and setToStartOfSequence().

◆ m_maxTileCacheFactor

ossim_uint32 ossimMultiThreadSequencer::m_maxTileCacheFactor

protected

Definition at line 134 of file ossimMultiThreadSequencer.h.

Referenced by setNumberOfThreads(), and setToStartOfSequence().

◆ m_nextJobBlock

ossim::Block ossimMultiThreadSequencer::m_nextJobBlock

protected

Definition at line 139 of file ossimMultiThreadSequencer.h.

Referenced by getNextTile(), and nextJob().

◆ m_nextTileID

ossim_uint32 ossimMultiThreadSequencer::m_nextTileID

protected

ID of next tile to be threaded, different from base class' theCurrentTileNumber.

Definition at line 131 of file ossimMultiThreadSequencer.h.

Referenced by getNextTile(), nextJob(), setNumberOfThreads(), and setToStartOfSequence().

◆ m_numThreads

ossim_uint32 ossimMultiThreadSequencer::m_numThreads

protected

Definition at line 129 of file ossimMultiThreadSequencer.h.

Referenced by setNumberOfThreads(), and setToStartOfSequence().

◆ m_tileCache

TileCache ossimMultiThreadSequencer::m_tileCache

protected

Saves tiles output by threaded jobs.

Definition at line 132 of file ossimMultiThreadSequencer.h.

Referenced by getNextTile(), nextJob(), and setTileInCache().

◆ m_totalNumberOfTiles

ossim_uint32 ossimMultiThreadSequencer::m_totalNumberOfTiles

protected

Definition at line 137 of file ossimMultiThreadSequencer.h.

Referenced by getNextTile(), nextJob(), and setToStartOfSequence().

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

Classes

Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ TileCache

Constructor & Destructor Documentation

◆ ossimMultiThreadSequencer()

◆ ~ossimMultiThreadSequencer()

Member Function Documentation

◆ getNextTile()

◆ getNumberOfThreads()

◆ handlerGetTileT()

◆ initJobs()

◆ loadState()

◆ maxCacheSize()

◆ nextJob()

◆ print()

◆ setCacheTileSize()

◆ setNumberOfThreads()

◆ setTileInCache()

◆ setToStartOfSequence()

◆ setUseCache()

◆ setUseSharedHandlers()

Friends And Related Function Documentation

◆ ossimGetTileJob

Member Data Documentation

◆ d_cacheEmptyCount

◆ d_cacheTileSize

◆ d_debugEnabled

◆ d_idleTime1

◆ d_idleTime2

◆ d_idleTime3

◆ d_idleTime4

◆ d_idleTime5

◆ d_idleTime6

◆ d_jobGetTileT

◆ d_maxCacheUsed

◆ d_printMutex

◆ d_t1

◆ d_timedBlocksDt

◆ d_timeMetricsEnabled

◆ d_timerMutex

◆ d_useCache

◆ d_useSharedHandlers

◆ m_cacheMutex

◆ m_callback

◆ m_getTileBlock

◆ m_inputChain

◆ m_jobMtQueue

◆ m_jobMutex

◆ m_maxCacheSize

◆ m_maxTileCacheFactor

◆ m_nextJobBlock

◆ m_nextTileID

◆ m_numThreads

◆ m_tileCache

◆ m_totalNumberOfTiles