Subsystem Class Reference

Inheritance diagram for Subsystem:

Collaboration diagram for Subsystem:

Public Member Functions
	Subsystem (const char *name)
void	SetDefaultCommand (Command *command)
Command *	GetDefaultCommand ()
void	SetCurrentCommand (Command *command)
Command *	GetCurrentCommand ()
virtual void	InitDefaultCommand ()
virtual std::string	GetName ()
virtual void	InitTable (ITable *table)
virtual ITable *	GetTable ()
virtual std::string	GetSmartDashboardType ()
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 Attributes
ITable *	m_table
Protected Attributes inherited from ErrorBase
Error	m_error

Friends
class	Scheduler

Additional Inherited Members
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 Member Functions inherited from ErrorBase
	ErrorBase ()
	Initialize the instance status to 0 for now.
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 17 of file Subsystem.h.

Constructor & Destructor Documentation

Subsystem::Subsystem

(

const char *

name

)

Creates a subsystem with the given name

Parameters

name	the name of the subsystem

Definition at line 17 of file Subsystem.cpp.

Member Function Documentation

Command * Subsystem::GetCurrentCommand

(

)

Returns the command which currently claims this subsystem.

Returns

the command which currently claims this subsystem

Definition at line 117 of file Subsystem.cpp.

Command * Subsystem::GetDefaultCommand

(

)

Returns the default command (or null if there is none).

Returns

the default command

Definition at line 94 of file Subsystem.cpp.

std::string Subsystem::GetName ( )

virtual

Returns

the name of the subtable of SmartDashboard that the Sendable object will use

Implements NamedSendable.

Definition at line 148 of file Subsystem.cpp.

std::string Subsystem::GetSmartDashboardType ( )

virtual

Returns

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

Implements Sendable.

Reimplemented in PIDSubsystem.

Definition at line 153 of file Subsystem.cpp.

ITable * Subsystem::GetTable ( )

virtual

Returns

the table that is currently associated with the sendable

Implements Sendable.

Definition at line 177 of file Subsystem.cpp.

void Subsystem::InitDefaultCommand ( )

virtual

Initialize the default command for this subsystem This is meant to be the place to call SetDefaultCommand in a subsystem and will be called on all the subsystems by the CommandBase method before the program starts running by using the list of all registered Subsystems inside the Scheduler.

This should be overridden by a Subsystem that has a default Command

Definition at line 35 of file Subsystem.cpp.

void Subsystem::InitTable ( ITable *  subtable )

virtual

Initializes a table for this sendable object.

Parameters

subtable

The table to put the values in.

Implements Sendable.

Reimplemented in PIDSubsystem.

Definition at line 158 of file Subsystem.cpp.

void Subsystem::SetCurrentCommand

(

Command *

command

)

Sets the current command

Parameters

command

the new current command

Definition at line 107 of file Subsystem.cpp.

void Subsystem::SetDefaultCommand

(

Command *

command

)

Sets the default command. If this is not called or is called with null, then there will be no default command for the subsystem.

WARNING: This should NOT be called in a constructor if the subsystem is a singleton.

Parameters

command

the default command (or null if there should be none)

Definition at line 48 of file Subsystem.cpp.

---

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

• Subsystem.h
• Subsystem.cpp