device.h

Go to the documentation of this file.

/**
 * @file device.h
 * @brief Implements device port and connection logic used by VEX device subclasses.
 */
 
#pragma once
 
struct _V5_Device;
 
namespace crust {
 
/**
 * @brief Base class for devices connected to physical Smart Ports.
 *
 * Stores the physical port, expected device type, and C SDK handle.
 * Derived classes use handle() to call C SDK functions.
 */
class Device {
 public:
  /**
   * @brief Gets the physical Smart Port number.
   * @return Port number [1, 21], rather than the C SDK's [0, 20] index.
   */
  int port() const { return port_; }
 
  /**
   * @brief Checks whether the expected device is currently connected.
   * @return True if this port has a valid handle and reports the expected device type;
   *         false if disconnected, occupied by another device type, or no status is available.
   */
  bool installed() const;
 
 protected:
  /**
   * @brief Resolves and caches the C SDK handle for a physical Smart Port.
   * @param port Physical Smart Port number [1, 21].
   * @param expected_type C SDK device type supplied by the base class.
   */
  Device(int port, int expected_type);
 
  /// Destroys the device.
  ~Device() = default;
 
  /// Provides the device handle associated with this port.
  _V5_Device* handle() const { return device_; }
 
 private:
  int port_;            ///< Physical Smart Port number [1, 21].
  int expected_type_;   ///< C SDK Device Type Number.
  _V5_Device* device_;  ///< Device handle.
};
 
}  // namespace crust