Class holding a chunk data. More...

Public Types

enum  kChunksStatus {
  kChunkStatusOnHold = 0x01, kChunkStatusSubmitted = 0x02, kChunkStatusCompleted = 0x04, kChunkStatusWarning = 0x08,
  kChunkStatusError = 0x10
}
 Chunk status enumeration. More...
 

Public Member Functions

virtual const std::string getBorrowedInstances ()
 
virtual float getByFrame ()
 
virtual long getChunkId ()
 
virtual const std::string getDependFromChunks ()
 
virtual const std::string getDependFromChunksErrorLevels ()
 
virtual long long int getElapsed ()
 
virtual float getEndFrame ()
 
virtual long long int getEndTime ()
 
virtual const std::vector< MClientLib::MTextFileMarkergetErrorMarkers ()
 
virtual int getExitCode ()
 
virtual int getFrameStart ()
 
virtual int getFrameStep ()
 
virtual long getId ()
 
virtual bool getIsAssembler ()
 
virtual long getJobId ()
 
virtual int getPacketType ()
 
virtual int getPlatform ()
 
virtual int getPriority ()
 
virtual const std::string getRenderedBy ()
 
virtual int getRequeued ()
 
virtual const std::string getResult ()
 
virtual bool getSelectedForEmergency ()
 
virtual const std::vector< MClientLib::MTextFileMarkergetSilencedErrorMarkers ()
 
virtual const std::vector< MClientLib::MTextFileMarkergetSilencedWarningMarkers ()
 
virtual float getStartFrame ()
 
virtual long long int getStartTime ()
 
virtual int getStatus ()
 
virtual const std::string getTask ()
 
virtual long long int getUpdateTime ()
 
virtual const std::vector< MClientLib::MTextFileMarkergetWarningMarkers ()
 
 MChunk ()
 
 MChunk (const MChunk &ref)
 
virtual const std::vector< long > numberedFrames ()
 
virtual const std::vector< float > rangeFrames ()
 
virtual void setBorrowedInstances (const std::string &_borrowedInstances)
 
virtual void setByFrame (float _byFrame)
 
virtual void setChunkId (long _chunkId)
 
virtual void setDependFromChunks (const std::string &_depends)
 
virtual void setDependFromChunksErrorLevels (const std::string &_depends)
 
virtual void setElapsed (long long int _elapsed)
 
virtual void setEndFrame (float _endFrame)
 
virtual void setEndTime (long long int endingTime)
 
virtual void setErrorMarkers (const std::vector< MClientLib::MTextFileMarker > &_errorMarkers)
 
virtual void setExitCode (int _exitCode)
 
virtual void setFrameStart (int _frameStart)
 
virtual void setFrameStep (int _frameStep)
 
virtual void setId (long _id)
 
virtual void setIsAssembler (bool _isAssembler)
 
virtual void setJobId (long _jobId)
 
virtual void setPacketType (int _packetType)
 
virtual void setPlatform (int _platform)
 
virtual void setPriority (int _priority)
 
virtual void setRenderedBy (const std::string &_renderedBy)
 
virtual void setRequeued (int _requeued)
 
virtual void setResult (const std::string &_result)
 
virtual void setSelectedForEmergency (bool _selectedForEmergency)
 
virtual void setSilencedErrorMarkers (const std::vector< MClientLib::MTextFileMarker > &_errorMarkers)
 
virtual void setSilencedWarningMarkers (const std::vector< MClientLib::MTextFileMarker > &_warningMarkers)
 
virtual void setStartFrame (float _startFrame)
 
virtual void setStartTime (long long int startingTime)
 
virtual void setStatus (int _status)
 
virtual void setTask (const std::string &_task)
 
virtual void setUpdateTime (long long int _updateTime)
 
virtual void setWarningMarkers (const std::vector< MClientLib::MTextFileMarker > &_warningMarkers)
 
virtual ~MChunk ()
 

Detailed Description

Class holding a chunk data.

Holds data related to a chunk

Definition at line 64 of file MChunk.h.

Constructor & Destructor Documentation

MChunk ( )

Default constructor

MChunk ( const MChunk ref)

Copy constructor

Parameters
[in]refReference to the chunk to be copied from
virtual ~MChunk ( )
virtual

Default destructor

Member Function Documentation

virtual const std::string getBorrowedInstances ( )
virtual
Returns
a comma separated list of instances borrowed by this chunk
virtual float getByFrame ( )
virtual
Returns
the chunk frames jump
virtual long getChunkId ( )
virtual
Returns
the chunk ID
virtual const std::string getDependFromChunks ( )
virtual
Returns
a comma separated list of chunk's dependancies
virtual const std::string getDependFromChunksErrorLevels ( )
virtual
Returns
a comma separated list of chunk's dependancies error levels
virtual long long int getElapsed ( )
virtual
Returns
the total chunk elapsed time
virtual float getEndFrame ( )
virtual
Returns
the chunk ending frame
virtual long long int getEndTime ( )
virtual
Returns
the chunk processing ending time, may be 0
virtual const std::vector<MClientLib::MTextFileMarker> getErrorMarkers ( )
virtual
Returns
the errors markers of the completed chunk
virtual int getExitCode ( )
virtual
Returns
the chunk's result exit code
virtual int getFrameStart ( )
virtual
Returns
the chunk frames numbering
virtual int getFrameStep ( )
virtual
Returns
the chunk frames numbering step
virtual long getId ( )
virtual
Returns
the chunk absolute ID
virtual bool getIsAssembler ( )
virtual
Returns
the assembler flag of the chunk
virtual long getJobId ( )
virtual
Returns
the parent Job ID
virtual int getPacketType ( )
virtual
Returns
the chunk packet type
virtual int getPlatform ( )
virtual
Returns
the platform of the node that processed the chunk
virtual int getPriority ( )
virtual
Returns
the chunk priority
virtual const std::string getRenderedBy ( )
virtual
Returns
the instance name that processed the chunk
virtual int getRequeued ( )
virtual
Returns
the number of times the chunk has been requeued
virtual const std::string getResult ( )
virtual
Returns
the chunk string result
virtual bool getSelectedForEmergency ( )
virtual
Returns
if the chunk is selected for emergency queue on next pass - INTERNAL USE ONLY
virtual const std::vector<MClientLib::MTextFileMarker> getSilencedErrorMarkers ( )
virtual
Returns
the silenced errors markers of the completed chunk
virtual const std::vector<MClientLib::MTextFileMarker> getSilencedWarningMarkers ( )
virtual
Returns
the silenced warnings markers of the completed chunk
virtual float getStartFrame ( )
virtual
Returns
the chunk starting frame
virtual long long int getStartTime ( )
virtual
Returns
the chunk processing starting time, may be 0
virtual int getStatus ( )
virtual
Returns
the chunk status code, uses kChunksStatus enumeration
virtual const std::string getTask ( )
virtual
Returns
the task name associated with the chunk
virtual long long int getUpdateTime ( )
virtual
Returns
the last time the chunk has been updated
virtual const std::vector<MClientLib::MTextFileMarker> getWarningMarkers ( )
virtual
Returns
the warnings markers of the completed chunk
virtual const std::vector<long> numberedFrames ( )
virtual
Returns
a list of the total frames belonging to the chunk including numbering applied
virtual const std::vector<float> rangeFrames ( )
virtual
Returns
a list of the total frames belonging to the chunk without numbering applied
virtual void setBorrowedInstances ( const std::string &  _borrowedInstances)
virtual

Sets the instances borrowed by this chunk

Parameters
[in]_borrowedInstancesThe list of instances borrowed by this chunk
virtual void setByFrame ( float  _byFrame)
virtual

Sets the chunk frames jump

Parameters
[in]_byFrameThe chunk by frame
virtual void setChunkId ( long  _chunkId)
virtual

Sets the chunk ID relative to the parent job

Parameters
[in]_chunkIdThe chunk ID relative to the parent job
virtual void setDependFromChunks ( const std::string &  _depends)
virtual

Sets a comma separated list of chunk's ID to depend from

Parameters
[in]_dependsThe chunk dependances comma separated
virtual void setDependFromChunksErrorLevels ( const std::string &  _depends)
virtual

Sets a comma separated list of error levels related to dependant chunks

Parameters
[in]_dependsThe chunk error levels comma separated
virtual void setElapsed ( long long int  _elapsed)
virtual

Sets the total chunk elapsed time

Parameters
[in]_elapsedThe chunk elapsed time
virtual void setEndFrame ( float  _endFrame)
virtual

Sets the chunk ending frame

Parameters
[in]_endFrameThe chunk end frame
virtual void setEndTime ( long long int  endingTime)
virtual

Sets the chunk processing ending time, may be 0

Parameters
[in]endingTimeThe chunk end time
virtual void setErrorMarkers ( const std::vector< MClientLib::MTextFileMarker > &  _errorMarkers)
virtual

Sets the errors markers of the completed chunk

Parameters
[in]_errorMarkersThe error markers for a completed chunk
virtual void setExitCode ( int  _exitCode)
virtual

Sets the process exit code

Parameters
[in]_exitCodeProcess exit code
virtual void setFrameStart ( int  _frameStart)
virtual

Sets the chunk frames numbering

Parameters
[in]_frameStartThe chunk frame numbering
virtual void setFrameStep ( int  _frameStep)
virtual

Sets the chunk frames numbering step

Parameters
[in]_frameStepThe chunk frame numbering step
virtual void setId ( long  _id)
virtual

Sets the chunk absolute ID

Parameters
[in]_idThe chunk absolute ID
virtual void setIsAssembler ( bool  _isAssembler)
virtual

Sets the assembler flag of the chunk

Parameters
[in]_isAssemblerThe chunk assembler flag
virtual void setJobId ( long  _jobId)
virtual

Sets the parent Job ID

Parameters
[in]_jobIdThe chunk parent job ID
virtual void setPacketType ( int  _packetType)
virtual

Sets the chunk packet type

Parameters
[in]_packetTypeThe chunk packet type
virtual void setPlatform ( int  _platform)
virtual

Sets the platform enumeration for a processed chunk

Parameters
[in]_platformPlatform enumeration
virtual void setPriority ( int  _priority)
virtual

Sets the chunk priority

Parameters
[in]_priorityThe chunk priority
virtual void setRenderedBy ( const std::string &  _renderedBy)
virtual

Sets the node name that processed the chunk

Parameters
[in]_renderedByThe chunk rendering node name
virtual void setRequeued ( int  _requeued)
virtual

Sets the number of times the chunk has been requeued

Parameters
[in]_requeuedThe chunk requeue count
virtual void setResult ( const std::string &  _result)
virtual

Sets the chunk string result

Parameters
[in]_resultThe chunk result
virtual void setSelectedForEmergency ( bool  _selectedForEmergency)
virtual

Sets the chunk as selected for emergency queue on next pass - INTERNAL USE ONLY

Parameters
[in]_selectedForEmergencyThe chunk emergency state
virtual void setSilencedErrorMarkers ( const std::vector< MClientLib::MTextFileMarker > &  _errorMarkers)
virtual

Sets the silenced errors markers of the completed chunk

Parameters
[in]_errorMarkersThe silenced error markers for a completed chunk
virtual void setSilencedWarningMarkers ( const std::vector< MClientLib::MTextFileMarker > &  _warningMarkers)
virtual

Sets the silenced warnings markers of the completed chunk

Parameters
[in]_warningMarkersThe silenced warning markers for a completed chunk
virtual void setStartFrame ( float  _startFrame)
virtual

Sets the chunk starting frame

Parameters
[in]_startFrameThe chunk start frame
virtual void setStartTime ( long long int  startingTime)
virtual

Sets the chunk processing starting time, may be 0

Parameters
[in]startingTimeThe chunk start time
virtual void setStatus ( int  _status)
virtual

Sets the chunk status code, uses kChunksStatus enumeration

Parameters
[in]_statusThe chunk status
virtual void setTask ( const std::string &  _task)
virtual

Sets the task name that associated with chunk

Parameters
[in]_taskThe chunk task name
virtual void setUpdateTime ( long long int  _updateTime)
virtual

Sets the last time the chunk has been updated

Parameters
[in]_updateTimeThe chunk update time
virtual void setWarningMarkers ( const std::vector< MClientLib::MTextFileMarker > &  _warningMarkers)
virtual

Sets the warnings markers of the completed chunk

Parameters
[in]_warningMarkersThe warning markers for a completed chunk

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