Interface IFunctionDefinition

Interface to a function definition

Inherited Members

IDistinguishable.DistinctionCode

Namespace: MESL.SqlRace.Domain.Functions

Assembly: MESL.SqlRace.Domain.dll

Syntax

public interface IFunctionDefinition : IDistinguishable

Properties

CalculateOverWholeSession

Gets or sets whether the function should always be calculated over the session as a whole

Declaration

bool CalculateOverWholeSession { get; set; }

Property Value

Type	Description
System.Boolean	true if [calculate over whole session]; otherwise, false.

CalculationModeInfoDefinition

Gets the definition of the calculation mode information.

Declaration

CalculationModeInfoDefinition CalculationModeInfoDefinition { get; }

Property Value

Type	Description
CalculationModeInfoDefinition	The definition of the calculation mode information.

ExecutionStrategyDefinition

Gets or sets the execution strategy definition.

Declaration

IFunctionExecutionStrategyDefinition ExecutionStrategyDefinition { get; set; }

Property Value

Type	Description
IFunctionExecutionStrategyDefinition	The execution strategy definition.

FullFilePath

Gets or sets the full file path.

Declaration

string FullFilePath { get; set; }

Property Value

Type	Description
System.String	The full file path.

FunctionFolder

Gets the folder from which the function was loaded.

Declaration

string FunctionFolder { get; set; }

Property Value

Type	Description
System.String	The function folder.

FunctionMode

Gets or sets how the function is to be evaluated

Declaration

FunctionMode FunctionMode { get; set; }

Property Value

Type	Description
MESL.SqlRace.Functions.Interfaces.Enums.FunctionMode	The function mode.

ImplementationDefinition

The implementation-specific implementation of this function

Declaration

IFunctionImplementationDefinition ImplementationDefinition { get; }

Property Value

Type	Description
IFunctionImplementationDefinition	The implementation definition.

InputParameterIdentifiers

Gets the input parameter identifiers for the function.

Declaration

List<string> InputParameterIdentifiers { get; }

Property Value

Type	Description
System.Collections.Generic.List<System.String>	The input parameter identifiers required as inputs for the function.

InstanceIdentifier

Gets the instance identifier.

Declaration

Guid InstanceIdentifier { get; }

Property Value

Type	Description
System.Guid	The instance identifier.

InterpolateBetweenSamples

Gets or sets whether interpolation should be used between samples

Declaration

bool InterpolateBetweenSamples { get; set; }

Property Value

Type	Description
System.Boolean	true if [interpolate between samples]; otherwise, false.

JoinGapsAroundNull

Gets or sets whether gaps should be joined around null values

Declaration

bool JoinGapsAroundNull { get; set; }

Property Value

Type	Description
System.Boolean	true if [join gaps around null]; otherwise, false.

Name

Gets or sets the name.

Declaration

string Name { get; set; }

Property Value

Type	Description
System.String	The name.

OutputParameterDefinitions

Gets the output parameter definitions.

Declaration

List<FunctionOutputParameterDefinition> OutputParameterDefinitions { get; }

Property Value

Type	Description
System.Collections.Generic.List<FunctionOutputParameterDefinition>	The output parameters definitions.

ProcessorInstanceDefinitions

Gets the processor instance definitions.

Declaration

List<IProcessorInstanceDefinition> ProcessorInstanceDefinitions { get; }

Property Value

Type	Description
System.Collections.Generic.List<IProcessorInstanceDefinition>	The processor instance definitions.

RelativePath

Gets the path to the function relative to the functions folder.

Declaration

string RelativePath { get; set; }

Property Value

Type	Description
System.String	The path

ShouldHide

Hides the definition from MESL.SqlRace.Domain.Functions.FunctionManager, and can only be retrieved via its InstanceIdentifier. Default value is false.

Declaration

bool ShouldHide { get; set; }

Property Value

Type	Description
System.Boolean	true if [hidden]; otherwise, false.

ShouldPersist

Gets or sets whether the function should live in-memory and not be physically persisted.

Declaration

bool ShouldPersist { get; set; }

Property Value

Type	Description
System.Boolean

StoreInSession

Gets or sets whether the function should be stored in an associated session

Declaration

bool StoreInSession { get; set; }

Property Value

Type	Description
System.Boolean	true if [store in session]; otherwise, false.

Methods

SetInstanceIdentifier(Guid)

Sets the instance identifier.

Declaration

void SetInstanceIdentifier(Guid instanceIdentifier)

Parameters

Type	Name	Description
System.Guid	instanceIdentifier	The instance identifier.