vrLib SDK Documentation
ROV Class
NamespacesVideoRayROV
Encapsulates an ROV. Specifically a PRO4 ROV.
Declaration Syntax
C#Visual BasicVisual C++
public class ROV : Protocol_PRO4_IDevice
Public Class ROV _
	Implements Protocol_PRO4_IDevice
public ref class ROV : Protocol_PRO4_IDevice
Members
All MembersConstructorsMethodsPropertiesFields



IconMemberDescription
ROV()()()
Initializes a new instance of the ROV class

AccessoryCnt
AccessoryID
adc_raw
autoMode
CommsTimeout
Duration in mS to wait for response from device

ConsecutiveMissedResponseCount
Number of missed replys. This value is set by the CommsManager

Control_HorizontalThrusters(Double, Double)
Control API for the horizontal thrusters.

Control_SwitchCamera(Double)
Control API the switch camera feed.

Control_VerticalThruster(Double)
Control API for the vertical thruster.

controlGains
CountPacketsToSend
Gets the number of packets to be sent. Currently always returns 1 to maximize throughput to the ROV

currentCamera
Gets or sets the current camera feed.

DeviceName
A device name so the user can identify the device in the UI

DeviceType
Get the Device Type

EngineRoomMode
Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
FirmwareVersion
GetHashCode()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetSNMode
GetType()()()
Gets the Type of the current instance.
(Inherited from Object.)
HandleResponse_CSR(UInt32, array<Byte>[]()[])
Handles the response for a CSR Read.

HandleResponse_DeviceSpecific(Int32, array<Byte>[]()[])
Handles the response_ device specific.

HardwareComponentVersion
Return array of Hardware component version strings

HardwareComponentVersionString
String of concatinated component versions. Useful for display

health
INIT_COMMANDS_USED
InitMode
IsConnected
Gets a value indicating whether the ROV is connected.

LastCommContactTime
Lock
Thread syncronization object for ROV class As this is a publically accessible lock, please be VERY!!!! careful to avoid deadlock conditions.

mainCamera
mainLights
navigation
NetworkID
Get Network Node ID

NextPacketToSend
Gets the next packet to send.

ParseHardwareConfigData(array<Byte>[]()[])
Parses the hardware config data.

powerManager
PropagateCSR()()()
Update the subsystem classes based upon the CSR Note we just update everything for now, now worrying about readonly fields etc. It is VITIALLY IMPORTANT that everything is read in the correct order and with the correct sizes!!

SaveParameters
SaveParametersOperationComplete
SaveParametersOperationPending
servo_raw
servo_timebase
SN
The ROV Serial Number

thruster
ToString()()()
Returns a String that represents the current Object.
(Inherited from Object.)
UpdateCSR()()()
Move data from user structures into the csr. These are the inputs being sent to the device

UsesRawComms
Flag to indicate device uses RAW data stream and not true PRO4 protocol Most devices should set this to FALSE

watertemp
Inheritance Hierarchy

Assembly: vrLib (Module: vrLib) Version: 2.0.1.0 (2.0.1.0)