Struct RobotStatus

Robot Status class and exposed properties for Vector’s various states.

Implements

IEquatable<RobotStatus>

Namespace: Anki.Vector

Assembly: Anki.Vector.dll

Syntax

public struct RobotStatus : IEquatable<RobotStatus>

Properties

AreMotorsMoving

True if Vector is currently moving any of his motors (head, arm or wheels/treads).

public bool AreMotorsMoving { get; }

Property Type

Boolean

AreWheelsMoving

True if Vector’s wheels/treads are currently moving.

public bool AreWheelsMoving { get; }

Property Type

Boolean

IsAnimating

True if Vector is currently playing an animation.

public bool IsAnimating { get; }

Property Type

Boolean

IsBeingHeld

True if Vector is being held.

public bool IsBeingHeld { get; }

Property Type

Boolean

IsButtonPressed

True if Vector’s button is pressed.

public bool IsButtonPressed { get; }

Property Type

Boolean

IsCarryingBlock

True if Vector is currently carrying a block.

public bool IsCarryingBlock { get; }

Property Type

Boolean

IsCharging

True if Vector is currently charging.

public bool IsCharging { get; }

Property Type

Boolean

IsCliffDetected

True if Vector detected a cliff using any of his four cliff sensors.

public bool IsCliffDetected { get; }

Property Type

Boolean

IsDockingToMarker

True if Vector has seen a marker and is actively heading toward it (for example his charger or cube).

public bool IsDockingToMarker { get; }

Property Type

Boolean

IsFalling

True if Vector is currently falling.

public bool IsFalling { get; }

Property Type

Boolean

IsHeadInPos

True if Vector’s head is in the desired position (False if still trying to move there).

public bool IsHeadInPos { get; }

Property Type

Boolean

IsInCalmPowerMode

True if Vector is in calm power mode. Calm power mode is generally when Vector is sleeping or charging.

public bool IsInCalmPowerMode { get; }

Property Type

Boolean

IsLiftInPos

True if Vector’s arm is in the desired position (False if still trying to move it there).

public bool IsLiftInPos { get; }

Property Type

Boolean

IsOnCharger

True if Vector is currently on the charger.

public bool IsOnCharger { get; }

Property Type

Boolean

IsPathing

True if Vector is currently traversing a path.

public bool IsPathing { get; }

Property Type

Boolean

IsPickedUp

True if Vector is currently picked up (in the air).

public bool IsPickedUp { get; }

Property Type

Boolean

IsRobotMoving

True if Vector is in motion. This includes any of his motors (head, arm, wheels/tracks) and if he is being lifted, carried, or falling.

public bool IsRobotMoving { get; }

Property Type

Boolean

Methods

Equals(RobotStatus)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(RobotStatus other)

Parameters

Type	Name	Description
RobotStatus	other	An object to compare with this object.

Returns

Type	Description
Boolean	true if the current object is equal to the other parameter; otherwise, false.

Equals(Object)

Determines whether the specified Object, is equal to this instance.

public override bool Equals(object obj)

Parameters

Type	Name	Description
Object	obj	The Object to compare with this instance.

Returns

Type	Description
Boolean	true if the specified Object is equal to this instance; otherwise, false.

Overrides

ValueType.Equals(Object)

GetHashCode()

Returns a hash code for this instance.

public override int GetHashCode()

Returns

Type	Description
Int32	A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

Overrides

ValueType.GetHashCode()

ToString()

Converts to string.

public override string ToString()

Returns

Type	Description
String	A String that represents this instance.

Overrides

ValueType.ToString()

Operators

Equality(RobotStatus, RobotStatus)

Implements the operator ==.

public static bool operator ==(RobotStatus lhs, RobotStatus rhs)

Parameters

Type	Name	Description
RobotStatus	lhs	The LHS.
RobotStatus	rhs	The RHS.

Returns

Type	Description
Boolean	The result of the operator.

Inequality(RobotStatus, RobotStatus)

Implements the operator !=.

public static bool operator !=(RobotStatus lhs, RobotStatus rhs)

Parameters

Type	Name	Description
RobotStatus	lhs	The LHS.
RobotStatus	rhs	The RHS.

Returns

Type	Description
Boolean	The result of the operator.

Implements

System.IEquatable<T>