__prod_name Commands Overview
__prod_name uses commands to both setup and control an experiment. Most of the commands are going to be processed from configuration files, and are used to setup an experiment. You can also use commands through NetCom to control an experiment. Regardless of where the commands come from, they are processed by __prod_name identically.
Command Rules
All of the __prod_name commands obey some common rules. If a command deviates from these rules, the description of the command will let you know. Actual commands will appear in
italics
. When using commands in configuration files, there are additional rules (see
Configuration Files
for more information).
-
Commands begin with a hyphen (-).
-
correct:
-StartAcquisition
-
incorrect:
StartAcquisition
-
Commands and arguments are not case sensitive.
-
-processconfigurationfile test.cfg
and
-ProcessConfigurationFile Test.cfg
are identical.
-
Commands must be spelled correctly, there are no abbreviations.
-
correct:
-StartAcquisition
-
incorrect:
-StartAcq
-
All command arguments are separated by a space.
-
-SetSpikeThreshold SC1 200
has two arguments, SC1 and 200.
-
If any command or argument contains a space, it must be surrounded by double quotes (" ").
-
-CreatePlotWindow Spike "Spike Window 1"
will create a Spike plot window named Spike Window 1.
-
All objects must be created before they are used.
-
For example, you must create the Hardware System before you can create any Acquisition Entities in it:
-CreateHardwareSubSystem AcqSystem1 DigitalLynxSXATLAS
must be called before
-CreateCscAcqEnt CSC1 AcqSytem1 NCS
-
All command arguments are required unless otherwise stated in the command documentation.