AxelSemrau.Chronos.Plugin.IPAL3Services Interface Reference

An object implementing this interface is provided by Chronos and passed to the PAL3task just before execution. More...

Inheritance diagram for AxelSemrau.Chronos.Plugin.IPAL3Services:

Collaboration diagram for AxelSemrau.Chronos.Plugin.IPAL3Services:

Public Member Functions
IActivityResult	ExecuteActivity (IActivity act)
	Use this to actually execute an activity. More...
IModuleReference	GetModuleReference (string strTrayName, ref int vialNo, bool bAllowVolatileVials=true)
	Gets a module reference for a position. More...
IModuleReference	AllocateVial (string strTrayName, int vialNo)
	Allocates the vial. More...
IActivityResult	ExecuteActivityWithoutErrorHandling (IActivity act)
	Use this to actually execute an activity, bypassing the normal error handler More...
Public Member Functions inherited from AxelSemrau.Chronos.Plugin.IDevice
void	Connect ()
	You may have connected to the device before this, but make sure you are connected after this. More...
void	Disconnect ()
	You may disconnect now. More...

Properties
IPalPlusConfigurationService	ConfigService [get]
	The service which provides information about the device configuration, like trays and modules. More...
IDirectExecutionSession	Session [get]
	The session you should use for any operation on the PAL3. More...
IPalPlusDirectService	DirectService [get]
	Gets PAL3 the Direct Service More...
bool	Simulating [get]
	Gets a value indicating whether this IPAL3Services is simulating. More...
IServiceLocator	Services [get]
	Gets the Driver Service Locator to obtain Driver services More...
bool	KeepSession [get, set]
	Enforce keeping the session open until the schedule is finished. More...
Properties inherited from AxelSemrau.Chronos.Plugin.IDevice
string	DisplayedTypeName [get]
	Text which is displayed in the instruments settings "Autosampler Type" column and in many other places. More...
string	DeviceTypeDescription [get]
	Text which is displayed to make clear which kind of device a named sampler is. More...
string	Name [get, set]
	User-selected name for the device instance. More...

Events
Action	BeforeSessionReset
	Hook up to this event if you want to be notified just before the PALs session is reset (after an error or at sequence end). More...
Events inherited from AxelSemrau.Chronos.Plugin.IDevice
Action< ConnectionState >	ConnectionStateChanged
	Raise this event when your connection state has changed. More...

Detailed Description

An object implementing this interface is provided by Chronos and passed to the PAL3task just before execution.

Definition at line 11 of file PAL3TaskInterfaces.cs.

Member Function Documentation

AllocateVial()

IModuleReference AxelSemrau.Chronos.Plugin.IPAL3Services.AllocateVial	(	string	strTrayName,
		int	vialNo
	)

Allocates the vial.

Parameters

strTrayName	Name of the STR tray.
vialNo	The vial no.

Returns

ExecuteActivity()

IActivityResult AxelSemrau.Chronos.Plugin.IPAL3Services.ExecuteActivity

(

IActivity

act

)

Use this to actually execute an activity.

Parameters

act

The act.

Returns

ExecuteActivityWithoutErrorHandling()

IActivityResult AxelSemrau.Chronos.Plugin.IPAL3Services.ExecuteActivityWithoutErrorHandling

(

IActivity

act

)

Use this to actually execute an activity, bypassing the normal error handler

Parameters

act

The act.

Returns

GetModuleReference()

IModuleReference AxelSemrau.Chronos.Plugin.IPAL3Services.GetModuleReference	(	string	strTrayName,
		ref int	vialNo,
		bool	bAllowVolatileVials = true
	)

Gets a module reference for a position.

Parameters

strTrayName
vialNo
bAllowVolatileVials

Returns

If the desired position represents a volatile vial, the vial number can change.

Property Documentation

ConfigService

IPalPlusConfigurationService AxelSemrau.Chronos.Plugin.IPAL3Services.ConfigService

get

The service which provides information about the device configuration, like trays and modules.

Definition at line 16 of file PAL3TaskInterfaces.cs.

        {
            get;
        }

DirectService

IPalPlusDirectService AxelSemrau.Chronos.Plugin.IPAL3Services.DirectService

get

Gets PAL3 the Direct Service

Definition at line 32 of file PAL3TaskInterfaces.cs.

        {
            get;
        }

KeepSession

bool AxelSemrau.Chronos.Plugin.IPAL3Services.KeepSession

getset

Enforce keeping the session open until the schedule is finished.

Usually, the session are disposed after not being used for a while if the assigned job was finished. In cases where this leads to unintended effects (like "volatile vials" becoming unusable), you can stop this.

Definition at line 93 of file PAL3TaskInterfaces.cs.

{ get; set; }

Services

IServiceLocator AxelSemrau.Chronos.Plugin.IPAL3Services.Services

get

Gets the Driver Service Locator to obtain Driver services

Definition at line 60 of file PAL3TaskInterfaces.cs.

{ get; }

Session

IDirectExecutionSession AxelSemrau.Chronos.Plugin.IPAL3Services.Session

get

The session you should use for any operation on the PAL3.

Definition at line 24 of file PAL3TaskInterfaces.cs.

        {
            get;
        }

Simulating

bool AxelSemrau.Chronos.Plugin.IPAL3Services.Simulating

get

Gets a value indicating whether this IPAL3Services is simulating.

true if simulating; otherwise, false.

Definition at line 50 of file PAL3TaskInterfaces.cs.

{ get; }

Referenced by MockPlugin.Tasks.MockUseMultipleDevicesTask.Execute().

Event Documentation

BeforeSessionReset

Action AxelSemrau.Chronos.Plugin.IPAL3Services.BeforeSessionReset

Hook up to this event if you want to be notified just before the PALs session is reset (after an error or at sequence end).

Definition at line 55 of file PAL3TaskInterfaces.cs.

---

The documentation for this interface was generated from the following file:

• PAL3TaskInterfaces.cs