vreckoDP_base::NestOfBirds Class Reference

#include <NestOfBirds.h>

Inheritance diagram for vreckoDP_base::NestOfBirds:

Public Member Functions
	NestOfBirds ()
	NestOfBirds (const char *_port_number)
	~NestOfBirds ()
virtual int	openDevice (void)
	Opens device and performs the initialization routines. More...
int	closeDevice (void)
	Closes device. More...
void	update (void)
	Updates the device - scan device and send required outputs. More...
bool	loadXMLParameters (XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *pParametersNode)
	OBSOLETE METHOD, kept for backwards compatibility. More...
XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *	saveXMLParameters (XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *)
	Save current setting into a XML node. More...
int	getRotate (float *p_rotate)
osg::Vec3 &	getRotate (void)
osg::Vec3 &	getRotateA (void)
osg::Matrix &	getRotateM (void)
osg::Quat &	getRotateQ (void)
int	getTranslate (float *p_trans)
osg::Vec3 &	getTranslate (void)
void	setInitialPosition (osg::Vec4 &_pos)
void	setInitialRotation (osg::Vec4 &_rot)
void	setInitialPosition (osg::Vec4 &_pos1, osg::Vec4 &_pos2)
void	setInitialRotation (osg::Vec4 &_rot1, osg::Vec4 &_rot2)
void	setOriginPosition (float _nx, float _ny, float _nz)
osg::Vec3	getOriginPosition (void)
void	setTranslateMapping (float _nx, float _ny, float _nz)
osg::Vec3	getTranslateMapping (void)
Public Member Functions inherited from vrecko::Device
	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	calibrateDevice (void)
	Device calibration. More...
virtual const std::string	getCalibrationString (void)
	Returns the description of the calibration process. 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...
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 VreckoMessage *	processRequest (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 (const char *xmlString)
	OBSOLETE METHOD, kept for backwards compatibility. More...
InputPinBase *	getInputPin (const char *strName)
	Returns pointer to an input pin with specified name. More...
OutputPinBase *	getOutputPin (const char *strName)
	Returns pointer to an output pin with specified name. More...
RequestInputPinBase *	getRequestInputPin (const char *strName)
	Returns pointer to an request input pin with specified name. More...
RequestOutputPinBase *	getRequestOutputPin (const char *strName)
	Returns pointer to an input pin with specified name. More...

Protected Member Functions
int	scanDevice (void)
bool	openSocket (void)
bool	scanDeviceX (void)
	DECLARE_OUTPUT (Position_sensor_0, vrecko::MessageVec3)
	DECLARE_OUTPUT (Orientation_sensor_0, vrecko::MessageQuat)
	DECLARE_OUTPUT (Position_sensor_1, vrecko::MessageVec3)
	DECLARE_OUTPUT (Orientation_sensor_1, vrecko::MessageQuat)
	DECLARE_OUTPUT (Position_sensor_2, vrecko::MessageVec3)
	DECLARE_OUTPUT (Orientation_sensor_2, vrecko::MessageQuat)
	DECLARE_OUTPUT (Position_sensor_3, vrecko::MessageVec3)
	DECLARE_OUTPUT (Orientation_sensor_3, vrecko::MessageQuat)

Protected Attributes
std::string	_hostname
int	_port
char	_buf [BUFSIZE]
int	sockfd
struct sockaddr_in	sockname
int	length
osg::Vec3	_translate [4]
osg::Vec3	_ret_translate [4]
osg::Quat	_rotate [4]
osg::Quat	_ret_rotate [4]
osg::Vec3	_origin_pos
osg::Vec3	_trans_mapp
vrecko::EventDispatcher *	pEventDispatcher
Protected Attributes inherited from vrecko::Device
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

Constructor & Destructor Documentation

NestOfBirds::NestOfBirds

(

)

NestOfBirds::NestOfBirds

(

const char *

_port_number

)

NestOfBirds::~NestOfBirds

(

)

Member Function Documentation

int NestOfBirds::closeDevice ( void  )

virtual

Closes device.

Implements vrecko::Device.

vreckoDP_base::NestOfBirds::DECLARE_OUTPUT ( Position_sensor_0  , vrecko::MessageVec3    )

protected

vreckoDP_base::NestOfBirds::DECLARE_OUTPUT ( Orientation_sensor_0  , vrecko::MessageQuat    )

protected

vreckoDP_base::NestOfBirds::DECLARE_OUTPUT ( Position_sensor_1  , vrecko::MessageVec3    )

protected

vreckoDP_base::NestOfBirds::DECLARE_OUTPUT ( Orientation_sensor_1  , vrecko::MessageQuat    )

protected

vreckoDP_base::NestOfBirds::DECLARE_OUTPUT ( Position_sensor_2  , vrecko::MessageVec3    )

protected

vreckoDP_base::NestOfBirds::DECLARE_OUTPUT ( Orientation_sensor_2  , vrecko::MessageQuat    )

protected

vreckoDP_base::NestOfBirds::DECLARE_OUTPUT ( Position_sensor_3  , vrecko::MessageVec3    )

protected

vreckoDP_base::NestOfBirds::DECLARE_OUTPUT ( Orientation_sensor_3  , vrecko::MessageQuat    )

protected

osg::Vec3 vreckoDP_base::NestOfBirds::getOriginPosition ( void  )

inline

int vreckoDP_base::NestOfBirds::getRotate

(

float *

p_rotate

)

osg::Vec3& vreckoDP_base::NestOfBirds::getRotate

(

void

)

osg::Vec3& vreckoDP_base::NestOfBirds::getRotateA

(

void

)

osg::Matrix& vreckoDP_base::NestOfBirds::getRotateM

(

void

)

osg::Quat & NestOfBirds::getRotateQ

(

void

)

int vreckoDP_base::NestOfBirds::getTranslate

(

float *

p_trans

)

osg::Vec3 & NestOfBirds::getTranslate

(

void

)

osg::Vec3 vreckoDP_base::NestOfBirds::getTranslateMapping ( void  )

inline

bool NestOfBirds::loadXMLParameters ( XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *  )

virtual

OBSOLETE METHOD, kept for backwards compatibility.

The preInitialize(), loadXMLParameters() and postInitialize() methods were replaced in 2011 by a single method initialize().

Parameters

*	(XERCES_CPP_NAMESPACE_QUALIFIER DOMNode)

Returns

(bool)

Reimplemented from vrecko::BaseClass.

int NestOfBirds::openDevice ( void  )

virtual

Opens device and performs the initialization routines.

Implements vrecko::Device.

bool NestOfBirds::openSocket ( void  )

protected

XERCES_CPP_NAMESPACE_QUALIFIER DOMNode * NestOfBirds::saveXMLParameters ( XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *  )

virtual

Save current setting into a XML node.

Warning

Currently not supported. It is safe to leave it without overriding.

Parameters

*	(XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument)

Returns

(XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *)

Reimplemented from vrecko::BaseClass.

int NestOfBirds::scanDevice ( void  )

protected

bool vreckoDP_base::NestOfBirds::scanDeviceX ( void  )

protected

void vreckoDP_base::NestOfBirds::setInitialPosition

(

osg::Vec4 &

_pos

)

void vreckoDP_base::NestOfBirds::setInitialPosition	(	osg::Vec4 &	_pos1,
		osg::Vec4 &	_pos2
	)

void vreckoDP_base::NestOfBirds::setInitialRotation

(

osg::Vec4 &

_rot

)

void vreckoDP_base::NestOfBirds::setInitialRotation	(	osg::Vec4 &	_rot1,
		osg::Vec4 &	_rot2
	)

void vreckoDP_base::NestOfBirds::setOriginPosition ( float  _nx, float  _ny, float  _nz  )

inline

void vreckoDP_base::NestOfBirds::setTranslateMapping ( float  _nx, float  _ny, float  _nz  )

inline

void NestOfBirds::update ( void  )

virtual

Updates the device - scan device and send required outputs.

Implements vrecko::Device.

Member Data Documentation

char vreckoDP_base::NestOfBirds::_buf[BUFSIZE]

protected

std::string vreckoDP_base::NestOfBirds::_hostname

protected

osg::Vec3 vreckoDP_base::NestOfBirds::_origin_pos

protected

int vreckoDP_base::NestOfBirds::_port

protected

osg::Quat vreckoDP_base::NestOfBirds::_ret_rotate[4]

protected

osg::Vec3 vreckoDP_base::NestOfBirds::_ret_translate[4]

protected

osg::Quat vreckoDP_base::NestOfBirds::_rotate[4]

protected

osg::Vec3 vreckoDP_base::NestOfBirds::_trans_mapp

protected

osg::Vec3 vreckoDP_base::NestOfBirds::_translate[4]

protected

int vreckoDP_base::NestOfBirds::length

protected

vrecko::EventDispatcher* vreckoDP_base::NestOfBirds::pEventDispatcher

protected

int vreckoDP_base::NestOfBirds::sockfd

protected

struct sockaddr_in vreckoDP_base::NestOfBirds::sockname

protected

---

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

• C:/Documents/School/OSG/VRECKO/include/vreckoDP/base/NestOfBirds.h
• C:/Documents/School/OSG/VRECKO/src/vreckoDP/base/NestOfBirds.cpp