• Marus Documentation
Show / Hide Table of Contents
  • Marus
    • BoatPhysics
    • BoatPhysicsMath
    • DebugPhysics
    • ModifyBoatMesh
    • SlammingForceData
    • TriangleData
  • Marus.Actuators
    • AUVRosController
    • PwmThruster
    • PwmThruster.AllowedVoltages
    • ThrusterController
  • Marus.Actuators.Datasheets
    • T200ThrusterDatasheet
  • Marus.Communications
    • RangeReading
  • Marus.Communications.Acoustics
    • AcousticDevice
    • AcousticDevice<T>
    • AcousticMedium
    • AcousticMediumHelper
    • AcousticMessage
    • AcousticReceiver
    • AcousticTranciever
    • AcousticTransmiter
    • AcousticTransmiterParams
    • MediumBase
    • Nanomodem
    • NanomodemMessage
    • NanomodemROS
    • TransmitionType
  • Marus.Communications.Rf
    • LoraDevice
    • LoraDeviceRos
    • LoraDummyTransmitter
    • LoraMessage
    • LoraRanging
    • LoraRangingRos
    • RfDevice
    • RfDevice<T>
    • RfMediumHelper
    • RfMessage
    • RfReceiver
    • RfTranciever
    • RfTransmiter
    • RfTransmitterParams
    • TransmitionType
  • Marus.Controllers
    • DiverGuidanceController
    • FishController
    • VesselForceController
    • VesselVelocityController
  • Marus.Core
    • GeographicFrame
    • GeoPoint
    • PauseMenu
    • TfExtensions
    • TimeHandler
  • Marus.CustomInspector
    • ConditionalHideAttribute
    • ConditionalHideInInspectorAttribute
    • HideInRuntimeInspectorAttribute
  • Marus.Logger
    • DataLogger
    • DataLoggerUtilities
    • GameObjectLogger
    • GameObjectLogger<T>
    • LogRecord
    • LogRecord<T>
  • Marus.Networking
    • MessageExtensions
    • ParamServerHandler
    • RosConnection
    • ServerStreamer<T>
    • ServerStreamer<T>.MessageHandleMode
    • ServiceCaller
    • TfHandler
    • VisualizationROS
  • Marus.NoiseDistributions
    • AlfaBeta
    • Gaussian
    • INoise
    • Noise
    • NoiseParameters
  • Marus.ObjectAnnotation
    • CameraObjectDetectionSaver
    • ClassObjects
    • ObjectRecord
    • PointCloudSegmentationSaver
  • Marus.Ocean
    • WaterHeightSampler
  • Marus.Quest
    • QuestControl
    • QuestWaypoint
  • Marus.ROS
    • TfStreamerROS
  • Marus.Sensors
    • CameraSensor
    • CameraSensorROS
    • LidarConfig
    • LidarReading
    • RaycastJobHelper
    • RaycastJobHelper<T>
    • RaycastJobHelper<T>.CreateRaycastCommandsJob
    • RaycastJobHelper<T>.ReadbackDataJob
    • RaycastLidar
    • RaycastLidarPointCloud2ROS
    • RaycastLidarROS
    • RayDefinitionType
    • RayInterval
    • SensorBase
    • SensorCallback
    • SensorSampler
    • SensorStreamer<TClient, TMsg>
    • Sonar2D
    • Sonar3D
    • SonarReading
  • Marus.Sensors.AIS
    • AISClassType
    • AisDevice
    • AisManager
    • AisMessage
    • AISMessageType
    • AisSensor
    • AisSensorROS
    • ManeuverIndicator
    • MMSIGenerator
    • NavigationStatus
    • PositionAccuracy
    • PositionReportClassA
    • Raim
    • TimeIntervals
  • Marus.Sensors.Core
    • CameraFrustum
    • ComputeBufferDataExtractor<T>
    • DepthCameras
    • DepthCameras.BufferPrecision
    • LidarMessage
    • PointField
    • SphericalProjectionFilter
  • Marus.Sensors.Primitive
    • DepthSensor
    • DvlSensor
    • GnssSensor
    • ImuROS
    • ImuSensor
    • PoseSensor
    • PoseSensorROS
    • RangeSensor
    • Sonar2DROS
    • Sonar3DROS
    • SonarPrimitive
    • SonarPrimitiveROS
  • Marus.Sensors.ROS
    • DepthSensorROS
    • DvlROS
    • GnssROS
  • Marus.StatisticsUI
    • MousePointToImagePointController
    • PathRecordingsVisualization
    • ScrollViewController
    • StatisticsEntry
    • StatisticsUIController
  • Marus.UI
    • Compass
    • Depth
  • Marus.Utils
    • Helpers
    • PCDLoader
    • PCDSaver
    • PointCloud
    • Singleton<T>
  • Marus.Visualization
    • ArrowVisualController
    • LineVisualController
    • LiveMovementVisualizer
    • ObjectBoundingBoxVisualizer
    • PathRecorder
    • PathVisualController
    • PointCloudManager
    • PointCloudRosVisualizer
    • PointVisualController
    • TransformVisualController
    • Visualizer
    • Visualizer.FilterValues
  • Marus.Visualization.Primitives
    • Arrow
    • Line
    • Path
    • Point
    • PointcloudMesh
    • Transform
    • VisualElement
  • TestUtils
    • ParameterServerMock
    • PingMock
    • TestClient
    • TfMock
    • Utils
  • UniColliderInterpolator
    • BoundsDivider
    • ColliderInterpolator
  • UnityStandardAssets.Characters.ThirdPerson
    • ThirdPersonSwimmer
    • ThirdPersonSwimmerController

Class RfMediumHelper

Static class with methods that are usefull for RF communication

Inheritance
System.Object
RfMediumHelper
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Marus.Communications.Rf
Assembly: cs.temp.dll.dll
Syntax
public static class RfMediumHelper

Methods

Broadcast<T>(T)

Sends message to every registered rf device.

Declaration
public static void Broadcast<T>(T msg)
    where T : RfMessage
Parameters
Type Name Description
T msg
Type Parameters
Name Description
T

GetAllRfDevices()

Declaration
public static RfDevice[] GetAllRfDevices()
Returns
Type Description
RfDevice[]

GetRfDeviceById(Int32)

Declaration
public static RfDevice GetRfDeviceById(int id)
Parameters
Type Name Description
System.Int32 id
Returns
Type Description
RfDevice

GetRfDeviceById<T>(Int32)

Declaration
public static T GetRfDeviceById<T>(int id)
    where T : RfDevice
Parameters
Type Name Description
System.Int32 id
Returns
Type Description
T
Type Parameters
Name Description
T

GetRfDevicesOnProtocol(String)

Declaration
public static RfDevice[] GetRfDevicesOnProtocol(string protocol)
Parameters
Type Name Description
System.String protocol
Returns
Type Description
RfDevice[]

Range(RfDevice, RfDevice)

Emulates time needed for message to arrive and sends it to other nanomodem.

AcousticDevice does not have to have the same message as generic. If it knows how to decode the protocoll, it will receive the message

Declaration
public static float Range(RfDevice source, RfDevice target)
Parameters
Type Name Description
RfDevice source
RfDevice target
Returns
Type Description
System.Single

Transmit<T>(T, RfReceiver)

RfDevice does not have to have the same message as generic. If it knows how to decode the protocoll, it will receive the message

Declaration
public static bool Transmit<T>(T message, RfReceiver receiver)
    where T : RfMessage
Parameters
Type Name Description
T message
RfReceiver receiver
Returns
Type Description
System.Boolean
Type Parameters
Name Description
T
In This Article
Back to top Generated by DocFX