Public Types

enum  kTemplateMusterEnvironmentHandling { kTemplateMusterEnvDoDefault, kTemplateMusterEnvGenerate, kTemplateMusterEnvSkip }
 Muster custom environment handling. More...
 
enum  kTemplatesEncoding { kTemplateEncodingUTF8, kTemplateEncodingUTF16 }
 Templates text encoding enumeration. More...
 

Public Member Functions

void addAppKiller (const std::string &processRegExp)
 
void addJobLicenseLimit (const std::string &tag, int limit, const std::string &field)
 
void addMapping (const std::string &templateValue, const std::string &builtinValue)
 
void addPopUpButtonClass (const std::string &buttonClass)
 
void addPopUpHandler (const std::string &popupRegExp, const std::string &subControlRegExp, const std::string &buttons)
 
void addPopUpHandler (const std::string &popupRegExp, const std::string &buttons)
 
void addPopUpIgnorer (const std::string &popupRegExp)
 
void addRule (const std::string &version, MClientLib::MTextFileRule rule)
 
void addSubmissionAdditionalItem (const char *groupName, MTemplateEngine::MTemplateItem *item)
 
void addSubmissionItem (MTemplateEngine::MTemplateItem *item)
 
void addTask (const std::string &name, MTemplateEngine::kTemplatesLogic _type, int _priority)
 
void addVersion (const std::string &version)
 
bool checkWebFilter (const std::string &field, const std::string &value)
 
void clearEnvironments ()
 
void clearMacros ()
 
void clearMappings ()
 
void clearRules ()
 
void clearSubmissionAdditionalItems ()
 
void clearSubmissionItems ()
 
void clearVersions ()
 
bool compareWebFilters (std::vector< std::string > *filters)
 
void encodeTree (void *pt, std::string(*encodeFunc)(const std::string &), int encoding, void *fields, std::vector< std::string > *filters)
 
MTemplateEngine::MTemplatePlatformgetActivePlatform ()
 
int getChunksTimeout ()
 
std::string getDefaultExcludedPools ()
 
std::string getDefaultPools ()
 
int getDefaultPriority ()
 
int getDelay ()
 
std::string getDelayGroup ()
 
std::string getDescription ()
 
bool getEnableAdditionalFlagsField ()
 
bool getEnableChunksTimeoutOverride ()
 
bool getEnableExitCodeErrorsOverrides ()
 
bool getEnableExitCodeWarningsOverrides ()
 
bool getEnableLogErrorsOverrides ()
 
bool getEnableLogWarningsOverrides ()
 
bool getEnablePostChunkActionsOverrides ()
 
bool getEnablePostJobActionsOverrides ()
 
bool getEnablePreChunkActionsOverrides ()
 
bool getEnablePreJobActionsOverrides ()
 
bool getEnableProcessFailureErrorsOverrides ()
 
std::string getEnvironment (const std::string &version, const std::string &environmentName)
 
std::map< std::string, std::string > getEnvironments (const std::string &version)
 
std::string getEnvironmentsContent ()
 
std::string getFileName ()
 
std::string getGlobalEnvironment (const std::string &environmentName)
 
std::string getGlobalMacro (const std::string &macroName)
 
std::string getIconFilename ()
 
int getID ()
 
bool getIsReservTemplate ()
 
const std::vector< std::string > & getJobLicensesFields ()
 
const std::vector< int > & getJobLicensesLimits ()
 
const std::vector< std::string > & getJobLicensesTags ()
 
std::string getLicensesGroup ()
 
std::string getMacro (const std::string &version, const std::string &macroName)
 
std::string getMacroContent ()
 
std::map< std::string, std::string > getMacros (const std::string &version)
 
std::map< std::string, std::string > * getMappings ()
 
int getMaximumLicenses ()
 
std::string getMd5Hash ()
 
int getMusterDispatcherActionsCustomEnvironmentMode ()
 
int getMusterInstanceActionsCustomEnvironmentMode ()
 
int getMusterInstanceCustomEnvironmentMode ()
 
std::string getName ()
 
bool getOverrideMaximumChunksRequeue ()
 
int getOverrideMaximumChunksRequeueValue ()
 
std::string getParserContent ()
 
std::vector< MClientLib::MTextFileRulegetRules (const std::string &version)
 
std::vector< MTemplateEngine::MTemplateItemHolder * > * getSubmissionAdditionalItems ()
 
std::vector< MTemplateEngine::MTemplateItem * > * getSubmissionItems ()
 
std::vector< MTemplateEngine::MTemplateTask * > getTasks ()
 
std::string getTemplateContent ()
 
int getTemplateEncoding ()
 
int getTemplateLogic ()
 
int getTemplateTasksMask ()
 
bool getTrimLogs ()
 
int getVersionIndex (const std::string &version)
 
std::vector< std::string > getVersions ()
 
std::string getVersionsContent ()
 
bool hasVersion (const std::string &version)
 
bool isPythonTemplate ()
 
void Lock ()
 
virtual bool onAlarmCheckForCustomEvent (int instanceNum, MClientLib::MAlarm *alarm)
 
virtual MTemplateEngine::kTemplateFunctionBehaviour onAlarmEnterState (int instanceNum, MClientLib::MAlarm *alarm)
 
virtual MTemplateEngine::kTemplateFunctionBehaviour onAlarmExpired (int instanceNum, MClientLib::MAlarm *alarm)
 
virtual MTemplateEngine::kTemplateFunctionBehaviour onAlarmTriggered (int instanceNum, MClientLib::MAlarm *alarm)
 
virtual int onApplicationFinder (MClientLib::MStringRef &moduleRegExp, MClientLib::MStringRef &moduleTag)
 
virtual std::string onBuildAdditionalParameters (MClientLib::MPropertiesMap &attributes)
 
virtual std::string onBuildCommandLine (int platform, MClientLib::MJob *job, MClientLib::MChunk *chunk, std::map< std::string, std::string > &clientTemplatePreferences, int instanceNum)
 
virtual MClientLib::MEnvironment onBuildEnvironment (MClientLib::MJob *job, MClientLib::MChunk *chunk, std::map< std::string, std::string > &clientTemplatePreferences, MClientLib::MEnvironment &existingEnvironment)
 
virtual std::string onBuildReservCommandLine (int platform, std::map< std::string, std::string > &clientTemplatePreferences, int instanceNum)
 
virtual MClientLib::MEnvironment onBuildReservEnvironment (std::map< std::string, std::string > &clientTemplatePreferences, MClientLib::MEnvironment &existingEnvironment)
 
virtual MTemplateEngine::kTemplateFunctionBehaviour onChangeProcessPriority (MClientLib::MJob *job, MClientLib::MChunk *chunk, MPid process, int priority, int instanceNum)
 
virtual void onCheckChanged (const std::string &fieldName, bool state, MTemplateEngine::MTemplateItemsFields &fieldsToChange)
 
virtual MTemplateEngine::kTemplateFunctionBehaviour onCheckClientAvailability ()
 
virtual MTemplateEngine::MTemplateError onCheckExitCode (MClientLib::MJob *job, MClientLib::MChunk *chunk, std::map< std::string, std::string > &clientTemplatePreferences, int exitCode)
 
virtual bool onCheckForFramesMask (MClientLib::MJob *job, MClientLib::MChunk *chunk, const char *line, MClientLib::MStringRef &maskOut)
 
virtual bool onCheckForFramesMaskForLayer (MClientLib::MJob *job, MClientLib::MChunk *chunk, const char *line, MClientLib::MStringRef &maskOut, MClientLib::MStringRef &layerOut)
 
virtual bool onCheckForFramesPrefixString (MClientLib::MJob *job, MClientLib::MChunk *chunk, const char *line, MClientLib::MStringRef &prefixOut)
 
virtual bool onCheckForSubframeAdvancingString (MClientLib::MJob *job, MClientLib::MChunk *chunk, const char *line)
 
virtual bool onCheckForSubframeProgress (MClientLib::MJob *job, MClientLib::MChunk *chunk, const char *line, MClientLib::MStringRef &progressOut)
 
virtual MTemplateEngine::MTemplateError onCheckLog (MClientLib::MJob *job, MClientLib::MChunk *chunk, std::map< std::string, std::string > &clientTemplatePreferences, const char *log, std::vector< MClientLib::MTextFileMarker > &warnings, std::vector< MClientLib::MTextFileMarker > &errors, std::vector< MClientLib::MTextFileMarker > &silencedWarnings, std::vector< MClientLib::MTextFileMarker > &silencedErrors)
 
virtual MTemplateEngine::MTemplateError onCheckLogLine (MClientLib::MJob *job, MClientLib::MChunk *chunk, std::map< std::string, std::string > &clientTemplatePreferences, const char *line, int lineNum, std::vector< MClientLib::MTextFileMarker > &warnings, std::vector< MClientLib::MTextFileMarker > &errors, std::vector< MClientLib::MTextFileMarker > &silencedWarnings, std::vector< MClientLib::MTextFileMarker > &silencedErrors)
 
virtual MTemplateEngine::kTemplateFunctionBehaviour onCheckProcessTermination (MClientLib::MJob *job, MClientLib::MChunk *chunk, MPid process, int instanceNum)
 
virtual MTemplateEngine::MTemplateError onChunkCompleted (MClientLib::MJob *job, MClientLib::MChunk *chunk, int instanceId)
 
virtual MTemplateEngine::MTemplateError onChunkEnd (MClientLib::MJob *job, MClientLib::MChunk *chunk, std::map< std::string, std::string > &clientTemplatePreferences, int instanceId)
 
virtual MTemplateEngine::MTemplateError onChunkRequeued (MClientLib::MJob *job, MClientLib::MChunk *chunk)
 
virtual MTemplateEngine::MTemplateError onChunkStart (MClientLib::MJob *job, MClientLib::MChunk *chunk, std::map< std::string, std::string > &clientTemplatePreferences, int instanceId)
 
virtual MTemplateEngine::MTemplateError onChunkSubmitted (MClientLib::MJob *job, MClientLib::MChunk *chunk, int instanceId)
 
virtual void onClientConnected (MClientLib::MNode *node)
 
virtual void onClientDisconnected (MClientLib::MNode *node)
 
virtual void onClientDisconnectedByHeartbeath (MClientLib::MNode *node)
 
virtual void onClientIdling ()
 
virtual void onClientStatusChanged (MClientLib::MNode *node)
 
virtual MTemplateEngine::kTemplateFunctionBehaviour onCollectProcessOutput (MPid mainProcess, MPid runningProcessPid, int instanceNum, MClientLib::MStringRef &output)
 
virtual void onCustomConsoleMessage (long clientId, const char *message)
 
virtual void onCustomDispatcherMessageToConsole (const char *message)
 
virtual void onCustomDispatcherMessageToNode (long instanceId, const char *message)
 
virtual void onCustomDispatcherMessageToNotificator (const char *message)
 
virtual void onCustomNodeMessage (long instanceId, const char *message)
 
virtual void onCustomNotificatorMessage (long clientId, const char *message)
 
virtual void onDeleteJob (MClientLib::MJob *job)
 
virtual MTemplateEngine::kTemplateFunctionBehaviour onDetectRunningProcess (MPid mainProcess, std::vector< MClientLib::MProcessSnapshot * > hostProcesses, std::map< std::string, std::string > &clientTemplatePreferences, MPid &runningProcessPid)
 
virtual MTemplateEngine::kTemplateFunctionBehaviour onDispatcherAlarmExpired (int instanceId, MClientLib::MAlarm *alarm)
 
virtual MTemplateEngine::kTemplateFunctionBehaviour onDispatcherAlarmTriggered (int instanceId, MClientLib::MAlarm *alarm)
 
virtual void onDispatcherIdling ()
 
virtual MTemplateEngine::kTemplateFunctionBehaviour onDispatcherOverrideBackupJob (MClientLib::MJob *job)
 
virtual MTemplateEngine::kTemplateFunctionBehaviour onDispatcherOverrideDeleteArchivedJobs (MClientLib::MJob *job)
 
virtual MTemplateEngine::kTemplateFunctionBehaviour onDispatcherOverrideFlagJobsAsArchived (MClientLib::MJob *job)
 
virtual MTemplateEngine::kTemplateFunctionBehaviour onDispatcherOverrideImpersonationUser (MClientLib::MJob *job, MClientLib::MChunk *chunk, MClientLib::MStringRef &usernameOut, MClientLib::MStringRef &passwordOut)
 
virtual void onEditJob (MClientLib::MJob *job)
 
virtual void onFieldChanged (const std::string &fieldName, const std::string &fieldValue, MTemplateEngine::MTemplateItemsFields &fieldsToChange)
 
virtual bool onFindApplication (MClientLib::MStringRef &basePath, std::map< std::string, std::string > &clientTemplatePreferences)
 
virtual MTemplateEngine::MTemplateError onGetApplicationPath (MClientLib::MJob *job, MClientLib::MChunk *chunk, std::map< std::string, std::string > &clientTemplatePreferences, MClientLib::MStringRef &pathOut)
 
virtual MTemplateEngine::MTemplateError onGetApplicationStartingFolder (MClientLib::MJob *job, MClientLib::MChunk *chunk, std::map< std::string, std::string > &clientTemplatePreferences, MClientLib::MStringRef &pathOut)
 
virtual std::string onGetFlagForRenderLayers (MClientLib::MJob *job, std::vector< std::string > &layers)
 
virtual MTemplateEngine::MTemplateError onGetReservApplicationPath (std::map< std::string, std::string > &clientTemplatePreferences, MClientLib::MStringRef &pathOut)
 
virtual MTemplateEngine::MTemplateError onGetReservApplicationStartingFolder (std::map< std::string, std::string > &clientTemplatePreferences, MClientLib::MStringRef &pathOut)
 
virtual void onGetSliceBoundaries (MClientLib::MJob *job, MClientLib::MChunk *chunk, MTemplateEngine::MTemplateSliceBoundaries *boundaries)
 
virtual std::string onGetSlicesInputFilename (MClientLib::MJob *job, MClientLib::MChunk *chunk)
 
virtual std::string onGetSlicesOutputFilename (MClientLib::MJob *job, MClientLib::MChunk *chunk)
 
virtual std::string onGetWindowsBatFile (MClientLib::MJob *job, MClientLib::MChunk *chunk, std::map< std::string, std::string > &clientTemplatePreferences, MClientLib::MEnvironment &existingEnvironment)
 
virtual MTemplateEngine::kTemplateFunctionBehaviour onInstanceOverrideImpersonationUser (MClientLib::MJob *job, MClientLib::MChunk *chunk, std::map< std::string, std::string > &clientTemplatePreferences, MClientLib::MStringRef &usernameOut, MClientLib::MStringRef &passwordOut)
 
virtual void onJobCompleted (MClientLib::MJob *job)
 
virtual MTemplateEngine::MTemplateError onJobEnd (MClientLib::MJob *job)
 
virtual void onJobPropertiesChanged (MClientLib::MJob *job)
 
virtual MTemplateEngine::MTemplateError onJobStart (MClientLib::MJob *job)
 
virtual bool onMailChunkCompleted (MClientLib::MJob *job, MClientLib::MChunk *chunk, MClientLib::MNode *node, bool chunkHasBeenRequeued, bool chunkHasMissingFrames, MClientLib::MStringRef &subjectOut, MClientLib::MStringRef &htmlBodyOut, MClientLib::MStringRef &plainBodyOut)
 
virtual bool onMailChunkStart (MClientLib::MJob *job, MClientLib::MChunk *chunk, MClientLib::MNode *node, MClientLib::MStringRef &subjectOut, MClientLib::MStringRef &htmlBodyOut, MClientLib::MStringRef &plainBodyOut)
 
virtual bool onMailConfigurationsChanged (const char *message, MClientLib::MStringRef &subjectOut, MClientLib::MStringRef &htmlBodyOut, MClientLib::MStringRef &plainBodyOut)
 
virtual bool onMailEngineStatus (bool state, MClientLib::MStringRef &subjectOut, MClientLib::MStringRef &htmlBodyOut, MClientLib::MStringRef &plainBodyOut)
 
virtual bool onMailExclusionListEvent (const char *message, MClientLib::MStringRef &subjectOut, MClientLib::MStringRef &htmlBodyOut, MClientLib::MStringRef &plainBodyOut)
 
virtual bool onMailJobCompleted (MClientLib::MJob *job, bool framesHaveBeenRequeued, MClientLib::MStringRef &subjectOut, MClientLib::MStringRef &htmlBodyOut, MClientLib::MStringRef &plainBodyOut)
 
virtual bool onMailJobStart (MClientLib::MJob *job, MClientLib::MStringRef &subjectOut, MClientLib::MStringRef &htmlBodyOut, MClientLib::MStringRef &plainBodyOut)
 
virtual bool onMailSendLogs (std::vector< MClientLib::MLog * > logs, MClientLib::MStringRef &subjectOut, MClientLib::MStringRef &htmlBodyOut, MClientLib::MStringRef &plainBodyOut)
 
virtual bool onMailSoftRestarts (const char *message, MClientLib::MStringRef &subjectOut, MClientLib::MStringRef &htmlBodyOut, MClientLib::MStringRef &plainBodyOut)
 
virtual bool onModuleFound (MClientLib::MStringRef &moduleExec, MClientLib::MStringRef &modulePath, std::map< std::string, std::string > &clientTemplatePreferences)
 
virtual void onPauseJob (MClientLib::MJob *job)
 
virtual void onPrepareTasks (MClientLib::MJob *job, std::vector< MTemplateEngine::MTemplateTask * > *tasks)
 
virtual void onReinitJob (MClientLib::MJob *job)
 
virtual void onResumeJob (MClientLib::MJob *job)
 
virtual MTemplateEngine::kTemplateFunctionBehaviour onStartProcess (MClientLib::MJob *job, MClientLib::MChunk *chunk, MClientLib::MEnvironment *env, std::map< std::string, std::string > &clientTemplatePreferences, int instanceNum, MPid &runningProcessPid)
 
virtual void onSubmitJob (MClientLib::MJob *job)
 
virtual MTemplateEngine::kTemplateFunctionBehaviour onTerminateProcess (MClientLib::MJob *job, MClientLib::MChunk *chunk, MPid process, int instanceNum)
 
virtual void onUserDeleteJob (MClientLib::MJob *job, MClientLib::MUser *user)
 
virtual void onUserEditJob (MClientLib::MJob *job, MClientLib::MUser *user)
 
virtual void onUserJobPropertiesChanged (MClientLib::MJob *job, MClientLib::MUser *user)
 
virtual void onUserPauseJob (MClientLib::MJob *job, MClientLib::MUser *user)
 
virtual void onUserReinitJob (MClientLib::MJob *job, MClientLib::MUser *user)
 
virtual void onUserResumeJob (MClientLib::MJob *job, MClientLib::MUser *user)
 
virtual void onUserSubmitJob (MClientLib::MJob *job, MClientLib::MUser *user)
 
virtual MTemplateEngine::kTemplateFunctionBehaviour onValidateChunkDependancies (MClientLib::MChunk *chunk)
 
virtual MTemplateEngine::kTemplateFunctionBehaviour onValidateJobDependancies (MClientLib::MJob *job)
 
virtual bool onValidateJobSubmission (MClientLib::MJob *job, MClientLib::MStringRef &err)
 
void Release ()
 
void removeEnvironment (const std::string &version, const std::string &environmentName)
 
void removeEnvironments (const std::string &version)
 
void removeMacro (const std::string &version, const std::string &macroName)
 
void removeMacros (const std::string &version)
 
void removeRules (const std::string &version)
 
void removeVersion (const std::string &version)
 
void Retain ()
 
void setChunksTimeout (int _chunksTimeout)
 
void setDefaultExcludedPools (const std::string &_defaultExcludedPools)
 
void setDefaultPools (const std::string &_defaultPools)
 
void setDefaultPriority (int _defaultPriority)
 
void setDelay (int _delay)
 
void setDelayGroup (const std::string &_delayGroup)
 
void setDescription (const std::string &_description)
 
void setEnableAdditionalFlagsField (bool _enableAdditionalFlagsField)
 
void setEnableChunksTimeoutOverride (bool _enableChunksTimeoutOverride)
 
void setEnableExitCodeErrorsOverrides (bool _enableExitCodeErrorsOverrides)
 
void setEnableExitCodeWarningsOverrides (bool _enableExitCodeWarningsOverrides)
 
void setEnableLogErrorsOverrides (bool _enableLogErrorsOverrides)
 
void setEnableLogWarningsOverrides (bool _enableLogWarningsOverrides)
 
void setEnablePostChunkActionsOverrides (bool _enablePostChunkActionsOverrides)
 
void setEnablePostJobActionsOverrides (bool _enablePostJobActionsOverrides)
 
void setEnablePreChunkActionsOverrides (bool _enablePreChunkActionsOverrides)
 
void setEnablePreJobActionsOverrides (bool _enablePreJobActionsOverrides)
 
void setEnableProcessFailureErrorsOverrides (bool _enableProcessFailureErrorsOverrides)
 
void setEnvironment (const std::string &version, const std::string &environmentName, const std::string &environmentValue)
 
void setEnvironments (const std::string &version, const std::map< std::string, std::string > &environments)
 
void setFilename (const std::string &_filename)
 
void setHandleHeadlessApp (bool _handleHeadlessApp)
 
void setHandlePopups (bool _handlePopUps)
 
void setHandleQtPopups (bool _handleQtPopUps)
 
void setHandleWin10PopUps (bool _handleWin10PopUps)
 
void setIconFilename (const std::string &_iconFilename)
 
void setID (int _id)
 
void setIsReservTemplate (bool _reservTemplate)
 
void setLicensesGroup (const std::string &_licensesGroup)
 
void setMacro (const std::string &version, const std::string &macroName, const std::string &macroValue)
 
void setMacros (const std::string &version, const std::map< std::string, std::string > &macros)
 
void setMaximumLicenses (int _maximumLicenses)
 
void setMd5Hash (const std::string &_md5Hash)
 
void setMusterDispatcherActionsCustomEnvironmentMode (kTemplateMusterEnvironmentHandling mode)
 
void setMusterInstanceActionsCustomEnvironmentMode (kTemplateMusterEnvironmentHandling mode)
 
void setMusterInstanceCustomEnvironmentMode (kTemplateMusterEnvironmentHandling mode)
 
void setName (const std::string &_name)
 
void setOverrideMaximumChunksRequeue (bool _overrideMaximumChunksRequeue)
 
void setOverrideMaximumChunksRequeueValue (int _overrideMaximumChunksRequeueValue)
 
void setPopUpsMaxChildWindows (int _popUpsMaxChildWindows)
 
void setRuleIndex (const std::string &version, int oldIndex, int index)
 
void setRules (const std::string &version, std::vector< MClientLib::MTextFileRule >)
 
void setTaskDependancies (const std::string &name, const std::vector< std::string > &dependancies, const std::vector< int > &errorLevels)
 
void setTaskEnable (const std::string &name, bool isEnabled)
 
void setTaskPriority (const std::string &name, int priority)
 
void setTemplateEncoding (int _templateEncoding)
 
void setTemplateLogic (int _templateLogic)
 
void setTrimLogs (bool _trimLogs)
 
void setVersionIndex (const std::string &version, int index)
 
void setVersions (const std::vector< std::string > &versions)
 
bool supportsFramesRanges ()
 
void Unlock ()
 

Data Fields

MTemplateEngine::MTemplateErrorOverride exitCodeErrorsOverrides
 
MTemplateEngine::MTemplateErrorOverride exitCodeWarningsOverrides
 
MTemplateEngine::MTemplateImageSlicing imageSlicing
 
MTemplateEngine::MTemplateErrorOverride logErrorsOverrides
 
MTemplateEngine::MTemplateErrorOverride logWarningsOverrides
 
MTemplateEngine::MTemplateMultiframe multiframe
 
MTemplateEngine::MTemplatePlatform platformLinux
 
MTemplateEngine::MTemplatePlatform platformOSX
 
MTemplateEngine::MTemplatePlatform platformWindows
 
MTemplateEngine::MTemplateActionOverride postChunkActionOverrides
 
MTemplateEngine::MTemplateActionOverride postJobActionOverrides
 
MTemplateEngine::MTemplateActionOverride preChunkActionOverrides
 
MTemplateEngine::MTemplateActionOverride preJobActionOverrides
 
MTemplateEngine::MTemplateErrorOverride processFailureErrorsOverrides
 

Friends

class MManager
 

Detailed Description

Class that instantiate a template

Definition at line 136 of file MTemplate.h.


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