Main Page   Modules   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

OSCAR::RoboworksInterface Class Reference
[Device]

#include <RoboworksInterface.h>

Inheritance diagram for OSCAR::RoboworksInterface:

Inheritance graph
[legend]
List of all members.

Public Methods

 RoboworksInterface (const String &_roboworksFile, unsigned int _numberOfTags, const char **_tagNames, const String &_ipAddress=SELF, OSCARError &err=DUMMY_ERROR(noError))
virtual ~RoboworksInterface ()
virtual bool Initialize ()
virtual bool Close ()

Protected Methods

virtual bool getPosition (VectorF &tagValues)
virtual bool setPosition (const VectorF &tagValues)

Protected Attributes

String roboworksFile
String ipAddress
unsigned int numberOfTags
char ** tagNames

Constructor & Destructor Documentation

OSCAR::RoboworksInterface::RoboworksInterface (  const String &    _roboworksFile,
unsigned int    _numberOfTags,
const char **    _tagNames,
const String &    _ipAddress = SELF,
OSCARError &    err = DUMMY_ERROR(noError)
) 
 

virtual OSCAR::RoboworksInterface::~RoboworksInterface (    )  [virtual]
 

Member Function Documentation

virtual bool OSCAR::RoboworksInterface::Close (    )  [virtual]
 

Generic close device function, could be overriden and implemented according to specific application in derivative class. This function provides a method to close a device after finishing use it. "isClosed" is false if this function is not executed.

Returns:
true if the device close succeed. false if device close failed. Call GetError() to get detailed error information
See also:
~Device()

Reimplemented from OSCAR::Device.

Reimplemented in OSCAR::PCRoboworksInterface.

virtual bool OSCAR::RoboworksInterface::getPosition (  VectorF &    tagValues )  [protected, virtual]
 

Reimplemented from OSCAR::RobotServoInterface.

Reimplemented in OSCAR::PCRoboworksInterface.

virtual bool OSCAR::RoboworksInterface::Initialize (    )  [virtual]
 

Generic initialize function, could be overriden and implemented according to specific application in derivative class This function must be called every time after an object is created, otherwise an error will happen which indicates not initialized.

In derived classes, check must be done to see if data member"isInitialized" is true in member functions in order to judge whether initialize has been executed.

Returns:
true if initialization succeeds. false if initialization fails. Call GetError() to get detailed error information

Reimplemented from OSCAR::Device.

Reimplemented in OSCAR::PCRoboworksInterface.

virtual bool OSCAR::RoboworksInterface::setPosition (  const VectorF &    tagValues )  [protected, virtual]
 

Reimplemented from OSCAR::RobotServoInterface.

Reimplemented in OSCAR::PCRoboworksInterface.

Member Data Documentation

String OSCAR::RoboworksInterface::ipAddress [protected]
 

unsigned int OSCAR::RoboworksInterface::numberOfTags [protected]
 

String OSCAR::RoboworksInterface::roboworksFile [protected]
 

char** OSCAR::RoboworksInterface::tagNames [protected]
 

The documentation for this class was generated from the following file:
RRG Homepage OSCAR Overview OSCAR Tutorials Simulations