Class Series

A series is a collection of radiation therapy objects of a patient. The series is part of a study. See the definition of a DICOM Series for more information.

Inheritance
System.Object
SerializableObject
ApiDataObject
Series
Implements
System.Xml.Serialization.IXmlSerializable
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 Series : ApiDataObject

Properties

FOR

The UID of the frame of reference.

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

Images

A collection of images that belong to the series.

Declaration
public IEnumerable<Image> Images { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<Image>

ImagingDeviceId

The identifier of the device that is used to scan the images into the system. Returns an empty string if the imaging device is not unique or the device identifier is not defined.

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

ImagingDeviceManufacturer

The manufacturer of the device that is used to scan the images into the system. Returns an empty string if the imaging device is not unique or the device manufacturer is not defined.

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

ImagingDeviceModel

The model of the device that is used to scan the images into the system. Returns an empty string if the imaging device is not unique or the device model is not defined.

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

ImagingDeviceSerialNo

The serial number of the device that is used to scan the images into the system. Returns an empty string if the imaging device is not unique or the device serial number is not defined.

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

Modality

The modality of the series.

Declaration
public SeriesModality Modality { get; }
Property Value
Type Description
SeriesModality

Study

Used for navigating to parent study.

Declaration
public Study Study { get; }
Property Value
Type Description
Study

UID

The DICOM UID.

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

Methods

SetImagingDevice(String)

[Availability of this method depends on your Eclipse Scripting API license] Sets the imaging device for the image series based on the identifier of the imaging device. If the imaging device identifier is not found, an exception is thrown.

Declaration
public void SetImagingDevice(string imagingDeviceId)
Parameters
Type Name Description
System.String imagingDeviceId

Identifier of the imaging device.

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

Implements

System.Xml.Serialization.IXmlSerializable