Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members

ClientDevice Class Reference

Any of a number of different devices that might be attached to a ClientBase, including trackers, etc. More...

#include <clientDevice.h>

Inheritance diagram for ClientDevice:


Public Member Functions
virtual	~ClientDevice ()
	We don't actually call disconnect() at the ClientDevice level destructor, because by the time we get here we're already partly destructed.
ClientBase *	get_client () const
	Returns the ClientBase this device is associated with.
TypeHandle	get_device_type () const
	Returns the type of device this is considered to be to the ClientBase: a ClientTrackerDevice, ClientAnalogDevice, or what have you.
const string &	get_device_name () const
	Returns the device name reported to the ClientBase.
bool	is_connected () const
	Returns true if the device is still connected to its ClientBase, false otherwise.
void	disconnect ()
	Disconnects the ClientDevice from its ClientBase object.
void	poll ()
	Causes the connected ClientBase to poll all of its clients, if necessary.
void	lock ()
	Grabs the mutex associated with this particular device.
void	unlock ()
	Releases the mutex associated with this particular device.
virtual void	output (ostream &out) const
virtual void	write (ostream &out, int indent_level=0) const
virtual TypeHandle	get_type () const
virtual TypeHandle	force_init_type ()
int	get_type_index () const
	Returns the internal index number associated with this object's TypeHandle, a unique number for each different type.
bool	is_of_type (TypeHandle handle) const
	Returns true if the current object is or derives from the indicated type.
bool	is_exact_type (TypeHandle handle) const
	Returns true if the current object is the indicated type exactly.
int	get_ref_count () const
	Returns the current reference count.
int	ref () const
	Explicitly increments the reference count.
int	unref () const
	Explicitly decrements the reference count.
void	test_ref_count_integrity () const
	Does some easy checks to make sure that the reference count isn't completely bogus.
Static Public Member Functions
TypeHandle	get_class_type ()
void	init_type ()
Protected Member Functions
	ClientDevice (ClientBase *client, TypeHandle device_type, const string &device_name)
Private Attributes
ClientBase *	_client
TypeHandle	_device_type
string	_device_name
bool	_is_connected
Static Private Attributes
TypeHandle	_type_handle
Friends
class	ClientBase

Detailed Description

Any of a number of different devices that might be attached to a ClientBase, including trackers, etc.

This is an abstract interface; the actual implementations are in ClientTrackerDevice, etc.

Definition at line 48 of file clientDevice.h.

Constructor & Destructor Documentation

ClientDevice::ClientDevice ( ClientBase * client,

TypeHandle device_type,

const string & device_name

) [protected]

Definition at line 38 of file clientDevice.cxx.
References _client, _is_connected, and ReferenceCount::ref().

ClientDevice::~ClientDevice ( ) [virtual]

We don't actually call disconnect() at the ClientDevice level destructor, because by the time we get here we're already partly destructed.
Instead, we should call disconnect() from each specific kind of derived class.
Definition at line 67 of file clientDevice.cxx.
References _client, _device_name, _device_type, _is_connected, ClientBase::disconnect_device(), lock(), nassertv, and unlock().

Member Function Documentation

void ClientDevice::disconnect ( )

Disconnects the ClientDevice from its ClientBase object.
The device will stop receiving updates.
Normally, you should not need to call this explicitly (and it is probably a mistake to do so); it will automatically be called when the ClientDevice object destructs.
The lock should *not* be held while this call is made; it will explicitly grab the lock itself.
Definition at line 103 of file clientDevice.cxx.

virtual TypeHandle ClientDevice::force_init_type ( void ) [inline, virtual]

Reimplemented from TypedReferenceCount.
Reimplemented in ClientAnalogDevice, ClientButtonDevice, ClientDialDevice, ClientTrackerDevice, VrpnAnalogDevice, VrpnButtonDevice, VrpnDialDevice, and VrpnTrackerDevice.
Definition at line 92 of file clientDevice.h.

TypeHandle ClientDevice::get_class_type ( void ) [inline, static]

Reimplemented from TypedReferenceCount.
Reimplemented in ClientAnalogDevice, ClientButtonDevice, ClientDialDevice, ClientTrackerDevice, VrpnAnalogDevice, VrpnButtonDevice, VrpnDialDevice, and VrpnTrackerDevice.
Definition at line 81 of file clientDevice.h.
Referenced by ClientTrackerDevice::get_class_type(), and ClientTrackerDevice::init_type().

ClientBase * ClientDevice::get_client ( ) const [inline]

Returns the ClientBase this device is associated with.

Definition at line 34 of file clientDevice.I.
References _is_connected, and INLINE.

const string & ClientDevice::get_device_name ( ) const [inline]

Returns the device name reported to the ClientBase.
This has some implementation-defined meaning to identify particular devices.
Definition at line 91 of file clientDevice.I.
References INLINE.
Referenced by ClientAnalogDevice::ensure_control_index().

TypeHandle ClientDevice::get_device_type ( ) const [inline]

Returns the type of device this is considered to be to the ClientBase: a ClientTrackerDevice, ClientAnalogDevice, or what have you.
This is not exactly the same thing as get_type(), because it does not return the exact type of the ClientDevice (e.g. it reports ClientTrackerDevice, not VrpnTrackerDevice).
Definition at line 74 of file clientDevice.I.
References INLINE.

int ReferenceCount::get_ref_count ( ) const [inline, inherited]

Returns the current reference count.

Definition at line 183 of file referenceCount.I.
Referenced by RenderState::determine_bin_index(), RenderEffects::determine_show_bounds(), FontPool::ns_garbage_collect(), TexturePool::ns_garbage_collect(), MaterialPool::ns_get_material(), and TexturePool::ns_release_texture().

virtual TypeHandle ClientDevice::get_type ( void ) const [inline, virtual]

Reimplemented from TypedReferenceCount.
Reimplemented in ClientAnalogDevice, ClientButtonDevice, ClientDialDevice, ClientTrackerDevice, VrpnAnalogDevice, VrpnButtonDevice, VrpnDialDevice, and VrpnTrackerDevice.
Definition at line 89 of file clientDevice.h.

int TypedObject::get_type_index ( ) const [inline, inherited]

Returns the internal index number associated with this object's TypeHandle, a unique number for each different type.
This is equivalent to get_type().get_index().
Definition at line 71 of file typedObject.I.
References TypeHandle::get_name(), TypedObject::get_type(), and INLINE.

void ClientDevice::init_type ( void ) [inline, static]

Reimplemented from TypedReferenceCount.
Reimplemented in ClientAnalogDevice, ClientButtonDevice, ClientDialDevice, ClientTrackerDevice, VrpnAnalogDevice, VrpnButtonDevice, VrpnDialDevice, and VrpnTrackerDevice.
Definition at line 84 of file clientDevice.h.
Referenced by ClientTrackerDevice::init_type().

bool ClientDevice::is_connected ( ) const [inline]

Returns true if the device is still connected to its ClientBase, false otherwise.

Definition at line 49 of file clientDevice.I.
References _device_type, and INLINE.

bool TypedObject::is_exact_type ( TypeHandle handle ) const [inline, inherited]

Returns true if the current object is the indicated type exactly.

Definition at line 101 of file typedObject.I.
Referenced by PT(), and CollisionNode::xform().

bool TypedObject::is_of_type ( TypeHandle handle ) const [inline, inherited]

Returns true if the current object is or derives from the indicated type.

Definition at line 86 of file typedObject.I.
Referenced by EggMaterialCollection::collapse_equivalent_materials(), EggTextureCollection::collapse_equivalent_textures(), DeferredNodeProperty::compose(), AnimBundleMaker::create_s_channel(), CharacterMaker::create_slider(), ProjectionScreen::cull_callback(), DataNode::define_output(), EggNode::determine_draw_order(), CharacterMaker::egg_to_index(), EggGroupUniquifier::EggGroupUniquifier(), EggPoolUniquifier::EggPoolUniquifier(), EggGroupNode::find_textures(), StaticTextFont::get_glyph(), EggMaterialCollection::insert_materials(), EggTextureCollection::insert_textures(), CharacterJoint::make_copy(), PT(), EggGroupNode::r_flatten_transforms(), EggGroupNode::r_transform_vertices(), EggGroupNode::recompute_polygon_normals(), CollisionLevelState::reserve(), PandaFramework::reset_frame_rate(), PandaFramework::set_texture(), EggGroupNode::steal_children(), and DataGraphTraverser::traverse().

void ClientDevice::lock ( ) [inline]

Grabs the mutex associated with this particular device.
The device will not update asynchronously while the mutex is held, allowing the user to copy the data out without fear of getting a partial update during the copy.
Definition at line 112 of file clientDevice.I.
Referenced by VrpnTracker::vrpn_position_callback(), VrpnTracker::vrpn_velocity_callback(), and ~ClientDevice().

void ClientDevice::output ( ostream & out ) const [virtual]

Reimplemented in ClientButtonDevice.
Definition at line 147 of file clientDevice.cxx.

void ClientDevice::poll ( )

Causes the connected ClientBase to poll all of its clients, if necessary.
This will be a no-op if the client is running in forked mode, or if it has already polled everything this frame.
This should generally be called before accessing the data in this ClientDevice to ensure that it is fresh.
Definition at line 135 of file clientDevice.cxx.

int ReferenceCount::ref ( ) const [inline, inherited]

Explicitly increments the reference count.
User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically.
This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.
The return value is the new reference count.
Definition at line 225 of file referenceCount.I.
Referenced by ClientDevice(), EggGroupNode::find_textures(), EggGroupNode::r_apply_texmats(), EggGroupNode::r_flatten_transforms(), and EggGroupNode::reverse_vertex_ordering().

void ReferenceCount::test_ref_count_integrity ( ) const [inline, inherited]

Does some easy checks to make sure that the reference count isn't completely bogus.

Definition at line 328 of file referenceCount.I.
References INLINE.
Referenced by EggNode::determine_bin(), and ReferenceCount::~ReferenceCount().

void ClientDevice::unlock ( ) [inline]

Releases the mutex associated with this particular device.
This should be called after all the data has been successfully copied out. See lock().
Definition at line 131 of file clientDevice.I.
Referenced by VrpnTracker::vrpn_position_callback(), VrpnTracker::vrpn_velocity_callback(), and ~ClientDevice().

int ReferenceCount::unref ( ) const [inline, inherited]

Explicitly decrements the reference count.
Note that the object will not be implicitly deleted by unref() simply because the reference count drops to zero. (Having a member function delete itself is problematic; plus, we don't have a virtual destructor anyway.) However, see the helper function unref_delete().
User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically.
This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.
The return value is the new reference count.
Definition at line 293 of file referenceCount.I.
References INLINE.
Referenced by RenderState::determine_bin_index(), and RenderEffects::determine_show_bounds().

void ClientDevice::write ( ostream & out,

int indent_level = 0

) const [virtual]

Reimplemented in ClientAnalogDevice, and ClientButtonDevice.
Definition at line 159 of file clientDevice.cxx.

Friends And Related Function Documentation

friend class ClientBase [friend]

Definition at line 97 of file clientDevice.h.

Member Data Documentation

ClientBase* ClientDevice::_client [private]

Definition at line 71 of file clientDevice.h.
Referenced by ClientDevice(), and ~ClientDevice().

string ClientDevice::_device_name [private]

Definition at line 73 of file clientDevice.h.
Referenced by ~ClientDevice().

TypeHandle ClientDevice::_device_type [private]

Definition at line 72 of file clientDevice.h.
Referenced by is_connected(), and ~ClientDevice().

bool ClientDevice::_is_connected [private]

Definition at line 74 of file clientDevice.h.
Referenced by ClientDevice(), get_client(), and ~ClientDevice().

TypeHandle ClientDevice::_type_handle [static, private]

Reimplemented from TypedReferenceCount.
Reimplemented in ClientAnalogDevice, ClientButtonDevice, ClientDialDevice, ClientTrackerDevice, VrpnAnalogDevice, VrpnButtonDevice, VrpnDialDevice, and VrpnTrackerDevice.
Definition at line 28 of file clientDevice.cxx.

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

panda/src/device/clientDevice.h
panda/src/device/clientDevice.cxx
panda/src/device/clientDevice.I

Generated on Fri May 2 00:48:23 2003 for Panda by

1.3

ClientDevice Class Reference

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Static Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation