# VrpnClient

from pandac.PandaModules import VrpnClient

Class : VrpnClient
Description : A specific ClientBase that connects to a VRPN server and records information on the connected VRPN devices.

## Inheritance:

VrpnClient: ClientBase
ClientBase: TypedReferenceCount
TypedReferenceCount: TypedObject ReferenceCount
TypedObject: MemoryBase
MemoryBase:
ReferenceCount: MemoryBase

## Methods of VrpnClient:

getClassType
getServerName
isConnected
isValid
write

## Methods of ClientBase:

forkAsynchronousThread
getClassType
getCoordinateSystem
getLastPollTime
isForked
poll
setCoordinateSystem

## Methods of TypedReferenceCount:

getClassType

## Methods of TypedObject:

getClassType
getType
getTypeIndex
isExactType
isOfType

## Methods of ReferenceCount:

getClassType
getRefCount
ref
testRefCountIntegrity
testRefCountNonzero
unref

getClassType static TypeHandle VrpnClient::get_class_type(void); Undocumented function.

getServerName string const &VrpnClient::get_server_name(void) const; Filename: vrpnClient.I Created by: jason (04Aug00) PANDA 3D SOFTWARE Copyright (c) 2001 - 2004, Disney Enterprises, Inc. All rights reserved All use of this software is subject to the terms of the Panda 3d Software license. You should have received a copy of this license along with this source code; you will also find a current copy of the license at http://etc.cmu.edu/panda3d/docs/license/ . To contact the maintainers of this program write to panda3d-general@lists.sourceforge.net . Description: Returns the name of the server as passed to the VrpnClient constructor.

isConnected bool VrpnClient::is_connected(void) const; Description: Returns true if the connection is established succesfully, false otherwise.

isValid bool VrpnClient::is_valid(void) const; Description: Returns true if everything seems to be kosher with the server (even if there is no connection), or false otherwise.

write void VrpnClient::write(ostream &out, int indent_level = (0)) const; Description: Writes a list of the active devices that the VrpnClient is currently polling each frame.

forkAsynchronousThread bool ClientBase::fork_asynchronous_thread(double poll_time); Description: Forks a separate thread to do all the polling of connected devices. The forked thread will poll after every poll_time seconds has elapsed. Returns true if the fork was successful, or false otherwise (for instance, because we were already forked, or because asynchronous threads are disabled).

getClassType static TypeHandle ClientBase::get_class_type(void); Undocumented function.

getCoordinateSystem CoordinateSystem ClientBase::get_coordinate_system(void) const; Description: Returns the coordinate system that all devices associated with this client will operate in. Normally, this is CS_default.

getLastPollTime double ClientBase::get_last_poll_time(void) const; Description: Returns the time (according to the global ClockObject's get_real_time() method) of the last device poll.

isForked bool ClientBase::is_forked(void) const; Filename: clientBase.I Created by: drose (25Jan01) PANDA 3D SOFTWARE Copyright (c) 2001 - 2004, Disney Enterprises, Inc. All rights reserved All use of this software is subject to the terms of the Panda 3d Software license. You should have received a copy of this license along with this source code; you will also find a current copy of the license at http://etc.cmu.edu/panda3d/docs/license/ . To contact the maintainers of this program write to panda3d-general@lists.sourceforge.net . Description: Returns true if the ClientBase has been forked (and, therefore, poll() does not need to be called), false otherwise.

poll bool ClientBase::poll(void); Description: Initiates a poll of the client devices, if we are not forked and if we have not already polled this frame. Returns true if the poll occurred, or false if it did not.

setCoordinateSystem void ClientBase::set_coordinate_system(CoordinateSystem cs); Description: Specifies the coordinate system that all devices associated with this client will operate in. Normally, this is CS_default.

getClassType static TypeHandle TypedReferenceCount::get_class_type(void); Undocumented function.

getClassType static TypeHandle TypedObject::get_class_type(void); Undocumented function.

getType virtual TypeHandle TypedObject::get_type(void) const = 0; Derived classes should override this function to return get_class_type().

getTypeIndex int TypedObject::get_type_index(void) const; Description: 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().

isExactType bool TypedObject::is_exact_type(TypeHandle handle) const; Description: Returns true if the current object is the indicated type exactly.

isOfType bool TypedObject::is_of_type(TypeHandle handle) const; Description: Returns true if the current object is or derives from the indicated type.

getClassType static TypeHandle ReferenceCount::get_class_type(void); Undocumented function.

getRefCount int ReferenceCount::get_ref_count(void) const; Description: Returns the current reference count.

ref void ReferenceCount::ref(void) const; Description: 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.

testRefCountIntegrity bool ReferenceCount::test_ref_count_integrity(void) const; Description: Does some easy checks to make sure that the reference count isn't completely bogus. Returns true if ok, false otherwise.

testRefCountNonzero bool ReferenceCount::test_ref_count_nonzero(void) const; Description: Does some easy checks to make sure that the reference count isn't zero, or completely bogus. Returns true if ok, false otherwise.

unref bool ReferenceCount::unref(void) const; Description: 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 true if the new reference count is nonzero, false if it is zero.