LocationAvailable XML block components

This section defines the elements and attributes that are contained in the LocationAvailable XML block.

LocationAvailable element

The LocationAvailable element has two children: StorageLocation and Command. The LocationAvailable element has the following attributes:

 

Name	Value
Device	The target device name.
IsRelidding	Indicates whether the labware is relidded at the target location. Possible values: 0 = The labware is not relidded 1 = The labware is relidded
IsSimulating	Indicates whether VWorks software is running in simulation mode. Possible values: 0 = VWorks software is not running in simulation mode 1 = VWorks software is running in simulation mode
IsSourceLocation	Indicates whether the target location is the same as the source location. Possible values: 0 = The target location is not the same as the source location 1 = The target location is the same as the source location
Labware	The labware type.
Location	The target location name.
PlateDevice	The source device name.
PlateLocation	The coordinates (cassette, slot) of the source location. The Cassette and Slot values are received by the plugin when VWorks software calls the MakeLocationAvailable method. See “MakeLocationAvailable method” .
PlateName	The labware name.
Robot	The robot name.
RobotObjectName	The robot type.

StorageLocation element

The StorageLocation element can have different structures for different device types.

StorageLocation element (Coordinates element child)

The StorageLocation element has two children: Coordinates and Location.

Coordinates element

The Coordinates element contains two StorageLocationCoordinate elements.

StorageLocationCoordinate element

Each StorageLocationCoordinate element has one of the following pairs of Name and Value attributes.

 

Name	Value
Name Value	The value Cassette. The name of the cassette. Note: The cassette name was received with a previous call to the GetMetaData method. See “GetMetaData method” .
Name Value	The value Slot. The name of the slot. Note: The slot name was received with a previous call to the GetMetaData method. See “GetMetaData method” .

StorageLocation element (Location element child)

The StorageLocation element contains one Location element.

Location element

VWorks software ignores the Location element in the LocationAvailable XML block. All attributes for this element are set to their default values as follows:

•

Group = 0

•	MaxStackHeight = 460

•	Offset = 0

•

Type = 1

Command element

When no task is executing or when VWorks software calls the MakeLocationAvailable method on a storage device where a task is executing, the Command element’s Name and PreferredTab attributes are not specified and these attributes are set to their default values as follows:

•	Compiler = 0

•	Editor = 0

•	NextTaskToExecute = 1

•	RequiresRefresh = 0

•	TaskRequiresLocation = 1

•	VisibleAvailability = 1

Except as noted in the previous paragraph, when a task is executing, the Command element provides information about the task. This element contains a Parameters element and has the following attributes:

 

Name	Value
Compiler	See “Compiler attribute” .
Editor	See “Editor attribute” .
Name	The name of the task. This attribute is not specified if no VWorks software task is executing.
NextTaskToExecute	See “NextTaskToExecute attribute” .
PreferredTab	See “PreferredTab attribute” . This attribute is not specified if no VWorks software task is executing.
RequiresRefresh	See “RequiresRefresh attribute” .
TaskRequiresLocation	See “TaskRequiresLocation attribute” .
VisibleAvailability	See “VisibleAvailability attribute” .

Parameters element (IsLocationAvailable method, storage device, task is executing)

The Parameters element can contain one or more Parameter elements, where the Name attribute is specific to the task that is named in the Command element.

For example, the Load task has two Parameter elements, loadIntoByLocation and loadIntoByGroup, while the Unload task has only one Parameter element, unloadFrom.

Parameter element

Each Parameter element has one or more pairs of Name and Description attributes plus the Scriptable, Style, and Type attributes.

For example, the Unload task has only one Parameter element, while the Load task has two Parameter elements. The Name and Description pairs are listed in the following table:

 

Task	Name attribute	Description attribute
Load	loadIntoByLocation loadIntoByGroup	load plate into locations load plate into groups
Unload	unloadFrom	unload plate from locations

Parameters element (IsLocationAvailable and MakeLocationAvailable methods, non-storage device, task is executing)

The Parameters element contains two Parameter elements, where the Name attribute has one of the following values:

•	Device to use

•	Location to use

Parameter element (Device to use)

The Device to use parameter specifies the device to be used by the task. This Parameter element contains one Ranges element and has the following attributes:

 

Name	Value
Description	The description of the parameter.
Name	The value Device to use.
Scriptable	See “Scriptable attribute” .
Style	See “Style attribute” .
Type	See “Type attribute” .
Value	The name of the device to be used.

Ranges element

The Ranges element contains one or more Range elements.

Range element

Each Range element contains the name of a device that can be used by the task. This element has the following attribute:

 

Name	Value
Value	The name of a device.

Parameter element (Location to use)

The Location to use parameter specifies the location to be used by the task. This Parameter element contains one Ranges element and has the following attributes:

 

Name	Value
Description	The description of the parameter.
Name	The value Location to use.
Scriptable	See “Scriptable attribute” .
Style	See “Style attribute” .
Type	See “Type attribute” .
Value	The name of the location to be used.

Ranges element

The Ranges element contains one or more Range elements.

Range element

Each Range element contains the name of a location that can be used by the task. This element has the following attribute:

 

Name	Value
Value	The name of the location.