COM object EvVariableVirtual

EvApplication > EvFileCollection > EvFile > EvVariablesCollection > EvVariableBase As EvVariableVirtual

 

View the COM map and the COM summary.

The EvVariableVirtual object gives access to information on and actions with a virtual variable in an EV file. You can also use the EvVariableBase object to gain access to further information on and actions for the variable.

The EvFile.Variables[] property lists all the variables in an EV file and is an EvVariablesCollection.

The EvFileset.Variables[] property that lists all variables in a fileset in an EV file and is an EvVariablesCollection.

EvVariableVirtual classes:

Properties

EvVariableVirtual methods and properties:

AddVariable
AsVariableBase
AsVariableAcoustic
AsVariableVirtual
ClassifyBottom
ClassifyRegion
Create3DFishTracks
Create3DSingleTargets
CreateCurtain
CreateLineRelativeRegion
DataType
DetectFishTracks
DetectSchools
DetectSurface
DetectSurfaceFromLine
ExportComplexData
ExportComplexDataForRegion
ExportData
ExportDataForRegion
ExportEchogramToImage
ExportEVD
ExportEVDRange
ExportFishTracksByCells
ExportFishTracksByCellsAll
ExportFishTracksByRegions
ExportFishTracksByRegionsAll
ExportFrequencyDistributionByCells
ExportFrequencyDistributionByCellsAll
ExportFrequencyDistributionByRegions
ExportFrequencyDistributionByRegionsAll
ExportFrequencyDistributionByRegionsByCells
ExportFrequencyDistributionByRegionsByCellsAll
ExportFrequencyDistributionBySingleRegion
ExportGeoreferencedSamples
ExportGeoreferencedSamplesByRegions
ExportGeoreferencedSamplesForRegion
ExportHAC
ExportICESCSVByCells
ExportICESCSVRegionClassesByCells
ExportICESCSVByRegionClassesByCellsAll
ExportIntegrationByCells
ExportIntegrationByCellsAll
ExportIntegrationByRegions
ExportIntegrationByRegionsAll
ExportIntegrationByRegionsByCells
ExportIntegrationByRegionsByCellsAll
ExportIntegrationBySingleRegionByCells
ExportLine
ExportQPSSD
ExportRegionsLog
ExportRegionsLogAll
ExportSettings
ExportSingleTargetsByCells
ExportSingleTargetsByCellsAll
ExportSingleTargetsByRegions
ExportSingleTargetsByRegionsAll
ExportSingleTargetsByRegionsByCells
ExportSingleTargetsByRegionsByCellsAll
ExportSingleTargetWidebandFrequencyResponse
ExportSingleTargetWidebandFrequencyResponseByRegions
ExportSingleTargetWidebandFrequencyResponseByRegionsAll
ExportSingleTargetWidebandFrequencyResponseForRegion
ExportTrackToImage
ExportUnderlyingData
ExportVegetation
FullName
GoToPing
GoToPingRange
GoToRegion
GetOperand
MaxStopRange

MeasurementCount
MinStartRange
Name
Operator
OperatorName
PickLine
PingMode
PositionVariable
Properties
SetFullName
ShortName
SetOperand
Useable
VariableType

EvVariableVirtual implements the following methods and properties:

 

Description

GetOperand

GetOperand(int Index)

Summary

Get the virtual variable's operand at operand-number Index n. The operand returned is an EvVariableBase object.

Parameters
  • Index
  • Index is an integer that corresponds to the operand-number of an operand in the operator. The number of operands required by an operator is a function of the nature of the operator. Operands are accessed one at a time and begin with an Index of 1.
Return

EvVariableBase

Operator

(read-only) EOperator Operator

Summary

Get the EOperator enum to identify the operator for the virtual variable.

Refer to EOperator for a list of the numbers and the associated operator.

See also: Enum issue under VBS.

Example

Refer to AddVariable snippet.

OperatorName

(read-only) string OperatorName

Summary

Get the name of the operator that this variable is created from.

SetFullName

boolean SetFullName(string Name)

Summary

Change the name of the virtual variable.

Parameters
  • Name
  • New name of the virtual variable, provided as a string of characters.
Return

True, when successful.

Example
Dim vEchoviewCom: Set vEchoviewCom = GetObject(, "EchoviewCom.EvApplication")
Dim vEvFile: Set vEvFile = vEchoviewCom.OpenFile("C:\temp\YourEvFile.EV")
Dim vVariableCollection: Set vVariablecollection=vEvFile.Variables
Dim vVirtualVariable: Set vVirtualVariable=vVariableCollection.FindByName("Copy 1")

MsgBox  "The variable name is  " + vVirtualVariable.Name

vVirtualVariable.SetFullName("Sv pings copy")

MsgBox  "The variable name is now " + vVirtualVariable.Name

Snippet: change the name of an acoustic variable.

...
Dim vVariableCollection: Set vVariablecollection=vEvFile.Variables
Dim vVariable: Set vVariable=vVariableCollection.FindByName("Sv pings")

MsgBox  "The variable name is  " + vVariable.Name

vVariable.SetFullName("Fred")

MsgBox  "The variable name is now " + vVariable.Name
SetOperand

SetOperand(int Index, Variable)

Summary

Set the virtual variable's operand.

Parameters
  • Index
  • Index is an integer that corresponds to the operand-number of an operand in the operator. The number of operands required by an operator is a function of the nature of the operator. Operands are accessed one at a time and begin with an Index of 1.
  • Variable
  • The acoustic variable or virtual variable as specified by EvVariableBase to be used as the operand at Index n.
Return

True, if successful.

Example

Refer to AddVariable snippet.

See also

Scripting with COM objects
COM object hierarchy
EvVariableBase
EvVariablesCollection