Interface IFunctionManager

An interface to the functions aspect of SQL Race

Namespace: MESL.SqlRace.Domain.Functions

Assembly: MESL.SqlRace.Domain.dll

Syntax

public interface IFunctionManager

Properties

ConstantDefinitions

A read-only list of all constant definitions

Declaration

IReadOnlyList<IConstantDefinition> ConstantDefinitions { get; }

Property Value

Type	Description
System.Collections.Generic.IReadOnlyList<IConstantDefinition>

FunctionDefinitions

A read-only list of all function definitions.

Declaration

IReadOnlyList<IFunctionDefinition> FunctionDefinitions { get; }

Property Value

Type	Description
System.Collections.Generic.IReadOnlyList<IFunctionDefinition>	The function definitions.

Methods

AddConstantDefinition(IConstantDefinition)

Adds a constant definition to the function manager

Declaration

void AddConstantDefinition(IConstantDefinition constantDefinition)

Parameters

Type	Name	Description
IConstantDefinition	constantDefinition

Build(IFunctionDefinition)

Builds the given function definition by committing changes to it, building the function implementation, and making its output parameters available for use.

Declaration

FunctionBuildResults Build(IFunctionDefinition functionDef)

Parameters

Type	Name	Description
IFunctionDefinition	functionDef	The function definition to build.

Returns

Type	Description
FunctionBuildResults	The results of the function build operation.

CreateFunctionDefinition(Guid)

Creates a function definition based on the specified function executor. Defaults to MESL.SqlRace.Functions.Interfaces.Enums.FunctionMode.LeadingEdge and Frequency of 10Hz.

Declaration

IFunctionDefinition CreateFunctionDefinition(Guid functionBuilderId)

Parameters

Type	Name	Description
System.Guid	functionBuilderId	The unique ID of registered function builder.

Returns

Type	Description
IFunctionDefinition	A new function definition.

CreateFunctionDefinition(Guid, FunctionMode, CalculationModeInfoDefinition)

Creates a function definition based on the specified function executor.

Declaration

IFunctionDefinition CreateFunctionDefinition(Guid functionBuilderId, FunctionMode functionMode, CalculationModeInfoDefinition calculationModeInfoDefinition)

Parameters

Type	Name	Description
System.Guid	functionBuilderId	The unique ID of registered function builder.
MESL.SqlRace.Functions.Interfaces.Enums.FunctionMode	functionMode	MESL.SqlRace.Functions.Interfaces.Enums.FunctionMode
CalculationModeInfoDefinition	calculationModeInfoDefinition	CalculationModeInfoDefinition

Returns

Type	Description
IFunctionDefinition	A new function definition.

GetFunctionDefinition(Guid)

Looks for a function definition by its instance identifier including hidden ones.

Declaration

IFunctionDefinition GetFunctionDefinition(Guid instanceIdentifier)

Parameters

Type	Name	Description
System.Guid	instanceIdentifier

Returns

Type	Description
IFunctionDefinition	IFunctionDefinition

Remove(IFunctionDefinition)

Removes the specified function definition.

Declaration

void Remove(IFunctionDefinition functionDef)

Parameters

Type	Name	Description
IFunctionDefinition	functionDef	The function definition.

RemoveConstantDefinition(String)

Removes a constant definition from a constant manager

Declaration

void RemoveConstantDefinition(string name)

Parameters

Type	Name	Description
System.String	name

Save(IFunctionDefinition)

Saves the given function definition.

Declaration

void Save(IFunctionDefinition functionDef)

Parameters

Type	Name	Description
IFunctionDefinition	functionDef	The function definition to save.

Validate(IFunctionDefinition)

Validates the specified function definition by evaluating its properties and building it to get errors and warnings. Does not persist the function definition, and makes no permanent changes to the state of the system.

Declaration

FunctionValidationResults Validate(IFunctionDefinition functionDef)

Parameters

Type	Name	Description
IFunctionDefinition	functionDef	The function definition to validate.

Returns

Type	Description
FunctionValidationResults	The results of the function build operation.

Events

FunctionAdded

Occurs when function is added.

Declaration

event EventHandler<FunctionAddedEventArgs> FunctionAdded

Event Type

Type	Description
System.EventHandler<FunctionAddedEventArgs>

FunctionModified

Occurs when function is modified.

Declaration

event EventHandler<FunctionModifiedEventArgs> FunctionModified

Event Type

Type	Description
System.EventHandler<FunctionModifiedEventArgs>

FunctionRemoved

Occurs when function is removed.

Declaration

event EventHandler<FunctionRemovedEventArgs> FunctionRemoved

Event Type

Type	Description
System.EventHandler<FunctionRemovedEventArgs>

FunctionRenamed

Occurs when function is renamed.

Declaration

event EventHandler<FunctionRenamedEventArgs> FunctionRenamed

Event Type

Type	Description
System.EventHandler<FunctionRenamedEventArgs>