[DataContract]
public class Algorithm : BaseEntityWithPermissions, IAlgorithm, IBaseEntityWithPermissions, ISetCopier, IHasFolderStructure, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties, ICloneableAsync<IAlgorithm>, ISetCopierCloneAlterer

Constructors

Algorithm()

Declaration

public Algorithm()

Properties

AllowReruns

Indicates if an algorithm run is allowed to be re-run when it is complete

Declaration

[EnumDataType(typeof(RerunState))]
public RerunState AllowReruns { get; set; }

Property Value

Type	Description
RerunState

Declaration

[NotMapped]
public string AllowReruns_Tooltip { get; set; }

Property Value

Type	Description
string

CodeSnippetID

Links to ICodeSnippet. An optional code snippet for processing additional complexity in an algorithm

Declaration

public Guid? CodeSnippetID { get; set; }

Property Value

Type	Description
Guid?

CodeSnippetID_Label

Declaration

public string CodeSnippetID_Label { get; set; }

Property Value

Type	Description
string

CodeSnippetID_Label_Silent

Declaration

[NotMapped]
public string CodeSnippetID_Label_Silent { get; set; }

Property Value

Type	Description
string

CopierCloneType

Declaration

public SetCopierCloneType CopierCloneType { get; set; }

Property Value

Type	Description
SetCopierCloneType

Description

A user friendly description of this algorithm

Declaration

[StringLength(2000)]
public string Description { get; set; }

Property Value

Type	Description
string

FolderID

The link to the folder this item is contained in

Declaration

public Guid? FolderID { get; set; }

Property Value

Type	Description
Guid?

FolderID_Label

Declaration

public string FolderID_Label { get; set; }

Property Value

Type	Description
string

FolderID_Label_Silent

Declaration

[NotMapped]
public string FolderID_Label_Silent { get; set; }

Property Value

Type	Description
string

Name

[Key] A unique friendly name for this algorithm.

Declaration

[Unique]
[Required]
[StringLength(500)]
public string Name { get; set; }

Property Value

Type	Description
string

QueryRunnerID

Links to IQueryRunner. The runner that has parameters and populates this algorithm

Declaration

[RequiredNoDefaultIDValidation]
public Guid QueryRunnerID { get; set; }

Property Value

Type	Description
Guid

QueryRunnerID_Label

Declaration

public string QueryRunnerID_Label { get; set; }

Property Value

Type	Description
string

QueryRunnerID_Label_Silent

Declaration

[NotMapped]
public string QueryRunnerID_Label_Silent { get; set; }

Property Value

Type	Description
string

RunType

Indicates how the system should run an algorithm, whether it stores the calculation, produces an output, or allows a choice

Declaration

[EnumDataType(typeof(AlgorithmRunState))]
public AlgorithmRunState RunType { get; set; }

Property Value

Type	Description
AlgorithmRunState

Declaration

[NotMapped]
public string RunType_Tooltip { get; set; }

Property Value

Type	Description
string

Methods

AlterCopiedItem(IEntityUpdater, UserInfo, IReadOnlyCache, IBaseEntity)

A custom ability to alter this item when it is was copied by the user in the UI, not when it is being imported

Declaration

public Task AlterCopiedItem(IEntityUpdater host, UserInfo user, IReadOnlyCache cache, IBaseEntity sourceItem)

Parameters

Type	Name	Description
IEntityUpdater	host	The context this item was copied into
UserInfo	user	The current user
IReadOnlyCache	cache	The current local cache
IBaseEntity	sourceItem	The original source item this item was copied from

Returns

Type	Description
Task	A task inidicating the finishing of this method

CopyFromEntity(IBaseEntity)

Declaration

protected override void CopyFromEntity(IBaseEntity src)

Parameters

Type	Name	Description
IBaseEntity	src

Overrides

BaseEntity.CopyFromEntity(IBaseEntity)

CopyFromSource(IAlgorithm)

Updates all properties in this item to have the same properties as the source object.

Declaration

public void CopyFromSource(IAlgorithm source)

Parameters

Type	Name	Description
IAlgorithm	source	The source object to copy all values from.

CopyRelatedItem(IBaseEntity, EntityRelationship)

Determines whether the source item should be copied based on the provided relationship

Declaration

public bool CopyRelatedItem(IBaseEntity sourceItem, EntityRelationship rel)

Parameters

Type	Name	Description
IBaseEntity	sourceItem	The original source item this item was copied from
EntityRelationship	rel	The particular relationship from the source item

Returns

Type	Description
bool

ToString()

Declaration

public override string ToString()

Returns

Type	Description
string