Click or drag to resize

CompleteTaskModel Class

The CompleteTask action marks a task as complete in the simulation.
Inheritance Hierarchy

Namespace:  Livit.Learn.Model.Actions
Assembly:  Livit.Learn.Model (in Livit.Learn.Model.dll) Version: 0.0.0.0
Syntax
C#
[SerializableAttribute]
public class CompleteTaskModel : ActionModel

The CompleteTaskModel type exposes the following members.

Constructors
  NameDescription
Public methodCompleteTaskModel
Initializes a new instance of the CompleteTaskModel class
Top
Properties
  NameDescription
Public propertyAttached
Defines an attached property.
(Inherited from BaseModel.)
Public propertyComments
(Development) Includes comments in the XML code.
(Inherited from BaseModel.)
Public propertyConditions (Inherited from ConditionsDependantModel.)
Public propertyConditionTimeout (Inherited from ConditionsDependantModel.)
Public propertyCode exampleDataContext
Contains a source of all bindings defined for element.
(Inherited from BaseModel.)
Public propertyExternalXmlPath (Inherited from BaseModel.)
Public propertyGlobalOrderIndex (Inherited from ActionModel.)
Public propertyHashedPath (Inherited from ActionModel.)
Public propertyId
Defines a unique identifier for an element in the simulation.
(Inherited from BaseModel.)
Public propertyIgnoreInPH (Inherited from ActionModel.)
Public propertyIsIdAutogenerated (Inherited from BaseModel.)
Public propertyIsRunning (Inherited from ActionModel.)
Public propertyIsTransient (Inherited from ActionModel.)
Public propertyIsTransientInstance (Inherited from ActionModel.)
Public propertyTargetTask
Public propertyTemplateVersionId
Contains a id of source template.
(Inherited from BaseModel.)
Public propertyXmlComments
(Development) Used as temporary storage for XML comments (like ) to keep them.
(Inherited from BaseModel.)
Top
Methods
  NameDescription
Public methodDeepCopy
Creates an in-memory clone of this object using a BinaryFormatter to ensure all child properties are copied as well.
(Inherited from BaseModel.)
Public methodShallowCopy (Inherited from BaseModel.)
Public methodToString
Returns a string that represents the current object.
(Inherited from BaseModel.)
Public methodUpdateModels
This method will update this model and all its child models.
(Inherited from BaseModel.)
Top
Remarks

It is recommended to use Task.CompletedWhen instead of CompleteTask whenever possible.

Using CompleteTask significantly increases the risk of a task being unintentionally completed, leaving the user blocked in the simulation.

As a best practice, always use conditions in Task.CompletedWhen to let the task monitor changes in the simulation and assessing completion by itself, which enables proper separation of concerns in the XML.

See Also