FollowReference class abstract
Follow Reference Maneuver class
This maneuver follows a reference given by an external entity.
- Inheritance
-
- Object
- Message
- ImcMessage
- Maneuver
- FollowReference
- Implemented types
Constructors
- FollowReference([void updates(FollowReferenceBuilder b)?])
-
factory
Properties
- abbrev → String
-
no setteroverride
- altitudeInterval → double
-
Similarly to Loiter Radius, this field is used to define the "z" distance considered to be inside the vacitiny of
the target location. An AUV may, for instance, be floating until it more than z units above the current reference,
in which case it actively changes its position in order to achieve the desired depth / altitude.
no setter
- controlEnt → int
-
The entity identifier of the entity that is allowed to provide references to this maneuver.
If the value ''0xFF'' is used, any entity is allowed to command references.
no setter
- controlSrc → int
-
The IMC identifier of the source system that is allowed to provide references to this maneuver.
If the value ''0xFFFF'' is used, any system is allowed to command references.
no setter
- dst → int
-
no setterinherited
- dstEnt → int
-
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- loiterRadius → double
-
Whenever an intended reference is achieved, this maneuver will maintain the vehicle in vaticiny of that
location. The loiter radius is used to define the radius of this (xy) area.
no setter
- msgId → int
-
no setteroverride
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- src → int
-
no setterinherited
- srcEnt → int
-
no setterinherited
- sync → int
-
no setterinherited
- timeout → double
-
The ammount of time, in seconds, after which the maneuver will be terminated if no reference has
been received. In other words, the controlling entity should send reference updates in shorter periods than
'timeout'.
no setter
- timestamp → DateTime?
-
no setterinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
rebuild(
dynamic updates(FollowReferenceBuilder)) → FollowReference -
Rebuilds the instance.
inherited
-
toBuilder(
) → FollowReferenceBuilder -
Converts the instance to a builder
B.inherited -
toJson(
[bool includeHeader = true]) → Map< String, dynamic> -
To JSON object
override
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited