THE WHISKER COMMAND SET

This guide explains the information you would need to write your own powerful behavioural tasks.

For every entry that details a Whisker command or message, most or all of the following headings may be shown:

Message

Shows the syntax of the command.

Bold or plain text is quoted literally.

<parameters> are shown in italics and in angle brackets ( < > ).

[<optional parameters>] are enclosed in square brackets ( [ ] ).

[Optional literal text] is also enclosed in square brackets.

Square brackets are also sent by the server to indicate timestamps. (See TimeStamps.)

Alternatives are separated by a vertical bar ( | ), e.g. one | two | three.

Information sent by the client is shown in red.

Information sent by the server is shown in blue.

Originator

Whether the message or command is initiated by the Server or the Client.

Response (immediate socket)

(For client commands only.) Gives the possible responses the server may make if the client sends the command via the immediate socket.

Response (main socket)

(For client commands only.) Gives the possible responses the server may make if the client sends the command via the main socket.

Details

Explains the command in detail.

SDK Control / SDK Control Method

For server messages, explains the manner in which the SDK responds to the server's message.

For client commands, gives the syntax used to pass the command to the server via the SDK control.

THE SDK DOCUMENTATION IS NOT YET COMPLETE. All commands have SDK versions: these have the same name as the WhiskerCommand messages that they instantiate. The documentation is in the process of being updated to reflect the SDK options; in the meantime, their usage can be easily surmised from their parameter names and the documentation for those commands that have been properly documented!

ClientLib

Explains the manner in which the command is handled by the C++ client library (WhiskerClientLib).

Note: two versions of each of the virtual functions are provided: a version which contains timestamped information, and another which does not. If you do not override the timestamped version, the function without timing information will be called by the library. See WhiskerTask.h file for details.

Examples

Illustrates examples of the message.