edu.wpi.first.wpilibj.communication
Class UsageReporting

java.lang.Object
  extended by edu.wpi.first.wpilibj.communication.UsageReporting

public final class UsageReporting
extends java.lang.Object

Author:
mwills

Field Summary
static int kCANPlugin_2CAN
           
static int kCANPlugin_BlackJagBridge
           
static int kFramework_Iterative
           
static int kFramework_Simple
           
static int kLanguage_CPlusPlus
           
static int kLanguage_Java
           
static int kLanguage_LabVIEW
           
static int kLanguage_Python
           
static int kResourceType_Accelerometer
           
static int kResourceType_ADXL345
           
static int kResourceType_AnalogChannel
           
static int kResourceType_AnalogTrigger
           
static int kResourceType_AnalogTriggerOutput
           
static int kResourceType_AxisCamera
           
static int kResourceType_Button
           
static int kResourceType_CANJaguar
           
static int kResourceType_CANPlugin
           
static int kResourceType_Command
           
static int kResourceType_Compressor
           
static int kResourceType_Controller
           
static int kResourceType_Counter
           
static int kResourceType_Dashboard
           
static int kResourceType_DigitalInput
           
static int kResourceType_DigitalOutput
           
static int kResourceType_DriverStationCIO
           
static int kResourceType_DriverStationEIO
           
static int kResourceType_DriverStationLCD
           
static int kResourceType_Encoder
           
static int kResourceType_Framework
           
static int kResourceType_GearTooth
           
static int kResourceType_Gyro
           
static int kResourceType_I2C
           
static int kResourceType_Jaguar
           
static int kResourceType_Joystick
           
static int kResourceType_Kinect
           
static int kResourceType_KinectStick
           
static int kResourceType_Language
           
static int kResourceType_Module
           
static int kResourceType_PCVideoServer
           
static int kResourceType_PIDController
           
static int kResourceType_Preferences
           
static int kResourceType_PWM
           
static int kResourceType_Relay
           
static int kResourceType_RobotDrive
           
static int kResourceType_SerialPort
           
static int kResourceType_Servo
           
static int kResourceType_SmartDashboard
           
static int kResourceType_Solenoid
           
static int kResourceType_SPI
           
static int kResourceType_Task
           
static int kResourceType_Ultrasonic
           
static int kResourceType_Victor
           
static int kUsageReporting_version
           
 
Method Summary
static void report(int resource, int instanceNumber)
          Report the usage of a resource of interest.
static void report(int resource, int instanceNumber, int context)
          Report the usage of a resource of interest.
static void report(int resource, int instanceNumber, int context, java.lang.String feature)
          Report the usage of a resource of interest.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

kUsageReporting_version

public static final int kUsageReporting_version
See Also:
Constant Field Values

kResourceType_Controller

public static final int kResourceType_Controller
See Also:
Constant Field Values

kResourceType_Module

public static final int kResourceType_Module
See Also:
Constant Field Values

kResourceType_Language

public static final int kResourceType_Language
See Also:
Constant Field Values

kResourceType_CANPlugin

public static final int kResourceType_CANPlugin
See Also:
Constant Field Values

kResourceType_Accelerometer

public static final int kResourceType_Accelerometer
See Also:
Constant Field Values

kResourceType_ADXL345

public static final int kResourceType_ADXL345
See Also:
Constant Field Values

kResourceType_AnalogChannel

public static final int kResourceType_AnalogChannel
See Also:
Constant Field Values

kResourceType_AnalogTrigger

public static final int kResourceType_AnalogTrigger
See Also:
Constant Field Values

kResourceType_AnalogTriggerOutput

public static final int kResourceType_AnalogTriggerOutput
See Also:
Constant Field Values

kResourceType_CANJaguar

public static final int kResourceType_CANJaguar
See Also:
Constant Field Values

kResourceType_Compressor

public static final int kResourceType_Compressor
See Also:
Constant Field Values

kResourceType_Counter

public static final int kResourceType_Counter
See Also:
Constant Field Values

kResourceType_Dashboard

public static final int kResourceType_Dashboard
See Also:
Constant Field Values

kResourceType_DigitalInput

public static final int kResourceType_DigitalInput
See Also:
Constant Field Values

kResourceType_DigitalOutput

public static final int kResourceType_DigitalOutput
See Also:
Constant Field Values

kResourceType_DriverStationCIO

public static final int kResourceType_DriverStationCIO
See Also:
Constant Field Values

kResourceType_DriverStationEIO

public static final int kResourceType_DriverStationEIO
See Also:
Constant Field Values

kResourceType_DriverStationLCD

public static final int kResourceType_DriverStationLCD
See Also:
Constant Field Values

kResourceType_Encoder

public static final int kResourceType_Encoder
See Also:
Constant Field Values

kResourceType_GearTooth

public static final int kResourceType_GearTooth
See Also:
Constant Field Values

kResourceType_Gyro

public static final int kResourceType_Gyro
See Also:
Constant Field Values

kResourceType_I2C

public static final int kResourceType_I2C
See Also:
Constant Field Values

kResourceType_Framework

public static final int kResourceType_Framework
See Also:
Constant Field Values

kResourceType_Jaguar

public static final int kResourceType_Jaguar
See Also:
Constant Field Values

kResourceType_Joystick

public static final int kResourceType_Joystick
See Also:
Constant Field Values

kResourceType_Kinect

public static final int kResourceType_Kinect
See Also:
Constant Field Values

kResourceType_KinectStick

public static final int kResourceType_KinectStick
See Also:
Constant Field Values

kResourceType_PIDController

public static final int kResourceType_PIDController
See Also:
Constant Field Values

kResourceType_Preferences

public static final int kResourceType_Preferences
See Also:
Constant Field Values

kResourceType_PWM

public static final int kResourceType_PWM
See Also:
Constant Field Values

kResourceType_Relay

public static final int kResourceType_Relay
See Also:
Constant Field Values

kResourceType_RobotDrive

public static final int kResourceType_RobotDrive
See Also:
Constant Field Values

kResourceType_SerialPort

public static final int kResourceType_SerialPort
See Also:
Constant Field Values

kResourceType_Servo

public static final int kResourceType_Servo
See Also:
Constant Field Values

kResourceType_Solenoid

public static final int kResourceType_Solenoid
See Also:
Constant Field Values

kResourceType_SPI

public static final int kResourceType_SPI
See Also:
Constant Field Values

kResourceType_Task

public static final int kResourceType_Task
See Also:
Constant Field Values

kResourceType_Ultrasonic

public static final int kResourceType_Ultrasonic
See Also:
Constant Field Values

kResourceType_Victor

public static final int kResourceType_Victor
See Also:
Constant Field Values

kResourceType_Button

public static final int kResourceType_Button
See Also:
Constant Field Values

kResourceType_Command

public static final int kResourceType_Command
See Also:
Constant Field Values

kResourceType_AxisCamera

public static final int kResourceType_AxisCamera
See Also:
Constant Field Values

kResourceType_PCVideoServer

public static final int kResourceType_PCVideoServer
See Also:
Constant Field Values

kResourceType_SmartDashboard

public static final int kResourceType_SmartDashboard
See Also:
Constant Field Values

kLanguage_LabVIEW

public static final int kLanguage_LabVIEW
See Also:
Constant Field Values

kLanguage_CPlusPlus

public static final int kLanguage_CPlusPlus
See Also:
Constant Field Values

kLanguage_Java

public static final int kLanguage_Java
See Also:
Constant Field Values

kLanguage_Python

public static final int kLanguage_Python
See Also:
Constant Field Values

kCANPlugin_BlackJagBridge

public static final int kCANPlugin_BlackJagBridge
See Also:
Constant Field Values

kCANPlugin_2CAN

public static final int kCANPlugin_2CAN
See Also:
Constant Field Values

kFramework_Iterative

public static final int kFramework_Iterative
See Also:
Constant Field Values

kFramework_Simple

public static final int kFramework_Simple
See Also:
Constant Field Values
Method Detail

report

public static void report(int resource,
                          int instanceNumber)
Report the usage of a resource of interest.

Parameters:
resource - one of the values in the tResourceType above (max value 51).
instanceNumber - an index that identifies the resource instance.

report

public static void report(int resource,
                          int instanceNumber,
                          int context)
Report the usage of a resource of interest.

Parameters:
resource - one of the values in the tResourceType above (max value 51).
instanceNumber - an index that identifies the resource instance.
context - an optional additional context number for some cases (such as module number). Set to 0 to omit.

report

public static void report(int resource,
                          int instanceNumber,
                          int context,
                          java.lang.String feature)
Report the usage of a resource of interest.

Parameters:
resource - one of the values in the tResourceType above (max value 51).
instanceNumber - an index that identifies the resource instance.
context - an optional additional context number for some cases (such as module number). Set to 0 to omit.
feature - a string to be included describing features in use on a specific resource. Setting the same resource more than once allows you to change the feature string.