Class OverrideString

Namespace

CENTREL.XIA.Configuration.Types

Assembly

CENTREL.XIA.Configuration.Types.dll

Represents a string value that is configured by the XIA Configuration Client, which can however be overridden by a manually input value.

public class OverrideString : GlobalSerializableClassicBase, IEquatable<OverrideString>

Inheritance

object

OverrideString

Implements

IEquatable<OverrideString>

Constructors

OverrideString()

Initializes a new instance of the CENTREL.XIA.Configuration.Types.OverrideString class.

public OverrideString()

OverrideString(string)

Initializes a new instance of the CENTREL.XIA.Configuration.Types.OverrideString class.

public OverrideString(string agentValue)

Parameters

agentValue string

The agent value to use to initialize this object.

OverrideString(string, string)

Initializes a new instance of the CENTREL.XIA.Configuration.Types.OverrideString class.

public OverrideString(string agentValue, string overriddenValue)

Parameters

agentValue string

The agent value to use to initialize this object.

overriddenValue string

The manually overridden value.

Properties

AgentValue

The underlying value determined by a XIA Configuration Client. This value can be overridden by a user and is not used by the data comparer.

public string AgentValue { get; set; }

Property Value

string

Overridden

Determines if the value has been overridden by a user and manually entered.

public bool Overridden { get; set; }

Property Value

bool

Value

The effective value - either the value detected by the XIA Configuration Client, or if overridden the value entered manually by the user.

public string Value { get; set; }

Property Value

string

Methods

Equals(OverrideString)

Determines if the value of this object is equal to the specified CENTREL.XIA.Configuration.Types.OverrideString.

public bool Equals(OverrideString other)

Parameters

other OverrideString

The CENTREL.XIA.Configuration.Types.OverrideString to compare to.

Returns

bool

A System.Boolean value that indicates whether the value of this object is equal to the specified CENTREL.XIA.Configuration.Types.OverrideString.

Equals(object)

Determines if the value of this object is equal to the specified object.

public override bool Equals(object obj)

Parameters

obj object

The object to compare to.

Returns

bool

A System.Boolean value that indicates whether the value of this object is equal to the specified object.

FromXml(string)

Returns a CENTREL.XIA.Configuration.Types.OverrideString class from the specified XML.

public static OverrideString FromXml(string xml)

Parameters

xml string

The XML representation of the object.

Returns

OverrideString

A CENTREL.XIA.Configuration.Types.OverrideString class.

GetHashCode()

Serves as a hash function for this particular type.

public override int GetHashCode()

Returns

int

A hash code for this CENTREL.XIA.Configuration.Types.OverrideString.

MergeAgentData(OverrideString)

Merges the specified AgentData Override String into this Override String. If this Override String is Overridden only the Agent Value is updated.

public void MergeAgentData(OverrideString agentData)

Parameters

agentData OverrideString

ToString()

Returns the value of this CENTREL.XIA.Configuration.Types.OverrideString in the format "Value" or "Value [Manual]".

public override string ToString()

Returns

string

The value of this CENTREL.XIA.Configuration.Types.OverrideString in a human readable format.