cisst-saw
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Attributes | List of all members
mtsPuck Class Reference

#include <mtsPuck.h>

Inheritance diagram for mtsPuck:
mtsComponent osaPuck cmnGenericObject

Public Member Functions

 mtsPuck (const std::string &componentname, osaPuck::ID id, osaCANBus *can)
 
- Public Member Functions inherited from mtsComponent
 mtsComponent (const std::string &deviceName)
 
virtual ~mtsComponent ()
 
const std::string & GetName (void) const
 
void GetName (std::string &placeHolder) const
 
void SetName (const std::string &componentName)
 
virtual void Configure (const std::string &filename="")
 
virtual void Create (void)
 
bool CreateAndWait (double timeoutInSeconds)
 
virtual void Start (void)
 
bool StartAndWait (double timeoutInSeconds)
 
virtual void Suspend (void)
 
virtual void Kill (void)
 
bool KillAndWait (double timeoutInSeconds)
 
virtual void Startup (void)
 
virtual void Cleanup (void)
 
mtsInterfaceProvidedAddInterfaceProvided (const std::string &interfaceProvidedName, mtsInterfaceQueueingPolicy queueingPolicy=MTS_COMPONENT_POLICY)
 
virtual mtsInterfaceProvidedAddInterfaceProvidedWithoutSystemEvents (const std::string &interfaceProvidedName, mtsInterfaceQueueingPolicy queueingPolicy=MTS_COMPONENT_POLICY, bool isProxy=false)
 
CISST_DEPRECATED
mtsInterfaceProvided
AddProvidedInterface (const std::string &interfaceProvidedName)
 
virtual mtsInterfaceOutputAddInterfaceOutput (const std::string &interfaceOutputName)
 
bool InterfaceExists (const std::string &interfaceName, cmnLogLevel lod=CMN_LOG_LEVEL_INIT_VERBOSE) const
 
bool InterfaceProvidedOrOutputExists (const std::string &interfaceName, cmnLogLevel lod=CMN_LOG_LEVEL_INIT_VERBOSE) const
 
bool InterfaceRequiredOrInputExists (const std::string &interfaceName, cmnLogLevel lod=CMN_LOG_LEVEL_INIT_VERBOSE) const
 
mtsInterfaceProvidedGetInterfaceProvided (const std::string &interfaceProvidedName) const
 
mtsInterfaceOutputGetInterfaceOutput (const std::string &interfaceOutputName) const
 
size_t GetNumberOfInterfacesProvided (void) const
 
size_t GetNumberOfInterfacesOutput (void) const
 
bool RemoveInterfaceProvided (const std::string &interfaceProvidedName, const bool skipDisconnect=false)
 
mtsInterfaceRequiredAddInterfaceRequired (const std::string &interfaceRequiredName, mtsRequiredType isRequired=MTS_REQUIRED)
 
virtual mtsInterfaceRequiredAddInterfaceRequiredWithoutSystemEventHandlers (const std::string &interfaceRequiredName, mtsRequiredType isRequired=MTS_REQUIRED)
 
CISST_DEPRECATED
mtsInterfaceRequired
AddRequiredInterface (const std::string &requiredInterfaceName)
 
virtual mtsInterfaceInputAddInterfaceInput (const std::string &interfaceInputName)
 
const mtsInterfaceProvidedGetInterfaceProvidedFor (const std::string &interfaceRequiredName)
 
mtsInterfaceRequiredGetInterfaceRequired (const std::string &interfaceRequiredName)
 
mtsInterfaceInputGetInterfaceInput (const std::string &interfaceInputName) const
 
size_t GetNumberOfInterfacesRequired (void) const
 
size_t GetNumberOfInterfacesInput (void) const
 
bool RemoveInterfaceRequired (const std::string &interfaceRequiredName, const bool skipDisconnect=false)
 
const mtsManagerComponentServicesGetManagerComponentServices (void) const
 
mtsManagerComponentServicesGetManagerComponentServices (void)
 
mtsStateTableGetStateTable (const std::string &stateTableName)
 
bool AddStateTable (mtsStateTable *existingStateTable, bool addInterfaceProvided=true)
 
void UseSeparateLogFileDefault (bool forwardToLogger=true)
 
void UseSeparateLogFileDefaultWithDate (bool forwardToLogger=true)
 
void UseSeparateLogFile (const std::string &filename, bool forwardToLogger=true)
 
cmnLogger::StreamBufTypeGetLogMultiplexer (void) const
 
bool IsRunning (void) const
 
bool CISST_DEPRECATED Running (void) const
 
bool IsStarted (void) const
 
bool IsTerminated (void) const
 
bool IsEndTask (void) const
 
const mtsComponentStateGetState (void) const
 
void GetState (mtsComponentState &state) const
 
void ToStream (std::ostream &outputStream) const
 
bool SetReplayMode (void)
 
bool SetReplayData (const std::string &stateTableName, const std::string &fileName)
 
bool SetReplayTime (const double time)
 
std::vector< std::string > GetNamesOfInterfacesProvidedOrOutput (void) const
 
std::vector< std::string > GetNamesOfInterfacesProvided (void) const
 
std::vector< std::string > GetNamesOfInterfacesOutput (void) const
 
std::vector< std::string > GetNamesOfInterfacesRequiredOrInput (void) const
 
std::vector< std::string > GetNamesOfInterfacesRequired (void) const
 
std::vector< std::string > GetNamesOfInterfacesInput (void) const
 
- Public Member Functions inherited from cmnGenericObject
virtual ~cmnGenericObject (void)
 
virtual const
cmnClassServicesBase
Services (void) const =0
 
bool ReconstructFrom (const cmnGenericObject &other)
 
std::string ToString (void) const
 
virtual void ToStreamRaw (std::ostream &outputStream, const char delimiter= ' ', bool headerOnly=false, const std::string &headerPrefix="") const
 
virtual bool FromStreamRaw (std::istream &inputStream, const char delimiter= ' ')
 
virtual void SerializeRaw (std::ostream &outputStream) const
 
virtual void DeSerializeRaw (std::istream &inputStream)
 
virtual size_t ScalarNumber (void) const
 
virtual bool ScalarNumberIsFixed (void) const
 
virtual double Scalar (const size_t CMN_UNUSED(index)) const throw (std::out_of_range)
 
virtual std::string ScalarDescription (const size_t CMN_UNUSED(index), const std::string &CMN_UNUSED(userDescription)) const
 
- Public Member Functions inherited from osaPuck
 osaPuck ()
 Default constructor. More...
 
 osaPuck (osaPuck::ID id, osaCANBus *can, bool createfilter=true)
 Create a puck with an ID and a CAN device. More...
 
osaPuck::ID GetID () const
 Return the puck ID. More...
 
Barrett::Value GroupIndex () const
 Return the index of the puck within its group. More...
 
Barrett::Value IpNm () const
 Return the motor Amp/Nm constant. More...
 
Barrett::Value CountsPerRevolution () const
 Return the encoder counts/revolution constant. More...
 
osaPuck::Errno InitializeMotor ()
 Perform the initial configuration. More...
 
osaPuck::Errno InitializeSM ()
 Perform the initial configuration. More...
 
osaPuck::Errno SetMode (Barrett::Value mode)
 
osaPuck::Errno GetMode (Barrett::Value &mode)
 
osaPuck::Errno GetGroupA ()
 
osaPuck::Errno GetGroupB ()
 
osaPuck::Errno GetGroupC ()
 
osaPuck::Errno SetGroupA (Barrett::Value A)
 
osaPuck::Errno SetGroupB (Barrett::Value B)
 
osaPuck::Errno SetGroupC (Barrett::Value C)
 
osaPuck::Errno GetStatus (Barrett::Value &status)
 
osaPuck::Errno GetCountsPerRev ()
 
osaPuck::Errno GetIpNm ()
 
osaPuck::Errno GetGroupIndex ()
 
osaPuck::Errno GetMembership ()
 
osaPuck::Errno IgnoreFault (Barrett::Value fault)
 
osaPuck::Errno SetVelocityWarning (Barrett::Value vw)
 
osaPuck::Errno SetVelocityFault (Barrett::Value vf)
 
osaPuck::Errno SetTorqueWarning (Barrett::Value tw)
 
osaPuck::Errno SetTorqueFault (Barrett::Value tf)
 
osaPuck::Errno GetProperty (Barrett::ID id, Barrett::Value &value)
 Query the puck for a property ID. More...
 
osaPuck::Errno SetProperty (Barrett::ID propid, Barrett::Value propval, bool verify)
 Set the puck property ID to a value. More...
 
osaPuck::Errno Reset ()
 Reset the firmware. More...
 
osaPuck::Errno Ready ()
 Set the status to ready. More...
 
osaPuck::Errno SetPosition (double q)
 
osaPuck::Errno GetPosition (Barrett::Value &position)
 
osaPuck::Errno UnpackCANFrame (const osaCANBusFrame &canframe, Barrett::ID &id, Barrett::Value &value)
 unpack a CAN frame More...
 

Protected Attributes

mtsInterfaceProvidedio
 The input/output interface. More...
 
mtsInterfaceProvidedctl
 The control interface. More...
 
- Protected Attributes inherited from mtsComponent
std::string Name
 
mtsComponentState State
 
mtsInterfaceProvidedInterfaceProvidedToManager
 
bool UseSeparateLogFileFlag
 
cmnLogger::StreamBufTypeLoDMultiplexerStreambuf
 
std::ofstream * LogFile
 
StateTableMapType StateTables
 
mtsManagerComponentServicesManagerComponentServices
 
mtsFunctionWrite EventGeneratorChangeState
 
bool ReplayMode
 
InterfacesProvidedMapType InterfacesProvided
 
InterfacesOutputMapType InterfacesOutput
 
InterfacesRequiredMapType InterfacesRequired
 
InterfacesInputMapType InterfacesInput
 

Additional Inherited Members

- Public Types inherited from mtsComponent
typedef mtsComponent ThisType
 
- Public Types inherited from osaPuck
enum  ID {
  PUCK_ID1 =1, PUCK_ID2 =2, PUCK_ID3 =3, PUCK_ID4 =4,
  PUCK_ID5 =5, PUCK_ID6 =6, PUCK_ID7 =7, SAFETY_MODULE_ID =10,
  PUCK_IDF1 =11, PUCK_IDF2 =12, PUCK_IDF3 =13, PUCK_IDF4 =14
}
 Define the ID of a puck. More...
 
enum  Errno { ESUCCESS, EFAILURE }
 Error values. More...
 
- Static Public Member Functions inherited from osaPuck
static osaPuck::ID OriginID (osaCANBusFrame::ID id)
 Return the origin ID of the CAN id. More...
 
static osaPuck::ID OriginID (const osaCANBusFrame &canframe)
 Return the origin ID of the CAN frame. More...
 
static osaPuck::ID DestinationID (osaCANBusFrame::ID id)
 Return the destination ID of the CAN id. More...
 
static osaPuck::ID DestinationID (const osaCANBusFrame &canframe)
 Return the destination ID of the CAN frame. More...
 
- Static Public Attributes inherited from osaPuck
static const Barrett::Value STATUS_RESET = 0
 Define the modes of a puck. More...
 
static const Barrett::Value STATUS_READY = 2
 
static const Barrett::Value MODE_IDLE = 0
 Define the status of a puck. More...
 
static const Barrett::Value MODE_TORQUE = 2
 
static const Barrett::Value MODE_POSITION = 3
 
static const Barrett::Value MODE_PID = 3
 
static const Barrett::Value MODE_VELOCITY = 4
 
static const Barrett::Value MODE_TRAPEZOIDAL = 5
 
- Protected Types inherited from mtsComponent
typedef cmnNamedMap
< mtsStateTable
StateTableMapType
 
typedef cmnNamedMap
< mtsInterfaceProvided
InterfacesProvidedMapType
 
typedef cmnNamedMap
< mtsInterfaceOutput
InterfacesOutputMapType
 
typedef cmnNamedMap
< mtsInterfaceRequired
InterfacesRequiredMapType
 
typedef cmnNamedMap
< mtsInterfaceInput
InterfacesInputMapType
 
- Protected Member Functions inherited from mtsComponent
 mtsComponent (void)
 
 mtsComponent (const mtsComponent &other)
 
void Initialize (void)
 
mtsInterfaceRequiredAddInterfaceRequiredExisting (const std::string &interfaceRequiredName, mtsInterfaceRequired *interfaceRequired)
 
mtsInterfaceRequiredAddInterfaceRequiredUsingMailbox (const std::string &interfaceRequiredName, mtsMailBox *mailBox, mtsRequiredType required)
 
mtsInterfaceProvidedAddInterfaceProvidedUsingMailbox (const std::string &interfaceProvidedName, mtsMailBox *mailBox)
 
mtsInterfaceInputAddInterfaceInputExisting (const std::string &interfaceInputName, mtsInterfaceInput *interfaceInput)
 
mtsInterfaceOutputAddInterfaceOutputExisting (const std::string &interfaceOutputName, mtsInterfaceOutput *interfaceOutput)
 
void KillSeparateLogFile (void)
 
virtual bool WaitForState (mtsComponentState desiredState, double timeout)
 
size_t ProcessMailBoxes (InterfacesProvidedMapType &interfaces)
 
size_t ProcessQueuedCommands (void)
 
size_t ProcessQueuedEvents (void)
 
mtsInterfaceRequiredEnableDynamicComponentManagement (void)
 Enable support for dynamic component management services. More...
 
bool AddInterfaceInternal (const bool useMangerComponentServices=false)
 Add internal interfaces. More...
 
void InterfaceInternalCommands_GetEndUserInterface (const mtsEndUserInterfaceArg &argin, mtsEndUserInterfaceArg &argout)
 
void InterfaceInternalCommands_AddObserverList (const mtsEventHandlerList &argin, mtsEventHandlerList &argout)
 
void InterfaceInternalCommands_RemoveEndUserInterface (const mtsEndUserInterfaceArg &argin, mtsEndUserInterfaceArg &argout)
 
void InterfaceInternalCommands_RemoveObserverList (const mtsEventHandlerList &argin, mtsEventHandlerList &argout)
 
void InterfaceInternalCommands_ComponentCreate (const mtsDescriptionComponent &componentDescription, bool &result)
 
void InterfaceInternalCommands_ComponentStartOther (const mtsComponentStatusControl &arg)
 

Constructor & Destructor Documentation

mtsPuck::mtsPuck ( const std::string &  componentname,
osaPuck::ID  id,
osaCANBus can 
)

Member Data Documentation

mtsInterfaceProvided* mtsPuck::ctl
protected

The control interface.

mtsInterfaceProvided* mtsPuck::io
protected

The input/output interface.


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