Skip to content

Get Connection Information

Description

Get information about a connection using (get-info ...).

(get-info 'connection ... )

Syntax and Default Values

The generic (get-info ... ) function can be used to obtain connection-specific information using the following Lisp syntax:

(get-info 'connection connection_reference data_type)

Parameters

The (get-info 'connection ... ) function takes one argument:

  • connection_reference: any connection.
  • data_type: a symbol defining the type of connection data we want to obtain.

Discussion

Although the (get-info ... ) command is a general-purpose command used throughout the Modalys environment, we are describing its use specifically as it relates to connections here.

This function allows you to query a connection for potentially useful information. The following data types may be used:

  • 'state (returns 1 if currently active/connected, 0 if inactive/not connected)
  • 'speed
  • 'position
  • 'force

The following data types are used for bi-directional connections like 'bow

  • 'speed-horizontal
  • 'speed-vertical
  • 'position-horizontal
  • 'position-vertical
  • 'force-horizontal
  • 'force-vertical

Options

There are no special options for this function.

★     ★