WPILibC++  unspecified
frc::SendableBase Class Reference
Inheritance diagram for frc::SendableBase:
Collaboration diagram for frc::SendableBase:

Public Member Functions

 SendableBase (bool addLiveWindow=true)
 Creates an instance of the sensor base. More...
 
 ~SendableBase () override
 Free the resources used by this object.
 
std::string GetName () const final
 Gets the name of this Sendable object. More...
 
void SetName (const llvm::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 llvm::Twine &subsystem) final
 Sets the subsystem name of this Sendable object. More...
 
- Public Member Functions inherited from frc::Sendable
void SetName (const llvm::Twine &subsystem, const llvm::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 llvm::Twine &moduleType, int channel)
 Sets the name of the sensor with a channel number. More...
 
void SetName (const llvm::Twine &moduleType, int moduleNumber, int channel)
 Sets the name of the sensor with a module and channel number. More...
 

Constructor & Destructor Documentation

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 SendableBase::AddChild ( std::shared_ptr< Sendable child)
protected

Add a child component.

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

Add a child component.

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

Gets the name of this Sendable object.

Returns
Name

Implements frc::Sendable.

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

Gets the subsystem name of this Sendable object.

Returns
Subsystem name

Implements frc::Sendable.

void SendableBase::SetName ( const llvm::Twine name)
finalvirtual

Sets the name of this Sendable object.

Parameters
namename

Implements frc::Sendable.

void SendableBase::SetName ( const llvm::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 SendableBase::SetName ( const llvm::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 SendableBase::SetSubsystem ( const llvm::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 files: