Class StructureCode

Represents a structure code and its coding scheme.

Inheritance
System.Object
SerializableObject
StructureCode
Implements
System.Xml.Serialization.IXmlSerializable
System.IEquatable<StructureCode>
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: VMS.TPS.Common.Model.API
Assembly: VMS.TPS.Common.Model.API.dll
Syntax
public class StructureCode : SerializableObject, IXmlSerializable, IEquatable<StructureCode>

Properties

Code

The structure code as defined in the associated coding scheme.

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

CodeMeaning

The meaning of the structure code.

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

CodingScheme

The coding scheme of the structure code.

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

DisplayName

The display name of the code.

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

IsEncompassStructureCode

Indicates whether the structure code is an encompass structure code.

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

Methods

Equals(Object)

Determines whether the current object is considered equal to the specified object.

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
System.Object obj
Returns
Type Description
System.Boolean
Overrides
System.Object.Equals(System.Object)

Equals(StructureCode)

Determines whether this structure code is considered equal to the specified structure code.

Declaration
public bool Equals(StructureCode other)
Parameters
Type Name Description
StructureCode other
Returns
Type Description
System.Boolean

GetHashCode()

Returns the hash code for this structure code.

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32
Overrides
System.Object.GetHashCode()

ToString()

Returns a string that represents this object.

Declaration
public override string ToString()
Returns
Type Description
System.String

A string that represents this object.
Overrides
System.Object.ToString()

ToStructureCodeInfo()

Returns a StructureCodeInfo object with the same coding scheme and code as in the current structure code object.

Declaration
public StructureCodeInfo ToStructureCodeInfo()
Returns
Type Description
StructureCodeInfo

WriteXml(XmlWriter)

Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see System.Xml.Serialization.XmlSerializer.

Declaration
public override void WriteXml(XmlWriter writer)
Parameters
Type Name Description
System.Xml.XmlWriter writer

The System.Xml.XmlWriter stream, to which the object is serialized.
Overrides

Operators

Equality(StructureCode, StructureCode)

The equality operator.

Declaration
public static bool operator ==(StructureCode sc1, StructureCode sc2)
Parameters
Type Name Description
StructureCode sc1
StructureCode sc2
Returns
Type Description
System.Boolean

Inequality(StructureCode, StructureCode)

The inequality operator.

Declaration
public static bool operator !=(StructureCode sc1, StructureCode sc2)
Parameters
Type Name Description
StructureCode sc1
StructureCode sc2
Returns
Type Description
System.Boolean

Implements

System.Xml.Serialization.IXmlSerializable
System.IEquatable<T>