Public Types | Public Member Functions | Protected Attributes
MJob Class Reference
MClientLib classes

Class holding a job data structure. More...

Public Types

enum  kErrorChecksType { kDefaultErrorCheck, kSkipWarnings, kSkipErrors, kSkipBoth }
 Job error check type enumeration. More...
 
enum  kFramesCheckFileMode { kFramesCheckFileNone, kFramesCheckFileSize, kFramesCheckFileBoundaries }
 Job frames check file check enumeration. More...
 
enum  kFramesCheckMode { kFramesCheckNone, kFramesCheckJob, kFramesCheckChunk }
 Job frames check mode enumeration. More...
 
enum  kJobsBackupAction { kJobsBackupActionNone = 0x00, kJobsBackupActionOverwriteExistings = 0x01, kJobsBackupActionDuplicateEntry = 0x02 }
 Job backup restore operation action modes enumeration. More...
 
enum  kJobsBackupRestoreAction {
  kJobsBackupRestoreActionNone = 0x00, kJobsBackupRestoreActionOverwriteExistings = 0x01, kJobsBackupRestoreActionDuplicateEntry = 0x02, kJobsBackupRestoreActionRestoreParents = 0x04,
  kJobsBackupRestoreActionReparent = 0x08
}
 Job backup restore action enumeration. More...
 
enum  kJobsBackupRestoreState { kJobsBackupRestoreNone, kJobsBackupRestoreObjectsExist = 0x01, kJobsBackupRestoreMissingParents = 0x02 }
 Job backup restore operation conflicts enumeration. More...
 
enum  kJobsBackupStates { kJobsBackupStatesNone = 0x00, kJobsBackupStatesObjectExist = 0x01 }
 Job backup conflic state enumeration. More...
 
enum  kJobsChunksPrioritiesType {
  kRampingDown, kRampingUp, kCenterUp, kCenterDown,
  kInterleavedDown, kInterleavedUp
}
 Job chunks priority mode enumeration. More...
 
enum  kJobsCompletationStatus {
  kJobCompletionStatusSuccessfull, kJobCompletionStatusProcessStartingError, kJobCompletionStatusLogParsingWarning, kJobCompletionStatusLogParsingError,
  kJobCompletionStatusExitCodeWarning, kJobCompletionStatusExitCodeError, kJobCompletionStatusPreChunkActionError, kJobCompletionStatusPostChunkActionError
}
 Job completion status enumeration. More...
 
enum  kJobsDependLinkMode { kJobDependLinkOnJob = 0, kJobDependLinkOnChunks }
 Job dependancies link mode enumeration. More...
 
enum  kJobsDependMode { kJobDependUncompleted = -1, kJobDependSuccess, kJobDependWarnings, kJobDependErrors }
 Job dependancies type enumeration. More...
 
enum  kJobsNotificationsType { kNotificationsDisabled, kNotificationsOnComplete, kNotificationsOnWarning, kNotificationsOnError }
 Job notifications type enumeration. More...
 
enum  kJobsStatus {
  kJobStatusOnQueue = 0x01, kJobStatusStarted = 0x02, kJobStatusInprogressWarnings = 0x04, kJobStatusInprogressErrors = 0x08,
  kJobStatusPreJobAction = 0x10, kJobStatusPostJobAction = 0x20, kJobStatusPendingPreJobAction = 0x40, kJobStatusPendingPostJobAction = 0x80,
  kJobStatusPendingFramecheck = 0x100, kJobStatusFramecheck = 0x200, kJobStatusJobCompleted = 0x400, kJobStatusCompletedWithWarnings = 0x800,
  kJobStatusCompletedWithErrors = 0x1000, kJobStatusPendingPostJobPyAction = 0x2000, kJobStatusPostJobPyAction = 0x4000, kJobStatusLocked = 0x100000,
  kJobStatusArchived = 0x200000, kJobStatusPaused = 0x400000, kJobEmergencyQueue = 0x800000, kJobRegularQueue = 0x1000000,
  kJobStatusUnlocked = 0x2000000, kJobStatusUnarchived = 0x4000000, kJobStatusUnpaused = 0x8000000
}
 Job status enumeration. More...
 
enum  kJobsType { kJobTypeJob, kJobTypeFolder }
 Job types enumeration. More...
 
enum  kMissingFramesStatus {
  kMissingFrameStatusValid, kMissingFrameStatusMissing, kMissingFrameStatusSizeError, kMissingFrameStatusFileOpenError,
  kMissingFrameStatusDimensionsError
}
 Job frmae check result enumeration. More...
 

Public Member Functions

virtual bool attributeExists (const char *key)
 
virtual bool attributeGetBool (const char *key, bool &dest, bool *state=0)
 
virtual bool attributeGetBool (const char *key)
 
virtual bool attributeGetFloat (const char *key, float &dest, bool *state=0)
 
virtual float attributeGetFloat (const char *key)
 
virtual bool attributeGetInt (const char *key, int &dest, bool *state=0)
 
virtual int attributeGetInt (const char *key)
 
virtual bool attributeGetInt64 (const char *key, long long int &dest, bool *state=0)
 
virtual long long int attributeGetInt64 (const char *key)
 
virtual bool attributeGetLong (const char *key, long &dest, bool *state=0)
 
virtual bool attributeGetString (const char *key, std::string &dest, bool *state=0, bool *subst=0)
 
virtual std::string attributeGetString (const char *key)
 
virtual bool attributeGetTimet (const char *key, time_t &dest, bool *state=0)
 
virtual bool attributeHasSubstitutionEnabled (const char *key)
 
virtual bool attributeIsEnabled (const char *key)
 
virtual void attributeRemove (const char *key)
 
virtual void attributesClear ()
 
virtual void attributeSetBool (const char *key, bool value, bool state=true)
 
virtual void attributeSetFloat (const char *key, float value, bool state=true)
 
virtual void attributeSetInt (const char *key, int value, bool state=true)
 
virtual void attributeSetInt64 (const char *key, long long int value, bool state=true)
 
virtual void attributeSetLong (const char *key, long value, bool state=true)
 
virtual void attributeSetString (const char *key, std::string value, bool state=true, bool subst=false)
 
virtual void attributeSetTimet (const char *key, time_t *value, bool state=true)
 
std::list< MClientLib::MChunk > BuildChunks (std::list< MClientLib::MFramesRange > &ranges, std::set< float > &totalFrames, long chunksStartingID)
 
std::vector< MClientLib::MMFGroup * > CheckForMissingFrames (job_framecheck_progress_callback callback, job_framecheck_abort_callback abortCallback, void *context, const std::map< std::string, std::string > &framesMask, int fileCheckType, long long int fileMin, long long int fileMax, bool openImage, bool checkImageDimensions, int imageWidth, int imageHeight, long chunkId=-1)
 
std::vector< MClientLib::MMFGroup * > CheckForMissingFrames (const std::map< std::string, std::string > &framesMask, int fileCheckType, long long int fileMin, long long int fileMax, bool openImage, bool checkImageDimensions, int imageWidth, int imageHeight, long chunkId=-1)
 
virtual void clearJob ()
 
virtual void copyFromJob (MJob &job, bool copyAttributes, bool copyIdentities)
 
virtual bool getArchivied ()
 
MClientLib::MPropertiesMap getAttributes ()
 
MClientLib::itemAttributesMap & getAttributesMap ()
 
virtual bool getBorrowInstances ()
 
virtual int getBorrowInstancesValue ()
 
virtual std::string getCamera ()
 
virtual int getChunksCount ()
 
virtual int getChunksInterleave ()
 
virtual int getChunksPriority ()
 
virtual std::string getDepartment ()
 
virtual int getDependLinkMode ()
 
virtual int getDependMode ()
 
virtual std::string getDepends ()
 
virtual bool getEmergencyQueue ()
 
virtual long long int getEndTime ()
 
virtual std::string getExcludedPools ()
 
virtual int getExitCodesErrorCheckType ()
 
std::list< MClientLib::MFramesRange > GetFrameRanges ()
 
virtual std::string getIncludedPools ()
 
virtual int getIndent ()
 
virtual long getJobId ()
 
virtual int getJobType ()
 
virtual bool getLocked ()
 
virtual int getLogsErrorCheckType ()
 
virtual std::vector< MClientLib::MTextFileRule > getLogsParsingRules ()
 
virtual int getMailNotificationsAtChunkLevelType ()
 
virtual int getMailNotificationsAtJobLevelType ()
 
virtual int getMaximumNodes ()
 
virtual int getMobileNotificationsAtChunkLevelType ()
 
virtual int getMobileNotificationsAtJobLevelType ()
 
virtual std::string getName ()
 
virtual int getNotificatorNotificationsAtChunkLevelType ()
 
virtual int getNotificatorNotificationsAtJobLevelType ()
 
virtual bool getOverrideChunksTimeout ()
 
virtual int getOverrideChunksTimeoutValue ()
 
virtual bool getOverrideErrorExitCodes ()
 
virtual std::string getOverrideErrorExitCodesValue ()
 
virtual bool getOverrideMailNotificationsAtChunkLevel ()
 
virtual bool getOverrideMailNotificationsAtJobLevel ()
 
virtual bool getOverrideMaximumChunksRequeue ()
 
virtual int getOverrideMaximumChunksRequeueValue ()
 
virtual bool getOverrideMinimumCores ()
 
virtual int getOverrideMinimumCoresValue ()
 
virtual bool getOverrideMinimumDiskSpace ()
 
virtual double getOverrideMinimumDiskSpaceValue ()
 
virtual bool getOverrideMinimumPhysical ()
 
virtual bool getOverrideMinimumPhysicalGPUs ()
 
virtual int getOverrideMinimumPhysicalGPUsValue ()
 
virtual int getOverrideMinimumPhysicalValue ()
 
virtual bool getOverrideMinimumRam ()
 
virtual double getOverrideMinimumRamValue ()
 
virtual bool getOverrideMinimumSpeed ()
 
virtual double getOverrideMinimumSpeedValue ()
 
virtual bool getOverrideMinimumThreads ()
 
virtual int getOverrideMinimumThreadsValue ()
 
virtual bool getOverrideMobileNotificationsAtChunkLevel ()
 
virtual bool getOverrideMobileNotificationsAtJobLevel ()
 
virtual bool getOverrideNotificatorNotificationsAtChunkLevel ()
 
virtual bool getOverrideNotificatorNotificationsAtJobLevel ()
 
virtual bool getOverrideStartMailNotificationsAtChunkLevel ()
 
virtual bool getOverrideStartMailNotificationsAtJobLevel ()
 
virtual bool getOverrideStartMobileNotificationsAtChunkLevel ()
 
virtual bool getOverrideStartMobileNotificationsAtJobLevel ()
 
virtual bool getOverrideStartNotificatorNotificationsAtChunkLevel ()
 
virtual bool getOverrideStartNotificatorNotificationsAtJobLevel ()
 
virtual bool getOverrideValidExitCodes ()
 
virtual std::string getOverrideValidExitCodesValue ()
 
virtual bool getOverrideWarningExitCodes ()
 
virtual std::string getOverrideWarningExitCodesValue ()
 
virtual std::string getOwner ()
 
virtual int getPacketSize ()
 
virtual int getPacketType ()
 
virtual long getParentId ()
 
virtual bool getPaused ()
 
virtual long long int getPauseOn ()
 
virtual int getPriority ()
 
virtual long long int getProcessingTime ()
 
virtual double getProgress ()
 
virtual std::string getProject ()
 
std::list< MClientLib::MFramesRange > GetRangedChunks (std::list< MClientLib::MFramesRange > &ranges, int &framesCount)
 
virtual int getRequeued ()
 
virtual long long int getResumesOn ()
 
virtual std::string getSequence ()
 
virtual std::string getShot ()
 
virtual int getStartMailNotificationsAtChunkLevelType ()
 
virtual int getStartMailNotificationsAtJobLevelType ()
 
virtual int getStartMobileNotificationsAtChunkLevelType ()
 
virtual int getStartMobileNotificationsAtJobLevelType ()
 
virtual int getStartNotificatorNotificationsAtChunkLevelType ()
 
virtual int getStartNotificatorNotificationsAtJobLevelType ()
 
virtual long long int getStartsOn ()
 
virtual long long int getStartTime ()
 
virtual int getStatus ()
 
virtual long long int getSubmissionTime ()
 
virtual int getTasksMask ()
 
virtual int getTemplateID ()
 
virtual std::string getTemplateVersion ()
 
virtual std::string getTotalTime ()
 
virtual long long int getUpdateTime ()
 
virtual int getWorkingNodes ()
 
 MJob (long _id)
 
void NormalizeFramesAttributes (const std::set< float > &totalFrames, const std::list< MClientLib::MChunk > &chunks, bool editingJob)
 
void NormalizeFramesMasks ()
 
virtual void setArchivied (bool _archivied)
 
virtual void setBorrowInstances (bool _borrowInstances)
 
virtual void setBorrowInstancesValue (int _borrowInstances)
 
virtual void setCamera (const std::string &_camera)
 
virtual void setChunksCount (int _chunksCount)
 
virtual void setChunksInterleave (int _chunksInterleave)
 
virtual void setChunksPriority (int _chunksPriority)
 
virtual void setDepartment (const std::string &_department)
 
virtual void setDependLinkMode (int _dependLinkMode)
 
virtual void setDependMode (int _dependMode)
 
virtual void setDepends (const std::string &_depends)
 
virtual void setEmergencyQueue (bool _emergencyQueue)
 
virtual void setEndTime (long long int _endTime)
 
virtual void setExcludedPools (const std::string &_excludedPools)
 
virtual void setExitCodesErrorCheckType (int _exitcodesErrorCheckType)
 
virtual void setIncludedPools (const std::string &_includedPools)
 
virtual void setIndent (int _indent)
 
virtual void setJobId (long _jobId)
 
virtual void setJobType (int _jobType)
 
virtual void setLocked (bool _locked)
 
virtual void setLogsErrorCheckType (int _logsErrorCheckType)
 
virtual void setLogsParsingRules (const std::vector< MClientLib::MTextFileRule > &_rules)
 
virtual void setMailNotificationsAtChunkLevelType (int _mailNotificationsAtChunkLevelType)
 
virtual void setMailNotificationsAtJobLevelType (int _mailNotificationsAtJobLevelType)
 
virtual void setMaximumNodes (int _maximumNodes)
 
virtual void setMobileNotificationsAtChunkLevelType (int _mobileNotificationsAtChunkLevelType)
 
virtual void setMobileNotificationsAtJobLevelType (int _mobileNotificationsAtJobLevelType)
 
virtual void setName (const std::string &_name)
 
virtual void setNotificatorNotificationsAtChunkLevelType (int _notificatorNotificationsAtChunkLevelType)
 
virtual void setNotificatorNotificationsAtJobLevelType (int _notificatorNotificationsAtJobLevelType)
 
virtual void setOverrideChunksTimeout (bool _overrideChunksTimeout)
 
virtual void setOverrideChunksTimeoutValue (int _overrideChunksTimeoutValue)
 
virtual void setOverrideErrorExitCodes (bool _overrideErrorExitCodes)
 
virtual void setOverrideErrorExitCodesValue (const std::string &_overrideErrorExitCodesValue)
 
virtual void setOverrideMailNotificationsAtChunkLevel (bool _overrideMailNotificationsAtChunkLevel)
 
virtual void setOverrideMailNotificationsAtJobLevel (bool _overrideMailNotificationsAtJobLevel)
 
virtual void setOverrideMaximumChunksRequeue (bool _overrideMaximumChunksRequeue)
 
virtual void setOverrideMaximumChunksRequeueValue (int _maximumChunksRequeue)
 
virtual void setOverrideMinimumCores (bool _overrideMinimumCores)
 
virtual void setOverrideMinimumCoresValue (int _overrideMinimumCoresValue)
 
virtual void setOverrideMinimumDiskSpace (bool _overrideMinimumDiskSpace)
 
virtual void setOverrideMinimumDiskSpaceValue (double _overrideMinimumDiskSpaceValue)
 
virtual void setOverrideMinimumPhysical (bool _overrideMinimumPhysical)
 
virtual void setOverrideMinimumPhysicalGPUs (bool _overrideMinimumPhysicalGPUs)
 
virtual void setOverrideMinimumPhysicalGPUsValue (int _overrideMinimumPhysicalGPUsValue)
 
virtual void setOverrideMinimumPhysicalValue (int _overrideMinimumPhysicalValue)
 
virtual void setOverrideMinimumRam (bool _overrideMinimumRam)
 
virtual void setOverrideMinimumRamValue (double _overrideMinimumRamValue)
 
virtual void setOverrideMinimumSpeed (bool _overrideMinimumSpeed)
 
virtual void setOverrideMinimumSpeedValue (double _overrideMinimumSpeedValue)
 
virtual void setOverrideMinimumThreads (bool _overrideMinimumThreads)
 
virtual void setOverrideMinimumThreadsValue (int _overrideMinimumThreadsValue)
 
virtual void setOverrideMobileNotificationsAtChunkLevel (bool _overrideMobileNotificationsAtChunkLevel)
 
virtual void setOverrideMobileNotificationsAtJobLevel (bool _overrideMobileNotificationsAtJobLevel)
 
virtual void setOverrideNotificatorNotificationsAtChunkLevel (bool _overrideNotificatorNotificationsAtChunkLevel)
 
virtual void setOverrideNotificatorNotificationsAtJobLevel (bool _overrideNotificatorNotificationsAtJobLevel)
 
virtual void setOverrideStartMailNotificationsAtChunkLevel (bool _overrideMailNotificationsAtChunkLevel)
 
virtual void setOverrideStartMailNotificationsAtJobLevel (bool _overrideMailNotificationsAtJobLevel)
 
virtual void setOverrideStartMobileNotificationsAtChunkLevel (bool _overrideMobileNotificationsAtChunkLevel)
 
virtual void setOverrideStartMobileNotificationsAtJobLevel (bool _overrideMobileNotificationsAtJobLevel)
 
virtual void setOverrideStartNotificatorNotificationsAtChunkLevel (bool _overrideNotificatorNotificationsAtChunkLevel)
 
virtual void setOverrideStartNotificatorNotificationsAtJobLevel (bool _overrideNotificatorNotificationsAtJobLevel)
 
virtual void setOverrideValidExitCodes (bool _overrideValidExitCodes)
 
virtual void setOverrideValidExitCodesValue (const std::string &_overrideValidExitCodesValue)
 
virtual void setOverrideWarningExitCodes (bool _overrideWarningExitCodes)
 
virtual void setOverrideWarningExitCodesValue (const std::string &_overrideWarningExitCodesValue)
 
virtual void setOwner (const std::string &_owner)
 
virtual void setPacketSize (int _packetSize)
 
virtual void setPacketType (int _packetType)
 
virtual void setParentId (long _parentId)
 
virtual void setPaused (bool _paused)
 
virtual void setPauseOn (long long int _pauseOn)
 
virtual void setPriority (int _priority)
 
virtual void setProcessingTime (long long int _endTime)
 
virtual void setProgress (double _progress)
 
virtual void setProject (const std::string &_project)
 
virtual void setRequeued (int _requeued)
 
virtual void setResumesOn (long long int _resumesOn)
 
virtual void setSequence (const std::string &_sequence)
 
virtual void setShot (const std::string &_shot)
 
virtual void setStartMailNotificationsAtChunkLevelType (int _mailNotificationsAtChunkLevelType)
 
virtual void setStartMailNotificationsAtJobLevelType (int _mailNotificationsAtJobLevelType)
 
virtual void setStartMobileNotificationsAtChunkLevelType (int _mobileNotificationsAtChunkLevelType)
 
virtual void setStartMobileNotificationsAtJobLevelType (int _mobileNotificationsAtJobLevelType)
 
virtual void setStartNotificatorNotificationsAtChunkLevelType (int _notificatorNotificationsAtChunkLevelType)
 
virtual void setStartNotificatorNotificationsAtJobLevelType (int _notificatorNotificationsAtJobLevelType)
 
virtual void setStartsOn (long long int _startsOn)
 
virtual void setStartTime (long long int _startTime)
 
virtual void setStatus (int _status)
 
virtual void setSubmissionTime (long long int _submissionTime)
 
virtual void setTasksMask (int _tasksMask)
 
virtual void setTemplateID (int _templateID)
 
virtual void setTemplateVersion (const std::string &_templateVersion)
 
virtual void setUpdateTime (long long int updateTime)
 
virtual void setWorkingNodes (int _workingNodes)
 

Protected Attributes

MClientLib::MPropertiesMap attributes
 

Detailed Description

Class holding a job data structure.

Holds data related to a job

Definition at line 130 of file MJob.h.

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