Class DVHEstimationModelSummary

A summary of an DVH Estimation Model. Contains the needed information for selecting a model.

Inheritance

System.Object

SerializableObject

DVHEstimationModelSummary

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 DVHEstimationModelSummary : SerializableObject, IXmlSerializable

Properties

Description

Model Description

Declaration

public string Description { get; }

Property Value

Type	Description
System.String

IsPublished

True if set to published state. Only published models are available for optimizing.

Declaration

public bool IsPublished { get; }

Property Value

Type	Description
System.Boolean

IsTrained

True if the model contains data.

Declaration

public bool IsTrained { get; }

Property Value

Type	Description
System.Boolean

ModelDataVersion

Version

Declaration

public string ModelDataVersion { get; }

Property Value

Type	Description
System.String

ModelParticleType

Returns particle type for the model. Either ParticleType.Proton or ParticleType.Photon.

Declaration

public ParticleType ModelParticleType { get; }

Property Value

Type	Description
ParticleType

ModelUID

Model UID. To be used for the Load command.

Declaration

public Guid ModelUID { get; }

Property Value

Type	Description
System.Guid

Name

Display Name

Declaration

public string Name { get; }

Property Value

Type	Description
System.String

Revision

Publish revision of the model

Declaration

public int Revision { get; }

Property Value

Type	Description
System.Int32

TreatmentSite

Indicating the treatment site the model was created for

Declaration

public string TreatmentSite { get; }

Property Value

Type	Description
System.String

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