Class Application

The main application interface.

Inheritance

System.Object

SerializableObject

Application

Implements

System.Xml.Serialization.IXmlSerializable

System.IDisposable

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

Properties

Calculation

Calculation related functions

Declaration

public Calculation Calculation { get; }

Property Value

Type	Description
Calculation

CurrentUser

The user who is currently logged on.

Declaration

public User CurrentUser { get; }

Property Value

Type	Description
User

Equipment

Provides access to clinical devices and accessories.

Declaration

public Equipment Equipment { get; }

Property Value

Type	Description
Equipment

PatientSummaries

Fetches patient summaries from the database.

Declaration

public IEnumerable<PatientSummary> PatientSummaries { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<PatientSummary>

ScriptEnvironment

Gets the script environment.

Declaration

public ScriptEnvironment ScriptEnvironment { get; }

Property Value

Type	Description
ScriptEnvironment

StructureCodes

Provides access to the structure code dictionaries with the active structure codes.

Declaration

public ActiveStructureCodeDictionaries StructureCodes { get; }

Property Value

Type	Description
ActiveStructureCodeDictionaries

Methods

ClosePatient()

Closes the current patient. If the script tries to access the data of a closed patient, an access violation exception occurs.

Declaration

public void ClosePatient()

CreateApplication()

Creates an application instance for a standalone script and logs into the system.

Declaration

public static Application CreateApplication()

Returns

Type	Description
Application	Application object that is the root of the data model.

Remarks

Code that uses ESAPI must run on a single-threaded apartment (STAThread). The Dispose method must be called before the program exits. Only one application instance may be created during the entire run of the program.

CreateApplication(String, String)

Creates an application instance and logs into the system.

Declaration

[Obsolete("Eclipse Scripting API Application executes using the currently logged in Windows user credentials. The given username and password are ignored.")]
public static Application CreateApplication(string username, string password)

Parameters

Type	Name	Description
System.String	username	Username for logging in or null value to invoke an interactive login dialog.
System.String	password	Password for logging in or null value to invoke an interactive login dialog.

Returns

Type	Description
Application	Application object that is the root of the data model.

Remarks

Code that uses ESAPI must run on a single-threaded apartment (STAThread). Dispose must be called before the program exits. Only one Application instance may be created during the entire run of the program.

Dispose()

Releases all unmanaged resources of this object.

Declaration

public void Dispose()

OpenPatient(PatientSummary)

Opens a patient.

Declaration

public Patient OpenPatient(PatientSummary patientSummary)

Parameters

Type	Name	Description
PatientSummary	patientSummary	Patient summary.

Returns

Type	Description
Patient	Opened patient if found.

Remarks

Only one patient can be open at the same time.

OpenPatientById(String)

Opens a patient by using a patient identifier.

Declaration

public Patient OpenPatientById(string id)

Parameters

Type	Name	Description
System.String	id	Patient ID

Returns

Type	Description
Patient	Opened patient if found.

Remarks

Only one patient can be open at the same time.

SaveModifications()

[Availability of this method depends on your Eclipse Scripting API license] Saves data modifications to the database if saving is allowed. Note: Calling this method can cause a multi-user warning dialog box to appear if the same patient is modified by other parties.

Declaration

public void SaveModifications()

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

System.IDisposable