WPILibC++  unspecified
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Pages
SmartDashboard Class Reference
Inheritance diagram for SmartDashboard:
SensorBase ErrorBase

Static Public Member Functions

static void init ()
 
static void PutData (llvm::StringRef key, Sendable *data)
 Maps the specified key to the specified value in this table. More...
 
static void PutData (NamedSendable *value)
 Maps the specified key (where the key is the name of the SmartDashboardNamedData to the specified value in this table. More...
 
static SendableGetData (llvm::StringRef keyName)
 Returns the value at the specified key. More...
 
static void PutBoolean (llvm::StringRef keyName, bool value)
 Maps the specified key to the specified value in this table. More...
 
static bool GetBoolean (llvm::StringRef keyName, bool defaultValue)
 Returns the value at the specified key. More...
 
static void PutNumber (llvm::StringRef keyName, double value)
 Maps the specified key to the specified value in this table. More...
 
static double GetNumber (llvm::StringRef keyName, double defaultValue)
 Returns the value at the specified key. More...
 
static void PutString (llvm::StringRef keyName, llvm::StringRef value)
 Maps the specified key to the specified value in this table. More...
 
static std::string GetString (llvm::StringRef keyName, llvm::StringRef defaultValue)
 Returns the value at the specified key. More...
 
static void PutValue (llvm::StringRef keyName, std::shared_ptr< nt::Value > value)
 Maps the specified key to the specified complex value (such as an array) in this table. More...
 
static std::shared_ptr< nt::ValueGetValue (llvm::StringRef keyName)
 Retrieves the complex value (such as an array) in this table into the complex data object The key can not be nullptr. More...
 
- Static Public Member Functions inherited from SensorBase
static void DeleteSingletons ()
 Delete all the singleton classes on the list. More...
 
static uint32_t GetDefaultSolenoidModule ()
 
static bool CheckSolenoidModule (uint8_t moduleNumber)
 Check that the solenoid module number is valid. More...
 
static bool CheckDigitalChannel (uint32_t channel)
 Check that the digital channel number is valid. More...
 
static bool CheckRelayChannel (uint32_t channel)
 Check that the digital channel number is valid. More...
 
static bool CheckPWMChannel (uint32_t channel)
 Check that the digital channel number is valid. More...
 
static bool CheckAnalogInput (uint32_t channel)
 Check that the analog input number is value. More...
 
static bool CheckAnalogOutput (uint32_t channel)
 Check that the analog output number is valid. More...
 
static bool CheckSolenoidChannel (uint32_t channel)
 Verify that the solenoid channel number is within limits. More...
 
static bool CheckPDPChannel (uint32_t channel)
 Verify that the power distribution channel number is within limits. More...
 
- Static Public Member Functions inherited from ErrorBase
static void SetGlobalError (Error::Code code, llvm::StringRef contextMessage, llvm::StringRef filename, llvm::StringRef function, uint32_t lineNumber)
 
static void SetGlobalWPIError (llvm::StringRef errorMessage, llvm::StringRef contextMessage, llvm::StringRef filename, llvm::StringRef function, uint32_t lineNumber)
 
static ErrorGetGlobalError ()
 Retrieve the current global error.
 

Additional Inherited Members

- Public Member Functions inherited from SensorBase
 SensorBase ()
 Creates an instance of the sensor base and gets an FPGA handle.
 
 SensorBase (const SensorBase &)=delete
 
SensorBaseoperator= (const SensorBase &)=delete
 
- Public Member Functions inherited from ErrorBase
 ErrorBase (const ErrorBase &)=delete
 
ErrorBaseoperator= (const ErrorBase &)=delete
 
virtual ErrorGetError ()
 Retrieve the current error. More...
 
virtual const ErrorGetError () const
 
virtual void SetErrnoError (llvm::StringRef contextMessage, llvm::StringRef filename, llvm::StringRef 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, llvm::StringRef contextMessage, llvm::StringRef filename, llvm::StringRef function, uint32_t lineNumber) const
 Set the current error information associated from the nivision Imaq API. More...
 
virtual void SetError (Error::Code code, llvm::StringRef contextMessage, llvm::StringRef filename, llvm::StringRef function, uint32_t lineNumber) const
 Set the current error information associated with this sensor. More...
 
virtual void SetWPIError (llvm::StringRef errorMessage, Error::Code code, llvm::StringRef contextMessage, llvm::StringRef filename, llvm::StringRef function, uint32_t lineNumber) const
 Set the current error information associated with this sensor. More...
 
virtual void CloneError (const 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...
 
- Static Public Attributes inherited from SensorBase
static const uint32_t kDigitalChannels = 26
 
static const uint32_t kAnalogInputs = 8
 
static const uint32_t kAnalogOutputs = 2
 
static const uint32_t kSolenoidChannels = 8
 
static const uint32_t kSolenoidModules = 2
 
static const uint32_t kPwmChannels = 20
 
static const uint32_t kRelayChannels = 8
 
static const uint32_t kPDPChannels = 16
 
static const uint32_t kChassisSlots = 8
 
- Protected Member Functions inherited from SensorBase
void AddToSingletonList ()
 Add sensor to the singleton list. More...
 
- Protected Attributes inherited from ErrorBase
Error m_error
 
- Static Protected Attributes inherited from SensorBase
static void * m_digital_ports [kDigitalChannels]
 
static void * m_relay_ports [kRelayChannels]
 
static void * m_pwm_ports [kPwmChannels]
 
- Static Protected Attributes inherited from ErrorBase
static priority_mutex _globalErrorMutex
 
static Error _globalError
 

Member Function Documentation

bool SmartDashboard::GetBoolean ( llvm::StringRef  keyName,
bool  defaultValue 
)
static

Returns the value at the specified key.

If the key is not found, returns the default value.

Parameters
keyNamethe key
Returns
the value
Sendable * SmartDashboard::GetData ( llvm::StringRef  key)
static

Returns the value at the specified key.

Parameters
keyNamethe key
Returns
the value
double SmartDashboard::GetNumber ( llvm::StringRef  keyName,
double  defaultValue 
)
static

Returns the value at the specified key.

If the key is not found, returns the default value.

Parameters
keyNamethe key
Returns
the value
std::string SmartDashboard::GetString ( llvm::StringRef  keyName,
llvm::StringRef  defaultValue 
)
static

Returns the value at the specified key.

If the key is not found, returns the default value.

Parameters
keyNamethe key
Returns
the value
std::shared_ptr< nt::Value > SmartDashboard::GetValue ( llvm::StringRef  keyName)
static

Retrieves the complex value (such as an array) in this table into the complex data object The key can not be nullptr.

Parameters
keyNamethe key
valuethe object to retrieve the value into
void SmartDashboard::PutBoolean ( llvm::StringRef  keyName,
bool  value 
)
static

Maps the specified key to the specified value in this table.

The key can not be nullptr. The value can be retrieved by calling the get method with a key that is equal to the original key.

Parameters
keyNamethe key
valuethe value
void SmartDashboard::PutData ( llvm::StringRef  key,
Sendable data 
)
static

Maps the specified key to the specified value in this table.

The key can not be nullptr. The value can be retrieved by calling the get method with a key that is equal to the original key.

Parameters
keyNamethe key
valuethe value
void SmartDashboard::PutData ( NamedSendable value)
static

Maps the specified key (where the key is the name of the SmartDashboardNamedData to the specified value in this table.

The value can be retrieved by calling the get method with a key that is equal to the original key.

Parameters
valuethe value
void SmartDashboard::PutNumber ( llvm::StringRef  keyName,
double  value 
)
static

Maps the specified key to the specified value in this table.

The key can not be nullptr. The value can be retrieved by calling the get method with a key that is equal to the original key.

Parameters
keyNamethe key
valuethe value
void SmartDashboard::PutString ( llvm::StringRef  keyName,
llvm::StringRef  value 
)
static

Maps the specified key to the specified value in this table.

Neither the key nor the value can be nullptr. The value can be retrieved by calling the get method with a key that is equal to the original key.

Parameters
keyNamethe key
valuethe value
void SmartDashboard::PutValue ( llvm::StringRef  keyName,
std::shared_ptr< nt::Value value 
)
static

Maps the specified key to the specified complex value (such as an array) in this table.

The key can not be nullptr. The value can be retrieved by calling the RetrieveValue method with a key that is equal to the original key.

Parameters
keyNamethe key
valuethe value

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