Class DVHEstimationModelStructure

Structure of a DVH estimation model in Planning Model Library

Inheritance

System.Object

SerializableObject

DVHEstimationModelStructure

Implements

System.Xml.Serialization.IXmlSerializable

Inherited Members

SerializableObject.GetSchema()

SerializableObject.ReadXml(XmlReader)

SerializableObject.ClearSerializationHistory()

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: VMS.TPS.Common.Model.API

Assembly: VMS.TPS.Common.Model.API.dll

Syntax

public class DVHEstimationModelStructure : SerializableObject

Constructors

DVHEstimationModelStructure(IDVHEstimationModelStructure)

Public constructor

Declaration

public DVHEstimationModelStructure(IDVHEstimationModelStructure impl)

Parameters

Type	Name	Description
VMS.TPS.Common.Model.IDVHEstimationModelStructure	impl	IDVHEstimationModelStructure object

Properties

Id

Id of the structure

Declaration

public string Id { get; }

Property Value

Type	Description
System.String

IsValid

Is Valid

Declaration

public bool IsValid { get; }

Property Value

Type	Description
System.Boolean

ModelStructureGuid

Model Id

Declaration

public Guid ModelStructureGuid { get; }

Property Value

Type	Description
System.Guid

StructureCodes

List of structure codes associated with the structure

Declaration

public IReadOnlyList<StructureCode> StructureCodes { get; }

Property Value

Type	Description
System.Collections.Generic.IReadOnlyList<StructureCode>

StructureType

Structure type: PTV or OAR

Declaration

public DVHEstimationStructureType StructureType { get; }

Property Value

Type	Description
DVHEstimationStructureType

Methods

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

SerializableObject.WriteXml(XmlWriter)

Implements

System.Xml.Serialization.IXmlSerializable