A device, attached to the ClientBase by a DialNode, that records the data from a single named dial device. More...
#include "clientDialDevice.h"
Public Member Functions | |
virtual TypeHandle | force_init_type () |
int | get_num_dials () const |
Returns the number of dial dials known to the ClientDialDevice. More... | |
virtual TypeHandle | get_type () const |
bool | is_dial_known (int index) const |
Returns true if the state of the indicated dial dial is known, or false if we have never heard anything about this particular dial. More... | |
void | push_dial (int index, double offset) |
Marks that the dial has been offset by the indicated amount. More... | |
double | read_dial (int index) |
Returns the number of complete revolutions of the dial since the last time read_dial() was called. More... | |
![]() | |
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. More... | |
void | acquire () |
Grabs the mutex associated with this particular device. More... | |
void | disconnect () |
Disconnects the ClientDevice from its ClientBase object. More... | |
ClientBase * | get_client () const |
Returns the ClientBase this device is associated with. More... | |
const string & | get_device_name () const |
Returns the device name reported to the ClientBase. More... | |
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. More... | |
bool | is_connected () const |
Returns true if the device is still connected to its ClientBase, false otherwise. More... | |
virtual void | output (ostream &out) const |
void | poll () |
Causes the connected ClientBase to poll all of its clients, if necessary. More... | |
void | unlock () |
Releases the mutex associated with this particular device. More... | |
virtual void | write (ostream &out, int indent_level=0) const |
![]() | |
TypedReferenceCount (const TypedReferenceCount ©) | |
void | operator= (const TypedReferenceCount ©) |
![]() | |
TypedObject (const TypedObject ©) | |
TypedObject * | as_typed_object () |
Returns the object, upcast (if necessary) to a TypedObject pointer. More... | |
const TypedObject * | as_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... | |
void | operator= (const TypedObject ©) |
![]() | |
int | get_ref_count () const |
Returns the current reference count. More... | |
WeakReferenceList * | get_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 | 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... | |
void | weak_ref (WeakPointerToVoid *ptv) |
Adds the indicated PointerToVoid as a weak reference to this object. More... | |
void | weak_unref (WeakPointerToVoid *ptv) |
Removes the indicated PointerToVoid as a weak reference to this object. More... | |
Static Public Member Functions | |
static TypeHandle | get_class_type () |
static void | init_type () |
![]() | |
static TypeHandle | get_class_type () |
static void | init_type () |
![]() | |
static TypeHandle | get_class_type () |
static void | init_type () |
![]() | |
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 TypeHandle | get_class_type () |
static void | init_type () |
A device, attached to the ClientBase by a DialNode, that records the data from a single named dial device.
The named device can contain any number of dials, numbered in sequence beginning at zero.
A dial is a rotating device that does not have stops–it can keep rotating any number of times. Therefore it does not have a specific position at any given time, unlike an AnalogDevice.
Definition at line 35 of file clientDialDevice.h.
|
inline |
Returns the number of dial dials known to the ClientDialDevice.
This number may change as more dials are discovered.
Definition at line 46 of file clientDialDevice.I.
|
inline |
Returns true if the state of the indicated dial dial is known, or false if we have never heard anything about this particular dial.
Definition at line 95 of file clientDialDevice.I.
|
inline |
Marks that the dial has been offset by the indicated amount.
It is the user's responsibility to ensure that this call is protected within acquire().
Definition at line 58 of file clientDialDevice.I.
|
inline |
Returns the number of complete revolutions of the dial since the last time read_dial() was called.
This is a destructive operation; it is not possible to read the dial without resetting the counter.
It is the user's responsibility to ensure that this call is protected within acquire().
Definition at line 77 of file clientDialDevice.I.