Libraries.Robots.Spike.Motor Documentation

Inherits from: Libraries.Language.Object

Actions Documentation

Compare(Libraries.Language.Object object)

This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.

Parameters

Return

integer: The Compare result, Smaller, Equal, or Larger.

Example

Object o
Object t
integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)

Equals(Libraries.Language.Object object)

This action determines if two objects are equal based on their hash code values.

Parameters

Return

boolean: True if the hash codes are equal and false if they are not equal.

Example

use Libraries.Language.Object
use Libraries.Language.Types.Text
Object o
Text t
boolean result = o:Equals(t)

GetAbsolutePosition()

Return

integer

GetDutyCycle()

Return

integer

GetHashCode()

This action gets the hash code for an object.

Return

integer: The integer hash code of the object.

Example

Object o
integer hash = o:GetHashCode()

GetPort()

Return

integer

GetRelativePosition()

Return

integer

GetVelocity()

Return

integer

Run(integer velocity)

Parameters

  • integer velocity

RunForTime(integer time, integer velocity)

Parameters

  • integer time
  • integer velocity

RunToAbsolutePosition(integer position, integer velocity)

Parameters

  • integer position
  • integer velocity

RunToDegrees(integer degrees, integer velocity)

Parameters

  • integer degrees
  • integer velocity

RunToRelativePosition(integer position, integer velocity)

Parameters

  • integer position
  • integer velocity

SetDutyCycle(integer pulseWidthModulation)

Parameters

  • integer pulseWidthModulation

SetPort(integer port)

Parameters

  • integer port

SetRelativePosition(integer position)

Parameters

  • integer position

Stop()