Revision as of 09:52, 25 May 2017

CatTaskScheduleHelper

Helper class for scheduling CatTasks

Constructors

() - Instanciate helper

Methods

CatTaskSchedule GetScheduleByInstanceId(int instanceId "Id of an instance of a task") - From an instance, find the task and find its schedule
CatTaskSchedule GetScheduleByMetaDataId(int taskId "Id of a task") - From a task, find its schedule
Empty RescheduleByInstanceId(int instanceId "Id of an instance of a task", CatTaskSchedule schedule "The new schedule to use") - From an instance, find the task and alter its schedule
Empty RescheduleByMetaDataId(int taskId "Id of a task", CatTaskSchedule schedule "The new schedule to use") - From a task, alter its schedule
string ToString() - The string representation of the object.

Properties

string ObjectTypeName { get; } - The name of the type of object.
TypeInformation TypeInformation { get; } - Get information about this class.

@@ Line 1: / Line 1: @@
+{{CGscriptClass_Template
-Helper class for scheduling CatTasks
+|Name=<nowiki>CatTaskScheduleHelper</nowiki>
+|Description=<nowiki>Helper class for scheduling CatTasks</nowiki>
-Constructors
+|Constructors=
+{{CGscriptConstructors_Template|Description=<nowiki>Instanciate helper</nowiki>}}
-() - Instanciate helper
+|Methods=
+{{CGscriptMethods_Template|ReturnType=CatTaskSchedule|Name=<nowiki>GetScheduleByInstanceId</nowiki>|Parameters=
-Methods
+{{CGscriptParameters_Template|Type=int|Name=<nowiki>instanceId</nowiki>|Description=<nowiki>Id of an instance of a task</nowiki>}}
+|Description=<nowiki>From an instance, find the task and find its schedule</nowiki>}}
-CatTaskSchedule GetScheduleByInstanceId(int instanceId "Id of an instance of a task") - From an instance, find the task and find its schedule
+{{CGscriptMethods_Template|ReturnType=CatTaskSchedule|Name=<nowiki>GetScheduleByMetaDataId</nowiki>|Parameters=
+{{CGscriptParameters_Template|Type=int|Name=<nowiki>taskId</nowiki>|Description=<nowiki>Id of a task</nowiki>}}
-CatTaskSchedule GetScheduleByMetaDataId(int taskId "Id of a task") - From a task, find its schedule
+|Description=<nowiki>From a task, find its schedule</nowiki>}}
+{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>RescheduleByInstanceId</nowiki>|Parameters=
-Empty RescheduleByInstanceId(int instanceId "Id of an instance of a task", CatTaskSchedule schedule "The new schedule to use") - From an instance, find the task and alter its schedule
+{{CGscriptParameters_Template|Type=int|Name=<nowiki>instanceId</nowiki>|Description=<nowiki>Id of an instance of a task</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=CatTaskSchedule|Name=<nowiki>schedule</nowiki>|Description=<nowiki>The new schedule to use</nowiki>}}
+|Description=<nowiki>From an instance, find the task and alter its schedule</nowiki>}}
-Empty RescheduleByMetaDataId(int taskId "Id of a task", CatTaskSchedule schedule "The new schedule to use") - From a task, alter its schedule
+{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>RescheduleByMetaDataId</nowiki>|Parameters=
+{{CGscriptParameters_Template|Type=int|Name=<nowiki>taskId</nowiki>|Description=<nowiki>Id of a task</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=CatTaskSchedule|Name=<nowiki>schedule</nowiki>|Description=<nowiki>The new schedule to use</nowiki>}}
-string ToString() - The string representation of the object.
+|Description=<nowiki>From a task, alter its schedule</nowiki>}}
+{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
-Properties
+|Properties=
+{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
-string ObjectTypeName { get; } - The name of the type of object.
+{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
+}}
-TypeInformation TypeInformation { get; } - Get information about this class.
-[[Category:Classes]]