WPILibC++  2020.3.2-60-g3011ebe
frc::SendableCameraWrapper Class Reference

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

#include <SendableCameraWrapper.h>

Inheritance diagram for frc::SendableCameraWrapper:
frc::Sendable frc::SendableHelper< SendableCameraWrapper >

Public Member Functions

 SendableCameraWrapper (CS_Source source, const private_init &)
 Creates a new sendable wrapper. More...
 
void InitSendable (SendableBuilder &builder) override
 Initializes this Sendable object. More...
 
- Public Member Functions inherited from frc::SendableHelper< SendableCameraWrapper >
 SendableHelper (const SendableHelper &rhs)=default
 
 SendableHelper (SendableHelper &&rhs)
 
SendableHelperoperator= (const SendableHelper &rhs)=default
 
SendableHelperoperator= (SendableHelper &&rhs)
 
std::string GetName () const
 Gets the name of this Sendable object. More...
 
void SetName (const wpi::Twine &name)
 Sets the name of this Sendable object. More...
 
void SetName (const wpi::Twine &subsystem, const wpi::Twine &name)
 Sets both the subsystem name and device name of this Sendable object. More...
 
std::string GetSubsystem () const
 Gets the subsystem name of this Sendable object. More...
 
void SetSubsystem (const wpi::Twine &subsystem)
 Sets the subsystem name of this Sendable object. More...
 

Static Public Member Functions

static SendableCameraWrapperWrap (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. More...
 
static SendableCameraWrapperWrap (CS_Source source)
 

Additional Inherited Members

- Protected Member Functions inherited from frc::SendableHelper< SendableCameraWrapper >
void SetName (const wpi::Twine &moduleType, int channel)
 Sets the name of the sensor with a channel number. More...
 
void SetName (const wpi::Twine &moduleType, int moduleNumber, int channel)
 Sets the name of the sensor with a module and channel number. More...
 
void AddChild (std::shared_ptr< Sendable > child)
 Add a child component. More...
 
void AddChild (void *child)
 Add a child component. More...
 

Detailed Description

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

Constructor & Destructor Documentation

◆ SendableCameraWrapper()

frc::SendableCameraWrapper::SendableCameraWrapper ( CS_Source  source,
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
sourcethe source to wrap

Member Function Documentation

◆ InitSendable()

void frc::SendableCameraWrapper::InitSendable ( SendableBuilder builder)
overridevirtual

Initializes this Sendable object.

Parameters
buildersendable builder

Implements frc::Sendable.

◆ Wrap()

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
sourcethe video source to wrap
Returns
a sendable wrapper object for the video source, usable in Shuffleboard via ShuffleboardTab::Add() and ShuffleboardLayout::Add()

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