Class ContextParameter

Namespace

EncDotNet.S100.Portrayals

Assembly

EncDotNet.S100.Portrayals.dll

An S-100 Part 9 context parameter: a named, typed input to the portrayal rules (e.g. safety contour, shallow-contour depth, symbol style) whose value the mariner or host application may override. Declared in the catalogue's context section as parameter elements.

public sealed class ContextParameter

Inheritance

object

ContextParameter

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Default

Default value in its textual form, from parameter/default; used when no override is supplied.

public required string Default { get; init; }

Property Value

string

Description

The parameter's description block.

public required Description Description { get; init; }

Property Value

Description

Enable

Optional XPath condition, from parameter/@enable, over other parameters' values that determines whether this parameter applies (e.g. //FourShades[1]='true'); null when absent. Captured as declared; not evaluated by this library.

public string? Enable { get; init; }

Property Value

string

Id

Parameter identifier, from parameter/@id (e.g. SafetyContour); the name the rules use to look the value up.

public required string Id { get; init; }

Property Value

string

Type

Value type, from parameter/type as written in the catalogue (e.g. Boolean, Double, String).

public required string Type { get; init; }

Property Value

string

Validation

Value constraints from parameter/validate, or null when the parameter declares none.

public ContextParameterValidation? Validation { get; init; }

Property Value

ContextParameterValidation