DiGi.Core.Parameter.Interfaces

DiGi.Core.Parameter

DiGi.Core.Parameter.Interfaces Namespace

Interfaces

IParameterDefinition Interface

Defines the contract for a parameter definition.

public interface IParameterDefinition : DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IObject, System.IEquatable<DiGi.Core.Parameter.Interfaces.IParameterDefinition>, DiGi.Core.Interfaces.INamedObject

Derived
↳ ParameterDefinition

Implements DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IObject, System.IEquatable<IParameterDefinition>, DiGi.Core.Interfaces.INamedObject

Properties

IParameterDefinition.GroupName Property

Gets the group name to which this parameter belongs.

string? GroupName { get; }

Property Value

System.String

IParameterDefinition.ParameterType Property

Gets the type of the parameter.

DiGi.Core.Parameter.Enums.ParameterType ParameterType { get; }

Property Value

ParameterType

IParameterDefinition.UniqueId Property

Gets the unique identifier of the parameter definition.

string? UniqueId { get; }

Property Value

System.String

Methods

IParameterDefinition.IsValid(object) Method

Determines whether the specified value is valid for this parameter definition.

bool IsValid(object? value);

Parameters

value System.Object

The value to validate.

Returns

System.Boolean
True if the value is valid, false otherwise.

IParametrizedGuidObject Interface

Defines the contract for a GUID-based unique object that can be parameterized.

public interface IParametrizedGuidObject : DiGi.Core.Parameter.Interfaces.IParametrizedUniqueObject, DiGi.Core.Parameter.Interfaces.IParametrizedObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.IUniqueIdObject, DiGi.Core.Interfaces.IUniqueObject, DiGi.Core.Interfaces.IGuidObject

Derived
↳ ParametrizedGuidObject

Implements IParametrizedUniqueObject, IParametrizedObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.IUniqueIdObject, DiGi.Core.Interfaces.IUniqueObject, DiGi.Core.Interfaces.IGuidObject

IParametrizedObject Interface

Defines the contract for an object that can be parameterized.

public interface IParametrizedObject : DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IObject

Derived
↳ ParametrizedGuidObject
↳ ParametrizedObject
↳ ParametrizedUniqueIdObject
↳ IParametrizedGuidObject
↳ IParametrizedUniqueIdObject
↳ IParametrizedUniqueObject

Implements DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IObject

Methods

IParametrizedObject.GetParameterDefinitions<TParameterDefinition>() Method

Gets a list of parameter definitions of the specified type.

System.Collections.Generic.List<TParameterDefinition>? GetParameterDefinitions<TParameterDefinition>()
    where TParameterDefinition : DiGi.Core.Parameter.Interfaces.IParameterDefinition;

Type parameters

TParameterDefinition

The type of the parameter definition.

Returns

System.Collections.Generic.List<TParameterDefinition>
A list containing the matching parameter definitions, or null.

IParametrizedObject.Remove(IParameterDefinition) Method

Removes the specified parameter definition from the object.

bool Remove(DiGi.Core.Parameter.Interfaces.IParameterDefinition? parameterDefinition);

Parameters

parameterDefinition IParameterDefinition

The parameter definition to remove.

Returns

System.Boolean
True if the parameter was removed, false otherwise.

IParametrizedObject.SetValue(IParameterDefinition, object, SetValueSettings) Method

Sets the value of the specified parameter.

bool SetValue(DiGi.Core.Parameter.Interfaces.IParameterDefinition? parameterDefinition, object? value, DiGi.Core.Parameter.Classes.SetValueSettings? setValueSettings=null);

Parameters

parameterDefinition IParameterDefinition

The parameter definition to set.

value System.Object

The value to set.

setValueSettings SetValueSettings

Optional settings for setting the value.

Returns

System.Boolean
True if the value was successfully set, false otherwise.

IParametrizedObject.TryGetValue<T>(IParameterDefinition, T, GetValueSettings) Method

Tries to get the value of the specified parameter.

bool TryGetValue<T>(DiGi.Core.Parameter.Interfaces.IParameterDefinition? parameterDefinition, out T? value, DiGi.Core.Parameter.Classes.GetValueSettings? getValueSettings=null);

Type parameters

T

The expected type of the parameter value.

Parameters

parameterDefinition IParameterDefinition

The parameter definition to retrieve.

value T

The retrieved value, or default if not found.

getValueSettings GetValueSettings

Optional settings for retrieving the value.

Returns

System.Boolean
True if the value was successfully retrieved, false otherwise.

IParametrizedUniqueIdObject Interface

Defines the contract for a unique ID object that can be parameterized.

public interface IParametrizedUniqueIdObject : DiGi.Core.Parameter.Interfaces.IParametrizedUniqueObject, DiGi.Core.Parameter.Interfaces.IParametrizedObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.IUniqueIdObject, DiGi.Core.Interfaces.IUniqueObject

Derived
↳ ParametrizedUniqueIdObject

Implements IParametrizedUniqueObject, IParametrizedObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.IUniqueIdObject, DiGi.Core.Interfaces.IUniqueObject

IParametrizedUniqueObject Interface

Defines the contract for a unique object that can be parameterized.

public interface IParametrizedUniqueObject : DiGi.Core.Parameter.Interfaces.IParametrizedObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.IUniqueIdObject, DiGi.Core.Interfaces.IUniqueObject

Derived
↳ ParametrizedGuidObject
↳ ParametrizedUniqueIdObject
↳ IParametrizedGuidObject
↳ IParametrizedUniqueIdObject

Implements IParametrizedObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.IUniqueIdObject, DiGi.Core.Interfaces.IUniqueObject