High-Level and Utility API Description
This chapter presents a description of the High-Level API commands organized by major topics, as mentioned in the following list:
- Initialization, Setup and Cleanup—basic overhead to set up the test.
- Port Ownership—commands to control port ownership and sharing.
- Data Transmission—setup for data transmission.
- Data Capture and Statistics—setup for data capture and statistics.
- Console Output and Logging—output messages to the console and log files.
This chapter provides an overview of the high-level API functions and utility commands. The full details of the commands described herein may be found in the following appendices:
- Appendix 2 - Utility Commands includes complete descriptions of each of the Utility commands.
- Appendix 3 - High-Level API includes complete descriptions of each of the high-level commands.
The high-level commands are characterized by one or more of the following characteristics:
- They perform a combination of IxTclHAL commands.
- They perform one or more IxTclHAL commands over a range of ports.
- They control test operation sequences
Arguments to the high-level APIs are passed in one of the following two ways:
- By value: Denoted by (By value) in the Appendix C description. By value arguments are either a constant or a $variable reference. For example: 32, {{1 1 1} {1 2 1}} or $portList
- By reference: Denoted by (By reference) in the Appendix C description. By reference arguments must be references to variables, without the '$'. For example, pl after set pl {{1 1 1} [1 1 2}} or one2oneArray.
Read the individual description pages in the Appendices to determine which arguments are passed by reference and by value.