Phoenix.h

Go to the documentation of this file.

/* Copyright (C) Cross The Road Electronics 2024 */
#pragma once
 
/* If you are linking Phoenix on a platform that is *not* the NI RoboRIO, 
 * define Phoenix_No_WPI before the Phoenix.h include.
 * The Phoenix WPI extensions are only available on roboRIO.
 * This is necessary if compiling on RaspberryPi, Jetson, Linux-Desktop, etc.
 */
#ifndef Phoenix_No_WPI
#define Phoenix_WPI
#endif
 
#include "ctre/phoenix/CANifier.h"
#include "ctre/phoenix/ErrorCode.h"
#include "ctre/phoenix/paramEnum.h"
#include "ctre/phoenix/HsvToRgb.h"
#include "ctre/phoenix/LinearInterpolation.h"
#include "ctre/phoenix/led/CANdle.h"
#include "ctre/phoenix/motion/BufferedTrajectoryPointStream.h"
#include "ctre/phoenix/motion/MotionProfileStatus.h"
#include "ctre/phoenix/motion/TrajectoryPoint.h"
#include "ctre/phoenix/motorcontrol/can/TalonSRX.h"
#include "ctre/phoenix/motorcontrol/can/VictorSPX.h"
#include "ctre/phoenix/motorcontrol/DemandType.h"
#include "ctre/phoenix/motorcontrol/Faults.h"
#include "ctre/phoenix/motorcontrol/FollowerType.h"
#include "ctre/phoenix/motorcontrol/IMotorController.h"
#include "ctre/phoenix/motorcontrol/IMotorControllerEnhanced.h"
#include "ctre/phoenix/motorcontrol/InvertType.h"
#include "ctre/phoenix/motorcontrol/SensorCollection.h"
#include "ctre/phoenix/sensors/CANCoder.h"
#include "ctre/phoenix/sensors/PigeonIMU.h"
#include "ctre/phoenix/signals/MovingAverage.h"
#include "ctre/phoenix/tasking/Schedulers/ConcurrentScheduler.h"
#include "ctre/phoenix/tasking/ILoopable.h"
#include "ctre/phoenix/tasking/IProcessable.h"
#include "ctre/phoenix/Utilities.h"
 
#ifdef Phoenix_WPI
#include "ctre/phoenix/motorcontrol/can/WPI_TalonSRX.h"
#include "ctre/phoenix/motorcontrol/can/WPI_VictorSPX.h"
#include "ctre/phoenix/sensors/WPI_CANCoder.h"
#include "ctre/phoenix/sensors/WPI_PigeonIMU.h"
#include "ctre/phoenix/tasking/ButtonMonitor.h"
#endif
 
/*
 * In general it is bad-practice to include namespaces in a C++ header, as this 
 * can cause a name conflict with other types in other modules.
 * 
 * However doing so allows users to quickly start developing with the Phoenix class library 
 * with a single include "Phoenix.h", without having to learn the various namespaces.
 * This is particularly useful for aspiring student-programmers who may not understand all of the language features yet.
 * 
 * Those who understand the benefits of namespaces can instead include the core headers (above)
 * or modify this header if proper namespace-scoping is required.
 */
using namespace ctre;
using namespace ctre::phoenix;
using namespace ctre::phoenix::led;
using namespace ctre::phoenix::motion;
using namespace ctre::phoenix::motorcontrol;
using namespace ctre::phoenix::motorcontrol::can;
using namespace ctre::phoenix::sensors;
using namespace ctre::phoenix::signals;
using namespace ctre::phoenix::tasking;
using namespace ctre::phoenix::tasking::schedulers;