Class ApiDataObject

The base class of objects in the Eclipse Scripting API.

Inheritance

System.Object

ApiDataObject

BrachyFieldReferencePoint

BrachySolidApplicator

ExternalBeamTreatmentUnit

RadioactiveSourceModel

TreatmentUnitOperatingLimit

Implements

System.Xml.Serialization.IXmlSerializable

Inherited Members

SerializableObject.GetSchema()

SerializableObject.ReadXml(XmlReader)

SerializableObject.ClearSerializationHistory()

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 abstract class ApiDataObject : SerializableObject, IXmlSerializable

Properties

Comment

A comment about the object.

Declaration

public string Comment { get; }

Property Value

Type	Description
System.String

HistoryDateTime

The date when this object was last modified.

Declaration

public DateTime HistoryDateTime { get; }

Property Value

Type	Description
System.DateTime

HistoryUserDisplayName

The name of the last user who modified this object.

Declaration

public string HistoryUserDisplayName { get; }

Property Value

Type	Description
System.String

HistoryUserName

The identifier of the last user who modified this object.

Declaration

public string HistoryUserName { get; }

Property Value

Type	Description
System.String

Id

The identifier of the object.

Declaration

public string Id { get; }

Property Value

Type	Description
System.String

Name

The name of the object.

Declaration

public string Name { 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	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 this type.

Declaration

public override int GetHashCode()

Returns

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

Overrides

System.Object.GetHashCode()

ToString()

Returns a string that represents the current object.

Declaration

public override string ToString()

Returns

Type	Description
System.String	A string that represents the current object.

Overrides

System.Object.ToString()

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(ApiDataObject, ApiDataObject)

The equality operator.

Declaration

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

Parameters

Type	Name	Description
ApiDataObject	a	First operand.
ApiDataObject	b	Second operand.

Returns

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

Inequality(ApiDataObject, ApiDataObject)

The inequality operator.

Declaration

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

Parameters

Type	Name	Description
ApiDataObject	a	First operand.
ApiDataObject	b	Second operand.

Returns

Type	Description
System.Boolean	True if the given ApiDataObjects are not the same.

Implements

System.Xml.Serialization.IXmlSerializable