Class IonControlPointPairCollection

A collection of editable copies of control point pairs that describe the planned proton beam.

Inheritance

System.Object

IonControlPointPairCollection

Implements

System.Collections.Generic.IEnumerable<IonControlPointPair>

System.Collections.IEnumerable

Inherited Members

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 IonControlPointPairCollection : IEnumerable<IonControlPointPair>, IEnumerable

Remarks

To apply the parameters, call the ApplyParameters(BeamParameters) method of the IonBeam class. The parameters contained in this class are simply copies, and they do not reflect the current state of the data model.

Properties

Count

The number of control point pairs in the collection.

Declaration

public int Count { get; }

Property Value

Type	Description
System.Int32

Item[Int32]

Gets the specified IonControlPointPair from the collection.

Declaration

public IonControlPointPair this[int index] { get; }

Parameters

Type	Name	Description
System.Int32	index	Zero based index of the IonControlPointPair to retrieve.

Property Value

Type	Description
IonControlPointPair	IonControlPointPair at the given index.

Methods

GetEnumerator()

Retrieves enumerator for IonControlPointPairs in the collection.

Declaration

public IEnumerator<IonControlPointPair> GetEnumerator()

Returns

Type	Description
System.Collections.Generic.IEnumerator<IonControlPointPair>	Enumerator for IonControlPointPairs in the collection.

Explicit Interface Implementations

IEnumerable.GetEnumerator()

Declaration

IEnumerator IEnumerable.GetEnumerator()

Returns

Type	Description
System.Collections.IEnumerator

Implements

System.Collections.Generic.IEnumerable<T>

System.Collections.IEnumerable