Panda3D
Public Member Functions | Static Public Member Functions | List of all members
VrpnClient Class Reference

A specific ClientBase that connects to a VRPN server and records information on the connected VRPN devices. More...

#include "vrpnClient.h"

Inheritance diagram for VrpnClient:
ClientBase TypedReferenceCount TypedObject ReferenceCount MemoryBase MemoryBase

Public Member Functions

 VrpnClient (const std::string &server_name)
 
virtual TypeHandle force_init_type ()
 
const std::string & get_server_name () const
 Returns the name of the server as passed to the VrpnClient constructor. More...
 
virtual TypeHandle get_type () const
 
bool is_connected () const
 Returns true if the connection is established successfully, false otherwise. More...
 
bool is_valid () const
 Returns true if everything seems to be kosher with the server (even if there is no connection), or false otherwise. More...
 
void write (std::ostream &out, int indent_level=0) const
 Writes a list of the active devices that the VrpnClient is currently polling each frame. More...
 
- Public Member Functions inherited from ClientBase
bool fork_asynchronous_thread (double poll_time)
 Forks a separate thread to do all the polling of connected devices. More...
 
CoordinateSystem get_coordinate_system () const
 Returns the coordinate system that all devices associated with this client will operate in. More...
 
double get_last_poll_time () const
 Returns the time (according to the global ClockObject's get_real_time() method) of the last device poll. More...
 
bool is_forked () const
 Returns true if the ClientBase has been forked (and, therefore, poll() does not need to be called), false otherwise. More...
 
bool poll ()
 Initiates a poll of the client devices, if we are not forked and if we have not already polled this frame. More...
 
 PT (ClientDevice) get_device(TypeHandle device_type
 
void set_coordinate_system (CoordinateSystem cs)
 Specifies the coordinate system that all devices associated with this client will operate in. More...
 
- Public Member Functions inherited from TypedReferenceCount
 TypedReferenceCount (const TypedReferenceCount &copy)
 
void operator= (const TypedReferenceCount &copy)
 
- Public Member Functions inherited from TypedObject
 TypedObject (const TypedObject &copy)=default
 
TypedObjectas_typed_object ()
 Returns the object, upcast (if necessary) to a TypedObject pointer. More...
 
const TypedObjectas_typed_object () const
 Returns the object, upcast (if necessary) to a TypedObject pointer. More...
 
int get_best_parent_from_Set (const std::set< int > &) const
 
int get_type_index () const
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. More...
 
bool is_exact_type (TypeHandle handle) const
 Returns true if the current object is the indicated type exactly. More...
 
bool is_of_type (TypeHandle handle) const
 Returns true if the current object is or derives from the indicated type. More...
 
TypedObjectoperator= (const TypedObject &copy)=default
 
- Public Member Functions inherited from ReferenceCount
int get_ref_count () const
 
WeakReferenceListget_weak_list () const
 Returns the WeakReferenceList associated with this ReferenceCount object. More...
 
bool has_weak_list () const
 Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise. More...
 
void local_object ()
 This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack. More...
 
void ref () const
 Explicitly increments the reference count. More...
 
bool ref_if_nonzero () const
 Atomically increases the reference count of this object if it is not zero. More...
 
bool test_ref_count_integrity () const
 Does some easy checks to make sure that the reference count isn't completely bogus. More...
 
bool test_ref_count_nonzero () const
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More...
 
virtual bool unref () const
 Explicitly decrements the reference count. More...
 
WeakReferenceListweak_ref ()
 Adds the indicated PointerToVoid as a weak reference to this object. More...
 
void weak_unref ()
 Removes the indicated PointerToVoid as a weak reference to this object. More...
 

Static Public Member Functions

static double convert_to_secs (struct timeval msg_time)
 Little inline function to convert a struct timeval to only seconds. More...
 
static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from ClientBase
static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from TypedReferenceCount
static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from TypedObject
static TypeHandle get_class_type ()
 
static void init_type ()
 This function is declared non-inline to work around a compiler bug in g++ 2.96. More...
 
- Static Public Member Functions inherited from ReferenceCount
static TypeHandle get_class_type ()
 
static void init_type ()
 

Additional Inherited Members

- Public Attributes inherited from ClientBase
const std::string & device_name
 
- Public Attributes inherited from TypedObject
 get_type
 
- Public Attributes inherited from ReferenceCount
 get_ref_count
 Returns the current reference count. More...
 

Detailed Description

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

Definition at line 35 of file vrpnClient.h.

Member Function Documentation

◆ convert_to_secs()

double VrpnClient::convert_to_secs ( struct timeval  msg_time)
inlinestatic

Little inline function to convert a struct timeval to only seconds.

Definition at line 45 of file vrpnClient.I.

◆ get_server_name()

const std::string & VrpnClient::get_server_name ( ) const
inline

Returns the name of the server as passed to the VrpnClient constructor.

Definition at line 18 of file vrpnClient.I.

◆ is_connected()

bool VrpnClient::is_connected ( ) const
inline

Returns true if the connection is established successfully, false otherwise.

Definition at line 36 of file vrpnClient.I.

Referenced by write().

◆ is_valid()

bool VrpnClient::is_valid ( ) const
inline

Returns true if everything seems to be kosher with the server (even if there is no connection), or false otherwise.

Definition at line 27 of file vrpnClient.I.

Referenced by write().

◆ write()

void VrpnClient::write ( std::ostream &  out,
int  indent_level = 0 
) const

Writes a list of the active devices that the VrpnClient is currently polling each frame.

Definition at line 68 of file vrpnClient.cxx.

References indent(), is_connected(), and is_valid().


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