-
Notifications
You must be signed in to change notification settings - Fork 0
DiGi.Core.Parameter.Classes
Defines a set of types associated with an enum value.
public class AssociatedTypes : System.Attribute, System.Collections.IEnumerable, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IObjectInheritance System.Object → System.Attribute → AssociatedTypes
Implements System.Collections.IEnumerable, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IObject
Initializes a new instance of the AssociatedTypes class by copying another AssociatedTypes instance.
public AssociatedTypes(DiGi.Core.Parameter.Classes.AssociatedTypes? associatedTypes);associatedTypes AssociatedTypes
The AssociatedTypes instance to copy.
Initializes a new instance of the AssociatedTypes class from a JSON object.
public AssociatedTypes(System.Text.Json.Nodes.JsonObject? jsonObject);jsonObject System.Text.Json.Nodes.JsonObject
The JSON object containing associated types data.
Initializes a new instance of the AssociatedTypes class with specified values.
public AssociatedTypes(params System.Type[]? values);values System.Type[]
The associated types.
Gets the collection of associated types.
public System.Type[]? Types { get; }Creates a shallow copy of the current AssociatedTypes instance.
public virtual DiGi.Core.Interfaces.ISerializableObject? Clone();Implements Clone()
DiGi.Core.Interfaces.ISerializableObject
A cloned ISerializableObject.
Populates the current AssociatedTypes instance from a JSON object.
public virtual bool FromJsonObject(System.Text.Json.Nodes.JsonObject? jsonObject);jsonObject System.Text.Json.Nodes.JsonObject
The JSON object to read data from.
Implements FromJsonObject(JsonObject)
System.Boolean
True if successful, false otherwise.
Returns an enumerator that iterates through the associated types.
public System.Collections.IEnumerator GetEnumerator();Implements GetEnumerator()
System.Collections.IEnumerator
An IEnumerator for the Types collection.
Determines whether a specified type is associated with this instance.
public virtual bool IsValid(System.Type? type);type System.Type
The type to validate.
System.Boolean
True if the type is valid, false otherwise.
Converts the current AssociatedTypes instance to a JSON object.
public virtual System.Text.Json.Nodes.JsonObject? ToJsonObject();Implements ToJsonObject()
System.Text.Json.Nodes.JsonObject
The resulting JsonObject.
Represents a boolean value for a parameter.
public class BooleanParameterValue : DiGi.Core.Parameter.Classes.ParameterValueInheritance System.Object → System.Attribute → ParameterValue → BooleanParameterValue
Initializes a new instance of the BooleanParameterValue class.
public BooleanParameterValue();Initializes a new instance of the BooleanParameterValue class with specified nullability.
public BooleanParameterValue(bool nullable);nullable System.Boolean
A value indicating whether the parameter is nullable.
Initializes a new instance of the BooleanParameterValue class by copying an existing value.
public BooleanParameterValue(DiGi.Core.Parameter.Classes.BooleanParameterValue? booleanParameterValue);booleanParameterValue BooleanParameterValue
The BooleanParameterValue to copy.
Initializes a new instance of the BooleanParameterValue class from a JSON object.
public BooleanParameterValue(System.Text.Json.Nodes.JsonObject? jsonObject);jsonObject System.Text.Json.Nodes.JsonObject
The JSON object to initialize the current instance from.
Gets the type of the parameter, which is Integer.
public override DiGi.Core.Parameter.Enums.ParameterType ParameterType { get; }Creates a shallow copy of the current integer parameter value.
public override DiGi.Core.Interfaces.ISerializableObject? Clone();Implements Clone()
DiGi.Core.Interfaces.ISerializableObject
A shallow copy of the current integer parameter value.
Determines whether the specified value is a valid integer parameter value.
public override bool IsValid(object? value);value System.Object
The value to validate.
System.Boolean
True if the specified value is a valid integer parameter value; otherwise, false.
Attempts to convert the specified input value to an integer parameter value.
public override bool TryConvert(object? value_In, out object? value_Out);value_In System.Object
The input value to be converted.
value_Out System.Object
When this method returns, contains the converted value if successful; otherwise, null.
System.Boolean
True if the conversion was successful; otherwise, false.
Represents the abstract base class for complex parameter definitions.
public abstract class ComplexParameterDefinition : DiGi.Core.Parameter.Classes.ParameterDefinitionInheritance System.Object → DiGi.Core.Classes.Object → DiGi.Core.Classes.SerializableObject → ParameterDefinition → ComplexParameterDefinition
Derived
↳ EnumParameterDefinition
↳ ExternalParameterDefinition
Creates a new instance of the ComplexParameterDefinition class.
public ComplexParameterDefinition();Creates a new instance of the ComplexParameterDefinition class by copying another ComplexParameterDefinition.
public ComplexParameterDefinition(DiGi.Core.Parameter.Classes.ComplexParameterDefinition? complexParameterDefinition);complexParameterDefinition ComplexParameterDefinition
The ComplexParameterDefinition to copy.
Creates a new instance of the ComplexParameterDefinition class from a JSON object.
public ComplexParameterDefinition(System.Text.Json.Nodes.JsonObject? jsonObject);jsonObject System.Text.Json.Nodes.JsonObject
The JSON object containing the complex parameter definition data.
Gets the access type of the complex parameter definition.
public abstract DiGi.Core.Parameter.Enums.AccessType AccessType { get; }Gets the associated types of the complex parameter definition.
public abstract DiGi.Core.Parameter.Classes.AssociatedTypes? AssociatedTypes { get; }Gets the description of the complex parameter definition.
public abstract string? Description { get; }Gets the type of the parameter.
public override DiGi.Core.Parameter.Enums.ParameterType ParameterType { get; }Implements ParameterType
Gets the parameter value of the complex parameter definition.
public abstract DiGi.Core.Parameter.Classes.ParameterValue? ParameterValue { get; }Determines whether the specified value is valid for this complex parameter definition.
public override bool IsValid(object? value);value System.Object
The value to validate.
Implements IsValid(object)
System.Boolean
True if the value is valid, false otherwise.
Represents a double-precision floating-point value for a parameter.
public class DoubleParameterValue : DiGi.Core.Parameter.Classes.ParameterValueInheritance System.Object → System.Attribute → ParameterValue → DoubleParameterValue
Initializes a new instance of the DoubleParameterValue class.
public DoubleParameterValue();Initializes a new instance of the DoubleParameterValue class with specified nullability.
public DoubleParameterValue(bool nullable);nullable System.Boolean
A value indicating whether the parameter is nullable.
Initializes a new instance of the DoubleParameterValue class with specified nullability and range.
public DoubleParameterValue(bool nullable, double min, double max);nullable System.Boolean
A value indicating whether the parameter is nullable.
min System.Double
The minimum value for the parameter.
max System.Double
The maximum value for the parameter.
Initializes a new instance of the DoubleParameterValue class by copying an existing value.
public DoubleParameterValue(DiGi.Core.Parameter.Classes.DoubleParameterValue? doubleParameterValue);doubleParameterValue DoubleParameterValue
The existing value to copy from.
Initializes a new instance of the DoubleParameterValue class with a minimum value.
public DoubleParameterValue(double min);min System.Double
The minimum value for the parameter.
Initializes a new instance of the DoubleParameterValue class with a specified range.
public DoubleParameterValue(double min, double max);min System.Double
The minimum value for the parameter.
max System.Double
The maximum value for the parameter.
Initializes a new instance of the DoubleParameterValue class from a JSON object.
public DoubleParameterValue(System.Text.Json.Nodes.JsonObject? jsonObject);jsonObject System.Text.Json.Nodes.JsonObject
The JSON object to initialize the value from.
Gets the type of the parameter, which is Integer.
public override DiGi.Core.Parameter.Enums.ParameterType ParameterType { get; }Creates a shallow copy of the current integer parameter value.
public override DiGi.Core.Interfaces.ISerializableObject? Clone();Implements Clone()
DiGi.Core.Interfaces.ISerializableObject
A shallow copy of the current integer parameter value.
Determines whether the specified value is a valid integer parameter value.
public override bool IsValid(object? value);value System.Object
The value to validate.
System.Boolean
True if the specified value is a valid integer parameter value; otherwise, false.
Attempts to convert the specified input value to an integer parameter value.
public override bool TryConvert(object? value_In, out object? value_Out);value_In System.Object
The input value to be converted.
value_Out System.Object
When this method returns, contains the converted value if successful; otherwise, null.
System.Boolean
True if the conversion was successful; otherwise, false.
Defines a parameter based on an enumeration type.
public class EnumParameterDefinition : DiGi.Core.Parameter.Classes.ComplexParameterDefinitionInheritance System.Object → DiGi.Core.Classes.Object → DiGi.Core.Classes.SerializableObject → ParameterDefinition → ComplexParameterDefinition → EnumParameterDefinition
Initializes a new instance of the EnumParameterDefinition class.
public EnumParameterDefinition();Initializes a new instance of the EnumParameterDefinition class by copying an existing definition.
public EnumParameterDefinition(DiGi.Core.Parameter.Classes.EnumParameterDefinition? enumParameterDefinition);enumParameterDefinition EnumParameterDefinition
The existing enum parameter definition to copy.
Initializes a new instance of the EnumParameterDefinition class based on a specific enumeration value.
public EnumParameterDefinition(System.Enum? @enum);enum System.Enum
The enumeration value to use for initialization.
Initializes a new instance of the EnumParameterDefinition class from a JSON object.
public EnumParameterDefinition(System.Text.Json.Nodes.JsonObject? jsonObject);jsonObject System.Text.Json.Nodes.JsonObject
The JSON object used to initialize the parameter definition.
Gets the access type for the enum parameter.
public override DiGi.Core.Parameter.Enums.AccessType AccessType { get; }Gets the associated types for the enum parameter.
public override DiGi.Core.Parameter.Classes.AssociatedTypes? AssociatedTypes { get; }Gets or sets the description of the enum parameter.
public override string? Description { get; }Gets the group name to which the enum parameter belongs.
public override string GroupName { get; }Implements GroupName
Gets or sets the name of the enum parameter.
public override string? Name { get; }Implements Name
Gets or sets the current value of the enum parameter.
public override DiGi.Core.Parameter.Classes.ParameterValue? ParameterValue { get; }Gets or sets the unique identifier for the enum parameter.
public override string? UniqueId { get; }Implements UniqueId
Creates a copy of the current enum parameter definition.
public override DiGi.Core.Interfaces.ISerializableObject? Clone();Implements Clone()
DiGi.Core.Interfaces.ISerializableObject
A clone of the current enum parameter definition as an DiGi.Core.Interfaces.ISerializableObject.
Populates the enum parameter definition from a JSON object.
public override bool FromJsonObject(System.Text.Json.Nodes.JsonObject? jsonObject);jsonObject System.Text.Json.Nodes.JsonObject
The JSON object to populate the definition from.
Implements FromJsonObject(JsonObject)
System.Boolean
true if the population was successful; otherwise, false.
Converts the enum parameter definition to a JSON object.
public override System.Text.Json.Nodes.JsonObject ToJsonObject();Implements ToJsonObject()
System.Text.Json.Nodes.JsonObject
A System.Text.Json.Nodes.JsonObject representation of the enum parameter definition.
Explicitly converts an System.Enum to an EnumParameterDefinition.
public static DiGi.Core.Parameter.Classes.EnumParameterDefinition? explicit operator DiGi.Core.Parameter.Classes.EnumParameterDefinition?(System.Enum? @enum);enum System.Enum
The enum value to convert.
EnumParameterDefinition
An EnumParameterDefinition instance created from the provided enum, or null if the input is null.
Explicitly converts an EnumParameterDefinition to its underlying System.Enum value.
public static System.Enum? explicit operator System.Enum?(DiGi.Core.Parameter.Classes.EnumParameterDefinition? enumParameterDefinition);enumParameterDefinition EnumParameterDefinition
The enum parameter definition to convert.
System.Enum
The System.Enum value associated with the definition, or null if the input is null.
Represents a parameter definition defined externally with explicit metadata.
public class ExternalParameterDefinition : DiGi.Core.Parameter.Classes.ComplexParameterDefinition, DiGi.Core.Interfaces.INamedObject, DiGi.Core.Interfaces.IObjectInheritance System.Object → DiGi.Core.Classes.Object → DiGi.Core.Classes.SerializableObject → ParameterDefinition → ComplexParameterDefinition → ExternalParameterDefinition
Implements DiGi.Core.Interfaces.INamedObject, DiGi.Core.Interfaces.IObject
Creates a new instance of the ExternalParameterDefinition class.
public ExternalParameterDefinition();Creates a new instance of the ExternalParameterDefinition class by copying another ExternalParameterDefinition.
public ExternalParameterDefinition(DiGi.Core.Parameter.Classes.ExternalParameterDefinition? externalParameterDefinition);externalParameterDefinition ExternalParameterDefinition
The ExternalParameterDefinition to copy.
ExternalParameterDefinition(Guid, string, string, AccessType, ParameterValue, AssociatedTypes, string) Constructor
Creates a new instance of the ExternalParameterDefinition class with the specified parameters.
public ExternalParameterDefinition(System.Guid guid, string? name, string? description, DiGi.Core.Parameter.Enums.AccessType accessType, DiGi.Core.Parameter.Classes.ParameterValue? parameterValue, DiGi.Core.Parameter.Classes.AssociatedTypes associatedTypes, string? groupName);guid System.Guid
The unique identifier.
name System.String
The name.
description System.String
The description.
accessType AccessType
The access type.
parameterValue ParameterValue
The parameter value.
associatedTypes AssociatedTypes
The associated types.
groupName System.String
The group name.
Creates a new instance of the ExternalParameterDefinition class from a JSON object.
public ExternalParameterDefinition(System.Text.Json.Nodes.JsonObject? jsonObject);jsonObject System.Text.Json.Nodes.JsonObject
The JSON object containing the external parameter definition data.
Gets the access type of the external parameter definition.
public override DiGi.Core.Parameter.Enums.AccessType AccessType { get; }Gets the associated types of the external parameter definition.
public override DiGi.Core.Parameter.Classes.AssociatedTypes? AssociatedTypes { get; }Gets the description of the external parameter definition.
public override string? Description { get; }Gets the group name of the external parameter definition.
public override string? GroupName { get; }Implements GroupName
Gets the name of the external parameter definition.
public override string? Name { get; }Implements Name
Gets the parameter value of the external parameter definition.
public override DiGi.Core.Parameter.Classes.ParameterValue? ParameterValue { get; }Gets the unique identifier of the external parameter definition.
public override string UniqueId { get; }Implements UniqueId
Determines whether the specified value is valid for this external parameter definition.
public override bool IsValid(object? value);value System.Object
The value to validate.
Implements IsValid(object)
System.Boolean
True if the value is valid, false otherwise.
Contains settings for retrieving a parameter value.
public class GetValueSettingsInheritance System.Object → GetValueSettings
Initializes a new instance of the GetValueSettings class.
public GetValueSettings();Initializes a new instance of the GetValueSettings class with specified options.
public GetValueSettings(bool tryConvert, bool checkAccessType);tryConvert System.Boolean
Whether to attempt conversion if types do not match.
checkAccessType System.Boolean
Whether to check for read access permissions.
Gets or sets a value indicating whether the access type should be checked during retrieval.
public bool CheckAccessType { get; set; }Gets or sets a value indicating whether to attempt conversion of the value during retrieval.
public bool TryConvert { get; set; }Represents a GUID value for a parameter.
public class GuidParameterValue : DiGi.Core.Parameter.Classes.ParameterValueInheritance System.Object → System.Attribute → ParameterValue → GuidParameterValue
Initializes a new instance of the GuidParameterValue class.
public GuidParameterValue();Initializes a new instance of the GuidParameterValue class with specified nullability.
public GuidParameterValue(bool nullable);nullable System.Boolean
A value indicating whether the parameter is nullable.
Initializes a new instance of the GuidParameterValue class by copying an existing value.
public GuidParameterValue(DiGi.Core.Parameter.Classes.GuidParameterValue? guidParameterValue);guidParameterValue GuidParameterValue
The existing value to copy.
Initializes a new instance of the GuidParameterValue class from a JSON object.
public GuidParameterValue(System.Text.Json.Nodes.JsonObject? jsonObject);jsonObject System.Text.Json.Nodes.JsonObject
The JSON object to initialize from.
Gets the type of the parameter, which is Integer.
public override DiGi.Core.Parameter.Enums.ParameterType ParameterType { get; }Creates a shallow copy of the current integer parameter value.
public override DiGi.Core.Interfaces.ISerializableObject? Clone();Implements Clone()
DiGi.Core.Interfaces.ISerializableObject
A shallow copy of the current object.
Represents an integer value for a parameter.
public class IntegerParameterValue : DiGi.Core.Parameter.Classes.ParameterValueInheritance System.Object → System.Attribute → ParameterValue → IntegerParameterValue
Initializes a new instance of the IntegerParameterValue class.
public IntegerParameterValue();Initializes a new instance of the IntegerParameterValue class with specified nullability.
public IntegerParameterValue(bool nullable);nullable System.Boolean
Indicates whether the value can be null.
Initializes a new instance of the IntegerParameterValue class with specified nullability and range.
public IntegerParameterValue(bool nullable, int min, int max);nullable System.Boolean
Indicates whether the value can be null.
min System.Int32
The minimum value for the parameter.
max System.Int32
The maximum value for the parameter.
Initializes a new instance of the IntegerParameterValue class by copying an existing value.
public IntegerParameterValue(DiGi.Core.Parameter.Classes.IntegerParameterValue? integerParameterValue);integerParameterValue IntegerParameterValue
The existing integer parameter value to copy.
Initializes a new instance of the IntegerParameterValue class with a minimum value.
public IntegerParameterValue(int min);min System.Int32
The minimum value for the parameter.
Initializes a new instance of the IntegerParameterValue class with a specified range.
public IntegerParameterValue(int min, int max);min System.Int32
The minimum value for the parameter.
max System.Int32
The maximum value for the parameter.
Initializes a new instance of the IntegerParameterValue class from a JSON object.
public IntegerParameterValue(System.Text.Json.Nodes.JsonObject? jsonObject);jsonObject System.Text.Json.Nodes.JsonObject
The JSON object to initialize the value from.
Gets the type of the parameter, which is Integer.
public override DiGi.Core.Parameter.Enums.ParameterType ParameterType { get; }Creates a shallow copy of the current integer parameter value.
public override DiGi.Core.Interfaces.ISerializableObject? Clone();Implements Clone()
DiGi.Core.Interfaces.ISerializableObject
A shallow copy of the current object.
Determines whether the specified value is a valid integer parameter value.
public override bool IsValid(object? value);value System.Object
The value to validate.
System.Boolean
True if the value is valid; otherwise, false.
Attempts to convert the specified input value to an integer parameter value.
public override bool TryConvert(object? value_In, out object? value_Out);value_In System.Object
The input value to convert.
value_Out System.Object
When this method returns, contains the converted value if successful; otherwise, null.
System.Boolean
True if the conversion was successful; otherwise, false.
Represents a parameter value that can hold an object of one or more specified types.
public class ObjectParameterValue : DiGi.Core.Parameter.Classes.ParameterValueInheritance System.Object → System.Attribute → ParameterValue → ObjectParameterValue
Initializes a new instance of the ObjectParameterValue class.
public ObjectParameterValue();Initializes a new instance of the ObjectParameterValue class with specified nullability, inheritance rules, and allowed types.
public ObjectParameterValue(bool nullable, bool inheritance, params System.Type[] types);nullable System.Boolean
Specifies whether the value can be null.
inheritance System.Boolean
Specifies whether inheritance is considered when validating types.
types System.Type[]
The collection of allowed types for this parameter value.
Initializes a new instance of the ObjectParameterValue class by copying an existing instance.
public ObjectParameterValue(DiGi.Core.Parameter.Classes.ObjectParameterValue? objectParameterValue);objectParameterValue ObjectParameterValue
The existing instance to copy.
Initializes a new instance of the ObjectParameterValue class from a JSON object.
public ObjectParameterValue(System.Text.Json.Nodes.JsonObject? jsonObject);jsonObject System.Text.Json.Nodes.JsonObject
The JSON object to initialize the current instance with.
Gets the parameter type associated with this string parameter value.
public override DiGi.Core.Parameter.Enums.ParameterType ParameterType { get; }Creates a clone of the current string parameter value.
public override DiGi.Core.Interfaces.ISerializableObject? Clone();Implements Clone()
DiGi.Core.Interfaces.ISerializableObject
A new instance of DiGi.Core.Interfaces.ISerializableObject that is a copy of the current object.
Determines whether the specified value is valid for this parameter.
public override bool IsValid(object? value);value System.Object
The value to validate.
System.Boolean
True if the value is valid; otherwise, false.
Attempts to convert the specified input value to a compatible output value.
public override bool TryConvert(object? value_In, out object? value_Out);value_In System.Object
The input value to be converted.
value_Out System.Object
When this method returns, contains the converted value if successful; otherwise, null.
System.Boolean
True if the conversion was successful; otherwise, false.
Represents a parameter with a definition and a value.
public class Parameter : DiGi.Core.Classes.SerializableObjectInheritance System.Object → DiGi.Core.Classes.Object → DiGi.Core.Classes.SerializableObject → Parameter
Creates a new instance of the Parameter class by copying another Parameter.
public Parameter(DiGi.Core.Parameter.Classes.Parameter? parameter);parameter Parameter
The Parameter to copy.
Creates a new instance of the Parameter class with the specified parameter definition.
internal Parameter(DiGi.Core.Parameter.Interfaces.IParameterDefinition? parameterDefinition);parameterDefinition IParameterDefinition
The parameter definition.
Creates a new instance of the Parameter class with the specified parameter definition and value.
internal Parameter(DiGi.Core.Parameter.Interfaces.IParameterDefinition? parameterDefinition, object? value);parameterDefinition IParameterDefinition
The parameter definition.
value System.Object
The parameter value.
Creates a new instance of the Parameter class from a JSON object.
public Parameter(System.Text.Json.Nodes.JsonObject? jsonObject);jsonObject System.Text.Json.Nodes.JsonObject
The JSON object containing the parameter data.
Gets the name of the parameter.
public string? Name { get; }Gets the parameter definition.
public DiGi.Core.Parameter.Interfaces.IParameterDefinition? ParameterDefinition { get; }Gets the type of the parameter.
public DiGi.Core.Parameter.Enums.ParameterType ParameterType { get; }Gets the unique identifier of the parameter.
public string? UniqueId { get; }Gets the value of the parameter.
public object? Value { get; }Creates a deep copy of the Parameter.
public override DiGi.Core.Interfaces.ISerializableObject? Clone();Implements Clone()
DiGi.Core.Interfaces.ISerializableObject
A new cloned instance of the Parameter.
Gets the value of the parameter, converted to the specified type.
public T? GetValue<T>(DiGi.Core.Parameter.Classes.GetValueSettings? getValueSettings=null);T
The type to convert the value to.
getValueSettings GetValueSettings
Optional settings for retrieving the value.
T
The converted value, or default if conversion fails.
Sets the value of the parameter.
public bool SetValue(object? value, DiGi.Core.Parameter.Classes.SetValueSettings? setValueSettings=null);value System.Object
The value to set.
setValueSettings SetValueSettings
Optional settings for setting the value.
System.Boolean
True if the value was successfully set, false otherwise.
Tries to get the value of the parameter, converted to the specified type.
public bool TryGetValue<T>(out T? value, DiGi.Core.Parameter.Classes.GetValueSettings? getValueSettings=null);T
The type to convert the value to.
value T
The converted value, or default if conversion fails.
getValueSettings GetValueSettings
Optional settings for retrieving the value.
System.Boolean
True if the value was successfully retrieved, false otherwise.
Provides a base class for defining parameters.
public abstract class ParameterDefinition : DiGi.Core.Classes.SerializableObject, DiGi.Core.Parameter.Interfaces.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.INamedObjectInheritance System.Object → DiGi.Core.Classes.Object → DiGi.Core.Classes.SerializableObject → ParameterDefinition
Derived
↳ ComplexParameterDefinition
↳ SimpleParameterDefinition
Implements IParameterDefinition, 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
Initializes a new instance of the ParameterDefinition class.
public ParameterDefinition();Initializes a new instance of the ParameterDefinition class by copying an existing definition.
public ParameterDefinition(DiGi.Core.Parameter.Classes.ParameterDefinition? parameterDefinition);parameterDefinition ParameterDefinition
The parameter definition to copy from.
Initializes a new instance of the ParameterDefinition class from a JSON object.
public ParameterDefinition(System.Text.Json.Nodes.JsonObject? jsonObject);jsonObject System.Text.Json.Nodes.JsonObject
The JSON object to initialize the definition from.
Gets the group name to which the parameter belongs.
public abstract string? GroupName { get; }Implements GroupName
Gets or sets the name of the parameter.
public abstract string? Name { get; }Implements Name
Gets the type of the parameter.
public abstract DiGi.Core.Parameter.Enums.ParameterType ParameterType { get; }Implements ParameterType
Gets or sets the unique identifier for the parameter.
public abstract string? UniqueId { get; }Implements UniqueId
Determines whether the specified parameter definition is equal to the current instance.
public bool Equals(DiGi.Core.Parameter.Interfaces.IParameterDefinition? parameterDefinition);parameterDefinition IParameterDefinition
The parameter definition to compare with the current instance.
System.Boolean
True if the specified parameter definition is equal to the current instance; otherwise, false.
Validates whether the provided value is valid for this parameter definition.
public virtual bool IsValid(object? value);value System.Object
The value to validate.
Implements IsValid(object)
System.Boolean
True if the value is valid; otherwise, false.
Represents a group of parameters.
public class ParameterGroup : DiGi.Core.Classes.SerializableObject, System.Collections.Generic.IEnumerable<DiGi.Core.Parameter.Classes.Parameter>, System.Collections.IEnumerableInheritance System.Object → DiGi.Core.Classes.Object → DiGi.Core.Classes.SerializableObject → ParameterGroup
Implements System.Collections.Generic.IEnumerable<Parameter>, System.Collections.IEnumerable
Initializes a new instance of the ParameterGroup class by copying another group.
public ParameterGroup(DiGi.Core.Parameter.Classes.ParameterGroup? parameterGroup);parameterGroup ParameterGroup
The parameter group to copy from.
Initializes a new instance of the ParameterGroup class with a specified name.
public ParameterGroup(string? name);name System.String
The name of the parameter group.
Initializes a new instance of the ParameterGroup class with a specified name and a collection of parameters.
public ParameterGroup(string? name, System.Collections.Generic.IEnumerable<DiGi.Core.Parameter.Classes.Parameter>? parameters);name System.String
The name of the parameter group.
parameters System.Collections.Generic.IEnumerable<Parameter>
The collection of parameters to include in the group.
Initializes a new instance of the ParameterGroup class from a JSON object.
public ParameterGroup(System.Text.Json.Nodes.JsonObject? jsonObject);jsonObject System.Text.Json.Nodes.JsonObject
The JSON object to initialize the group from.
Gets or sets the display name of the parameter.
public string? Name { get; }Creates a deep copy of the current parameter group.
public override DiGi.Core.Interfaces.ISerializableObject? Clone();Implements Clone()
DiGi.Core.Interfaces.ISerializableObject
A deep copy of the current parameter group.
Determines whether any group in the collection contains a parameter matching the specified definition.
public bool Contains(DiGi.Core.Parameter.Interfaces.IParameterDefinition? parameterDefinition);parameterDefinition IParameterDefinition
The parameter definition to search for.
System.Boolean
True if the collection contains a parameter matching the specified definition; otherwise, false.
Determines whether any group in the collection contains a parameter with the specified unique identifier.
public bool Contains(string? uniqueId);uniqueId System.String
The unique identifier of the parameter to search for.
System.Boolean
True if the collection contains a parameter with the specified unique identifier; otherwise, false.
Returns an enumerator that iterates through the parameters in the group.
public System.Collections.Generic.IEnumerator<DiGi.Core.Parameter.Classes.Parameter> GetEnumerator();Implements GetEnumerator(), GetEnumerator()
System.Collections.Generic.IEnumerator<Parameter>
An enumerator that iterates through the parameters in the group.
Retrieves a list of parameter definitions that match the specified name and comparison criteria.
public System.Collections.Generic.List<DiGi.Core.Parameter.Interfaces.IParameterDefinition>? GetParameterDefinitions(string? name, DiGi.Core.Enums.TextComparisonType textComparisonType=DiGi.Core.Enums.TextComparisonType.Equals, bool caseSensitive=true);name System.String
The name of the parameters to search for.
textComparisonType DiGi.Core.Enums.TextComparisonType
The type of text comparison to use when matching the name.
caseSensitive System.Boolean
A value indicating whether the name comparison is case-sensitive.
System.Collections.Generic.List<IParameterDefinition>
A list of parameter definitions that match the specified criteria, or null if no matches are found.
Retrieves a list of parameter definitions of type T that match the specified name and comparison criteria.
public System.Collections.Generic.List<T>? GetParameterDefinitions<T>(string? name, DiGi.Core.Enums.TextComparisonType textComparisonType=DiGi.Core.Enums.TextComparisonType.Equals, bool caseSensitive=true)
where T : DiGi.Core.Parameter.Interfaces.IParameterDefinition;T
The type of parameter definitions to retrieve.
name System.String
The name of the parameters to search for.
textComparisonType DiGi.Core.Enums.TextComparisonType
The type of text comparison to use when matching the name.
caseSensitive System.Boolean
A value indicating whether the name comparison is case-sensitive.
System.Collections.Generic.List<T>
A list of parameter definitions of type T that match the specified criteria, or null if no matches are found.
Retrieves a list of parameter definitions of the specified type within the group.
public System.Collections.Generic.List<TParameterDefinition>? GetParameterDefinitions<TParameterDefinition>()
where TParameterDefinition : DiGi.Core.Parameter.Interfaces.IParameterDefinition;TParameterDefinition
The type of parameter definition to retrieve.
System.Collections.Generic.List<TParameterDefinition>
A list of parameter definitions of the specified type, or null if none are found.
Gets the value associated with the specified parameter definition from the collection.
public object? GetValue(DiGi.Core.Parameter.Interfaces.IParameterDefinition? parameterDefinition, DiGi.Core.Parameter.Classes.GetValueSettings? getValueSettings=null);parameterDefinition IParameterDefinition
The parameter definition to retrieve the value for.
getValueSettings GetValueSettings
Optional settings for retrieving the value.
System.Object
The value associated with the specified parameter definition, or null if not found.
Gets the value associated with the specified unique identifier from the collection.
public object? GetValue(string? uniqueId, DiGi.Core.Parameter.Classes.GetValueSettings? getValueSettings=null);uniqueId System.String
The unique identifier of the value to get.
getValueSettings GetValueSettings
Optional settings for retrieving the value.
System.Object
The value associated with the specified unique identifier, or null if not found.
Gets the value of type T associated with the specified parameter definition from the collection.
public T? GetValue<T>(DiGi.Core.Parameter.Interfaces.IParameterDefinition? parameterDefinition, DiGi.Core.Parameter.Classes.GetValueSettings? getValueSettings=null);T
The type of the value to retrieve.
parameterDefinition IParameterDefinition
The definition of the parameter whose value is to be retrieved.
getValueSettings GetValueSettings
Optional settings to control how the value is retrieved.
T
The value associated with the specified parameter definition, or the default value for type T if not found.
Gets the value of type T associated with the specified unique identifier.
public T? GetValue<T>(string? uniqueId, DiGi.Core.Parameter.Classes.GetValueSettings? getValueSettings=null);T
The type of the value to retrieve.
uniqueId System.String
The unique identifier of the value to get.
getValueSettings GetValueSettings
Optional settings for retrieving the value.
T
The value of type T associated with the specified unique identifier, or null if not found.
Removes the parameter matching the specified definition from the collection.
public bool Remove(DiGi.Core.Parameter.Interfaces.IParameterDefinition? parameterDefinition);parameterDefinition IParameterDefinition
The definition of the parameter to remove.
System.Boolean
True if the parameter was successfully removed; otherwise, false.
Removes the parameter with the specified unique identifier from the group.
public bool Remove(string uniqueId);uniqueId System.String
The unique identifier of the parameter to remove.
System.Boolean
True if the parameter was successfully removed; otherwise, false.
Adds or updates a parameter in the collection.
public bool SetValue(DiGi.Core.Parameter.Classes.Parameter? parameter);parameter Parameter
The parameter to add or update.
System.Boolean
True if the operation was successful; otherwise, false.
Sets the value for the parameter matching the specified definition within the collection.
public bool SetValue(DiGi.Core.Parameter.Interfaces.IParameterDefinition? parameterDefinition, object? value, DiGi.Core.Parameter.Classes.SetValueSettings? setValueSettings=null);parameterDefinition IParameterDefinition
The definition of the parameter to set.
value System.Object
The value to assign to the parameter.
setValueSettings SetValueSettings
Optional settings to control how the value is set.
System.Boolean
True if the value was successfully set; otherwise, false.
Sets the value for the parameter identified by the specified name within the collection.
public bool SetValue(string? name, object? value, DiGi.Core.Parameter.Classes.SetValueSettings? setValueSettings=null);name System.String
The name of the parameter to set.
value System.Object
The value to assign to the parameter.
setValueSettings SetValueSettings
Optional settings to control how the value is set.
System.Boolean
True if the value was successfully set; otherwise, false.
Attempts to get the value associated with the specified parameter definition from the collection.
public bool TryGetValue(DiGi.Core.Parameter.Interfaces.IParameterDefinition? parameterDefinition, out object? value, DiGi.Core.Parameter.Classes.GetValueSettings? getValueSettings=null);parameterDefinition IParameterDefinition
The parameter definition for which to retrieve the value.
value System.Object
When this method returns, contains the retrieved value if found; otherwise, null.
getValueSettings GetValueSettings
Optional settings to use when retrieving the value.
System.Boolean
True if the value was successfully retrieved; otherwise, false.
Attempts to get the value associated with the specified unique identifier from the collection.
public bool TryGetValue(string? uniqueId, out object? value, DiGi.Core.Parameter.Classes.GetValueSettings? getValueSettings=null);uniqueId System.String
The unique identifier of the parameter for which to retrieve the value.
value System.Object
When this method returns, contains the retrieved value if found; otherwise, null.
getValueSettings GetValueSettings
Optional settings to use when retrieving the value.
System.Boolean
True if the value was successfully retrieved; otherwise, false.
Attempts to get the value of type T associated with the specified parameter definition from the collection.
public bool TryGetValue<T>(DiGi.Core.Parameter.Interfaces.IParameterDefinition? parameterDefinition, out T? value, DiGi.Core.Parameter.Classes.GetValueSettings? getValueSettings=null);T
The type of the value to retrieve.
parameterDefinition IParameterDefinition
The parameter definition for which to retrieve the value.
value T
When this method returns, contains the retrieved value of type T if found; otherwise, the default value of T.
getValueSettings GetValueSettings
Optional settings to use when retrieving the value.
System.Boolean
True if the value was successfully retrieved; otherwise, false.
Attempts to get the value of type T associated with the specified unique identifier from the collection.
public bool TryGetValue<T>(string? uniqueId, out T? value, DiGi.Core.Parameter.Classes.GetValueSettings? getValueSettings=null);T
The type of the value to retrieve.
uniqueId System.String
The unique identifier of the parameter for which to retrieve the value.
value T
When this method returns, contains the retrieved value of type T if found; otherwise, the default value of T.
getValueSettings GetValueSettings
Optional settings to use when retrieving the value.
System.Boolean
True if the value was successfully retrieved; otherwise, false.
Represents a collection of parameter groups.
public class ParameterGroupCollection : DiGi.Core.Classes.SerializableObject, System.Collections.Generic.IEnumerable<DiGi.Core.Parameter.Classes.ParameterGroup>, System.Collections.IEnumerableInheritance System.Object → DiGi.Core.Classes.Object → DiGi.Core.Classes.SerializableObject → ParameterGroupCollection
Implements System.Collections.Generic.IEnumerable<ParameterGroup>, System.Collections.IEnumerable
Initializes a new instance of the ParameterGroupCollection class.
public ParameterGroupCollection();Initializes a new instance of the ParameterGroupCollection class by copying another collection.
public ParameterGroupCollection(DiGi.Core.Parameter.Classes.ParameterGroupCollection? parameterGroupCollection);parameterGroupCollection ParameterGroupCollection
The parameter group collection to copy from.
Initializes a new instance of the ParameterGroupCollection class from a collection of parameters.
public ParameterGroupCollection(System.Collections.Generic.IEnumerable<DiGi.Core.Parameter.Classes.Parameter>? parameters);parameters System.Collections.Generic.IEnumerable<Parameter>
The collection of parameters to initialize the collection with.
Initializes a new instance of the ParameterGroupCollection class from a JSON object.
public ParameterGroupCollection(System.Text.Json.Nodes.JsonObject? jsonObject);jsonObject System.Text.Json.Nodes.JsonObject
The JSON object to initialize the collection from.
Gets the parameter group associated with the specified name.
public DiGi.Core.Parameter.Classes.ParameterGroup? this[string? name] { get; }name System.String
The name of the parameter group to retrieve.
Creates a deep copy of the current parameter group collection.
public override DiGi.Core.Interfaces.ISerializableObject? Clone();Implements Clone()
DiGi.Core.Interfaces.ISerializableObject
A deep copy of the current parameter group collection.
Determines whether any group in the collection contains a parameter matching the specified definition.
public bool Contains(DiGi.Core.Parameter.Interfaces.IParameterDefinition? parameterDefinition);parameterDefinition IParameterDefinition
The parameter definition to search for.
System.Boolean
True if any group in the collection contains a parameter matching the specified definition; otherwise, false.
Determines whether any group in the collection contains a parameter with the specified unique identifier.
public bool Contains(string? uniqueId);uniqueId System.String
The unique identifier of the parameter to search for.
System.Boolean
True if any group in the collection contains a parameter with the specified unique identifier; otherwise, false.
Returns an enumerator that iterates through the parameter groups in the collection.
public System.Collections.Generic.IEnumerator<DiGi.Core.Parameter.Classes.ParameterGroup> GetEnumerator();Implements GetEnumerator(), GetEnumerator()
System.Collections.Generic.IEnumerator<ParameterGroup>
An enumerator that iterates through the parameter groups in the collection.
Retrieves a list of parameter definitions that match the specified name and comparison criteria across all groups.
public System.Collections.Generic.List<DiGi.Core.Parameter.Interfaces.IParameterDefinition>? GetParameterDefinitions(string? parameterName, DiGi.Core.Enums.TextComparisonType textComparisonType=DiGi.Core.Enums.TextComparisonType.Equals, bool caseSensitive=true);parameterName System.String
The name of the parameters to search for.
textComparisonType DiGi.Core.Enums.TextComparisonType
The type of text comparison to use when matching the name.
caseSensitive System.Boolean
A value indicating whether the comparison should be case-sensitive.
System.Collections.Generic.List<IParameterDefinition>
A list of parameter definitions that match the criteria, or null if none are found.
Retrieves a list of all parameter definitions of the specified type across all groups.
public System.Collections.Generic.List<TParameterDefinition> GetParameterDefinitions<TParameterDefinition>()
where TParameterDefinition : DiGi.Core.Parameter.Interfaces.IParameterDefinition;TParameterDefinition
The type of parameter definition to retrieve.
System.Collections.Generic.List<TParameterDefinition>
A list containing all parameter definitions of the specified type.
ParameterGroupCollection.GetParameterDefinitions<TParameterDefinition>(string, TextComparisonType, bool) Method
Retrieves a list of parameter definitions of type TParameterDefinition that match the specified name and comparison criteria across all groups.
public System.Collections.Generic.List<TParameterDefinition>? GetParameterDefinitions<TParameterDefinition>(string? parameterName, DiGi.Core.Enums.TextComparisonType textComparisonType=DiGi.Core.Enums.TextComparisonType.Equals, bool caseSensitive=true)
where TParameterDefinition : DiGi.Core.Parameter.Interfaces.IParameterDefinition;TParameterDefinition
The type of parameter definition to retrieve.
parameterName System.String
The name of the parameters to search for.
textComparisonType DiGi.Core.Enums.TextComparisonType
The type of text comparison to use when matching the name.
caseSensitive System.Boolean
A value indicating whether the comparison should be case-sensitive.
System.Collections.Generic.List<TParameterDefinition>
A list of parameter definitions that match the criteria, or null if none are found.
Gets the value associated with the specified parameter definition from the collection.
public object? GetValue(DiGi.Core.Parameter.Interfaces.IParameterDefinition? parameterDefinition, DiGi.Core.Parameter.Classes.GetValueSettings? getValueSettings=null);parameterDefinition IParameterDefinition
The parameter definition used to retrieve the value.
getValueSettings GetValueSettings
Optional settings to customize how the value is retrieved.
System.Object
The value associated with the specified parameter definition, or null if not found.
Gets the value associated with the specified unique identifier from the collection.
public object? GetValue(string? uniqueId, DiGi.Core.Parameter.Classes.GetValueSettings? getValueSettings=null);uniqueId System.String
The unique identifier of the value to retrieve.
getValueSettings GetValueSettings
Optional settings to customize how the value is retrieved.
System.Object
The value associated with the specified unique identifier, or null if not found.
Gets the value of type T associated with the specified parameter definition from the collection.
public T? GetValue<T>(DiGi.Core.Parameter.Interfaces.IParameterDefinition? parameterDefinition, DiGi.Core.Parameter.Classes.GetValueSettings? getValueSettings=null);T
The type of the value to retrieve.
parameterDefinition IParameterDefinition
The definition of the parameter whose value is to be retrieved.
getValueSettings GetValueSettings
Optional settings to control how the value is retrieved.
T
The value associated with the specified parameter definition, cast to type T, or null if not found.
Removes the parameter matching the specified definition from the collection.
public bool Remove(DiGi.Core.Parameter.Interfaces.IParameterDefinition? parameterDefinition);parameterDefinition IParameterDefinition
The definition of the parameter to remove.
System.Boolean
True if the parameter was successfully removed; otherwise, false.
Removes the parameter with the specified unique identifier from the collection.
public bool Remove(string? uniqueId);uniqueId System.String
The unique identifier of the parameter to remove.
System.Boolean
True if the parameter was successfully removed; otherwise, false.
Adds or updates a parameter in the collection.
public bool SetValue(DiGi.Core.Parameter.Classes.Parameter? parameter);parameter Parameter
The parameter to add or update.
System.Boolean
true if the operation was successful; otherwise, false.
Sets the value for the parameter matching the specified definition within the collection.
public bool SetValue(DiGi.Core.Parameter.Interfaces.IParameterDefinition? parameterDefinition, object? value, DiGi.Core.Parameter.Classes.SetValueSettings? setValueSettings=null);parameterDefinition IParameterDefinition
The definition of the parameter to set.
value System.Object
The value to assign to the parameter.
setValueSettings SetValueSettings
Optional settings to control how the value is set.
System.Boolean
True if the value was successfully set; otherwise, false.
Sets the value for the parameter identified by the specified name within the collection.
public bool SetValue(string? name, object? value, DiGi.Core.Parameter.Classes.SetValueSettings? setValueSettings=null);name System.String
The name of the parameter to set.
value System.Object
The value to assign to the parameter.
setValueSettings SetValueSettings
Optional settings to control how the value is set.
System.Boolean
True if the value was successfully set; otherwise, false.
Attempts to get the value associated with the specified parameter definition from the collection.
public bool TryGetValue(DiGi.Core.Parameter.Interfaces.IParameterDefinition? parameterDefinition, out object? value, DiGi.Core.Parameter.Classes.GetValueSettings? getValueSettings=null);parameterDefinition IParameterDefinition
The parameter definition associated with the value to get.
value System.Object
When this method returns, contains the value associated with the specified parameter definition, if found; otherwise, null.
getValueSettings GetValueSettings
Optional settings to use when retrieving the value.
System.Boolean
true if the value was found; otherwise, false.
Attempts to get the value associated with the specified unique identifier from the collection.
public bool TryGetValue(string? uniqueId, out object? value, DiGi.Core.Parameter.Classes.GetValueSettings? getValueSettings=null);uniqueId System.String
The unique identifier of the value to get.
value System.Object
When this method returns, contains the value associated with the specified unique identifier, if found; otherwise, null.
getValueSettings GetValueSettings
Optional settings to use when retrieving the value.
System.Boolean
true if the value was found; otherwise, false.
Attempts to get the value of type T associated with the specified parameter definition from the collection.
public bool TryGetValue<T>(DiGi.Core.Parameter.Interfaces.IParameterDefinition? parameterDefinition, out T? value, DiGi.Core.Parameter.Classes.GetValueSettings? getValueSettings=null);T
The type of the value to retrieve.
parameterDefinition IParameterDefinition
The parameter definition associated with the value to get.
value T
When this method returns, contains the value associated with the specified parameter definition, if found; otherwise, the default value of T.
getValueSettings GetValueSettings
Optional settings to use when retrieving the value.
System.Boolean
true if the value was found; otherwise, false.
Attempts to get the value of type T associated with the specified unique identifier from the collection.
public bool TryGetValue<T>(string? uniqueId, out T? value, DiGi.Core.Parameter.Classes.GetValueSettings? getValueSettings=null);T
The type of the value to retrieve.
uniqueId System.String
The unique identifier of the value to get.
value T
When this method returns, contains the value associated with the specified unique identifier, if found; otherwise, the default value of T.
getValueSettings GetValueSettings
Optional settings to use when retrieving the value.
System.Boolean
true if the value was found; otherwise, false.
Contains metadata and properties for a parameter definition.
public class ParameterProperties : System.AttributeInheritance System.Object → System.Attribute → ParameterProperties
Initializes a new instance of the ParameterProperties class with a specified name.
public ParameterProperties(string? name);name System.String
The name of the parameter.
Initializes a new instance of the ParameterProperties class with a unique identifier and name.
public ParameterProperties(string? uniqueId, string? name);uniqueId System.String
The unique identifier for the parameter.
name System.String
The name of the parameter.
Initializes a new instance of the ParameterProperties class with a name, description, and access type.
public ParameterProperties(string? name, string? description, DiGi.Core.Parameter.Enums.AccessType accessType);name System.String
The name of the parameter.
description System.String
The description of the parameter.
accessType AccessType
The access type of the parameter.
Initializes a new instance of the ParameterProperties class with a unique identifier, name, and description.
public ParameterProperties(string? uniqueId, string? name, string? description);uniqueId System.String
The unique identifier for the parameter.
name System.String
The name of the parameter.
description System.String
The description of the parameter.
Initializes a new instance of the ParameterProperties class with a unique identifier, name, description, and access type.
public ParameterProperties(string? uniqueId, string? name, string? description, DiGi.Core.Parameter.Enums.AccessType accessType);uniqueId System.String
The unique identifier for the parameter.
name System.String
The name of the parameter.
description System.String
The description of the parameter.
accessType AccessType
The access type of the parameter.
Initializes a new instance of the ParameterProperties class with full metadata including group name.
public ParameterProperties(string? uniqueId, string? name, string? description, DiGi.Core.Parameter.Enums.AccessType accessType, string? groupName);uniqueId System.String
The unique identifier for the parameter.
name System.String
The name of the parameter.
description System.String
The description of the parameter.
accessType AccessType
The access type of the parameter.
groupName System.String
The name of the group to which the parameter belongs.
Gets or sets the access level of the parameter.
public DiGi.Core.Parameter.Enums.AccessType AccessType { get; }Gets or sets the description of the parameter.
public string? Description { get; }Gets or sets the name of the group this parameter belongs to.
public string? GroupName { get; }Gets or sets the display name of the parameter.
public string? Name { get; }Gets or sets a unique string identifier for the object.
public string? UniqueId { get; }Base class for all parameter value types.
public abstract class ParameterValue : System.Attribute, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IObjectInheritance System.Object → System.Attribute → ParameterValue
Derived
↳ BooleanParameterValue
↳ DoubleParameterValue
↳ GuidParameterValue
↳ IntegerParameterValue
↳ ObjectParameterValue
↳ StringParameterValue
Implements DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IObject
Initializes a new instance of the ParameterValue class.
public ParameterValue();Initializes a new instance of the ParameterValue class with specified nullability.
public ParameterValue(bool nullable);nullable System.Boolean
A value indicating whether the parameter is nullable.
Initializes a new instance of the ParameterValue class by copying an existing instance.
public ParameterValue(DiGi.Core.Parameter.Classes.ParameterValue? parameterValue);parameterValue ParameterValue
The existing ParameterValue instance to copy.
Initializes a new instance of the ParameterValue class from a JSON object.
public ParameterValue(System.Text.Json.Nodes.JsonObject? jsonObject);jsonObject System.Text.Json.Nodes.JsonObject
The JSON object used to initialize the parameter value.
Gets a value indicating whether the parameter is nullable.
public bool Nullable { get; }Gets the parameter type associated with this value.
public abstract DiGi.Core.Parameter.Enums.ParameterType ParameterType { get; }Creates a clone of the current parameter value.
public abstract DiGi.Core.Interfaces.ISerializableObject? Clone();Implements Clone()
DiGi.Core.Interfaces.ISerializableObject
A new instance of DiGi.Core.Interfaces.ISerializableObject that is a copy of the current object, or null.
Populates the parameter value from the provided JSON object.
public bool FromJsonObject(System.Text.Json.Nodes.JsonObject? jsonObject);jsonObject System.Text.Json.Nodes.JsonObject
The JSON object to extract the value from.
Implements FromJsonObject(JsonObject)
System.Boolean
True if the population was successful; otherwise, false.
Validates whether the given value is compatible with this parameter.
public virtual bool IsValid(object? value);value System.Object
The value to validate.
System.Boolean
True if the value is valid; otherwise, false.
Converts the current parameter value to a JSON object.
public System.Text.Json.Nodes.JsonObject? ToJsonObject();Implements ToJsonObject()
System.Text.Json.Nodes.JsonObject
A System.Text.Json.Nodes.JsonObject representation of the parameter value, or null if conversion fails.
Attempts to convert an input value to the expected output type.
public virtual bool TryConvert(object? value_In, out object? value_Out);value_In System.Object
The value to be converted.
value_Out System.Object
When this method returns, contains the converted value if successful; otherwise, null.
System.Boolean
True if the conversion was successful; otherwise, false.
Base class for objects that possess a unique GUID and a set of parameters.
public abstract class ParametrizedGuidObject : DiGi.Core.Parameter.Classes.ParametrizedObject, DiGi.Core.Parameter.Interfaces.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.IGuidObjectInheritance System.Object → DiGi.Core.Classes.Object → DiGi.Core.Classes.SerializableObject → ParametrizedObject → ParametrizedGuidObject
Implements IParametrizedGuidObject, 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
Initializes a new instance of the ParametrizedGuidObject class.
public ParametrizedGuidObject();Initializes a new instance of the ParametrizedGuidObject class with a specified group collection.
public ParametrizedGuidObject(DiGi.Core.Parameter.Classes.ParameterGroupCollection? parameterGroupCollection);parameterGroupCollection ParameterGroupCollection
The collection of parameter groups to initialize the object with.
Initializes a new instance of the ParametrizedGuidObject class by copying another object.
public ParametrizedGuidObject(DiGi.Core.Parameter.Classes.ParametrizedGuidObject? parametrizedGuidObject);parametrizedGuidObject ParametrizedGuidObject
The source object to copy.
Initializes a new instance of the ParametrizedGuidObject class with a collection of parameters.
public ParametrizedGuidObject(System.Collections.Generic.IEnumerable<DiGi.Core.Parameter.Classes.Parameter>? parameters);parameters System.Collections.Generic.IEnumerable<Parameter>
The collection of parameters to initialize the object with.
Initializes a new instance of the ParametrizedGuidObject class with a specified GUID.
public ParametrizedGuidObject(System.Guid guid);guid System.Guid
The GUID to assign to the new instance.
Initializes a new instance of the ParametrizedGuidObject class with a specific GUID and data from another object.
public ParametrizedGuidObject(System.Guid guid, DiGi.Core.Parameter.Classes.ParametrizedGuidObject? parametrizedGuidObject);guid System.Guid
The GUID to assign to the new instance.
parametrizedGuidObject ParametrizedGuidObject
The source object from which to copy data.
Initializes a new instance of the ParametrizedGuidObject class from a JSON object.
public ParametrizedGuidObject(System.Text.Json.Nodes.JsonObject? jsonObject);jsonObject System.Text.Json.Nodes.JsonObject
The JSON object to deserialize into a new instance.
Gets the unique global identifier of the object.
public System.Guid Guid { get; }Implements Guid
Gets or sets a unique string identifier for the object.
public string? UniqueId { get; }Implements UniqueId
Creates a duplicate of the current object, optionally with a new GUID.
public DiGi.Core.Interfaces.IGuidObject? Duplicate(System.Nullable<System.Guid> guid=null);guid System.Nullable<System.Guid>
The optional GUID to assign to the duplicated object.
Implements Duplicate(Nullable<Guid>)
DiGi.Core.Interfaces.IGuidObject
A duplicate of the current object as an DiGi.Core.Interfaces.IGuidObject, or null if duplication fails.
Class ParametrizedObject.
public class ParametrizedObject : DiGi.Core.Classes.SerializableObject, DiGi.Core.Parameter.Interfaces.IParametrizedObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IObjectInheritance System.Object → DiGi.Core.Classes.Object → DiGi.Core.Classes.SerializableObject → ParametrizedObject
Derived
↳ ParametrizedGuidObject
↳ ParametrizedUniqueIdObject
Implements IParametrizedObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IObject
Initializes a new instance of the ParametrizedObject class.
public ParametrizedObject();Initializes a new instance of the ParametrizedObject class using a parameter group collection.
public ParametrizedObject(DiGi.Core.Parameter.Classes.ParameterGroupCollection? parameterGroupCollection);parameterGroupCollection ParameterGroupCollection
The parameter group collection to use for initialization.
Initializes a new instance of the ParametrizedObject class by copying another parametrized object.
public ParametrizedObject(DiGi.Core.Parameter.Classes.ParametrizedObject? parametrizedObject);parametrizedObject ParametrizedObject
The parametrized object to copy from.
Initializes a new instance of the ParametrizedObject class using a collection of parameters.
public ParametrizedObject(System.Collections.Generic.IEnumerable<DiGi.Core.Parameter.Classes.Parameter>? parameters);parameters System.Collections.Generic.IEnumerable<Parameter>
The collection of parameters to initialize the object with.
Initializes a new instance of the ParametrizedObject class from a JSON object.
public ParametrizedObject(System.Text.Json.Nodes.JsonObject? jsonObject);jsonObject System.Text.Json.Nodes.JsonObject
The JSON object to initialize from.
Gets the parameter group collection.
public DiGi.Core.Parameter.Classes.ParameterGroupCollection ParameterGroupCollection { get; }Creates a deep copy of the parametrized object.
public override DiGi.Core.Interfaces.ISerializableObject? Clone();Implements Clone()
DiGi.Core.Interfaces.ISerializableObject
A new cloned instance of the parametrized object.
Determines whether the object contains a parameter associated with the specified definition.
public bool Contains(DiGi.Core.Parameter.Interfaces.IParameterDefinition? parameterDefinition);parameterDefinition IParameterDefinition
The parameter definition to search for.
System.Boolean
True if the object contains a parameter associated with the specified definition; otherwise, false.
Determines whether the object contains a parameter with the specified unique identifier.
public bool Contains(string? uniqueId);uniqueId System.String
The unique identifier of the parameter to search for.
System.Boolean
True if the object contains a parameter with the specified unique identifier; otherwise, false.
Retrieves a list of parameter definitions that match the specified name and comparison criteria.
public System.Collections.Generic.List<DiGi.Core.Parameter.Interfaces.IParameterDefinition>? GetParameterDefinitions(string? parameterName, DiGi.Core.Enums.TextComparisonType textComparisonType=DiGi.Core.Enums.TextComparisonType.Equals, bool caseSensitive=true);parameterName System.String
The name of the parameters to search for.
textComparisonType DiGi.Core.Enums.TextComparisonType
The type of text comparison to use.
caseSensitive System.Boolean
A value indicating whether the comparison should be case-sensitive.
System.Collections.Generic.List<IParameterDefinition>
A list of parameter definitions that match the specified criteria, or null if none are found.
Retrieves all parameter definitions of type TParameterDefinition.
public System.Collections.Generic.List<TParameterDefinition>? GetParameterDefinitions<TParameterDefinition>()
where TParameterDefinition : DiGi.Core.Parameter.Interfaces.IParameterDefinition;TParameterDefinition
The type of the parameter definitions to retrieve.
Implements GetParameterDefinitions<TParameterDefinition>()
System.Collections.Generic.List<TParameterDefinition>
A list of all parameter definitions of the specified type, or null if none are found.
ParametrizedObject.GetParameterDefinitions<TParameterDefinition>(string, TextComparisonType, bool) Method
Retrieves a list of parameter definitions of type TParameterDefinition that match the specified name and comparison criteria.
public System.Collections.Generic.List<TParameterDefinition>? GetParameterDefinitions<TParameterDefinition>(string? parameterName, DiGi.Core.Enums.TextComparisonType textComparisonType=DiGi.Core.Enums.TextComparisonType.Equals, bool caseSensitive=true)
where TParameterDefinition : DiGi.Core.Parameter.Interfaces.IParameterDefinition;TParameterDefinition
The type of the parameter definitions to retrieve.
parameterName System.String
The name of the parameters to search for.
textComparisonType DiGi.Core.Enums.TextComparisonType
The type of text comparison to use.
caseSensitive System.Boolean
A value indicating whether the comparison should be case-sensitive.
System.Collections.Generic.List<TParameterDefinition>
A list of parameter definitions that match the specified criteria, or null if none are found.
Gets the value associated with the specified parameter definition.
public object? GetValue(DiGi.Core.Parameter.Interfaces.IParameterDefinition? parameterDefinition, DiGi.Core.Parameter.Classes.GetValueSettings? getValueSettings=null);parameterDefinition IParameterDefinition
The parameter definition for which to retrieve the value.
getValueSettings GetValueSettings
Optional settings for retrieving the value.
System.Object
The value associated with the specified parameter definition, or null if not found.
Gets the value associated with the specified unique identifier.
public object? GetValue(string? uniqueId, DiGi.Core.Parameter.Classes.GetValueSettings? getValueSettings=null);uniqueId System.String
The unique identifier of the value to retrieve.
getValueSettings GetValueSettings
Optional settings for retrieving the value.
System.Object
The value associated with the specified unique identifier, or null if not found.
Gets the value associated with the specified enumeration member.
public object? GetValue(System.Enum? @enum, DiGi.Core.Parameter.Classes.GetValueSettings? getValueSettings=null);enum System.Enum
The enumeration member associated with the value.
getValueSettings GetValueSettings
Optional settings for retrieving the value.
System.Object
The value associated with the specified enumeration member, or null if not found.
Gets the value of type T associated with the specified parameter definition.
public T? GetValue<T>(DiGi.Core.Parameter.Interfaces.IParameterDefinition? parameterDefinition, DiGi.Core.Parameter.Classes.GetValueSettings? getValueSettings=null);T
The type of the value to retrieve.
parameterDefinition IParameterDefinition
The definition of the parameter whose value is to be retrieved.
getValueSettings GetValueSettings
Optional settings for retrieving the value.
T
The value associated with the specified parameter definition, or null if not found.
Gets the value of type T associated with the specified enumeration member.
public T? GetValue<T>(System.Enum? @enum, DiGi.Core.Parameter.Classes.GetValueSettings? getValueSettings=null);T
The type of the value to retrieve.
enum System.Enum
The enumeration member associated with the value.
getValueSettings GetValueSettings
Optional settings for retrieving the value.
T
The value associated with the specified enumeration member, or null if not found.
Removes the parameter associated with the specified definition.
public bool Remove(DiGi.Core.Parameter.Interfaces.IParameterDefinition? parameterDefinition);parameterDefinition IParameterDefinition
The definition of the parameter to remove.
Implements Remove(IParameterDefinition)
System.Boolean
True if the parameter was successfully removed; otherwise, false.
Removes the parameter associated with the specified unique identifier.
public bool Remove(string? uniqueId);uniqueId System.String
The unique identifier of the parameter to remove.
System.Boolean
True if the parameter was successfully removed; otherwise, false.
Sets the value using the provided parameter object.
public bool SetValue(DiGi.Core.Parameter.Classes.Parameter? parameter);parameter Parameter
The parameter object containing the value to set.
System.Boolean
True if the value was successfully set; otherwise, false.
Sets the value for the specified parameter definition.
public bool SetValue(DiGi.Core.Parameter.Interfaces.IParameterDefinition? parameterDefinition, object? value, DiGi.Core.Parameter.Classes.SetValueSettings? setValueSettings=null);parameterDefinition IParameterDefinition
The parameter definition.
value System.Object
The value to set.
setValueSettings SetValueSettings
Optional settings for setting the value.
Implements SetValue(IParameterDefinition, object, SetValueSettings)
System.Boolean
True if the value was successfully set; otherwise, false.
Sets the value for the parameter with the specified name.
public bool SetValue(string? name, object? value, DiGi.Core.Parameter.Classes.SetValueSettings? setValueSettings=null);name System.String
The name of the parameter.
value System.Object
The value to set.
setValueSettings SetValueSettings
Optional settings for setting the value.
System.Boolean
True if the value was successfully set; otherwise, false.
Sets the value for the specified enumeration member.
public bool SetValue(System.Enum? @enum, object? value, DiGi.Core.Parameter.Classes.SetValueSettings? setValueSettings=null);enum System.Enum
The enumeration member.
value System.Object
The value to set.
setValueSettings SetValueSettings
Optional settings for setting the value.
System.Boolean
True if the value was successfully set; otherwise, false.
Attempts to retrieve the value associated with the specified parameter definition.
public bool TryGetValue(DiGi.Core.Parameter.Interfaces.IParameterDefinition? parameterDefinition, out object? value, DiGi.Core.Parameter.Classes.GetValueSettings? getValueSettings=null);parameterDefinition IParameterDefinition
The parameter definition associated with the value.
value System.Object
When this method returns, contains the retrieved value if successful; otherwise, null.
getValueSettings GetValueSettings
Optional settings to use when retrieving the value.
System.Boolean
True if the value was successfully retrieved; otherwise, false.
Attempts to retrieve the value associated with the specified unique identifier.
public bool TryGetValue(string? uniqueId, out object? value, DiGi.Core.Parameter.Classes.GetValueSettings? getValueSettings=null);uniqueId System.String
The unique identifier of the value to retrieve.
value System.Object
When this method returns, contains the retrieved value if successful; otherwise, null.
getValueSettings GetValueSettings
Optional settings for retrieving the value.
System.Boolean
True if the value was successfully retrieved; otherwise, false.
Attempts to retrieve the value associated with the specified enumeration member.
public bool TryGetValue(System.Enum? @enum, out object? value, DiGi.Core.Parameter.Classes.GetValueSettings? getValueSettings=null);enum System.Enum
The enumeration member associated with the value.
value System.Object
When this method returns, contains the retrieved value if successful; otherwise, null.
getValueSettings GetValueSettings
Optional settings to use when retrieving the value.
System.Boolean
True if the value was successfully retrieved; otherwise, false.
Attempts to retrieve the value of type T associated with the specified parameter definition.
public bool TryGetValue<T>(DiGi.Core.Parameter.Interfaces.IParameterDefinition? parameterDefinition, out T? value, DiGi.Core.Parameter.Classes.GetValueSettings? getValueSettings=null);T
The type of the value to retrieve.
parameterDefinition IParameterDefinition
The parameter definition associated with the value.
value T
When this method returns, contains the retrieved value of type T if successful; otherwise, the default value of T.
getValueSettings GetValueSettings
Optional settings to use when retrieving the value.
Implements TryGetValue<T>(IParameterDefinition, T, GetValueSettings)
System.Boolean
True if the value was successfully retrieved; otherwise, false.
Attempts to retrieve the value of type T associated with the specified unique identifier.
public bool TryGetValue<T>(string? uniqueId, out T? value, DiGi.Core.Parameter.Classes.GetValueSettings? getValueSettings=null);T
The type of the value to retrieve.
uniqueId System.String
The unique identifier for the value.
value T
When this method returns, contains the retrieved value of type T if successful; otherwise, the default value of T.
getValueSettings GetValueSettings
Optional settings to use when retrieving the value.
System.Boolean
True if the value was successfully retrieved; otherwise, false.
Attempts to retrieve the value of type T associated with the specified enumeration member.
public bool TryGetValue<T>(System.Enum? @enum, out T? value, DiGi.Core.Parameter.Classes.GetValueSettings? getValueSettings=null);T
The type of the value to retrieve.
enum System.Enum
The enumeration member associated with the value.
value T
When this method returns, contains the retrieved value of type T if successful; otherwise, the default value of T.
getValueSettings GetValueSettings
Optional settings to use when retrieving the value.
System.Boolean
True if the value was successfully retrieved; otherwise, false.
Represents an abstract base class for objects that possess both a set of parameters and a unique identifier.
public abstract class ParametrizedUniqueIdObject : DiGi.Core.Parameter.Classes.ParametrizedObject, DiGi.Core.Parameter.Interfaces.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.IUniqueObjectInheritance System.Object → DiGi.Core.Classes.Object → DiGi.Core.Classes.SerializableObject → ParametrizedObject → ParametrizedUniqueIdObject
Implements IParametrizedUniqueIdObject, 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
Initializes a new instance of the ParametrizedUniqueIdObject class.
public ParametrizedUniqueIdObject();Initializes a new instance of the ParametrizedUniqueIdObject class using a parameter group collection.
public ParametrizedUniqueIdObject(DiGi.Core.Parameter.Classes.ParameterGroupCollection? parameterGroupCollection);parameterGroupCollection ParameterGroupCollection
The parameter group collection to use for initialization.
Initializes a new instance of the ParametrizedUniqueIdObject class by copying another unique ID parametrized object.
public ParametrizedUniqueIdObject(DiGi.Core.Parameter.Classes.ParametrizedUniqueIdObject? parametrizedUniqueIdObject);parametrizedUniqueIdObject ParametrizedUniqueIdObject
The parametrized unique ID object to copy.
Initializes a new instance of the ParametrizedUniqueIdObject class with a specified unique identifier.
public ParametrizedUniqueIdObject(string? uniqueId);uniqueId System.String
The unique identifier.
Initializes a new instance of the ParametrizedUniqueIdObject class with a specific ID and values from another object.
public ParametrizedUniqueIdObject(string? uniqueId, DiGi.Core.Parameter.Classes.ParametrizedUniqueIdObject? parametrizedUniqueIdObject);uniqueId System.String
The unique identifier.
parametrizedUniqueIdObject ParametrizedUniqueIdObject
The parametrized unique ID object to copy values from.
Initializes a new instance of the ParametrizedUniqueIdObject class using a collection of parameters.
public ParametrizedUniqueIdObject(System.Collections.Generic.IEnumerable<DiGi.Core.Parameter.Classes.Parameter>? parameters);parameters System.Collections.Generic.IEnumerable<Parameter>
The collection of parameters to use for initialization.
Initializes a new instance of the ParametrizedUniqueIdObject class from a JSON object.
public ParametrizedUniqueIdObject(System.Text.Json.Nodes.JsonObject? jsonObject);jsonObject System.Text.Json.Nodes.JsonObject
The JSON object to initialize from.
Gets or sets the unique identifier for this object.
public string? UniqueId { get; }Implements UniqueId
Contains settings for setting a parameter value.
public class SetValueSettingsInheritance System.Object → SetValueSettings
Initializes a new instance of the SetValueSettings class.
public SetValueSettings();Initializes a new instance of the SetValueSettings class with specified options.
public SetValueSettings(bool tryConvert, bool checkAccessType);tryConvert System.Boolean
Whether to attempt conversion if types do not match.
checkAccessType System.Boolean
Whether to check for write access permissions.
Gets or sets a value indicating whether the access type should be checked during assignment.
public bool CheckAccessType { get; set; }Gets or sets a value indicating whether to attempt conversion of the value during assignment.
public bool TryConvert { get; set; }Represents a definition for a simple parameter.
public class SimpleParameterDefinition : DiGi.Core.Parameter.Classes.ParameterDefinitionInheritance System.Object → DiGi.Core.Classes.Object → DiGi.Core.Classes.SerializableObject → ParameterDefinition → SimpleParameterDefinition
Initializes a new instance of the SimpleParameterDefinition class by copying an existing definition.
public SimpleParameterDefinition(DiGi.Core.Parameter.Classes.SimpleParameterDefinition? simpleParameterDefinition);simpleParameterDefinition SimpleParameterDefinition
The parameter definition to copy from.
Initializes a new instance of the SimpleParameterDefinition class with the specified name.
public SimpleParameterDefinition(string? name);name System.String
The name of the parameter.
Initializes a new instance of the SimpleParameterDefinition class from a JSON object.
public SimpleParameterDefinition(System.Text.Json.Nodes.JsonObject? jsonObject);jsonObject System.Text.Json.Nodes.JsonObject
The JSON object to initialize the definition from.
Gets the name of the group to which this parameter belongs.
public override string GroupName { get; }Implements GroupName
Gets or sets the name of the parameter.
public override string? Name { get; }Implements Name
Gets the type of the parameter.
public override DiGi.Core.Parameter.Enums.ParameterType ParameterType { get; }Implements ParameterType
Gets or sets the unique identifier for the parameter.
public override string? UniqueId { get; }Implements UniqueId
Determines whether the specified value is a valid integer parameter value.
public override bool IsValid(object? value);value System.Object
The value to validate.
Implements IsValid(object)
System.Boolean
True if the value is a valid integer parameter value; otherwise, false.
Represents a parameter value that holds a string.
public class StringParameterValue : DiGi.Core.Parameter.Classes.ParameterValueInheritance System.Object → System.Attribute → ParameterValue → StringParameterValue
Initializes a new instance of the StringParameterValue class.
public StringParameterValue();Initializes a new instance of the StringParameterValue class with specified nullability.
public StringParameterValue(bool nullable);nullable System.Boolean
A value indicating whether the parameter is nullable.
Initializes a new instance of the StringParameterValue class by copying an existing instance.
public StringParameterValue(DiGi.Core.Parameter.Classes.StringParameterValue? stringParameterValue);stringParameterValue StringParameterValue
The existing instance to copy.
Initializes a new instance of the StringParameterValue class from a JSON object.
public StringParameterValue(System.Text.Json.Nodes.JsonObject? jsonObject);jsonObject System.Text.Json.Nodes.JsonObject
The JSON object to initialize from.
Gets the parameter type associated with this string parameter value.
public override DiGi.Core.Parameter.Enums.ParameterType ParameterType { get; }Creates a clone of the current string parameter value.
public override DiGi.Core.Interfaces.ISerializableObject? Clone();Implements Clone()
DiGi.Core.Interfaces.ISerializableObject
A clone of the current string parameter value.