Echoview object

The Command interface interacts with one instance of the <Echoview> object which is the Echoview window.

The command syntax is:

> Echoview | ActionName | Argument

If the <ActionName> is unique to the object then the <ObjectName> (i.e., Echoview in the above example) is redundant.

<Echoview> supports the following <ActionNames>:

Note: Supplied examples could be adjusted to suit your EV file, variable and virtual names. See also: Example display conventions.

ActionName Details
AppliedObjects
Syntax

AppliedObjects | Argument

Description

Lists all <ObjectNames> accessible by Echoview. The optional <Argument> specifies an <ObjectName> list index and returns that <ObjectName>. The list index begins at zero.

See also Filtering.

Example

> Echoview | AppliedObjects
0.2m | AAProcessed data 1 | Background noise removal 1 | Bottom | Bottom classification 1 | BottomEVL | Code 1 | Data range bitmap 1 | dB diff | Ev File | Fileset 1: angular position raw pings T1 | Fileset 1: angular position raw pings T2 | Fileset 1: heading data GPVTG | Fileset 1: line data depth GPGGA | Fileset 1: position GPS fixes | Fileset 1: position GPS fixes GPGGA | Fileset 1: position GPS fixes GPGLL | Fileset 1: position GPS fixes GPRMC | Fileset 1: Power dB raw pings T1 | Fileset 1: Power dB raw pings T2 | Fileset 1: Sv raw pings T1 | Fileset 1: Sv raw pings T2 | Fileset 1: T1 | Fileset 1: T2 | Fileset 1: TS raw pings T1 | Fileset 1: TS raw pings T2 | Fileset 2: Video data | Fileset 2: Video data (1) | Formula 1 | Ping subset 1 | Processed data 3 | STDM2 | Target samples bitmap 1 | Threshold offset 1 | Threshold offset 1EchoviewEVL | Vegetation? | Veg from above

ClearConsole
Syntax

ClearConsole

ClearConsole ActionOptionName

ActionOptionName

Description

Clears all text from the Console dialog box.

ActionOptionNames include:

  • ClearBlankLines
  • Removes blank lines prefaced by ">" that are used to separate command lines.
  • ClearCommands
  • Removes displayed command line text.
  • ClearErrors
  • Removes ERROR text.
  • ClearHelp
  • Removes text for command help returns.
  • ClearReplies
  • Removes text from displayed successful command line returns.
Examples

> ClearConsole

> ClearCommands

ClearHistory
Syntax

ClearHistory

Description

Clears the Console dialog box history log.

Example

> ClearHistory

Exit
Syntax

Exit

Description

Used to close an Echoview window. ActionOptions are <Save> or <Discard>.

Example

Exit Echoview.

> Exit

Save changes to the existing EV file and exit Echoview.

> Exit Save

Discard changes in the EV file and exit Echoview.

> Exit Discard

 

ExportCommands
Syntax

ExportCommands | Argument

Description

Exports successfully executed commands to a specified EC file. <ExportCommands> requires an <Argument>. This <Action> is the same as the item of that name on the Console menu or Console right-click menu.

<Argument>

EC file name and path. The file extension can be omitted; the file is saved with a .EC extension.

Example

> ExportCommands | C:\aFolder\AnotherECFile.EC

ExportCommandsAsVbs
Syntax

ExportCommandsAsVbs | Argument

Description

Exports successfully executed commands to a specified .VB file. <ExportCommandsAsVbs> requires an <Argument>. This <Action> is the same as the item of that name on the Console menu or Console right-click menu.

<Argument>

VB file name and path. The file extension can be omitted; the file is saved with a .VB extension.

Example

> ExportCommandsAsVbs | C:\aFolder\AVBFile.VB

ExportCommandsAsPython
Syntax

ExportCommandsAsPython | Argument

Description

Exports successfully executed commands to a specified .PY file. <ExportCommandsAsPython> requires an <Argument>. This <Action> is the same as the item of that name on the Console menu or Console right-click menu.

<Argument>

Python file name and path. The file extension can be omitted; the file is saved with a .PY extension.

Example

> ExportCommandsAsPython | C:\aFolder\AVBFile.PY

ImportCommands
Syntax

ImportCommands | Argument

Description

Reads interface commands from an .EC file. <ImportCommands> requires an <Argument>

<Argument>

EC file name and path.

Example

> ImportCommands | C:\aFolder\YourECFile.EC

LastLogMessage
Syntax

LastLogMessage

Description

Retrieves the most recent message form the Message dialog box.

Example

> Log | A message sent to the Command interface to the Message dialog box.
> LastLogMessage
A message sent to the Command interface to the Message dialog box.

LicenseContainerDetails
Syntax

LicenseContainerDetails

Description

Displays Echoview license informtion and includes:

  • Product code
  • Echoview license information as a text string
  • License item number
  • Expiry date DD/MM/YYY
  • Expiry time HH:MM:SS
  • Date of manufacture YYYYMMDD

For further information refer to Licenses and demonstration mode.

Example

> LicenseContainerDetails

100 "Contact and Account Name" 0 2999-12-31 23:59:59 20220601 | 109 "Timed" 1 2024-01-01 11:00:00 20220601

LicenseContainerNames
Syntax

LicenseContainerNames

Description

Displays the Echoview license name. For further information refer to Licenses and demonstration mode.

Example

> LicenseContainerNames
0-0000000

LicenseModules
Syntax

LicenseModules

Description

Displays a list of module short names managed by the Echoview license. Also included is the licensed module manufacture date and the expiry date.

  • Date of manufacture YYYYMMDD
  • Expiry date DD/MM/YYY
  • Expiry time HH:MM:SS

For further information refer to Licenses and demonstration mode.

Example

Listed modules are Essentials, Automation and Advanced Operators.

> LicenseModules
AOP 20220601 2024-01-01 11:00:00 | AUT 20220601 2024-01-01 11:00:00 | ESS 20220601 2024-01-01 11:00:00

Log
Syntax

Log | Argument

Description

Send a message to the Message dialog box. <Argument> is the content of the message.

Example

> Log | A message sent to the Command interface to the Message dialog box.

   
New
Syntax

New

New | Argument

Description

Opens a new EV file in an Echoview window.

<Argument>

EV file name and path.

Example

Create a new EV file.

> New

Create a new EV file and add two data files to the first fileset.

> New | YourData1Path | YourData2Path

Open
Syntax

Open | Argument

Description

Opens an existing EV file in an Echoview window. <Open> requires a <Argument>.

<Argument>

EV file name and path.

Example

> Open | C:\aFolder\YourEVFile.EV

See also

Command interface and command syntax
The Console dialog box