VEXcode Doxygen
Classes | Enumerations | Functions | Variables
vex Namespace Reference

device class
More...

Classes

class  __tridevice
 Base class that allows access to Three Wire Port functions and members. More...
 
class  accelerometer
 Use this class when programming with an accelerometer sensor. More...
 
class  analog_in
 Use this class when programming with an analog-in device. More...
 
class  brain
 Use the brain class to see battery information, SD card information, or write to the Screen. More...
 
class  bumper
 Use this class when programming with the bumper device. More...
 
class  color
 Use the color class to create Color objects. More...
 
class  competition
 Use this class to set up your program for competitions. More...
 
class  console
 
class  controller
 Use the controller class to get values from the remote controller as well as write to the controller's screen. More...
 
class  device
 Use the device class to get information about a vex device plugged into the V5. More...
 
class  devices
 Use the device class to get information about all of the vex devices plugged into the V5. More...
 
class  digital_in
 Use this class when programming with a digital-in device. More...
 
class  digital_out
 Use this class when programming with a digital-out device. More...
 
class  distance
 Use the distance class to control the distance sensor. More...
 
class  drivetrain
 
class  electromagnet
 Use the distance class to control the distance sensor. More...
 
class  encoder
 Use this class when programming with an encoder. More...
 
class  event
 
class  guido
 
class  gyro
 Use this class when programming with a gyro sensor. More...
 
class  inertial
 Use the inertial class to control the inertial sensor. More...
 
class  led
 Use this class when programming with a led device. More...
 
class  light
 Use this class when programming with a light sensor. More...
 
class  limit
 Use this class when programming with the limit switch. More...
 
class  line
 Use this class when programming with a line follower. More...
 
class  message_link
 Use the message_link class to send strings between vexlink devices. More...
 
class  motor
 Use the motor class to control motor devices. More...
 
class  motor29
 Use this class when programming a motor connected to a motor controller 29. More...
 
class  motor_group
 
class  motor_victor
 Use this class when programming with a motor connected to a victor motor controller. More...
 
class  mutex
 Use this class to create and control mutexes. More...
 
class  optical
 Use the optical class to control the optical sensor. More...
 
class  pneumatics
 Use this class when programming with a pneumatics device. More...
 
class  pot
 Use this class when programming with a potentiometer. More...
 
class  pwm_out
 Use this class when programming with a pwm-out device. More...
 
class  rotation
 Use the rotation class to control absolute encoder devices. More...
 
class  safearray
 
class  semaphore
 Use this class to synchronize access to resources. More...
 
class  serial_link
 Use the serial_link class to send raw data bytes between vexlink devices. More...
 
class  servo
 Use this class when programming with a servo device. More...
 
class  smartdrive
 
class  sonar
 Use this class when programming with a sonar sensor. More...
 
class  task
 Use this class to create and control tasks. More...
 
class  thread
 Use this class to create and control threads. More...
 
class  timer
 Use the timer class to create timers for your program. More...
 
class  triport
 Use this class to get and set information about devices on Three Wire Ports A through H. More...
 
class  vexlink
 
class  vision
 Use this class when programming the vision sensor. More...
 

Enumerations

enum  percentUnits { percentUnits::pct = 0 }
 The measurement units for percentage values. More...
 
enum  timeUnits { timeUnits::sec, timeUnits::msec }
 The measurement units for time values. More...
 
enum  currentUnits { currentUnits::amp }
 The measurement units for current values. More...
 
enum  voltageUnits { voltageUnits::volt, voltageUnits::mV }
 The measurement units for voltage values. More...
 
enum  powerUnits { powerUnits::watt }
 The measurement units for power values. More...
 
enum  torqueUnits { torqueUnits::Nm, torqueUnits::InLb }
 The measurement units for torque values. More...
 
enum  rotationUnits { rotationUnits::deg, rotationUnits::rev, rotationUnits::raw = 99 }
 The measurement units for rotation values. More...
 
enum  velocityUnits { velocityUnits::pct = (int)percentUnits::pct, velocityUnits::rpm, velocityUnits::dps }
 The measurement units for velocity values. More...
 
enum  distanceUnits { distanceUnits::mm, distanceUnits::in, distanceUnits::cm }
 The measurement units for distance values. More...
 
enum  analogUnits {
  analogUnits::pct = (int)percentUnits::pct, analogUnits::range8bit, analogUnits::range10bit, analogUnits::range12bit,
  analogUnits::mV
}
 The measurement units for analog values. More...
 
enum  temperatureUnits { temperatureUnits::celsius, temperatureUnits::fahrenheit }
 The measurement units for temperature values. More...
 
enum  directionType { directionType::fwd = 0, directionType::rev, undefined }
 The defined units for direction values. More...
 
enum  turnType { turnType::left, turnType::right }
 The defined units for turn values. More...
 
enum  brakeType { brakeType::coast = kV5MotorBrakeModeCoast, brakeType::brake = kV5MotorBrakeModeBrake, brakeType::hold = kV5MotorBrakeModeHold, undefined }
 The defined units for brake values. More...
 
enum  gearSetting { gearSetting::ratio36_1 = kMotorGearSet_36, gearSetting::ratio18_1 = kMotorGearSet_18, gearSetting::ratio6_1 = kMotorGearSet_06 }
 The defined units for gear values. More...
 
enum  fontType {
  fontType::mono20 = 0, fontType::mono30, fontType::mono40, fontType::mono60,
  fontType::prop20, fontType::prop30, fontType::prop40, fontType::prop60,
  fontType::mono15, fontType::mono12, fontType::cjk16
}
 The defined units for font values. More...
 
enum  triportType {
  triportType::analogInput, triportType::analogOutput, triportType::digitalInput, triportType::digitalOutput,
  triportType::button, triportType::potentiometer, triportType::lineSensor, triportType::lightSensor,
  triportType::gyro, triportType::accelerometer, triportType::motor, triportType::servo,
  triportType::quadEncoder, triportType::sonar, triportType::motorS
}
 The defined units for triport devices. More...
 
enum  controllerType { controllerType::primary = kControllerMaster, controllerType::partner = kControllerPartner }
 The defined units for controller devices. More...
 
enum  axisType { xaxis, yaxis, zaxis }
 The defined units for inertial sensor axis.
 
enum  orientationType { roll, pitch, yaw }
 The defined units for inertial sensor orientation.
 
enum  sizeType { none, small, medium, large }
 The defined units for distance sensor object size.
 
enum  ledState { off, on }
 The defined units for optical sensor led state.
 
enum  linkType { undefined, linkType::manager, linkType::worker, linkType::raw }
 The defined units for vexlink types. More...
 

Functions

void wait (double time, timeUnits units)
 

Variables

const rotationUnits degrees
 
const rotationUnits turns
 
const percentUnits percent
 
const timeUnits seconds
 
const distanceUnits inches
 
const distanceUnits mm
 
const directionType forward
 
const directionType reverse
 
const turnType left
 
const turnType right
 
const axisType xaxis
 
const axisType yaxis
 
const axisType zaxis
 
const orientationType roll
 
const orientationType pitch
 
const orientationType yaw
 
const fontType monoM
 
const fontType monoL
 
const fontType monoXL
 
const fontType monoXXL
 
const fontType monoS
 
const fontType monoXS
 
const fontType propM
 
const fontType propL
 
const fontType propXL
 
const fontType propXXL
 
const controllerType primary
 
const controllerType partner
 
const char * rumbleLong
 
const char * rumbleShort
 
const char * rumblePulse
 
const int32_t PORT1
 
const int32_t PORT2
 
const int32_t PORT3
 
const int32_t PORT4
 
const int32_t PORT5
 
const int32_t PORT6
 
const int32_t PORT7
 
const int32_t PORT8
 
const int32_t PORT9
 
const int32_t PORT10
 
const int32_t PORT11
 
const int32_t PORT12
 
const int32_t PORT13
 
const int32_t PORT14
 
const int32_t PORT15
 
const int32_t PORT16
 
const int32_t PORT17
 
const int32_t PORT18
 
const int32_t PORT19
 
const int32_t PORT20
 
const int32_t PORT21
 
const int32_t PORT22
 
const percentUnits pct
 
const timeUnits sec
 
const timeUnits msec
 
const voltageUnits volt
 
const currentUnits amp
 
const powerUnits watt
 
const torqueUnits Nm
 
const torqueUnits InLb
 
const rotationUnits deg
 
const rotationUnits rev
 
const velocityUnits rpm
 
const velocityUnits dps
 
const temperatureUnits celsius
 
const temperatureUnits fahrenheit
 
const directionType fwd
 
const brakeType coast
 
const brakeType brake
 
const brakeType hold
 
const gearSetting ratio36_1
 
const gearSetting ratio18_1
 
const gearSetting ratio6_1
 
const colorblack
 
const colorwhite
 
const colorred
 
const colorgreen
 
const colorblue
 
const coloryellow
 
const colororange
 
const colorpurple
 
const colorcyan
 
const colortransparent
 
const fontType mono20
 
const fontType mono30
 
const fontType mono40
 
const fontType mono60
 
const fontType mono15
 
const fontType mono12
 
const fontType prop20
 
const fontType prop30
 
const fontType prop40
 
const fontType prop60
 
const analogUnits range8bit
 
const analogUnits range10bit
 
const analogUnits range12bit
 
const analogUnits mV
 

Detailed Description

device class

Vision sensor device class

Triport device class

All devices class

base class with virtual member functions used with IMU and gyro

a safe array template

Enumeration Type Documentation

◆ analogUnits

enum vex::analogUnits
strong

The measurement units for analog values.

Enumerator
pct 

An analog unit that is measured in percentage.

range8bit 

An analog unit that is measured in an 8-bit analog value (a value with 256 possible states).

range10bit 

An analog unit that is measured in a 10-bit analog value (a value with 1024 possible states).

range12bit 

An analog unit that is measured in a 12-bit analog value (a value with 4096 possible states).

mV 

An analog unit that is measured in millivolts.

◆ brakeType

enum vex::brakeType
strong

The defined units for brake values.

Enumerator
coast 

A brake unit that is defined as coast.

brake 

A brake unit that is defined as brake.

hold 

A brake unit that is defined as hold.

◆ controllerType

enum vex::controllerType
strong

The defined units for controller devices.

Enumerator
primary 

A controller unit defined as a primary controller.

partner 

A controller unit defined as a partner controller.

◆ currentUnits

enum vex::currentUnits
strong

The measurement units for current values.

Enumerator
amp 

A current unit that is measured in amps.

◆ directionType

enum vex::directionType
strong

The defined units for direction values.

Enumerator
fwd 

A direction unit that is defined as forward.

rev 

A direction unit that is defined as backward.

◆ distanceUnits

enum vex::distanceUnits
strong

The measurement units for distance values.

Enumerator
mm 

A distance unit that is measured in millimeters.

in 

A distance unit that is measured in inches.

cm 

A distance unit that is measured in centimeters.

◆ fontType

enum vex::fontType
strong

The defined units for font values.

Enumerator
mono20 

A font unit that is defined as mono20.

mono30 

A font unit that is defined as mono30.

mono40 

A font unit that is defined as mono40.

mono60 

A font unit that is defined as mono60.

prop20 

A font unit that is defined as prop20.

prop30 

A font unit that is defined as prop30.

prop40 

A font unit that is defined as prop40.

prop60 

A font unit that is defined as prop60.

mono15 

A font unit that is defined as mono15.

mono12 

A font unit that is defined as mono12.

cjk16 

A font unit that is defined as cjk16.

◆ gearSetting

enum vex::gearSetting
strong

The defined units for gear values.

Enumerator
ratio36_1 

A gear unit that is defined as the red 36:1 gear cartridge used in V5 Smart Motors.

ratio18_1 

A gear unit that is defined as the green 18:1 gear cartridge used in V5 Smart Motors.

ratio6_1 

A gear unit that is defined as the blue 6:1 gear cartridge used in V5 Smart Motors.

◆ linkType

enum vex::linkType
strong

The defined units for vexlink types.

Enumerator
manager 

A vexlink type that is defined as the manager radio.

worker 

A vexlink type that is defined as the worker radio.

raw 

A vexlink type that is defined as a raw unmanaged link.

◆ percentUnits

enum vex::percentUnits
strong

The measurement units for percentage values.

Enumerator
pct 

A percentage unit that represents a value from 0% to 100%.

◆ powerUnits

enum vex::powerUnits
strong

The measurement units for power values.

Enumerator
watt 

A power unit that is measured in watts.

◆ rotationUnits

enum vex::rotationUnits
strong

The measurement units for rotation values.

Enumerator
deg 

A rotation unit that is measured in degrees.

rev 

A rotation unit that is measured in revolutions.

raw 

A rotation unit that is measured in raw data form.

◆ temperatureUnits

enum vex::temperatureUnits
strong

The measurement units for temperature values.

Enumerator
celsius 

A temperature unit that is measured in celsius.

fahrenheit 

A temperature unit that is measured in fahrenheit.

◆ timeUnits

enum vex::timeUnits
strong

The measurement units for time values.

Enumerator
sec 

A time unit that is measured in seconds.

msec 

A time unit that is measured in milliseconds.

◆ torqueUnits

enum vex::torqueUnits
strong

The measurement units for torque values.

Enumerator
Nm 

A torque unit that is measured in Newton Meters.

InLb 

A torque unit that is measured in Inch Pounds.

◆ triportType

enum vex::triportType
strong

The defined units for triport devices.

Enumerator
analogInput 

A triport unit that is defined as an analog input.

analogOutput 

A triport unit that is defined as an analog output.

digitalInput 

A triport unit that is defined as a digital input.

digitalOutput 

A triport unit that is defined as a digital output.

button 

A triport unit that is defined as a button.

potentiometer 

A triport unit that is defined as a potentiometer.

lineSensor 

A triport unit that is defined as a line sensor.

lightSensor 

A triport unit that is defined as a light sensor.

gyro 

A triport unit that is defined as a gyro.

accelerometer 

A triport unit that is defined as an accelerometer.

motor 

A triport unit that is defined as a motor.

servo 

A triport unit that is defined as a servo.

quadEncoder 

A triport unit that is defined as a quadrature encoder.

sonar 

A triport unit that is defined as a sonar.

motorS 

A triport unit that is defined as a motor with slew rate control.

◆ turnType

enum vex::turnType
strong

The defined units for turn values.

Enumerator
left 

A turn unit that is defined as left turning.

right 

A turn unit that is defined as right turning.

◆ velocityUnits

enum vex::velocityUnits
strong

The measurement units for velocity values.

Enumerator
pct 

A velocity unit that is measured in percentage.

rpm 

A velocity unit that is measured in rotations per minute.

dps 

A velocity unit that is measured in degrees per second.

◆ voltageUnits

enum vex::voltageUnits
strong

The measurement units for voltage values.

Enumerator
volt 

A voltage unit that is measured in volts.

mV 

The measurement units for power values millivolts.