frc::SendableCameraWrapper Class Reference

A wrapper to make video sources sendable and usable from Shuffleboard. More...

#include <frc/shuffleboard/SendableCameraWrapper.h>

Inheritance diagram for frc::SendableCameraWrapper:

Public Member Functions
	SendableCameraWrapper (std::string_view cameraName, const private_init &)
	Creates a new sendable wrapper.
	SendableCameraWrapper (std::string_view cameraName, std::span< const std::string > cameraUrls, const private_init &)
	Creates a new sendable wrapper.
void	InitSendable (wpi::SendableBuilder &builder) override
	Initializes this Sendable object.
Public Member Functions inherited from wpi::Sendable
virtual constexpr	~Sendable ()=default
Public Member Functions inherited from wpi::SendableHelper< SendableCameraWrapper >
constexpr	SendableHelper (const SendableHelper &rhs)=default
constexpr	SendableHelper (SendableHelper &&rhs)
constexpr SendableHelper &	operator= (const SendableHelper &rhs)=default
constexpr SendableHelper &	operator= (SendableHelper &&rhs)

Static Public Member Functions
static SendableCameraWrapper &	Wrap (const cs::VideoSource &source)
	Gets a sendable wrapper object for the given video source, creating the wrapper if one does not already exist for the source.
static SendableCameraWrapper &	Wrap (CS_Source source)
static SendableCameraWrapper &	Wrap (std::string_view cameraName, std::span< const std::string > cameraUrls)

Additional Inherited Members
Protected Member Functions inherited from wpi::SendableHelper< SendableCameraWrapper >
constexpr	SendableHelper ()=default
constexpr	~SendableHelper ()

Detailed Description

A wrapper to make video sources sendable and usable from Shuffleboard.

Constructor & Destructor Documentation

SendableCameraWrapper() [1/2]

frc::SendableCameraWrapper::SendableCameraWrapper ( std::string_view cameraName, const private_init &  )

inline

Creates a new sendable wrapper.

Private constructor to avoid direct instantiation with multiple wrappers floating around for the same camera.

Parameters

cameraName

the name of the camera to wrap

SendableCameraWrapper() [2/2]

frc::SendableCameraWrapper::SendableCameraWrapper ( std::string_view cameraName, std::span< const std::string > cameraUrls, const private_init &  )

inline

Creates a new sendable wrapper.

Private constructor to avoid direct instantiation with multiple wrappers floating around for the same camera.

Parameters

cameraName	the name of the camera to wrap
cameraUrls	camera URLs

Member Function Documentation

InitSendable()

void frc::SendableCameraWrapper::InitSendable ( wpi::SendableBuilder & builder )

overridevirtual

Initializes this Sendable object.

Parameters

builder

sendable builder

Implements wpi::Sendable.

Wrap() [1/3]

SendableCameraWrapper & frc::SendableCameraWrapper::Wrap ( const cs::VideoSource & source )

inlinestatic

Gets a sendable wrapper object for the given video source, creating the wrapper if one does not already exist for the source.

Parameters

source

the video source to wrap

Returns

a sendable wrapper object for the video source, usable in Shuffleboard via ShuffleboardTab::Add() and ShuffleboardLayout::Add()

Wrap() [2/3]

SendableCameraWrapper & frc::SendableCameraWrapper::Wrap ( CS_Source source )

inlinestatic

Wrap() [3/3]

SendableCameraWrapper & frc::SendableCameraWrapper::Wrap ( std::string_view cameraName, std::span< const std::string > cameraUrls )

inlinestatic

---

The documentation for this class was generated from the following file:

• frc/shuffleboard/SendableCameraWrapper.h