PropertiesOptions
Additional <PropertiesOptions> are available to the following objects: Ev File, <VariableName> and <TransducerName>. <PropertiesOptions> is the set of <ActionOptions> to use with a <PropertyName>. <PropertiesOptions> can be used in their simplest form or be used in extended commands with filters. However, be aware that the Command interface only supports the display of a single property for multiple objects or multiple properties for a single object.
PropertiesOptionNames include:
Property settings that return an array of values
<PropertyNames> that return an array of values are displayed as space separated values.
- Setting values that are space insensitive with respect to the Command interface have spaces removed.
- e.g. The return <InvisibleLines | Fileset1:LineDataHeave Fileset1:LineDataDepthINGGA Line2> lists 3 lines that are not displayed on the echogram as specified by the Lines page of the Variable Properties dialog box.
- Setting values that are space sensitive with respect to the Command interface are enclosed in quotes.
Array types
Array type |
Description |
Fixed size set |
has a fixed number of items, each either present or absent, and there is no numeric indexing of items. An example is ExportAnalysisVariables which represents the array for EV File Properties, Export page analysis export variables. |
Set |
has a variable number of items, each present at most once, and is indexed. An example is InvisibleLines which represents the undisplayed lines on the Lines page of the Variable Properties dialog box. |
List |
has a variable number of items, can have duplicates, and is indexed. An example is DataFileLocations which represents the Data file locations on the EV File page of the EV File Properties dilaog box. |
Fixed size array |
has a fixed number of items, with a defined order, each occupied or empty, it can hold duplicated values and is indexed. An example is PingStatusColors with represents the colors assigned on the Ping Status page of the EV File Properties dialog box. |
Notes:
- <PropertyNames> that specify a color do so as a RGB color value e.g. (R, G, B), (R,G,B) or R, G, B
- EchogramBackgroundColor for multibeam echogram Background color, IntegrationLineColor for single beam echogram Integration line color, 3 color maximum operator colors and various Line color settings are handled in this way.
Examples:- Return for Multibeam echogram Background color
- EchogramBackgroundColor | (128, 128, 128) |
- Assign a Color display minimum value to operand 3 of the 3 color maximum variable
- >3 color maximum 1 | Properties MinimumColor 2 =| 136,10, 40
- Return for Multibeam echogram Background color
- <ObjectName | Properties> outputs a <PropertyName | Value> list of set and default values. For further details refer to Ev File, Variable object and Transducer object.
- See also <FilterActions>.
- See also Amend a list of items.
Accessing array values
Under the Command interface:
- Echoview can use fixed arrays where you can access any item in the array. Fixed arrays don't permit the addition or removal of items in the array.
- Gaps between item indexes are not permitted.
Array items are indexed, the indexing starts at 0. A range of array items is specified by using StartRange... StopRange.
Changing array values
Array values may be changed by dealing with specific items in the array, or you can use <=> to assign a list of values. The assignment of values supports the use of a space or a semicolon to delimit the array list. The empty string "" indicates no recorded value for the indexed item.
Example: assign with list delimiter as a space or a semicolon
> Single target detection - split beam (method 2) 1 | HTIBeamPatternCoefficients
Single target detection - split beam (method 2) 1 | 0.00021 -0.545 -0.000083 -0.00677 -0.000424 -0.56 0.00451 -0.00614
> Single target detection - split beam (method 2) 1 | HTIBeamPatternCoefficients = | 0.00000 -0.545 -0.000083 -0.00677 -0.000424 -0.56 0.00451 -0.00614
> Single target detection - split beam (method 2) 1 | HTIBeamPatternCoefficients
Single target detection - split beam (method 2) 1 | 0.0 -0.545 -0.000083 -0.00677 -0.000424 -0.56 0.00451 -0.00614
>> Single target detection - split beam (method 2) 1 | HTIBeamPatternCoefficients = | 0.00021; -0.545; -0.000083; -0.00677; -0.000424; -0.56; 0.00451; -0.00614
> Single target detection - split beam (method 2) 1 | HTIBeamPatternCoefficients
Single target detection - split beam (method 2) 1 | 0.00021 -0.545 -0.000083 -0.00677 -0.000424 -0.56 0.00451 -0.00614
>
Example: array item, range
Display Ping status colors under a new EV file.
> PingStatusColors ValueDefault
Ev File | Blue Cyan Green Magenta Red Yellow White BlueDark CyanDark GreenDark
>
Get an array
> PingStatusColors
Ev File | Blue Cyan Green Magenta Red Yellow White BlueDark CyanDark GreenDark
>
Specify an array
> PingStatusColors = | Red Yellow Blue Green Cyan Magenta White BlueDark GreenDark CyanDark
> PingStatusColors
Ev File | Red Yellow Blue Green Cyan Magenta White BlueDark GreenDark CyanDark
>
Get an array item
> PingStatusColors 0
Ev File | Red
>
Get a range of items
> PingStatusColors 2..5
Ev File | Blue Green Cyan Magenta
>
Specify an item
> PingStatusColors 3 = | red
> PingStatusColors 2..5
Ev File | Blue Red Cyan Magenta
>
Specify a range of items
> PingStatusColors 2..5 =| Yellow Green Magenta Red
> PingStatusColors 2..5
Ev File | Yellow Green Magenta Red
>
Amend a list of items
You can amend items in an array. Amend options +=| and -=| may be used for supported Variable and EV File properties array types that can contain a values, strings or numbers.
=| All selects all the items in the set.
=| None deselects all items in the set.
=| Default restores the the defaults associated with a new EV file.
Array type |
Supported Amend options |
Fixed size set |
+=, -=, None, All, Default |
Set |
+=, -=, None, Default |
List |
+=, -=, None, Default |
Fixed size array |
None, Default |
Examples
Amend options are mathematical for numeric properties.
> Copy 1 | GridXAxisSpacingInPings +=| -2
Copy 1
> Copy 1 | GridXAxisSpacingInPings
Copy 1 | 98
Amend options handle strings or values in a property.
>ev file | ExportAnalysisVariables
Ev File | RegionID
> EvFile | ExportAnalysisVariables += | RegionName
Ev File | RegionID RegionName
Amend option that clears ExportAnalysisVariables items in preparation for specifying desired analysis variables.
ev file | ExportAnalysisVariables =| None
ev file | None
Exceeding the array's length, Adding an item, Removing an item
Bottom classification variable: displaying the Classes page properties; adding a new Class name to the end of the array; the return value when you query an index that exceeds the array's length; and removing a Class name from the beginning of the array.
> Bottom classification (Manual) | pageclasses
BottomClassColors | (128,128,0) (255,240,255) (198,0,0) (206,0,206) (255,0,128) (0,128,0) (180,145,22) (187,255,187) (255,192,130) |
BottomClassIds | 1 2 3 4 5 6 7 8 9 |
BottomClassNames | "Class 1" "Class 2" "Class 3" "Class 4" "Class 5" "Class 6" "Class 7" "Class 8" "Class 9" |
BottomClassNotes | "" "" "" "" "" "" "" "" ""
> Bottom classification (Manual) | BottomclassNames +=| 'AnotherName'
> Bottom classification (Manual) | bottomclassnames
BottomClassNames | "Class 1" "Class 2" "Class 3" "Class 4" "Class 5" "Class 6" "Class 7" "Class 8" "Class 9" "'AnotherName'" |
> Bottom classification (Manual) | bottomclassnames 10
Bottom classification (Manual) | None
> Bottom classification (Manual) | bottomclassnames 9
Bottom classification (Manual) | 'AnotherName'> Bottom classification (Manual) | bottomclassnames 0 -=
> Bottom classification (Manual) | bottomclassnames
Bottom classification (Manual) | "Class 2" "Class 3" "Class 4" "Class 5" "Class 6" "Class 7" "Class 8" "Class 9" "'AnotherName'"
>
PropertiesOptionName |
Details |
||||||
| ValueUnits | SyntaxObjectName | PropertyName ValueUnits ObjectName | ValueUnits Description<ValueUnits> returns a <PropertyName | Unit> list of the specified and default object Properties setting units for the object. Example<t1> Transducer object.
EV File Properties dialog box, Schools page, Maximum horizontal linking distance. > Evfile | SchoolsMaximumHorizontalLinkDistance ValueUnits |
||||||
| ValueMinimum | SyntaxObjectName | PropertyNameValueMinimum ObjectName |ValueMinimum Description<ValueMinimum> returns the minimum range of the object Properties as list of <PropertyName | Value> for both user specified and default settings. Example<t1> Transducer object.
|
||||||
| ValueMaximum | SyntaxObjectName | PropertyNameValueMaximum ObjectName |ValueMaximum Description<ValueMaximum> returns the maximum range of the object Properties as list of <PropertyName | Value> for both user specified and default settings. Example<t1> Transducer object.
|
||||||
| ValueDefault | SyntaxObjectName | PropertyName ValueDefault ObjectName | ValueDefault DescriptionLists the default values of the <ObjectName> Properties dialog box as a <PropertyName | Value> list. Example<T1> Transducer object.
|
||||||
| ValueOptions | SyntaxObjectName | PropertyNameValueOptions VirtualVariableName | PageOperatorValueOptions EvFile | ExportAnalysisVariables | ValueOptions DescriptionReturns properties whose value is selected from an enumerated list. The return is of the form <PropertyName | Value1 Value2 ... ValueN |>. The return includes settings where the enumerated list is empty. Be aware that a property value selected from a <ValueOptions> list may have specific collateral properties. Example<T1> Transducer object.
Some EV file settings with enumerated values (not shown are ExportAnalysisVariables and PingStatusColors ):
Collateral properties for the command interface property <RangeType> for the Ping subset Ranges setting.
|
||||||
| GraphName* | SyntaxVariableName | Properties GraphNameTitle VariableName | Properties GraphNameXAxisLabel VariableName | Properties GraphNameXAxisMinimum VariableName | Properties GraphNameXAxisMaximum VariableName | Properties GraphNameYAxisLabel VariableName | Properties GraphNameYAxisMinimum VariableName | Properties GraphNameYAxisMinimum VariableName | Properties FrequencyDistibutionBinCount GraphName* DescriptionPropertyOptions for many graphs Graph Properties dialog box settings: Title, X-axis and Y-axis labels; values for axis Minimum and Maximum limits and Frequency Distribution Bin Count. Specific graph source, labels and axes-limits may be set or read. See also: <VariableName | PageGraph>. <GraphName> support includes the following graphs:
Note: SingleTargetTsVsDepth can be a graph for a target length data. ExamplesPing graph title and X-axis minimum value with Sv pings variable as the graph data source. > Sv pings | GraphPingTitle =| Ping 192 Frequency distribution graph Bin Count set to 10 that is applied to all variables. The next request for the Frequency distribution graph bin count list, displays a return for variables. Note: Some listed variables (e.g. GPS fixes, line variables) do not support the frequency distribution graph. > GraphFrequencyDistributionBinCount =| 10 |
||||||
| Export | SyntaxObjectName | Export | YourFilePath Export | YourFilePath Description<Export> directs the Command interface to export the <ObjectName> Properties settings to a specified file path. For more information refer to Ev File, Variable or Transducer object pages. New text files contain plain text with the following file format. You can view the file in a plain text editor or open as delimited data with headers under Excel. Pre-existing files without a header line are not updated with a header.
Notes:
ExamplePart of the output for the command line <Export | YourFilePath>. This command line exports settings for all Ev file, TransducerName and VariableName objects in the EV file. EV File Properties ObjectName PropertyName CurrentValue Units MinimumValue MaximumValue ValueOptions DefaultValue Variable Properties ObjectName PropertyName CurrentValue Units MinimumValue MaximumValue ValueOptions DefaultValue > Copy1 | Export | "c:/temp/Copy1Properties.txt" |
See also
Ev File object
Variable object
Transducer object
Echoview Command interface and command syntax
Console dialog box