Class Module

Inheritance

System.Object

Module

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: CompAnalytics.Contracts

Assembly: CompAnalytics.Contracts.dll

Syntax

[DataContract]
public class Module

Constructors

Module()

Declaration

public Module()

Properties

AccumulatedValues

Declaration

[DataMember]
public List<object> AccumulatedValues { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<System.Object>

CacheResults

If enabled, a module's inputs will be cached for potential reuse.

Declaration

[DataMember]
public bool CacheResults { get; set; }

Property Value

Type	Description
System.Boolean

ContinueOnError

Declaration

[DataMember]
public bool ? ContinueOnError { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

ControlledModuleHandles

Declaration

[DataMember]
public HashSet<string> ControlledModuleHandles { get; set; }

Property Value

Type	Description
System.Collections.Generic.HashSet<System.String>

ControllingCycleHandles

Declaration

[DataMember]
public List<string> ControllingCycleHandles { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<System.String>

Failed

Declaration

[DataMember]
public bool Failed { get; set; }

Property Value

Type	Description
System.Boolean

ForceExecution

Declaration

[DataMember]
public bool ForceExecution { get; set; }

Property Value

Type	Description
System.Boolean

HasExecuted

Not all modules in application will execute. This will be set if we tried to execute it.

Declaration

[DataMember]
public bool HasExecuted { get; set; }

Property Value

Type	Description
System.Boolean

HasInputConnections

Declaration

[DataMember]
public bool HasInputConnections { get; set; }

Property Value

Type	Description
System.Boolean

HasOutputConnections

Declaration

[DataMember]
public bool HasOutputConnections { get; set; }

Property Value

Type	Description
System.Boolean

HasResumed

Declaration

public bool HasResumed { get; set; }

Property Value

Type	Description
System.Boolean

Id

Declaration

[DataMember]
public int ? Id { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

IsMinimized

Declaration

[DataMember]
public bool IsMinimized { get; set; }

Property Value

Type	Description
System.Boolean

IterationCount

How many times a cycle module (loop or stream) has executed.

Declaration

[DataMember]
public int ? IterationCount { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

LastRunId

Declaration

[DataMember]
public int ? LastRunId { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

Location

Declaration

[DataMember]
public Location Location { get; set; }

Property Value

Type	Description
Location

LoopComplete

Declaration

[DataMember]
public bool LoopComplete { get; set; }

Property Value

Type	Description
System.Boolean

ModuleInputs

Declaration

[DataMember]
public ModuleInputCollection ModuleInputs { get; set; }

Property Value

Type	Description
ModuleInputCollection

ModuleOutputs

Declaration

[DataMember]
public ModuleOutputCollection ModuleOutputs { get; set; }

Property Value

Type	Description
ModuleOutputCollection

ModuleType

Declaration

[DataMember]
public ModuleType ModuleType { get; set; }

Property Value

Type	Description
ModuleType

Name

Declaration

[DataMember]
public string Name { get; set; }

Property Value

Type	Description
System.String

NestedRefAppId

Declaration

[DataMember]
public int ? NestedRefAppId { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

PassedLoopValues

Declaration

public object PassedLoopValues { get; set; }

Property Value

Type	Description
System.Object

PinResults

Declaration

[DataMember]
public bool PinResults { get; set; }

Property Value

Type	Description
System.Boolean

ProgressStats

Declaration

[DataMember]
public ProgressStats ProgressStats { get; set; }

Property Value

Type	Description
ProgressStats

RequestingExecution

Declaration

[DataMember]
public bool RequestingExecution { get; set; }

Property Value

Type	Description
System.Boolean

RetryCount

Declaration

[DataMember]
public int RetryCount { get; set; }

Property Value

Type	Description
System.Int32

RetryDelay

Declaration

[DataMember]
public TimeSpan RetryDelay { get; set; }

Property Value

Type	Description
System.TimeSpan

RunReuseTimeoutMS

Oldest runs to look at for cached results (in ms)

Declaration

[DataMember]
public int RunReuseTimeoutMS { get; set; }

Property Value

Type	Description
System.Int32

Skipped

Declaration

[DataMember]
public bool Skipped { get; set; }

Property Value

Type	Description
System.Boolean

StreamBreak

Declaration

public bool StreamBreak { get; set; }

Property Value

Type	Description
System.Boolean

TryStepInto

Set when steping through application. True if user trying to step into module This does not go across the wire

Declaration

public bool TryStepInto { get; set; }

Property Value

Type	Description
System.Boolean

UiHandle

Declaration

[DataMember]
public string UiHandle { get; set; }

Property Value

Type	Description
System.String

Version

Declaration

[DataMember]
public int Version { get; set; }

Property Value

Type	Description
System.Int32

Methods

Clone()

Declaration

public Module Clone()

Returns

Type	Description
Module

GetInputOrDefault<T>(String, T)

Declaration

public T GetInputOrDefault<T>(string inputName, T defaultValue)

Parameters

Type	Name	Description
System.String	inputName
T	defaultValue

Returns

Type	Description
T

Type Parameters

Name	Description
T

GetInputOrDefault<ModuleT, ValueT>(Expression<Func<ModuleT, ModuleInput<ValueT>>>, ValueT)

Declaration

public ValueT GetInputOrDefault<ModuleT, ValueT>(Expression<Func<ModuleT, ModuleInput<ValueT>>> propertySelector, ValueT defaultValue)

Parameters

Type	Name	Description
System.Linq.Expressions.Expression<System.Func<ModuleT, ModuleInput<ValueT>>>	propertySelector
ValueT	defaultValue

Returns

Type	Description
ValueT

Type Parameters

Name	Description
ModuleT
ValueT

HasExecutorType<T>()

Declaration

public bool HasExecutorType<T>()

Returns

Type	Description
System.Boolean

Type Parameters

Name	Description
T