EVAcoVarDataGenerator: Control an Echoview data generator variable using COM...

Description Usage Arguments Value References Examples

View source: R/EVAcoVarConstantEdit.R

Description

This function modifies the data generator settings in an existing Echoview data generator virtual variable.

Usage

1
2
3
4
5
6
7
8
9
EVAcoVarDataGenerator(
  EVFile,
  acoVarName,
  Algorithm = c("Constant", "Tvg", "ConstantTvg"),
  OutputType = c("Sv", "TS", "Other dB", "Linear"),
  constantValue = NULL,
  ApplyTvgOverride = NULL,
  TvgOverride = NULL
)

Arguments

EVFile

An Echoview file COM object

acoVarName

Acoustic variable name

Algorithm

=c("Constant","Tvg","ConstantTvg") Data generator algorithm type

OutputType

=c("Sv","TS","Other dB","Linear") output type

constantValue

= NULL (numerical) constant value for the data generator.

ApplyTvgOverride

= NULL (boolean) Appply TVG override

TvgOverride

= NULL (numerical) TVG override value.

Value

a list object with two elements. $success: ping subset successfully changed, and $msg: message for processing log.

References

http://support.echoview.com/WebHelp/Echoview.htm/

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
## Not run: 
EVAcoVarDataGenerator(EVFile=EVFile,acoVarName='Data generator 1',
Algorithm='Constant',
OutputType='Linear',
constantValue=0.5,
ApplyTvgOverride=NULL,
TvgOverride=NULL)


## End(Not run)

AustralianAntarcticDivision/EchoviewR documentation built on Dec. 19, 2019, 1:31 a.m.