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

In AustralianAntarcticDivision/EchoviewR: Control of Echoview via COM

Control an Echoview data generator variable using COM scripting.

Description

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

Usage

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

## 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 Aug. 21, 2023, 6:56 p.m.