MClientLib::MChunk Class Reference

#include <MChunk.h>

Public Types
enum	kChunksStatus {   kChunkStatusOnHold = 0x01, kChunkStatusSubmitted = 0x02, kChunkStatusCompleted = 0x04, kChunkStatusWarning = 0x08,   kChunkStatusError = 0x10 }

Public Member Functions
	MChunk ()
virtual	~MChunk ()
virtual long	getId ()
virtual long	getJobId ()
virtual long	getChunkId ()
virtual int	getStatus ()
virtual int	getRequeued ()
virtual float	getStartFrame ()
virtual float	getEndFrame ()
virtual float	getByFrame ()
virtual int	getFrameStart ()
virtual int	getFrameStep ()
virtual long long int	getEndingTime ()
virtual long long int	getStartingTime ()
virtual std::string	getResult ()
virtual std::string	getRenderedBy ()
virtual long long int	getElapsed ()
virtual long long int	getUpdateTime ()
virtual bool	getIsAssembler ()
virtual void	setId (long _id)
virtual void	setJobId (long _jobId)
virtual void	setChunkId (long _chunkId)
virtual void	setStatus (int _status)
virtual void	setRequeued (int _requeued)
virtual void	setStartFrame (float _startFrame)
virtual void	setEndFrame (float _endFrame)
virtual void	setByFrame (float _byFrame)
virtual void	setFrameStart (int _frameStart)
virtual void	setFrameStep (int _frameStep)
virtual void	setEndingTime (long long int endingTime)
virtual void	setStartingTime (long long int startingTime)
virtual void	setResult (const std::string &_result)
virtual void	setRenderedBy (const std::string &_renderedBy)
virtual void	setElapsed (long long int _elapsed)
virtual void	setUpdateTime (long long int _updateTime)
virtual void	setIsAssembler (bool _isAssembler)
virtual bool	Unmarshall (std::vector< std::string > &items)
virtual bool	Unmarshall (const char *data)
virtual std::string	Marshall ()

Detailed Description

MChunk class that holds a chunk data

Holds data related to a chunk

Member Enumeration Documentation

enum MClientLib::MChunk::kChunksStatus

Chunk status enumeration

Enumerates the status of a chunk

Enumerator
kChunkStatusOnHold	The chunk is on hold waiting to be processed
kChunkStatusSubmitted	The chunk has been submitted and is currently being processed
kChunkStatusCompleted	The chunk has been processed successfully
kChunkStatusWarning	The chunk has been processed with at least a warning
kChunkStatusError	The chunk has been processed with at least an error

Constructor & Destructor Documentation

MClientLib::MChunk::MChunk

(

)

virtual MClientLib::MChunk::~MChunk ( )

virtual

Member Function Documentation

virtual float MClientLib::MChunk::getByFrame ( )

virtual

Returns the chunk frames jump

virtual long MClientLib::MChunk::getChunkId ( )

virtual

Returns the chunk ID

virtual long long int MClientLib::MChunk::getElapsed ( )

virtual

Returns the total chunk elapsed time

virtual float MClientLib::MChunk::getEndFrame ( )

virtual

Returns the chunk ending frame

virtual long long int MClientLib::MChunk::getEndingTime ( )

virtual

Returns the chunk processing ending time, may be 0

virtual int MClientLib::MChunk::getFrameStart ( )

virtual

Returns the chunk frames numbering

virtual int MClientLib::MChunk::getFrameStep ( )

virtual

Returns the chunk frames numbering step

virtual long MClientLib::MChunk::getId ( )

virtual

Returns the chunk absolute ID

virtual bool MClientLib::MChunk::getIsAssembler ( )

virtual

Returns the assembler flag of the chunk

virtual long MClientLib::MChunk::getJobId ( )

virtual

Returns the parent Job ID

virtual std::string MClientLib::MChunk::getRenderedBy ( )

virtual

Returns the instance name that processed the chunk

virtual int MClientLib::MChunk::getRequeued ( )

virtual

Returns the number of times the chunk has been requeued

virtual std::string MClientLib::MChunk::getResult ( )

virtual

Returns the chunk string result

virtual float MClientLib::MChunk::getStartFrame ( )

virtual

Returns the chunk starting frame

virtual long long int MClientLib::MChunk::getStartingTime ( )

virtual

Returns the chunk processing starting time, may be 0

virtual int MClientLib::MChunk::getStatus ( )

virtual

Returns the chunk status code, uses kChunksStatus enumeration

virtual long long int MClientLib::MChunk::getUpdateTime ( )

virtual

Returns the last time the chunk has been updated

virtual std::string MClientLib::MChunk::Marshall ( )

virtual

Encodes a chunk into a string stream

virtual void MClientLib::MChunk::setByFrame ( float  _byFrame )

virtual

Sets the chunk frames jump

virtual void MClientLib::MChunk::setChunkId ( long  _chunkId )

virtual

Sets the chunk ID

virtual void MClientLib::MChunk::setElapsed ( long long int  _elapsed )

virtual

Sets the total chunk elapsed time

virtual void MClientLib::MChunk::setEndFrame ( float  _endFrame )

virtual

Sets the chunk ending frame

virtual void MClientLib::MChunk::setEndingTime ( long long int  endingTime )

virtual

Sets the chunk processing ending time, may be 0

virtual void MClientLib::MChunk::setFrameStart ( int  _frameStart )

virtual

Sets the chunk frames numbering

virtual void MClientLib::MChunk::setFrameStep ( int  _frameStep )

virtual

Sets the chunk frames numbering step

virtual void MClientLib::MChunk::setId ( long  _id )

virtual

Sets the chunk absolute ID

virtual void MClientLib::MChunk::setIsAssembler ( bool  _isAssembler )

virtual

Sets the assembler flag of the chunk

virtual void MClientLib::MChunk::setJobId ( long  _jobId )

virtual

Sets the parent Job ID

virtual void MClientLib::MChunk::setRenderedBy ( const std::string &  _renderedBy )

virtual

Sets the instance name that processed the chunk

virtual void MClientLib::MChunk::setRequeued ( int  _requeued )

virtual

Sets the number of times the chunk has been requeued

virtual void MClientLib::MChunk::setResult ( const std::string &  _result )

virtual

Sets the chunk string result

virtual void MClientLib::MChunk::setStartFrame ( float  _startFrame )

virtual

Sets the chunk starting frame

virtual void MClientLib::MChunk::setStartingTime ( long long int  startingTime )

virtual

Sets the chunk processing starting time, may be 0

virtual void MClientLib::MChunk::setStatus ( int  _status )

virtual

Sets the chunk status code, uses kChunksStatus enumeration

virtual void MClientLib::MChunk::setUpdateTime ( long long int  _updateTime )

virtual

Sets the last time the chunk has been updated

virtual bool MClientLib::MChunk::Unmarshall ( std::vector< std::string > &  items )

virtual

Decodes a chunk from a vector of strings

virtual bool MClientLib::MChunk::Unmarshall ( const char *  data )

virtual

Decodes a chunk from a stream.Expects an unique string separater by carriage returns as produced by Marshall()

---

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

• C:/Users/leo/Documents/Muster8/sdk/includes/MClientLib/MChunk.h