ArmCommand class
- Inheritance
-
- Object
- GeneratedMessage
- ArmCommand
- Available extensions
Constructors
- ArmCommand({bool? stop, bool? calibrate, MotorCommand? swivel, MotorCommand? shoulder, MotorCommand? elbow, MotorCommand? gripperLift, double? ikX, double? ikY, double? ikZ, bool? jab, Version? version})
-
factory
-
ArmCommand.fromBuffer(List<
int> i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY]) -
factory
- ArmCommand.fromJson(String i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
-
factory
Properties
- calibrate ↔ bool
-
getter/setter pair
- elbow ↔ MotorCommand
-
getter/setter pair
- eventPlugin → EventPlugin?
-
Subclasses can override this getter to be notified of changes
to protobuf fields.
no setterinherited
- gripperLift ↔ MotorCommand
-
Needed for IK: If the wrist-lift moves, we need to re-calculate IK to keep the end-effector
stationary. See /Arm/src/ik/README.md in the Arm-Firmware repository.
getter/setter pair
- hashCode → int
-
Calculates a hash code based on the contents of the protobuf.
no setterinherited
- ikX ↔ double
-
Can be removed in future versions
getter/setter pair
- ikY ↔ double
-
getter/setter pair
- ikZ ↔ double
-
getter/setter pair
- info_ → BuilderInfo
-
no setteroverride
- isFrozen → bool
-
Returns
trueif this message is marked read-only. Otherwisefalse.no setterinherited - jab ↔ bool
-
Custom actions
getter/setter pair
- messageName → String
-
Available on Message, provided by the MessageUtils extension
The name of the message as declared in the .proto file.no setter - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- shoulder ↔ MotorCommand
-
getter/setter pair
- stop ↔ bool
-
General commands
getter/setter pair
- swivel ↔ MotorCommand
-
Move individual motors
getter/setter pair
- unknownFields → UnknownFieldSet
-
no setterinherited
- version ↔ Version
-
getter/setter pair
Methods
-
addExtension(
Extension extension, Object? value) → void -
Adds an extension field value to a repeated field.
inherited
-
check(
) → void -
inherited
-
clear(
) → void -
Clears all data that was set in this message.
inherited
-
clearCalibrate(
) → void -
clearElbow(
) → void -
clearExtension(
Extension extension) → void -
Clears an extension field and also removes the extension.
inherited
-
clearField(
int tagNumber) → void -
Clears the contents of a given field.
inherited
-
clearGripperLift(
) → void -
clearIkX(
) → void -
clearIkY(
) → void -
clearIkZ(
) → void -
clearJab(
) → void -
clearShoulder(
) → void -
clearStop(
) → void -
clearSwivel(
) → void -
clearVersion(
) → void -
clone(
) → ArmCommand -
Creates a deep copy of the fields in this message.
(The generated code uses mergeFromMessage.)
override
-
copyWith(
void updates(ArmCommand)) → ArmCommand -
Apply
updatesto a copy of this message.override -
createEmptyInstance(
) → ArmCommand -
Creates an empty instance of the same message type as this.
override
-
createMapField<
K, V> (int tagNumber, MapFieldInfo< K, V> fi) → Map<K, V> -
Creates a Map representing a map field.
inherited
-
createRepeatedField<
T> (int tagNumber, FieldInfo< T> fi) → List<T> -
Creates List implementing a mutable repeated field.
inherited
-
deepCopy(
) → T -
Available on T, provided by the GeneratedMessageGenericExtensions extension
Returns a writable deep copy of this message. -
ensureElbow(
) → MotorCommand -
ensureGripperLift(
) → MotorCommand -
ensureShoulder(
) → MotorCommand -
ensureSwivel(
) → MotorCommand -
ensureVersion(
) → Version -
extensionsAreInitialized(
) → bool -
inherited
-
freeze(
) → GeneratedMessage -
Make this message read-only.
inherited
-
getDefaultForField(
int tagNumber) → dynamic -
Returns the default value for the given field.
inherited
-
getExtension(
Extension extension) → dynamic -
Returns the value of
extension.inherited -
getField(
int tagNumber) → dynamic -
Returns the value of the field associated with
tagNumber, or the default value if it is not set.inherited -
getFieldOrNull(
int tagNumber) → dynamic -
Returns the value of a field, ignoring any defaults.
inherited
-
getTagNumber(
String fieldName) → int? -
inherited
-
hasCalibrate(
) → bool -
hasElbow(
) → bool -
hasExtension(
Extension extension) → bool -
Returns
trueif a value ofextensionis present.inherited -
hasField(
int tagNumber) → bool -
Whether this message has a field associated with
tagNumber.inherited -
hasGripperLift(
) → bool -
hasIkX(
) → bool -
hasIkY(
) → bool -
hasIkZ(
) → bool -
hasJab(
) → bool -
hasRequiredFields(
) → bool -
Whether the message has required fields.
inherited
-
hasShoulder(
) → bool -
hasStop(
) → bool -
hasSwivel(
) → bool -
hasVersion(
) → bool -
isInitialized(
) → bool -
Whether all required fields in the message and embedded messages are set.
inherited
-
mergeFromBuffer(
List< int> input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Merges serialized protocol buffer data into this message.
inherited
-
mergeFromCodedBufferReader(
CodedBufferReader input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
inherited
-
mergeFromJson(
String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Merges field values from
data, a JSON object, encoded as described by GeneratedMessage.writeToJson.inherited -
mergeFromJsonMap(
Map< String, dynamic> json, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Merges field values from a JSON object represented as a Dart map.
inherited
-
mergeFromMessage(
GeneratedMessage other) → void -
Merges the contents of the
otherinto this message.inherited -
mergeFromProto3Json(
Object? json, {TypeRegistry typeRegistry = const TypeRegistry.empty(), bool ignoreUnknownFields = false, bool supportNamesWithUnderscores = true, bool permissiveEnums = false}) → void -
Merges field values from
json, a JSON object using proto3 encoding.inherited -
mergeUnknownFields(
UnknownFieldSet unknownFieldSet) → void -
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
rebuild(
void updates(T)) → T -
Available on T, provided by the GeneratedMessageGenericExtensions extension
Applyupdatesto a copy of this message. -
setExtension(
Extension extension, Object value) → void -
Sets the value of a non-repeated extension field to
value.inherited -
setField(
int tagNumber, Object value) → void -
Sets the value of a field by its
tagNumber.inherited -
toBuilder(
) → GeneratedMessage -
Creates a writable, shallow copy of this message.
inherited
-
toDebugString(
) → String -
Returns a String representation of this message.
inherited
-
toProto3Json(
{TypeRegistry typeRegistry = const TypeRegistry.empty()}) → Object? -
Returns an Object representing Proto3 JSON serialization of
this.inherited -
toString(
) → String -
Returns a String representation of this message.
inherited
-
wrap(
[DateTime? timestamp]) → WrappedMessage -
Available on Message, provided by the MessageUtils extension
Returns a WrappedMessage representing this message with a timestamp -
writeToBuffer(
) → Uint8List -
inherited
-
writeToCodedBufferWriter(
CodedBufferWriter output) → void -
inherited
-
writeToJson(
) → String -
Returns a JSON string that encodes this message.
inherited
-
writeToJsonMap(
) → Map< String, dynamic> -
Returns the JSON encoding of this message as a Dart Map.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
create(
) → ArmCommand -
createRepeated(
) → PbList< ArmCommand> -
getDefault(
) → ArmCommand