PIDCommand Class Reference

Inheritance diagram for PIDCommand:

Collaboration diagram for PIDCommand:

Public Member Functions
	PIDCommand (const char *name, double p, double i, double d)
	PIDCommand (const char *name, double p, double i, double d, double period)
	PIDCommand (const char *name, double p, double i, double d, double f, double perioid)
	PIDCommand (double p, double i, double d)
	PIDCommand (double p, double i, double d, double period)
	PIDCommand (double p, double i, double d, double f, double period)
void	SetSetpointRelative (double deltaSetpoint)
virtual void	PIDWrite (float output)
virtual double	PIDGet ()
virtual void	InitTable (ITable *table)
virtual std::string	GetSmartDashboardType ()
Public Member Functions inherited from Command
	Command ()
	Command (const char *name)
	Command (double timeout)
	Command (const char *name, double timeout)
double	TimeSinceInitialized ()
void	Requires (Subsystem *s)
bool	IsCanceled ()
void	Start ()
bool	Run ()
void	Cancel ()
bool	IsRunning ()
bool	IsInterruptible ()
void	SetInterruptible (bool interruptible)
bool	DoesRequire (Subsystem *subsystem)
SubsystemSet	GetRequirements ()
CommandGroup *	GetGroup ()
void	SetRunWhenDisabled (bool run)
bool	WillRunWhenDisabled ()
int	GetID ()
virtual std::string	GetName ()
virtual ITable *	GetTable ()
virtual void	ValueChanged (ITable *source, const std::string &key, EntryValue value, bool isNew)
Public Member Functions inherited from ErrorBase
virtual Error &	GetError ()
	Retrieve the current error. Get the current error information associated with this sensor.
virtual const Error &	GetError () const
virtual void	SetErrnoError (const char *contextMessage, const char *filename, const char *function, uint32_t lineNumber) const
	Set error information associated with a C library call that set an error to the "errno" global variable. More...
virtual void	SetImaqError (int success, const char *contextMessage, const char *filename, const char *function, uint32_t lineNumber) const
	Set the current error information associated from the nivision Imaq API. More...
virtual void	SetError (Error::Code code, const char *contextMessage, const char *filename, const char *function, uint32_t lineNumber) const
	Set the current error information associated with this sensor. More...
virtual void	SetWPIError (const char *errorMessage, const char *contextMessage, const char *filename, const char *function, uint32_t lineNumber) const
	Set the current error information associated with this sensor. More...
virtual void	CloneError (ErrorBase *rhs) const
virtual void	ClearError () const
	Clear the current error information associated with this sensor.
virtual bool	StatusIsFatal () const
	Check if the current error code represents a fatal error. More...

Protected Member Functions
PIDController *	GetPIDController ()
virtual void	_Initialize ()
virtual void	_Interrupted ()
virtual void	_End ()
void	SetSetpoint (double setpoint)
double	GetSetpoint ()
double	GetPosition ()
virtual double	ReturnPIDInput ()=0
virtual void	UsePIDOutput (double output)=0
Protected Member Functions inherited from Command
void	SetTimeout (double timeout)
bool	IsTimedOut ()
bool	AssertUnlocked (const char *message)
void	SetParent (CommandGroup *parent)
virtual void	Initialize ()=0
virtual void	Execute ()=0
virtual bool	IsFinished ()=0
virtual void	End ()=0
virtual void	Interrupted ()=0
virtual void	_Execute ()
virtual void	_Cancel ()
Protected Member Functions inherited from ErrorBase
	ErrorBase ()
	Initialize the instance status to 0 for now.

Additional Inherited Members
Public Types inherited from Command
typedef std::set< Subsystem * >	SubsystemSet
Public Types inherited from PIDSource
enum	PIDSourceParameter { kDistance, kRate, kAngle }
Static Public Member Functions inherited from ErrorBase
static void	SetGlobalError (Error::Code code, const char *contextMessage, const char *filename, const char *function, uint32_t lineNumber)
static void	SetGlobalWPIError (const char *errorMessage, const char *contextMessage, const char *filename, const char *function, uint32_t lineNumber)
static Error &	GetGlobalError ()
Protected Attributes inherited from Command
ITable *	m_table
Protected Attributes inherited from ErrorBase
Error	m_error
Static Protected Attributes inherited from ErrorBase
static SEM_ID	_globalErrorMutex = semMCreate(SEM_Q_PRIORITY | SEM_DELETE_SAFE | SEM_INVERSION_SAFE)
static Error	_globalError

Detailed Description

Definition at line 16 of file PIDCommand.h.

Member Function Documentation

std::string PIDCommand::GetSmartDashboardType ( )

virtual

Returns

the string representation of the named data type that will be used by the smart dashboard for this sendable

Reimplemented from Command.

Definition at line 100 of file PIDCommand.cpp.

void PIDCommand::InitTable ( ITable *  subtable )

virtual

Initializes a table for this sendable object.

Parameters

subtable

The table to put the values in.

Reimplemented from Command.

Definition at line 103 of file PIDCommand.cpp.

---

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

• PIDCommand.h
• PIDCommand.cpp