MTemplateEngine classes. More...

Data Structures
class	MIconHash
	Class holding MD5 hasing of a template icon file. More...

class	MManager
	Class holding the unique templates manager class singleton. More...

class	MTemplate

class	MTemplateActionOverride
	Class that instantiate a template actions override setting. More...

class	MTemplateError
	Class holding a template API error object. More...

class	MTemplateErrorOverride
	Class that instantiate a template error override settings. More...

class	MTemplateHash
	Class holding data to an unique template file. More...

class	MTemplateImageSlicing
	Class that instantiate template image slicing specific settings. More...

class	MTemplateImageSlicingFileFormats
	Class that instantiate template image slicing supported file formats. More...

class	MTemplateItem
	Class holding a template field item. More...

class	MTemplateItemCheck
	Class that instantiate a boolean check box selector class. More...

class	MTemplateItemCombo
	Class that instantiate a combo selector class. More...

class	MTemplateItemComboItem
	Class that instantiate a combo selector element class. More...

class	MTemplateItemDouble
	Class that instantiate a double selector class. More...

class	MTemplateItemEvent
	Class holding a template event object. More...

class	MTemplateItemFile
	Class that instantiate a file selector class. More...

class	MTemplateItemFolder
	Class that instantiate a folder selector class. More...

class	MTemplateItemFramesRange
	Class that instantiate a frames range selector class. More...

class	MTemplateItemHolder
	Class that instantiate an item group holder class used to group template items in specific groups. More...

class	MTemplateItemInteger
	Class that instantiate an integer selector class. More...

class	MTemplateItemMultichoice
	Class that instantiate a multi choice selector class. More...

class	MTemplateItemsFields
	Class holding a template fields. More...

class	MTemplateItemString
	Class that instantiate a string selector class. More...

class	MTemplateItemYesNo
	Class that instantiate a boolean yes/no selector class. More...

class	MTemplateMultiframe
	Class that instantiate template multiframe specific settings. More...

class	MTemplateParsingRule
	Class holding a template logs parsing rule. More...

class	MTemplatePlatform
	Class that instantiate a template specific platform settings. More...

class	MTemplateSliceBoundaries
	Class that instantiate template image slicing boundaries. More...

class	MTemplateTask
	Class holding a template API task object. More...

class	MTemplateTextMarkers
	Class holding a template API error object. More...

Typedefs
typedef std::map< std::string, MIconHash * >	iconsHashesMap

typedef std::set< std::string >	iconsSet

typedef void(*	redirectionFuncPtr) (const char , const char )

typedef std::map< int, MTemplateHash * >	templatesHashesMap

typedef std::map< int, MTemplate * >	templatesMap

Enumerations
enum	kTemplateItemFieldsActivation { kTemplateItemFieldsActivationNone, kTemplateItemFieldsActivationEnable, kTemplateItemFieldsActivationDisable }

enum	kTemplateLogParsingRuleAction { kTemplateLogParsingRuleActionSilence = 0x01, kTemplateLogParsingRuleActionProcess = 0x02, kTemplateLogParsingRuleActionDefault = 0x04 }
	An enumeration defining a MTemplateParsingRule matching action,. More...

enum	kTemplateLogParsingRuleMatchType { kTemplateLogParsingRuleMatchStringMatch = 0x01, kTemplateLogParsingRuleMatchStringNotMatch = 0x02, kTemplateLogParsingRuleMatchStartStringMatch = 0x04, kTemplateLogParsingRuleMatchStartStringNotMatch = 0x08, kTemplateLogParsingRuleMatchEndStringMatch = 0x10, kTemplateLogParsingRuleMatchEndStringNotMatch = 0x12, kTemplateLogParsingRuleMatchRegExpMatch = 0x14, kTemplateLogParsingRuleMatchRegDoNotMatch = 0x18 }
	An enumeration defining a MTemplateParsingRule match type,. More...

enum	kTemplateLogParsingRuleType { kTemplateLogParsingRuleErrorType = 0x01, kTemplateLogParsingRuleWarningType = 0x02 }
	An enumeration defining a MTemplateParsingRule type,. More...

enum	kTemplateMusterEnvironmentHandling { kTemplateMusterEnvDoDefault, kTemplateMusterEnvGenerate, kTemplateMusterEnvSkip }
	Muster custom environment handling. More...

enum	kTemplatesEncoding { kTemplateEncodingUTF8, kTemplateEncodingUTF16 }
	Templates text encoding enumeration. More...

enum	kTemplatesErrorsActions { kTemplateErrorDefault = 0x01, kTemplateErrorPauseJob = 0x02, kTemplateErrorPauseClient = 0x04, kTemplateErrorAddTemplateToExclusion = 0x08, kTemplateErrorAddJobToExclusion = 0x10, kTemplateErrorRequeueChunk = 0x20, kTemplateErrorAbortRender = 0x40, kTemplateErrorIncreaseRequeue = 0x80, kTemplateErrorKillAnyInstance = 0x100 }

enum	kTemplatesErrorsTypes { kTemplateErrorTypeNone, kTemplateErrorTypeInfo, kTemplateErrorTypeError, kTemplateErrorTypeWarning, kTemplateErrorReservNoError, kTemplateErrorReservSpawnError, kTemplateErrorReservTerminated, kTemplateErrorReservTerminationError }

enum	kTemplatesItemTypes { kTemplateItemInvalid, kTemplateItemFile, kTemplateItemDouble, kTemplateItemString, kTemplateItemInt, kTemplateItemCombo, kTemplateItemFolder, kTemplateItemMultiChoice, kTemplateItemCheck, kTemplateItemYesNo, kTemplateItemFramesRange }

Detailed Description

MTemplateEngine classes.

Collection of the MTemplateEngine classes

Typedef Documentation

typedef std::map<std::string, MIconHash*> iconsHashesMap

Defines an ID map for template hashes

Definition at line 169 of file MManager.h.

typedef std::set<std::string> iconsSet

Defines a set to contain templates icons

Definition at line 172 of file MManager.h.

typedef void(* redirectionFuncPtr) (const char *, const char *)

Defines a prototype for Python output redirection used in registerPythonOutputCallbacks()

Definition at line 173 of file MManager.h.

typedef std::map<int,MTemplateHash*> templatesHashesMap

Defines an ID map for template hashes

Definition at line 170 of file MManager.h.

typedef std::map<int,MTemplate*> templatesMap

Defines an ID map for MTemplate objects

Definition at line 171 of file MManager.h.

Enumeration Type Documentation

enum kTemplateItemFieldsActivation

Templates events enumeration Enumerates the Muster templates events

Enumerator
kTemplateItemFieldsActivationNone	Do not change the activation status
kTemplateItemFieldsActivationEnable	Enables the activation status
kTemplateItemFieldsActivationDisable	Disables the activation status

Definition at line 65 of file MTemplateItemEvent.h.

enum kTemplateLogParsingRuleAction

An enumeration defining a MTemplateParsingRule matching action,.

Defines an enumeration used into the MTemplateParsingRule constructor to define the rule match action

Enumerator
kTemplateLogParsingRuleActionSilence	Silence the matched rule
kTemplateLogParsingRuleActionProcess	Force process the matched rule
kTemplateLogParsingRuleActionDefault	Pass parsing to template logic

Definition at line 94 of file MTemplateParsingRule.h.

enum kTemplateLogParsingRuleMatchType

An enumeration defining a MTemplateParsingRule match type,.

Defines an enumeration used into the MTemplateParsingRule constructor to define the rule match type

Enumerator
kTemplateLogParsingRuleMatchStringMatch	Rule applies to errors
kTemplateLogParsingRuleMatchStringNotMatch	Rule applies to warnings
kTemplateLogParsingRuleMatchStartStringMatch	Rule applies to errors
kTemplateLogParsingRuleMatchStartStringNotMatch	Rule applies to warnings
kTemplateLogParsingRuleMatchEndStringMatch	Rule applies to errors
kTemplateLogParsingRuleMatchEndStringNotMatch	Rule applies to warnings
kTemplateLogParsingRuleMatchRegExpMatch	Rule applies to errors
kTemplateLogParsingRuleMatchRegDoNotMatch	Rule applies to errors

Definition at line 78 of file MTemplateParsingRule.h.

enum kTemplateLogParsingRuleType

An enumeration defining a MTemplateParsingRule type,.

Defines an enumeration used into the MTemplateParsingRule constructor to define the rule type

Enumerator
kTemplateLogParsingRuleErrorType	Rule applies to errors
kTemplateLogParsingRuleWarningType	Rule applies to warnings

Definition at line 68 of file MTemplateParsingRule.h.

enum kTemplateMusterEnvironmentHandling

Muster custom environment handling.

Enumerates the result codes for a template function

Enumerator
kTemplateMusterEnvDoDefault	Process is spawn using Dispatcher global settings
kTemplateMusterEnvGenerate	Process is spawn with Muster custom environment
kTemplateMusterEnvSkip	Process is spawn without Muster custom environment

Definition at line 158 of file MTemplate.h.

enum kTemplatesEncoding

Templates text encoding enumeration.

Enumerates the Muster templates encoding types

Enumerator
kTemplateEncodingUTF8	UTF-8
kTemplateEncodingUTF16	UTF-16

Definition at line 147 of file MTemplate.h.

enum kTemplatesErrorsActions

Templates action enumeration Enumerates the Muster templates actions logic

Enumerator
kTemplateErrorDefault	Do the default
kTemplateErrorPauseJob	Pause the job
kTemplateErrorPauseClient	Pause the node/instance
kTemplateErrorAddTemplateToExclusion	Add template to the instance exclusions list
kTemplateErrorAddJobToExclusion	Add the job to the instance exclusions list
kTemplateErrorRequeueChunk	Requeue the chunk
kTemplateErrorAbortRender	Abort the job
kTemplateErrorIncreaseRequeue	Increase chunk requeue counter
kTemplateErrorKillAnyInstance	Kill any instance rendering the job,

Definition at line 65 of file MTemplateError.h.

enum kTemplatesErrorsTypes

Templates errors enumeration Enumerates the Muster templates errors

Enumerator
kTemplateErrorTypeNone	No error
kTemplateErrorTypeInfo	Informative entry
kTemplateErrorTypeError	Error level entry
kTemplateErrorTypeWarning	Warning level entry
kTemplateErrorReservNoError	No error, used in reserv templates
kTemplateErrorReservSpawnError	Error in spawning a reserv
kTemplateErrorReservTerminated	Error in checking reserv status
kTemplateErrorReservTerminationError	Error in terminating a reserv

Definition at line 79 of file MTemplateError.h.

enum kTemplatesItemTypes

Templates field type enumeration Enumerates the Muster templates fields types

Enumerator
kTemplateItemInvalid	Field is invalid
kTemplateItemFile	Field is a file selector
kTemplateItemDouble	Field is a double value selector
kTemplateItemString	Field is a string value selector
kTemplateItemInt	Field is an int value selector
kTemplateItemCombo	Field is a combo box selector
kTemplateItemFolder	Field is a folder selector
kTemplateItemMultiChoice	Field is a multi choice selector
kTemplateItemCheck	Field is a check box selector
kTemplateItemYesNo	Field is a yes/no boolean selector
kTemplateItemFramesRange	Field is a frame range

Definition at line 70 of file MTemplateItem.h.

Data Structures

Typedefs

Enumerations

Detailed Description

Typedef Documentation

Enumeration Type Documentation