Class FunctionOutputParameterDefinition

Defines an output parameter of a function

Inheritance
System.Object
FunctionOutputParameterDefinition
Namespace: MESL.SqlRace.Domain.Functions
Assembly: MESL.SqlRace.Domain.dll
Syntax
public sealed class FunctionOutputParameterDefinition : Object

Constructors

FunctionOutputParameterDefinition()

Declaration
public FunctionOutputParameterDefinition()

Properties

ApplicationName

Gets or sets the application group for this parameter

Declaration
public string ApplicationName { get; set; }
Property Value
Type Description
System.String

The name of the application.

BitShift

Gets or sets the bit shift for the parameter

Declaration
public short BitShift { get; set; }
Property Value
Type Description
System.Int16

The bit shift.
Remarks

The default value is 0

ByteOrder

Gets or sets the byte order for the parameter

Declaration
public ByteOrderType ByteOrder { get; set; }
Property Value
Type Description
ByteOrderType

The byte order.
Remarks

The default value is ByteOrderType.LittleEndian

ConversionFunctionName

Gets or sets the name of the conversion function that is applied to data values for this parameter

Declaration
public string ConversionFunctionName { get; set; }
Property Value
Type Description
System.String

The name of the conversion function.

DataBitMask

Gets or sets the bit mask used to provide a value to the parameter

Declaration
public uint DataBitMask { get; set; }
Property Value
Type Description
System.UInt32

The data bit mask.

Description

Gets or sets the description

Declaration
public string Description { get; set; }
Property Value
Type Description
System.String

The description.

ErrorBitMask

Gets or sets the bit mask used to provide an error value to the parameter

Declaration
public uint ErrorBitMask { get; set; }
Property Value
Type Description
System.UInt32

The error bit mask.

Format

Gets or sets the format for the parameter.

Declaration
public string Format { get; set; }
Property Value
Type Description
System.String

The format.

FormatOverride

Gets or sets the format override for the parameter. This can be used to override the format specified in the conversion function.

Declaration
public string FormatOverride { get; set; }
Property Value
Type Description
System.String

The format override.

Identifier

Gets or sets the identifier

Declaration
public string Identifier { get; }
Property Value
Type Description
System.String

The identifier.

InstanceIdentifier

Gets the instance identifier.

Declaration
public Guid InstanceIdentifier { get; }
Property Value
Type Description
System.Guid

The instance identifier.

MaximumValue

Gets or sets the maximum value

Declaration
public string MaximumValue { get; set; }
Property Value
Type Description
System.String

The maximum value.

MinimumValue

Gets or sets the minimum value

Declaration
public string MinimumValue { get; set; }
Property Value
Type Description
System.String

The minimum value.

Name

Gets or sets the name

Declaration
public string Name { get; set; }
Property Value
Type Description
System.String

The name.

OffsetValue

Gets or sets the offset value

Declaration
public double OffsetValue { get; set; }
Property Value
Type Description
System.Double

The offset value.

ShowInBrowser

Gets a value indicating whether this instance is available to browsers.

Declaration
public bool ShowInBrowser { get; set; }
Property Value
Type Description
System.Boolean

true if this instance is available to browsers; otherwise, false.

Units

Gets or sets the units for the parameter

Declaration
public string Units { get; set; }
Property Value
Type Description
System.String

The units.

WarningMaximumValue

Gets or sets the warning maximum value

Declaration
public double WarningMaximumValue { get; set; }
Property Value
Type Description
System.Double

The warning maximum value.

WarningMinimumValue

Gets or sets the warning minimum value.

Declaration
public double WarningMinimumValue { get; set; }
Property Value
Type Description
System.Double

The warning minimum value.

Methods

Create(String)

Static method for creating a function output parameter definition.

Declaration
public static FunctionOutputParameterDefinition Create(string name)
Parameters
Type Name Description
System.String name

The name.
Returns
Type Description
FunctionOutputParameterDefinition

Create(String, String, String)

Static method for acquiring a function output parameter

Declaration
public static FunctionOutputParameterDefinition Create(string name, string applicationGroup, string description)
Parameters
Type Name Description
System.String name

The name
System.String applicationGroup

The application group
System.String description

The description
Returns
Type Description
FunctionOutputParameterDefinition

A new instance of FunctionOutputParameterDefinition.

Extension Methods