Skip to content

AlgoRegistry

Summary

Provides all installed algorithms data

Signature

1
public abstract interface AlgoRegistry

Namespace

cAlgo.API

Methods

GetCount

Summary

Returns number of specific kind of installed algorithms.

Signature

1
public abstract int GetCount(AlgoKind algoKind)

Parameters

Name Type Description
algoKind AlgoKind Algorithms kind

Return Value

int

Exists (2)

Exists (1 of 2)

Summary

Checks existence of an algorithm.

Signature

1
public abstract bool Exists(string name)

Parameters

Name Type Description
name string Algorithm type name

Return Value

bool

Exists (2 of 2)

Summary

Checks existence of an algorithm.

Signature

1
public abstract bool Exists(string name, AlgoKind algoKind)

Parameters

Name Type Description
name string Algorithm type name
algoKind AlgoKind Algorithm type kind

Return Value

bool

Get (2)

Get (1 of 2)

Summary

Returns number of specific kind of installed algorithms.

Signature

1
public abstract AlgoType Get(string name)

Parameters

Name Type Description
name string

Return Value

AlgoType

Get (2 of 2)

Summary

Returns an algorithm type by it's name.

Signature

1
public abstract AlgoType Get(string name, AlgoKind algoKind)

Parameters

Name Type Description
name string Algorithm type name
algoKind AlgoKind

Return Value

AlgoType

Install (2)

Install (1 of 2)

Summary

Installs an algo file from provided file path.

Signature

1
public abstract InstallationResult Install(string filePath)

Parameters

Name Type Description
filePath string Algo file full file path.

Return Value

InstallationResult

Install (2 of 2)

Summary

Installs an algo file from provided URI.

Signature

1
public abstract InstallationResult Install(Uri uri)

Parameters

Name Type Description
uri Uri Algo file URI.

Return Value

InstallationResult

InstallAsync (4)

InstallAsync (1 of 4)

Summary

Installs an algo file from provided URI asynchrounsly.

Signature

1
public abstract InstallationOperation InstallAsync(string filePath)

Parameters

Name Type Description
filePath string Algo file full file path.

Return Value

InstallationOperation

InstallAsync (2 of 4)

Summary

Installs an algo file from provided URI asynchrounsly.

Signature

1
public abstract InstallationOperation InstallAsync(string filePath, Action<InstallationResult> callback)

Parameters

Name Type Description
filePath string Algo file full file path.
callback Action Callback that will be invoked with installation result.

Return Value

InstallationOperation

InstallAsync (3 of 4)

Summary

Installs an algo file from provided URI asynchrounsly.

Signature

1
public abstract InstallationOperation InstallAsync(Uri uri)

Parameters

Name Type Description
uri Uri Algo file URI.

Return Value

InstallationOperation

InstallAsync (4 of 4)

Summary

Installs an algo file from provided URI asynchrounsly.

Signature

1
public abstract InstallationOperation InstallAsync(Uri uri, Action<InstallationResult> callback)

Parameters

Name Type Description
uri Uri Algo file URI.
callback Action Callback that will be invoked with installation result.

Return Value

InstallationOperation

Properties

Count

Summary

Gets number of installed algorithms.

Signature

1
public abstract int Count {get;}

Return Value

int

Events

AlgoTypeInstalled

Summary

Occurs when a new algorithm is installed.

Signature

1
public abstract event Action<AlgoTypeInstalledEventArgs> AlgoTypeInstalled;

AlgoTypeDeleted

Summary

Occurs when an algorithm is deleted.

Signature

1
public abstract event Action<AlgoTypeDeletedEventArgs> AlgoTypeDeleted;

AlgoTypeChanged

Summary

Occurs when an algorithm is changed.

Signature

1
public abstract event Action<AlgoTypeChangedEventArgs> AlgoTypeChanged;