WPILibC++  2019.3.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
frc::SendableBase Class Reference
Inheritance diagram for frc::SendableBase:
frc::Sendable frc::ADXL345_I2C frc::ADXL345_SPI frc::ADXL362 frc::AnalogAccelerometer frc::AnalogInput frc::AnalogOutput frc::AnalogPotentiometer frc::AnalogTrigger frc::BuiltInAccelerometer frc::Command frc::Compressor frc::Counter frc::DigitalGlitchFilter frc::DigitalOutput frc::Encoder frc::GyroBase frc::InterruptableSensorBase frc::NidecBrushless frc::PIDBase frc::PowerDistributionPanel frc::PWM frc::Relay frc::RobotDriveBase frc::Scheduler frc::SendableCameraWrapper frc::SendableChooserBase frc::SmartDashboard frc::SolenoidBase frc::SpeedControllerGroup frc::Subsystem frc::Trigger frc::Ultrasonic

Public Member Functions

 SendableBase (bool addLiveWindow=true)
 Creates an instance of the sensor base. More...
 
 SendableBase (SendableBase &&rhs)
 
SendableBaseoperator= (SendableBase &&rhs)
 
std::string GetName () const final
 Gets the name of this Sendable object. More...
 
void SetName (const wpi::Twine &name) final
 Sets the name of this Sendable object. More...
 
std::string GetSubsystem () const final
 Gets the subsystem name of this Sendable object. More...
 
void SetSubsystem (const wpi::Twine &subsystem) final
 Sets the subsystem name of this Sendable object. More...
 
- Public Member Functions inherited from frc::Sendable
 Sendable (Sendable &&)=default
 
Sendableoperator= (Sendable &&)=default
 
void SetName (const wpi::Twine &subsystem, const wpi::Twine &name)
 Sets both the subsystem name and device name of this Sendable object. More...
 
virtual void InitSendable (SendableBuilder &builder)=0
 Initializes this Sendable object. More...
 

Protected Member Functions

void AddChild (std::shared_ptr< Sendable > child)
 Add a child component. More...
 
void AddChild (void *child)
 Add a child component. More...
 
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...
 

Constructor & Destructor Documentation

frc::SendableBase::SendableBase ( bool  addLiveWindow = true)
explicit

Creates an instance of the sensor base.

Parameters
addLiveWindowif true, add this Sendable to LiveWindow

Member Function Documentation

void frc::SendableBase::AddChild ( std::shared_ptr< Sendable child)
protected

Add a child component.

Parameters
childchild component
void frc::SendableBase::AddChild ( void *  child)
protected

Add a child component.

Parameters
childchild component
std::string frc::SendableBase::GetName ( ) const
finalvirtual

Gets the name of this Sendable object.

Returns
Name

Implements frc::Sendable.

std::string frc::SendableBase::GetSubsystem ( ) const
finalvirtual

Gets the subsystem name of this Sendable object.

Returns
Subsystem name

Implements frc::Sendable.

void frc::SendableBase::SetName ( const wpi::Twine name)
finalvirtual

Sets the name of this Sendable object.

Parameters
namename

Implements frc::Sendable.

void frc::SendableBase::SetName ( const wpi::Twine moduleType,
int  channel 
)
protected

Sets the name of the sensor with a channel number.

Parameters
moduleTypeA string that defines the module name in the label for the value
channelThe channel number the device is plugged into
void frc::SendableBase::SetName ( const wpi::Twine moduleType,
int  moduleNumber,
int  channel 
)
protected

Sets the name of the sensor with a module and channel number.

Parameters
moduleTypeA string that defines the module name in the label for the value
moduleNumberThe number of the particular module type
channelThe channel number the device is plugged into (usually PWM)
void frc::SendableBase::SetSubsystem ( const wpi::Twine subsystem)
finalvirtual

Sets the subsystem name of this Sendable object.

Parameters
subsystemsubsystem name

Implements frc::Sendable.


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