SlideLoader

_Stg_InitializeSlideLoader, Stg_AllowSlideLoaderCassetteManipulation, Stg_GetBarCode, Stg_GetBarCodeEx, Stg_GetCassetteCount, Stg_GetLoadedSlide, Stg_GetSlideCount, Stg_GetSlideLoaderHolderCapacity, Stg_InitializeSlideLoader, Stg_IsBarCodeScanned, Stg_IsCassettePresent, Stg_IsCassetteScanned, Stg_IsSlideLoaded, Stg_IsSlideLoaderCassetteManipulationAllowed, Stg_IsSlideLoaderInitialized, Stg_IsSlidePresent, Stg_IsSlidePresentEx, Stg_LoadSlideFrom, Stg_PreScanBarCode, Stg_ScanCassette, Stg_ScanPosition, Stg_SetSlidePresent, Stg_SlideloaderCheckStageEmpty, Stg_SlideLoaderGetHwStatus, Stg_SlideLoaderMoveAtVelocity, Stg_SlideLoaderShowError, Stg_SlideLoaderWarmInitAvailable, Stg_StopSlideLoader, Stg_TransferSlide, Stg_UnloadSlide, Stg_UnloadSlideTo

Stg_AllowSlideLoaderCassetteManipulation

Description 

 Stg_AllowSlideLoaderCassetteManipulation();

Allows manipulation with the slide loader cassette.

Stg_GetBarCode

Description 

 Stg_GetBarCode(
   int  cassette,
   int  slide,
   char *LpBarCode
);

This function returns the bar code which was scanned on the selected slide in a cassette.

Parameters

int cassette

Cassette ID

-1

all cassettes

1-4

ID number of the cassette

int slide

Slide ID.

-1

all slides

1...50

ID number of the slide

char *LpBarCode

Pointer to information about the bar code.

Stg_GetBarCodeEx

Description 

 Stg_GetBarCodeEx(
   int  cassette,
   int  slide,
   int  HolderPos,
   char *LpBarCode
);

This function returns the bar code which was scanned on the selected slide in a cassette.

Parameters

int cassette

Cassette ID

-1

all cassettes

1-4

ID number of the cassette

int slide

Slide ID.

-1

all slides

1...50

ID number of the slide

int HolderPos

Slide holder position.

char *LpBarCode

Pointer to information about the bar code.

Stg_GetCassetteCount

Description 

 Stg_GetCassetteCount();

This function returns number of scanned cassettes.

Stg_GetLoadedSlide

Description 

 Stg_GetLoadedSlide(
   int *cassette,
   int lp *Slide
);

This function returns identification number of the slide which is currently loaded.

Parameters

int *cassette

Cassette ID

-1

all cassettes

1-4

ID number of the cassette

int lp *Slide

Slide ID.

-1

all slides

1...50

ID number of the slide

Stg_GetSlideCount

Description 

 Stg_GetSlideCount(
   int  cassette
);

This function returns the maximum number of slides in the selected cassette.

Parameters

int cassette

Cassette ID

-1

all cassettes

1-4

ID number of the cassette

Stg_GetSlideLoaderHolderCapacity

Description 

 Stg_GetSlideLoaderHolderCapacity();

Returns the capacity of the slide holder.

Stg_InitializeSlideLoader

Interactive command to this function: Devices > Initiate loader

Description 

 Stg_InitializeSlideLoader();

This function initializes the slide loader.

Stg_IsBarCodeScanned

Description 

 Stg_IsBarCodeScanned(
   int  cassette,
   int  slide
);

Retrieves the information if a bar code on a selected slide in a cassette has been already scanned or not.

Parameters

int cassette

Cassette ID

-1

all cassettes

1-4

ID number of the cassette

int slide

Slide ID.

-1

all slides

1...50

ID number of the slide

Return Values

TRUE if scanned, FALSE if not.

Stg_IsCassettePresent

Description 

 Stg_IsCassettePresent(
   int  cassette
);

Retrieves the information if the selected cassette is present or not.

Parameters

int cassette

Cassette ID

-1

all cassettes

1-4

ID number of the cassette

Return Values

TRUE if present, FALSE if not.

Stg_IsCassetteScanned

Description 

 Stg_IsCassetteScanned(
   int  cassette
);

Retrieves the information if the selected cassette has been already scanned or not.

Parameters

int cassette

Cassette ID

-1

all cassettes

1-4

ID number of the cassette

Return Values

TRUE if scanned, FALSE if not.

Stg_IsSlideLoaded

Description 

 Stg_IsSlideLoaded();

Retrieves the information if the slide in a cassette is loaded.

Stg_IsSlideLoaderCassetteManipulationAllowed

Description 

 Stg_IsSlideLoaderCassetteManipulationAllowed();

Returns whether the cassette manipulation is allowed with the current slide loader.

Stg_IsSlideLoaderInitialized

Description 

 Stg_IsSlideLoaderInitialized();

This function returns the information whether the slide loader has been initialized or not.

Stg_IsSlidePresent

Description 

 Stg_IsSlidePresent(
   int  cassette,
   int  slide
);

Retrieves the information if the selected slide in a cassette is present or not.

Parameters

int cassette

Cassette ID

-1

all cassettes

1-4

ID number of the cassette

int slide

Slide ID.

-1

all slides

1...50

ID number of the slide

Return Values

TRUE if present, FALSE if not.

Stg_IsSlidePresentEx

Description 

 Stg_IsSlidePresentEx();

Retrieves the information if the selected slide in a cassette is present or not.

Stg_LoadSlideFrom

Description 

 Stg_LoadSlideFrom(
   int  cassette,
   int  slide
);

This function loads a slide specified by its location.

Parameters

int cassette

Cassette ID

-1

all cassettes

1-4

ID number of the cassette

int slide

Slide ID.

-1

all slides

1...50

ID number of the slide

Stg_PreScanBarCode

Description 

 Stg_PreScanBarCode(
   int  cassette,
   int  slide
);

This function scans the bar code on the selected slide in a cassette.

Parameters

int cassette

Cassette ID

-1

all cassettes

1-4

ID number of the cassette

int slide

Slide ID.

-1

all slides

1...50

ID number of the slide

Note

If you set the cassette parameter to 2 and slide parameter to -1, all slides on the cassette number 2 are scanned.

Stg_ScanCassette

Description 

 Stg_ScanCassette(
   int  cassette
);

This function scans the selected cassette.

Parameters

int cassette

Cassette ID

-1

all cassettes

1-4

ID number of the cassette

Stg_ScanPosition

Description 

 Stg_ScanPosition(
   int  cassette,
   int  slide
);

Makes the device scan the selected position for presence of a slide.

Parameters

int cassette

Cassette ID

-1

all cassettes

1-4

ID number of the cassette

int slide

Slide ID.

-1

all slides

1...50

ID number of the slide

Stg_SetSlidePresent

Description 

 Stg_SetSlidePresent(
   int  cassette,
   int  slide
);

Marks a position in a cassette as loaded with a slide/well plate.

Parameters

int cassette

Cassette ID

-1

all cassettes

1-4

ID number of the cassette

int slide

Slide ID.

-1

all slides

1...50

ID number of the slide

Stg_SlideLoaderGetHwStatus

Description 

 Stg_SlideLoaderGetHwStatus();

This function returns a 32-bit number to indicate the Slide Loader status. Please find further details in the manufacturer's device documentation.

Stg_SlideloaderCheckStageEmpty

Description 

 Stg_SlideloaderCheckStageEmpty(
   int *LpPlatePresent
);

Verifies whether the stage is empty or occupied.

Parameters

int *LpPlatePresent

0

No well plate on the stage.

1

A well plate is inserted on the stage.

Stg_SlideLoaderMoveAtVelocity

Description 

 Stg_SlideLoaderMoveAtVelocity(
   int  Axis,
   int  Speed
);

This function enables you to specify precise velocity and direction of the mechanical hand movement.

Parameters

int Axis

Movement direction. Please find further details in the manufacturer's device documentation.

1

X axis

2

Y axis

3

Z axis

int Speed

0

Half of the optimal speed.

1

Optimal speed (with this speed it is ensured that the step size which is recommended for the current objective will be complied with).

2

Twice the optimal speed.

Stg_SlideLoaderShowError

Description 

 Stg_SlideLoaderShowError(
   int  ForceShowError
);

If an error occurs when working with the slide loader device, you are notified about it by a message box. However, this works only with the SlideLoader GUI element (control window) displayed. If the control window is closed, no message box appears. Run this function to override this behavior and display the error messages at all times.

Parameters

int ForceShowError

Display error messages even if the GUI is hidden.

0

Do not display error messages when GUI is hidden.

1

Force error messages to display.

Stg_SlideLoaderWarmInitAvailable

Description 

int Stg_SlideLoaderWarmInitAvailable();

Tests whether a warm initialization of the loader is safe or not.

Return Values

int

0

Full initialization is required otherwise a crash of the hardware parts might occur.

1

It is safe to perform the warm initialization (the device will not move, only the system state is set to initialized).

Stg_StopSlideLoader

Description 

 Stg_StopSlideLoader();

Terminates the Slide Loader functions.

Stg_TransferSlide

Description 

 Stg_TransferSlide(
   int  CassetteSrc,
   int  SlideSrc,
   int  CassetteDst,
   int  SlideDst
);

This function transfers slide to a new position.

Parameters

int CassetteSrc

Original cassette position from which the slide is transferred.

int SlideSrc

Original slide position from which the slide is transferred.

int CassetteDst

New cassette position to which the slide is transferred.

int SlideDst

New slide position to which the slide is transferred.

Stg_UnloadSlide

Description 

 Stg_UnloadSlide();

This function unloads the loaded slide to its original location.

Stg_UnloadSlideTo

Description 

 Stg_UnloadSlideTo(
   int  cassette,
   int  slide
);

This function unloads the currently loaded slide to the specified position.

Parameters

int cassette

Cassette ID

-1

all cassettes

1-4

ID number of the cassette

int slide

Slide ID.

-1

all slides

1...50

ID number of the slide

_Stg_InitializeSlideLoader

This function runs the Devices > Initiate loader command.

Description 

 _Stg_InitializeSlideLoader();

This function opens the Stage warning dialog before initializing the slide loader.