Specialization of Protocol_PRO4_InterfaceAdapter for the KCF smart tether
This implementations allows us to intercept quiers to the ROV and emulate them at the
surface. This saves a bit of comms bandwidth, and allows us to inject our depth sensor
etc.
Declaration Syntax| C# | Visual Basic | Visual C++ |
[SerializableAttribute] public class InterfaceAdapter_KCF_SmartTether : Protocol_PRO4_InterfaceAdapter
<SerializableAttribute> _ Public Class InterfaceAdapter_KCF_SmartTether _ Inherits Protocol_PRO4_InterfaceAdapter
[SerializableAttribute] public ref class InterfaceAdapter_KCF_SmartTether : public Protocol_PRO4_InterfaceAdapter
Members| All Members | Constructors | Methods | Properties | ||
| Icon | Member | Description |
|---|---|---|
 | InterfaceAdapter_KCF_SmartTether()()() | Initializes a new instance of the InterfaceAdapter_KCF_SmartTether class |
 | BaudRate |
BaudRate to use to communicate with external application
Usually does not matter if using a virtual serial port
(Inherited from Protocol_PRO4_InterfaceAdapter.) |
| Close()()() |
Close the communication port
(Inherited from Protocol_PRO4_InterfaceAdapter.) |
| CommsTimeout |
Duration in mS to wait for response from device
(Inherited from Protocol_PRO4_InterfaceAdapter.) |
| ConsecutiveMissedResponseCount |
Number of missed replys.
This value is set by the CommsManager
(Inherited from Protocol_PRO4_InterfaceAdapter.) |
| CountPacketsToSend |
Gets the number of packets to be sent.
(Inherited from Protocol_PRO4_InterfaceAdapter.) |
| DeviceName |
A device name so the user can identify the device in the UI
(Overrides Protocol_PRO4_InterfaceAdapter.DeviceName.) |
| DeviceType |
Get the Device Type
(Inherited from Protocol_PRO4_InterfaceAdapter.) |
| Equals(Object) | (Inherited from Object.) |
| ExpectedResponseLength |
Gets or sets the expected length of the response.
This is used to know when a transmission is complete FROM a device on the tether bus which does NOT
implement the PRO4 protocol. It is currently used for the KCF smart tether
(Overrides Protocol_PRO4_InterfaceAdapter.ExpectedResponseLength.) |
| GetHashCode()()() |
Serves as a hash function for a particular type.
(Inherited from Object.) |
| GetType()()() |
Gets the Type of the current instance.
(Inherited from Object.) |
| HandleResponse_CSR(UInt32, array<Byte>[]()[]) |
Handler for standard CSR read responses
(Inherited from Protocol_PRO4_InterfaceAdapter.) |
| HandleResponse_DeviceSpecific(Int32, array<Byte>[]()[]) |
Handler for device specific responses
(Inherited from Protocol_PRO4_InterfaceAdapter.) |
| HostInitiatedComms |
Flag to indicate if all comms to the device are host initiated
Examples would be standard VR devices, KCF nodes, etc.
If this flag is false than the
(Overrides Protocol_PRO4_InterfaceAdapter.HostInitiatedComms.) |
| ImmediateOutput |
Flag to indicated that output from device should be sent immediately to the
communication port. If false data is que'd in an output que which can be accessed via
the Read functions.
Default is true;
(Inherited from Protocol_PRO4_InterfaceAdapter.) |
| MaxLength_input |
Gets or sets the max size for the input que.
(Inherited from Protocol_PRO4_InterfaceAdapter.) |
| MaxLength_output |
Gets or sets the max length_output.
(Inherited from Protocol_PRO4_InterfaceAdapter.) |
| MaxRxCount |
Set limit on the maximum size to send to the device
(Inherited from Protocol_PRO4_InterfaceAdapter.) |
| MaxTxCount |
Set limit on the maximum size to send to the device
(Inherited from Protocol_PRO4_InterfaceAdapter.) |
| NetworkID |
Get Network Node ID
(Inherited from Protocol_PRO4_InterfaceAdapter.) |
| NextPacketToSend |
Gets the next packet to send.
(Inherited from Protocol_PRO4_InterfaceAdapter.) |
| Open(String, Int32) |
Opens the specified port to be used as the relay port.
Data to/from this port is muxed onto the tether bus
(Inherited from Protocol_PRO4_InterfaceAdapter.) |
| Open()()() |
Opens the specified port to be used as the relay port.
Data to/from this port is muxed onto the tether bus
(Inherited from Protocol_PRO4_InterfaceAdapter.) |
| Port_ReceivedData(Object, CommPort..::.DataReceivedArgs) |
Standard handler for data reception from the tether bus.
The base behavior is to add the data to the output que for transmission on attached port
(Overrides Protocol_PRO4_InterfaceAdapter.Port_ReceivedData(Object, CommPort..::.DataReceivedArgs).) |
| PortName |
Comm port to use to communicate with external application
Typically this will be a virtual serial port, but could be a real one
(Inherited from Protocol_PRO4_InterfaceAdapter.) |
| Read |
Return any bytes available from the device
(Inherited from Protocol_PRO4_InterfaceAdapter.) |
| ROV |
The attached ROV.
This is used for the depth and yaw information of the final node in the SmartTether
|
| Rx(array<Byte>[]()[]) |
Called by the handler of the PRO4 protocol communications port when
data has been recieved.
This data is either que'd or immeditatly sent to the port depending upon the
ImmediateOutput flag
(Inherited from Protocol_PRO4_InterfaceAdapter.) |
| RxCount |
Get the number of bytes in the recieve buffer
This is used for polled operation
(Inherited from Protocol_PRO4_InterfaceAdapter.) |
| ToString()()() | (Inherited from Object.) |
| Tx()()() |
Get an encapulated packet with bytes to be sent to the device
(Inherited from Protocol_PRO4_InterfaceAdapter.) |
| UsesRawComms |
Flag to indicate device uses RAW data stream and not true PRO4 protocol
Most devices should set this to FALSE
(Overrides Protocol_PRO4_InterfaceAdapter.UsesRawComms.) |
| Write(array<Byte>[]()[]) |
Que data to be sent out the muliplexed PRO4 protocol channel
(Inherited from Protocol_PRO4_InterfaceAdapter.) |
| Write(Byte) |
Que's a single byte to be sent out the muliplexed PRO4 protocol channel
(Inherited from Protocol_PRO4_InterfaceAdapter.) |
Inheritance Hierarchy| Object | ||
 | Protocol_PRO4_InterfaceAdapter | |
| InterfaceAdapter_KCF_SmartTether | |