Class OptimizationObjective

Provides a common base type for all structure-specific optimization objectives.

Inheritance

System.Object

SerializableObject

OptimizationObjective

OptimizationEUDObjective

OptimizationLineObjective

OptimizationMeanDoseObjective

OptimizationPointObjective

Implements

System.Xml.Serialization.IXmlSerializable

Inherited Members

SerializableObject.GetSchema()

SerializableObject.ReadXml(XmlReader)

SerializableObject.ClearSerializationHistory()

System.Object.ToString()

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

Properties

Operator

Specifies the type of the objective (upper, lower, exact).

Declaration

public OptimizationObjectiveOperator Operator { get; }

Property Value

Type	Description
OptimizationObjectiveOperator

Priority

The priority of the objective as a positive double.

Declaration

public double Priority { get; }

Property Value

Type	Description
System.Double

Structure

The structure to which this optimization objective belongs.

Declaration

public Structure Structure { get; }

Property Value

Type	Description
Structure

StructureId

The identifier of the structure.

Declaration

public string StructureId { get; }

Property Value

Type	Description
System.String

Methods

Equals(Object)

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

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
System.Object	obj	The object to compare with the current object.

Returns

Type	Description
System.Boolean	true if the specified object is equal to the current object; otherwise, false.

Overrides

System.Object.Equals(System.Object)

GetHashCode()

Serves as a hash function for a particular type.

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32	A hash code for the current object.

Overrides

System.Object.GetHashCode()

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)

Operators

Equality(OptimizationObjective, OptimizationObjective)

The equality operator.

Declaration

public static bool operator ==(OptimizationObjective a, OptimizationObjective b)

Parameters

Type	Name	Description
OptimizationObjective	a	The first operand.
OptimizationObjective	b	The second operand.

Returns

Type	Description
System.Boolean	True if the given objects are the same.

Inequality(OptimizationObjective, OptimizationObjective)

The inequality operator.

Declaration

public static bool operator !=(OptimizationObjective a, OptimizationObjective b)

Parameters

Type	Name	Description
OptimizationObjective	a	The first operand.
OptimizationObjective	b	The second operand.

Returns

Type	Description
System.Boolean	True if the given objects are different.

Implements

System.Xml.Serialization.IXmlSerializable