vrecko
virtual reality framework
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
vrecko::Device Class Referenceabstract

#include <Device.h>

Inheritance diagram for vrecko::Device:
vrecko::BaseClass vreckoDP_base::A3DBird vreckoDP_base::fdtDataGlove vreckoDP_base::fsPinchGlove vreckoDP_base::KeyboardMouse vreckoDP_base::LHeadTracker vreckoDP_base::MicroScribe3D vreckoDP_base::NestOfBirds vreckoDP_base::OptiTrack vreckoDP_base::Ultratrak vreckoDP_base::VRPN3DMouse vreckoDP_base::Wiimote vreckoDP_Kinect::Kinect

Public Member Functions

 Device (const char *startingDeviceName, const char *pname="")
 
virtual ~Device ()
 
int getID (void)
 Returns the ID of the device. More...
 
void setID (int new_id)
 Sets ID of the device. More...
 
const std::string & getDeviceType (void)
 Returns the type of the device. More...
 
void setPortName (const char *pname)
 Sets the port name for the device. More...
 
const char * getPortName (void)
 Returns port name of the device. More...
 
virtual int openDevice (void)=0
 Opens device and performs the initialization routines. More...
 
virtual int closeDevice (void)=0
 Closes device. More...
 
virtual int calibrateDevice (void)
 Device calibration. More...
 
virtual const std::string getCalibrationString (void)
 Returns the description of the calibration process. More...
 
virtual void update (void)=0
 Updates the device - scan device and send required outputs. More...
 
- Public Member Functions inherited from vrecko::BaseClass
 BaseClass (const char *startingSenderString)
 The main constructor. More...
 
 BaseClass (BaseClass &bc)
 Copy constructor. Probably not really used. More...
 
virtual ~BaseClass ()
 Destructor. More...
 
virtual bool initialize (XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *parameters=NULL)
 Core initialization. More...
 
virtual bool initializeFromString (const char *xmlString)
 Helper method that allows to initialize ability from a XML-formatted string. More...
 
virtual
XERCES_CPP_NAMESPACE_QUALIFIER
DOMNode
saveXMLParameters (XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *)
 Save current setting into a XML node. More...
 
bool inputPresent (const std::string &name)
 Returns true if input pin (not request inputpin ) with given name is present. More...
 
bool outputPresent (const std::string &name)
 Returns true if output pin (not request output pin) with given name is present. More...
 
void addInputPin (InputPinBase *pin)
 Adds an input pin. More...
 
void removeInputPin (InputPinBase *pin)
 Removes an input pin. More...
 
void addOutputPin (OutputPinBase *pin)
 Adds an output pin. More...
 
void removeOutputPin (OutputPinBase *pin)
 Removes and output pin. More...
 
void addRequestInputPin (RequestInputPinBase *pin)
 Adds a request input pin. More...
 
void removeRequestInputPin (RequestInputPinBase *pin)
 Removes a request input pin. More...
 
void addRequestOutputPin (RequestOutputPinBase *pin)
 Adds a request output pin. More...
 
void removeRequestOutputPin (RequestOutputPinBase *pin)
 Removes a request output pin. More...
 
bool addNotification (BaseClass *receiver, unsigned long notificationTypes)
 Registers an observer that will be notified if a specific change occurs. More...
 
bool removeNotification (BaseClass *receiver, unsigned long notificationTypes=NOTIFICATION_ALL)
 Unregisters a previously registered observer. More...
 
virtual void processEvent (const std::string &input_name, VreckoMessage *pMessage)
 Internal method for processing the events. More...
 
virtual VreckoMessageprocessRequest (const std::string &request_input_name, VreckoMessage *pMessage)
 Internal method for processing the requests. More...
 
virtual const std::string & getSenderString (void)
 Returns the sender (or receiver) identification string. More...
 
void reportError (const std::string &error)
 Print error message. More...
 
void setPriority (long int pr)
 Sets the priority. (Possible problems - read the full description for more info) More...
 
long int getPriority (void) const
 Returns current object priority. More...
 
void setAttribute (const std::string &attr_name, int attr_value)
 Sets an attribute value. More...
 
int getAttribute (const std::string &attr_name)
 Returns attribute value. More...
 
int getAttribute (const char *attr_name)
 Returns attribute value. More...
 
void deleteAttribute (const std::string &attr_name)
 Delete an attribute. More...
 
void setSceneFile (const std::string &sceneFileName)
 Set the name of the file this component was in (and possibly will be saved to). More...
 
const std::string & getSceneFile () const
 Get the name of the file this component was in. More...
 
virtual void preInitialize (void)
 OBSOLETE METHOD, kept for backwards compatibility. More...
 
virtual void postInitialize (void)
 OBSOLETE METHOD, kept for backwards compatibility. More...
 
virtual bool loadXMLParameters (XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *)
 OBSOLETE METHOD, kept for backwards compatibility. More...
 
virtual bool loadXMLParameters (const char *xmlString)
 OBSOLETE METHOD, kept for backwards compatibility. More...
 
InputPinBasegetInputPin (const char *strName)
 Returns pointer to an input pin with specified name. More...
 
OutputPinBasegetOutputPin (const char *strName)
 Returns pointer to an output pin with specified name. More...
 
RequestInputPinBasegetRequestInputPin (const char *strName)
 Returns pointer to an request input pin with specified name. More...
 
RequestOutputPinBasegetRequestOutputPin (const char *strName)
 Returns pointer to an input pin with specified name. More...
 

Protected Attributes

int id
 device ID More...
 
std::string device_type
 device type More...
 
std::string port_name
 name of the port More...
 
- Protected Attributes inherited from vrecko::BaseClass
AttributeMap attribute
 
MTReadWriteLock attributeLock
 
std::string senderString
 
MTLock notificationsLock
 
std::vector
< NOTIFICATION_DESCRIPTION
notifications
 
long int priority
 
const std::string * sceneFile
 
PinList inputPinsList
 
PinList outputPinsList
 
PinList requestInputPinsList
 
PinList requestOutputPinsList
 

Additional Inherited Members

- Public Types inherited from vrecko::BaseClass
enum  NotificationTypes {
  NOTIFICATION_DELETE_CLASS = 1, NOTIFICATION_EO_REGISTERING = 2, NOTIFICATION_EO_UNREGISTERING = 4, NOTIFICATION_PROGRAM_TERMINATION = 8,
  NOTIFICATION_ALL = 0xFFFFFFFF
}
 
- Protected Types inherited from vrecko::BaseClass
typedef std::map< std::string,
int > 
AttributeMap
 Attributes. More...
 
typedef std::vector
< osg::ref_ptr< IOPinBase > > 
PinList
 
- Protected Member Functions inherited from vrecko::BaseClass
bool sendNotifications (unsigned long notificationType, void *notificationData)
 
virtual int processNotification (BaseClass *sender, unsigned long notificationType, void *notificationData)
 Process an incoming notification. More...
 
IOPinBasefindPinInList (const char *strName, PinList *pinList)
 Internal method to find a given pin in a given list. More...
 

Detailed Description

Basic class for devices that are implemented in VRECKO.

Constructor & Destructor Documentation

Device::Device ( const char *  startingDeviceName,
const char *  pname = "" 
)
virtual vrecko::Device::~Device ( )
inlinevirtual

Member Function Documentation

virtual int vrecko::Device::calibrateDevice ( void  )
inlinevirtual
virtual const std::string vrecko::Device::getCalibrationString ( void  )
inlinevirtual

Returns the description of the calibration process.

const std::string& vrecko::Device::getDeviceType ( void  )
inline

Returns the type of the device.

int vrecko::Device::getID ( void  )
inline

Returns the ID of the device.

const char* vrecko::Device::getPortName ( void  )
inline

Returns port name of the device.

void Device::setID ( int  new_id)

Sets ID of the device.

void vrecko::Device::setPortName ( const char *  pname)
inline

Sets the port name for the device.

Member Data Documentation

std::string vrecko::Device::device_type
protected

device type

int vrecko::Device::id
protected

device ID

std::string vrecko::Device::port_name
protected

name of the port


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