COM object EvTransducer

EvApplication > EvFileCollection > EvFile > EvTransducersCollection > EvTransducer

View the COM map and the COM summary.

Description

Alongship

(read-only) double Alongship

Summary

Get the value for the Alongship angle (degrees) on the Geometry page of the Transducer Properties dialog box. Alongship angle and Athwartship angle specify the pointing direction of the transducer beam. Beam rotation describes the rotation of transducer face. Together these descriptors specify the orientation of the transducer.

See also SetAlongAndAthwartship and its note.

Example

EvTransducer snippet

AlongshipOffset

double AlongshipOffset

Summary

Get or set the AlongshipOffset is the X - alongship offset for the location of the transducer relative a reference point on the Geometry page of the Transducer Properties dialog box.

Example

EvTransducer snippet

Athwartship

(read-only) double Athwartship

Summary

Get the value for the Athwartship angle (degrees) on the Geometry page of the Transducer Properties dialog box. Alongship angle and Athwartship angle specify the pointing direction of the transducer beam. Beam rotation describes the rotation of transducer face. Together these descriptors specify the orientation of the transducer.

See also SetAlongAndAthwartship and its note.

Example

EvTransducer snippet

AthwartshipOffset

double AthwartshipOffset

Summary

Get or set the AthwartshipOffset is the Y - athwartship offset for the location of the transducer relative a reference point on the Geometry page of the Transducer Properties dialog box.

Example

EvTransducer snippet

Azimuth

double Azimuth

Summary

Get or set the Azimuth (degrees) setting on the Geometry page of the Transducer Properties dialog box. Elevation and Azimuth specify the pointing direction of the transducer beam. Beam rotation describes the rotation of transducer face. Together these descriptors specify the orientation of the transducer.

See also SetAlongAndAthwartship note.

Example

EvTransducer snippet

BeamRotation

double BeamRotation

Summary

Get or Set the Beam rotation (degrees) setting, the rotation of the transducer face, on the Geometry page of the Transducer Properties dialog box.

Example

EvTransducer snippet

Elevation

double Elevation

Summary

Get or set the Elevation (degrees) setting on the Geometry page of the Transducer Properties dialog box. Elevation and Azimuth specify the pointing direction of the transducer beam. Beam rotation describes the rotation of transducer face. Together these descriptors specify the orientation of the transducer.

See also SetAlongAndAthwartship note.

Example

EvTransducer snippet

Name

(read-write) string Name

Summary

Get or set the Name of the transducer on the General page of the Transducer Properties dialog box.

Example

EvTransducer snippet

Notes

(read-write) string Notes

Summary

Get or set the Notes of the transducer on the General page of the Transducer Properties dialog box.

Example

EvTransducer snippet

SetAlongAndAthwartship

boolean SetAlongAndAthwartship(double Alongship, double Athwartship )

Summary

Set Alongship angle and Athwartship angle on the Geometry page of the Transducer Properties dialog box.

To determine the direction of the transducer beam use EvTransducer.Alongship and EvTransducer.Athwartship.

Note: SetAlongAndAthwartship can change the values for Alongship angle and Athwartship angle. Such changes are reflected in corresponding changes to Elevation and Azimuth values. Echoview calculations use Elevation and Azimuth. As a result Alongship and Athwartship angles are converted (internally) to Elevation and Azimuth values. It is a known issue that some combinations of Alongship angle and Athwartship angle result in an inconsistent or physically impossible transducer orientations. Such inconsistent values are ignored and onscreen they are displayed in red on the Orientation page of the Transducer Properties dialog box.

Parameters

• Alongship
• Alongship angle in degrees.
• Athwartship
• Athwartship angle in degrees

Return

True, if successful.

False, when combinations of Alongship angle and Athwartship angle result in an inconsistent or physically impossible transducer orientations. See Note.

Example

Dim vEchoviewCom: Set vEchoviewCom = GetObject(, "EchoviewCom.EvApplication")
Dim vEvFile: Set vEvFile = vEchoviewCom.EvFiles.Item(0)
Dim oTrans: Set oTrans = vEvFile.Transducers(0)
oTrans.Name = "Transducer"
oTrans.Notes = "Notes go here"
oTrans.AlongshipOffset = 1
oTrans.AthwartshipOffset = 1.4
oTrans.VerticalOffset = 0.5
oTrans.Elevation = 10
oTrans.Azimuth = 270
oTrans.SetAlongAndAthwartship 0, -10
oTrans.BeamRotation = 20

VerticalOffset

double VerticalOffset

Summary

Get or set the VerticalOffset is the Z - vertical offset for the location of the transducer relative a reference point on the Geometry page of the Transducer Properties dialog box.

Example

EvTransducer snippet