pt.lsts.neptus.messages

Interface IMessage

All Superinterfaces:

java.lang.Cloneable

All Known Implementing Classes:

Abort, Aborted, Acceleration, AcousticMessage, AcousticOperation, AcousticSystems, AcousticSystemsQuery, AlignmentState, AllocatedControlTorques, AngularVelocity, Announce, AnnounceService, AutopilotMode, BeamConfig, Brake, ButtonEvent, CacheControl, Calibration, CameraZoom, CcuEvent, ClockControl, CloseSession, Collision, CommsRelay, CompassCalibration, CompressedImage, Conductivity, ControlCommand, ControlLoops, ControlParcel, CoverArea, CpuUsage, CreateSession, CrudeOil, Current, CustomManeuver, DataSanity, Depth, DepthOffset, DesiredControl, DesiredHeading, DesiredHeadingRate, DesiredPath, DesiredPitch, DesiredRoll, DesiredSpeed, DesiredVelocity, DesiredVerticalRate, DesiredZ, DevCalibrationControl, DevCalibrationState, DevDataBinary, DevDataText, DeviceState, Dislodge, Distance, DvlRejection, DynamicsSimParam, Elevator, EmergencyControl, EmergencyControlState, EntityActivationState, EntityInfo, EntityList, EntityMonitoringState, EntityParameter, EntityParameters, EntityState, EstimatedState, EstimatedStreamVelocity, EulerAngles, EulerAnglesDelta, Event, FineOil, FollowPath, FollowReference, FollowRefState, FollowSystem, FollowTrajectory, Formation, FormationControlParams, FormationEval, FormationEvaluation, FormationMonitor, FormationParameters, FormationPlanExecution, FormationState, FormCtrlParam, FormState, FuelLevel, GetOperationalLimits, GetParametersXml, Goto, GpsFix, GpsFixRejection, GpsNavData, GroundVelocity, GroupMembershipState, GroupStreamVelocity, Header, Heartbeat, IdleManeuver, ImageTxSettings, IMCMessage, IndicatedSpeed, IoEvent, IridiumMsgRx, IridiumMsgTx, IridiumTxStatus, LblBeacon, LblConfig, LblEstimate, LblRange, LblRangeAcceptance, LcdControl, LeaderState, LeakSimulation, LedBrightness, LinkLevel, LogBookControl, LogBookEntry, LoggingControl, Loiter, LowLevelControl, MagneticField, Maneuver, ManeuverControlState, Map, MapFeature, MapPoint, MessagePart, MonitorEntityState, MsgList, NavigationData, NavigationUncertainty, NeptusBlob, OperationalLimits, ParametersXml, PathControlState, PathPoint, PlanControl, PlanControlState, PlanDB, PlanDBInformation, PlanDBState, PlanGeneration, PlanManeuver, PlanSpecification, PlanStatistics, PlanTransition, PlanVariable, PolygonVertex, PopEntityParameters, PopUp, PowerChannelControl, PowerChannelState, PowerOperation, Pressure, Pulse, PulseDetectionControl, PushEntityParameters, PWM, QueryEntityActivationState, QueryEntityInfo, QueryEntityParameters, QueryEntityState, QueryLedBrightness, QueryPowerChannelState, Reference, RegisterManeuver, RelativeHumidity, RelativeState, RemoteActions, RemoteActionsRequest, RemoteSensorInfo, RemoteState, ReplayControl, ReportedState, RestartSystem, RhodamineDye, Rows, Rpm, RSSI, Salinity, SaveEntityParameters, ServoPosition, SessionKeepAlive, SessionStatus, SessionSubscription, SetControlSurfaceDeflection, SetEntityParameters, SetLedBrightness, SetPWM, SetServoPosition, SetThrusterActuation, SimulatedState, Sms, SmsRx, SmsState, SmsTx, SonarData, SoundSpeed, StationKeeping, StopManeuver, StorageUsage, SystemGroup, Target, Teleoperation, TeleoperationDone, Temperature, TextMessage, TrajectoryPoint, TransportBindings, TrexAttribute, TrexCommand, TrexObservation, TrexOperation, TrexPlan, TrexToken, TrueSpeed, Turbidity, UamRxFrame, UamRxRange, UamTxFrame, UamTxStatus, UASimulation, UsblAngles, UsblFix, UsblPosition, VehicleCommand, VehicleFormation, VehicleFormationParticipant, VehicleLinks, VehicleMedium, VehicleOperationalLimits, VehicleState, VelocityDelta, Voltage, VSWR, WaterDensity, WaterVelocity, WindSpeed, YoYo

public interface IMessage
extends java.lang.Cloneable

Method Summary

Modifier and Type	Method and Description
<M extends IMessage> M	cloneMessage()
java.lang.String	getAbbrev()
java.lang.Number	getAsNumber(java.lang.String fieldName) Retrieve the value of the field as a Number
java.lang.String	getAsString(java.lang.String fieldName) Retrieve the value of a field as a String
java.lang.String[]	getFieldNames()
java.lang.Object	getHeaderValue(java.lang.String field)
java.lang.String	getLongFieldName(java.lang.String fieldName) Retrieve the long name (human readable) of a given field
java.lang.String	getLongName()
int	getMgid()
IMessageProtocol<? extends IMessage>	getProtocolFactory()
java.lang.String	getTypeOf(java.lang.String fieldName) Retrieve the field type of the given field
java.lang.String	getUnitsOf(java.lang.String fieldName) Retrieves the units of the given field
java.lang.Object	getValue(java.lang.String fieldName) Retrieve the value of a field as an Object
boolean	hasFlag(java.lang.String flagName) Verify if the message has the given flag set
IMessage	setValue(java.lang.String fieldName, java.lang.Object value) Sets the value of a field to the given Object
void	validate() Verifies if the message is valid by generating exceptions when the message is not valid

Method Detail

getMgid

int getMgid()

Returns:

the message serial ID

getAbbrev

java.lang.String getAbbrev()

Returns:

the message abbreviated name

getLongName

java.lang.String getLongName()

Returns:

the message human readable name

getFieldNames

java.lang.String[] getFieldNames()

Returns:

the list of field names

validate

void validate()
       throws InvalidMessageException

Verifies if the message is valid by generating exceptions when the message is not valid

Throws:

InvalidMessageException

getValue

java.lang.Object getValue(java.lang.String fieldName)

Retrieve the value of a field as an Object

Parameters:

fieldName - The name of the field to consult

Returns:

The value of the given field or null if the field does not exist or an error occurred

getAsString

java.lang.String getAsString(java.lang.String fieldName)

Retrieve the value of a field as a String

Parameters:

fieldName - The name of the field to consult

Returns:

The value of the field as a String or null in case of an error

getAsNumber

java.lang.Number getAsNumber(java.lang.String fieldName)

Retrieve the value of the field as a Number

Parameters:

fieldName - The name of the field to consult

Returns:

The numeric value of the field of null in case the field is not numeric / does not exist

getTypeOf

java.lang.String getTypeOf(java.lang.String fieldName)

Retrieve the field type of the given field

Returns:

The field type of given field like "uint8_t" or "plaintext"

getUnitsOf

java.lang.String getUnitsOf(java.lang.String fieldName)

Retrieves the units of the given field

Returns:

The units of the field or an empty String in case no units are defined

hasFlag

boolean hasFlag(java.lang.String flagName)

Verify if the message has the given flag set

Returns:

true if the flag is set or false otherwise

getLongFieldName

java.lang.String getLongFieldName(java.lang.String fieldName)

Retrieve the long name (human readable) of a given field

Parameters:

fieldName - The field's (abbreviated) name

Returns:

the long name (human readable) of a given field

setValue

IMessage setValue(java.lang.String fieldName,
                  java.lang.Object value)
           throws InvalidFieldException

Sets the value of a field to the given Object

Parameters:

fieldName - The name of the field to be changed

value - The new value to be given to the field

Returns:

TODO

Throws:

InvalidFieldException - in case this field does not exist in the message

getProtocolFactory

IMessageProtocol<? extends IMessage> getProtocolFactory()

cloneMessage

<M extends IMessage> M cloneMessage()

Returns:

a copy of this message

getHeaderValue

java.lang.Object getHeaderValue(java.lang.String field)