MSharePick

DESCRIPTION

This module is part of the COVISA toolkit (version 2.0) of collaborative modules. A full description of the COVISA module suite and API is given in the IRIS Explorer Collaborative User Guide. You are strongly advised to read this guide before using the COVISA modules.

Once connection to the collaborative session has been achieved using the MServer module, this module can be launched.

MSharePick is used to share Pick data between members of a collaborative session. Data passed in on the input port (In_Pick) is passed to all other members in the session. Data passed in to the session, from other collaborators, comes out on the output port (Out_Pick). This module is capable of being a loop controller.

The 'Group ID' for this module can be seen on the control panel. This ID uniquely identifies all collaborating modules that are conceptually sharing a single data object. This ID allows collaborators to identify modules that are sharing the same data object. When a new data object is passed in to one member of the Group, this then becomes the new shared data object for the whole group.

INPUTS

Port: In_Pick
Type: Pick
Optional: This port is optional.

Pick data to be shared with the collaborating session.

WIDGETS

Port: Pass Through
Type: Option Menu
Menu Item: Off
Menu Item: On

This switch, which by default is off, controls the routing of the data through the module.

When off and not connected to a collaborative session, data passed in goes no where.

When on and not connected to a collaborative session, data passed in on an input port, is passed through to the corresponding out- put port.

When off and connected to a collaborative session, data passed in on an input port is passed into the collaborative session only.

When on and connected to a collaborative session, data passed in on an input port is passed into the collaborative and also passed out on the corresponding output port.

Port: Initiate
Type: Button

Makes the module connect to the COVISA_server.

Port: Connection_State
Type: Option Menu
Menu Item: Reconnect
Menu Item: Disconnect

This menu box allows the module to be disconnected and reconnected from/to the COVISA_server. Note: once the last 'Group' member disconnects from the COVISA_server the 'Group ID' is deleted and reconnection is no longer possible.

OUTPUTS

Port: Out_Pick
Type: Pick

A shared Pick data object passed in from the collaborative session, or from the module's input port if the "Pass Through" switch is set to on.

KNOWN PROBLEMS

None

SEE ALSO

Other COVISA toolkit modules:

MAdvisor, MServer, MShareGeom, MShareGraph3D, MShareLat, MShareLatToGeom, MShareParam, MSharePointer, MSharePyr

The IRIS Explorer COVISA collaborative module suite and API was developed at the University of Leeds.

You are referred to the IRIS Explorer Collaborative User Guide for more information.


[Documentation Home]