Task

A wrapper for components within the Project Schematic.

Declaration Syntax

public class Task : ACTMarshalByRefObject, ITask

Table 1945: Members

Property

ActiveDirectory

Obtains the active design point directory for the task's task group.

Property

AlwaysIncludeInDPUpdate

Gets a value indicating whether this task should always be part of a design point update even if it won't affect any parameter value.

Property

Caption

Gets or sets task's UI-visible display text.

Property

Container

Gets the container for the given task.

Property

CoordinateId

Gets the task coordinate Id as a union of the task group letter and task index.

Property

CoupledClients

Gets the list of coupled client data tasks.

Property

CoupledToTask

Gets the coupling server task (if available).

Property

DirectoryName

Gets the data directory name to be shown in the UI

Property

ImageName

Gets the task icon image name.

Property

InputData

Gets the input data, by type string key, for this task.

Property

InternalObject

Gets the task's internal object (component).

Property

IsFailedState

Gets a value indicating whether this task is in a failed state from a previous data operation (e.g., update, refresh).

Property

IsSharing

Gets a value indicating whether this task is a slave of a master sharing source.

Property

MasterTask

Gets the master task from which this task directly consumes shared data. This will always be the immediate upstream sharing source, no matter if the sharing is full-share. For the true root data task, use RealTask.

Property

Name

Gets the task's name (same as TaskId).

Property

Notes

Gets or sets the task notes.

Property

OutputData

Gets the output data, by type string key, for this task.

Property

Parameters

Gets the list of input and output parameters associated with the task.

Property

Properties

Gets a dictionary of properties, accessible by property name.

Property

RealTask

Gets the shared data root task from which this task consumes shared data. This will always be the first (original, non-grayed) sharing source if full-shared. Otherwise, it will be the task itself.

Property

Solver

Gets the task solver type.

Property

SourceTasks

Gets the list of tasks providing data to this task.

Property

State

Gets the task's state.

Property

TargetTasks

Gets the list of tasks consuming data from this task.

Property

TaskGroup

Gets the task-containing task group.

Property

TaskId

Gets the task's ID

Property

Template

Gets the template from which this task was created.

Property

UsedLicenses

Gets the used licenses for this component. This dictionary maps the license ids to the number of used licenses for this task.

Property

UserId

Gets the ID to be shown in the UI

Property

UserTask

Gets the ACT User Object associated with this task. This will return null unless the task is a custom ACT-defined task.

Method

Clean()

Deletes the heavyweight data (e.g. solution and/or results) of this task to reduce the size of the project.

Method

ExecuteCommand(string, IDictionary<string, object>)

Executes a specific task-bound command.

Method

GetPropertyNames()

The names of all properties declared within this task's data model.

Method

Refresh()

Refreshes the input data for a task by reading all changed data from upstream (source) tasks. Does not perform any calculations or updates based on the new data.

Method

Remove()

Deletes the task and all dependents from its task group.

Method

Reset()

Resets the task by removing all user input and result data.

Method

Update()

Updates the task by refreshing the input from all upstream components and then performs a local calculation based on current data.