EVShiftRegionTime: Change the time of an Echoview Region

EVShiftRegionTimeR Documentation

Change the time of an Echoview Region

Description

This function shifts the time of an echoview region using COM scripting

Usage

EVShiftRegionTime(
  EVFile,
  regionName,
  days = 0,
  hours = 0,
  minutes = 0,
  seconds = 0,
  milliseconds = 0
)

Arguments

EVFile

An Echoview file COM object

regionName

a string containing the name of the Echoview region

days

an integer value specifying days to add (positive) or subtract (negative). Default = 0

hours

an integer value specifying hours to add (positive) or subtract (negative). Default = 0

minutes

an integer value specifying minutes to add (positive) or subtract (negative). Default = 0

seconds

an integer value specifying seconds to add (positive) or subtract (negative). Default = 0

milliseconds

an integer value specifying milliseconds to add (positive) or subtract (negative). Default = 0

Value

a list object with one element, $msg: message for processing log.

References

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

See Also

EVOpenFile

Examples

## Not run: 
EVAppObj <- COMCreate('EchoviewCom.EvApplication')
EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile

#Shift the region time by 10 seconds
EVShiftRegionTime(EVFile, "testregion", seconds = 10)

#Subtract 1 hour from the region time
EVShiftRegionTime(EVFile, "testregion", hours = -1)

## End(Not run)

AustralianAntarcticDivision/EchoviewR documentation built on May 14, 2024, 10:32 a.m.