COM object EvPlatform

EvApplication > EvFileCollection > EvFile > EvPlatformsCollection > EvPlatform

 

View the COM map and the COM summary.

The EVPlatform object gives you the ability access to information about a platform in an EV file.

The EvFile.Platforms[] property lists all the platforms in an EV file and is an EvPlatformsCollection.

EvPlatform classes:

HeaveSource

EvPlatform methods and properties:

Name
PlatformType
PositionSource
WaterLevel

 

Description

HeaveSource

EvLine HeaveSource

Summary

Get or specify Heave source on the Position page of the Platform Properties dialog box.

Parameters

The heave source is an EvLine.

Return

Whether successful.

Example

See also: Enum issue under VBS.

Dim vEvCom: Set vEvCom = GetObject(, "EchoviewCom.EvApplication")
Dim vEvFile: Set vEvFile = vEvCom.OpenFile("C:\Your.EV")
 
Dim vPlatform: Set vPlatform = vEvFile.Platforms.Item(0)
MsgBox "'" + vPlatform.Name + "' position source '" + vPlatform.PositionSource.Name + "'"
 
vPlatform.PositionSource = vEvFile.Variables.FindByName("Fileset1: position GPS fixes GPGGA")
vPlatform.Name = "Boat"
MsgBox "'" + vPlatform.Name + "' position source '" + vPlatform.PositionSource.Name + "'"
  
' 0 for ePlatformPositionDeterminedByGPS, 1 for ePlatformPositionFixed
vPlatform.PlatformType = 1
MsgBox "'" + vPlatform.Name + "' type '" + CStr(vPlatform.PlatformType) + "'"
  
vPlatform.WaterLevel = -100
MsgBox "'" + vPlatform.Name + "' water level '" + CStr(vPlatform.WaterLevel) + "'"
  
vPlatform.HeaveSource = vEvFile.Lines.FindByName("Fileset1: HeaveLine")
If vPlatform.HeaveSource Is Nothing Then
MsgBox "'" + vPlatform.Name + "' has no heave source"
Else
MsgBox "'" + vPlatform.Name + "' heave source '" + vPlatform.HeaveSource.Name + "'"
End If

Name

string Name

Summary

Get or specify the name of the platform on the General page of the Platform Properties dialog box.

Parameters
  • Platform name
Return

Whether successful.

Example

Refer to Platform example.

PlatformType

ePlatformPositionType PlatformType

Summary

Get or specify Platform type on the Position page of the Platform Properties dialog box.

Parameters

The platform type is specified using ePlatformPositionType.

Return

Whether successful.

Example

Refer to Platform example

PositionSource

EvVariableBase PositionSource

Summary

Get or specify the Position source on the Position page of the Platform Properties dialog box.

Parameters

The Position source is specified using EvVariableBase.

Return

Whether successful.

Example

Refer to Platform example

WaterLevel

double WaterLevel

Summary

Get or specify the value for the Z coordinate of the water level on the Position page of the Platform Properties dialog box.

Parameters

The water level is a real number in meters.

Return

Whether successful.

Example

Refer to Platform example.

See also

Scripting with COM objects
COM object hierarchy
EvPlatformsCollection