Module Class Reference

Inheritance diagram for Module:

Collaboration diagram for Module:

Public Member Functions
nLoadOut::tModuleType	GetType ()
UINT8	GetNumber ()
Public Member Functions inherited from SensorBase
	SensorBase ()
virtual	~SensorBase ()
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 lineNumber) const
	Set error information associated with a C library call that set an error to the "errno" global variable.
virtual void	SetImaqError (int success, const char *contextMessage, const char *filename, const char *function, UINT32 lineNumber) const
	Set the current error information associated from the nivision Imaq API.
virtual void	SetError (Error::Code code, const char *contextMessage, const char *filename, const char *function, UINT32 lineNumber) const
	Set the current error information associated with this sensor.
virtual void	SetWPIError (const char *errorMessage, const char *contextMessage, const char *filename, const char *function, UINT32 lineNumber) const
	Set the current error information associated with this sensor.
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.

Static Public Member Functions
static Module *	GetModule (nLoadOut::tModuleType type, UINT8 number)
Static Public Member Functions inherited from SensorBase
static void	DeleteSingletons ()
static UINT32	GetDefaultAnalogModule ()
static UINT32	GetDefaultDigitalModule ()
static UINT32	GetDefaultSolenoidModule ()
static bool	CheckAnalogModule (UINT8 moduleNumber)
static bool	CheckDigitalModule (UINT8 moduleNumber)
static bool	CheckPWMModule (UINT8 moduleNumber)
static bool	CheckRelayModule (UINT8 moduleNumber)
static bool	CheckSolenoidModule (UINT8 moduleNumber)
static bool	CheckDigitalChannel (UINT32 channel)
static bool	CheckRelayChannel (UINT32 channel)
static bool	CheckPWMChannel (UINT32 channel)
static bool	CheckAnalogChannel (UINT32 channel)
static bool	CheckSolenoidChannel (UINT32 channel)
Static Public Member Functions inherited from ErrorBase
static void	SetGlobalError (Error::Code code, const char *contextMessage, const char *filename, const char *function, UINT32 lineNumber)
static void	SetGlobalWPIError (const char *errorMessage, const char *contextMessage, const char *filename, const char *function, UINT32 lineNumber)
static Error &	GetGlobalError ()

Protected Member Functions
	Module (nLoadOut::tModuleType type, UINT8 number)
virtual	~Module ()
Protected Member Functions inherited from SensorBase
void	AddToSingletonList ()
Protected Member Functions inherited from ErrorBase
	ErrorBase ()
	Initialize the instance status to 0 for now.

Protected Attributes
nLoadOut::tModuleType	m_moduleType
	The type of module represented.
UINT8	m_moduleNumber
	The module index within the module type.

Additional Inherited Members
Static Public Attributes inherited from SensorBase
static const UINT32	kSystemClockTicksPerMicrosecond = 40
static const UINT32	kDigitalChannels = 14
static const UINT32	kAnalogChannels = 8
static const UINT32	kAnalogModules = 2
static const UINT32	kDigitalModules = 2
static const UINT32	kSolenoidChannels = 8
static const UINT32	kSolenoidModules = 2
static const UINT32	kPwmChannels = 10
static const UINT32	kRelayChannels = 8
static const UINT32	kChassisSlots = 8
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 15 of file Module.h.

Constructor & Destructor Documentation

Module::Module ( nLoadOut::tModuleType  type, UINT8  number  )

explicitprotected

Constructor.

Parameters

type	The type of module represented.
number	The module index within the module type.

Definition at line 20 of file Module.cpp.

Module::~Module ( )

protectedvirtual

Destructor.

Definition at line 30 of file Module.cpp.

Member Function Documentation

Module * Module::GetModule ( nLoadOut::tModuleType  type, UINT8  number  )

static

Static module singleton factory.

Parameters

type	The type of module represented.
number	The module index within the module type.

Definition at line 40 of file Module.cpp.

---

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

• Module.h
• Module.cpp