| | |
- Boost.Python.instance(__builtin__.object)
-
- Analog
- AnalogData
- AnalogDataVec
- AnalogInterface
- AnalogProxy
- BaseDeviceInterface
- Command
- CommandInterface
- CommandProxy
- Digital
- DigitalData
- DigitalDataVec
- DigitalInterface
- DigitalProxy
- Event
-
- KeyEvent
- MouseEvent
- InputManager
- KeyboardMouse
- KeyboardMouseInterface
- KeyboardMouseProxy
- Position
- PositionData
- PositionDataVec
- PositionInterface
- PositionProxy
- PositionUnitConversion
- String
- StringData
- StringDataVec
- StringInterface
- StringProxy
class Analog(Boost.Python.instance) |
| |
gadget.Analog is the abstract base class from which devices
returning analog data must derive. This is in addition to
gadget.Input. gadget.Input provides pure virtual function
constraints in the following functions: startSampling(),
stopSampling(), sample(), and updateData().
gadget.Analog adds the function getAnalogDdta() for retrieving the
received analog data. This is similar to the additions made by
gadget.Position and gadget.Digital.
|
| |
- Method resolution order:
- Analog
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- __init__(...)
- addAnalogSample(...)
- addAnalogSample(sampleList)
Helper method to add a collection of samples to the analog
sample buffers for this device. This MUST be called by all
analog devices to add a new sample. The data samples passed
in will then be modified by any local filters.
Post-condition:
The given samples are added to the buffers and the local
filters are run on the new samples.Arguments:
sampleList -- The list of newly collected samples as a
gadget.AnalogDataVec object.
- config(...)
- config(element) -> Boolean
Reads the minimum and maximum value configuration information
for this analog device.
Arguments:
element -- The config element for an analog device. It must
derive from the base config element type
'analog_device'.
- getAnalogData(...)
- getAnalogData(devNum = 0) -> gadget.AnalogData object
Returns analog data.
Post-condition:
A value is returned in the range from 0.0 to 1.0
Keyword arguments:
devNum -- The device unit numbmer to access. This parameter
optional. It defaults to 0.
- getAnalogDataBuffer(...)
- getAnalogDataBuffer() -> list of lists of AnalogData objects
Returns the current stable sample buffers for this device.
- getInputTypeName(...)
- readObject(...)
- readObject(reader) -> vpr.ReturnStatus object
De-serializes this object.
- swapAnalogBuffers(...)
- swapAnalogBuffers()
Swaps the analog data buffers.
Post-condition:
If the ready queue has values, then those values are copied
from the ready queue to the stable queue. If not, the stable
queue is not changed.
- writeObject(...)
- writeObject(writer) -> vpr.ReturnStatus object
Serializes this object.
Data and other attributes defined here:
- __instance_size__ = 88
Data and other attributes inherited from Boost.Python.instance:
- __dict__ = <dictproxy object>
- __new__ = <built-in method __new__ of Boost.Python.class object>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
- __weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>
|
class AnalogData(Boost.Python.instance) |
| |
gadget.InputData subclass for analog data.
|
| |
- Method resolution order:
- AnalogData
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- __init__(...)
- getAnalog(...)
- getTime(...)
- setAnalog(...)
- setTime(...)
Data and other attributes defined here:
- __instance_size__ = 20
Data and other attributes inherited from Boost.Python.instance:
- __dict__ = <dictproxy object>
- __new__ = <built-in method __new__ of Boost.Python.class object>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
- __weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>
|
class AnalogInterface(Boost.Python.instance) |
| |
Wrapper to provide an easier way to access analog proxy objects
from within user applications. Users can simply declare a local
interface variable and use it as a smart pointer for the proxy.
|
| |
- Method resolution order:
- AnalogInterface
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- __init__(...)
- getData(...)
- getData() -> float
Gets the current analog data value from the device.
- getProxy(...)
- getProxy() -> gadget.AnalogProxy object
Returns the underlying proxy to which we are connected.
- getProxyName(...)
- getProxyName() -> string object
Returns the name of the proxy.
- getTimeStamp(...)
- getTimeStamp() -> vpr.Interval object
Returns the time of the last update.
- init(...)
- init(proxyName)
Initializes this object.
Arguments:
proxyName -- String name of the analog proxy to connect to.
- isConnected(...)
- isConnected() -> Boolean
Identifies whether this device interface is connected to a
proxy.
- refresh(...)
- refresh()
Refreshes the interface based on the current configuration.
Post-conditions:
(mProxyIndex == -1) ==> Proxy not initialized yet.
(mProxyIndex !- -1) ==> mProxyName has name of device and
local proxy pionter is set to the
analog device.
Data and other attributes defined here:
- __instance_size__ = 64
Data and other attributes inherited from Boost.Python.instance:
- __dict__ = <dictproxy object>
- __new__ = <built-in method __new__ of Boost.Python.class object>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
- __weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>
|
class AnalogProxy(Boost.Python.instance) |
| |
A proxy class to analog devices used by the Input Manager.
An analog proxy always points to an analog device and a unit
number within that device. The Input Manager can therefore keep
an array of these around and treat them as analog devices that
only return a single sub-device's amount of data (one float).
|
| |
- Method resolution order:
- AnalogProxy
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- __init__(...)
- config(...)
- config(element) -> Boolean
Configures this proxy using the given jccl.ConfigElement
instance.
- getAnalogPtr(...)
- getAnalogPtr() -> gadget.Analog object
- getData(...)
- getData() -> float
Gets the current analog data value.
- getDeviceName(...)
- getDeviceName() -> string object
Gets the name of the device that we are proxying.
- getName(...)
- getName() -> string object
Gets the name of the proxy.
- getTimeStamp(...)
- getTimeStamp() -> vpr.Interval object
Returns the time of the last update.
- getUnit(...)
- getUnit() -> int
Returns the unit index into the analog device from which this
proxy is reading data.
- isStupefied(...)
- isStupefied() -> Boolean
Is the proxy currently stupefied?
If the device we are proxying does not exist, then this will
return True.
- isStupified(...)
- isStupified() -> Boolean
Is the proxy currently stupefied?
If the device we are proxying does not exist, then this will
return True.
NOTE: The name of this method is spelled incorrectly, and it
will be removed in PyJuggler 1.2. Use isStupefied()
instead.
- refresh(...)
- refresh() -> Boolean
Refreshes the proxy. This attempts to lookup the device that
we are proxying. If the lookup fails, then we become
stupefied. If not, then the proxy is pointed at this
potentially new device.
- set(...)
- set(devName, devPtr)
Sets the proxy to point to the given type-specific device.
Pre-condition:
devPtr must be a valid device of type gadget.Analog
Post-condition:
The proxy now references the given device. The device name we
are proxying is set to devPtr.getInstanceName().Arguments:
devName -- The name of the device at which we are pointing.
devPtr -- Pointer to the device. For gadget.AnalogProxy,
this points to an instance of gadget.Analog.
- setName(...)
- setName(name)
Sets the name of the proxy.
Arguments:
name -- The name for this proxy as a string object.
- stupefy(...)
- stupefy(newState = True)
Sets the stupefication state of this proxy.
Keyword arguments:
newState -- The new state of stupefication.
- stupify(...)
- stupify(newState = True)
Sets the stupefication state of this proxy.
Keyword arguments:
newState -- The new state of stupefication.
NOTE: The name of this method is spelled incorrectly, and it
will be removed in PyJuggler 1.2. Use stupefy() instead.
- updateData(...)
- updateData()
Updates the cached data copy from the device.
Static methods defined here:
- getElementType(...)
- getElementType() -> string object
Data and other attributes defined here:
- __instance_size__ = 48
Data and other attributes inherited from Boost.Python.instance:
- __dict__ = <dictproxy object>
- __new__ = <built-in method __new__ of Boost.Python.class object>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
- __weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>
|
class BaseDeviceInterface(Boost.Python.instance) |
| | |
- Method resolution order:
- BaseDeviceInterface
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- __init__(...)
- getProxyName(...)
- getProxyName() -> string object
Returns the name of the proxy.
- init(...)
- init(proxyName)
Initializes this object.
Arguments:
proxyName -- String name of the proxy to connect to.
- isConnected(...)
- isConnected() -> Boolean
Identifies whether this device interface is connected to a
proxy.
- refresh(...)
Static methods defined here:
- refreshAllDevices(...)
- refreshAllDevices()
Refreshes all the known device interface objects.
Data and other attributes defined here:
- __instance_size__ = 28
Data and other attributes inherited from Boost.Python.instance:
- __dict__ = <dictproxy object>
- __new__ = <built-in method __new__ of Boost.Python.class object>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
- __weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>
|
class Command(Boost.Python.instance) |
| |
gadget.Command is the abstract base class for devices that
translate spoken commands into integer-identified commands.
Drivers for all such devices must derive from this class. This is
in addition to gadget.Input. gadget.Input provides pure virtual
function constraints in the following functions: startSampling(),
stopSampling(), sample(), and updateData().
gadget.Command adds the function getCommandDdta() for retrieving
the received commands. This is similar to the additions made by
gadget.Position and gadget.Analog.
|
| |
- Method resolution order:
- Command
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- __init__(...)
- addCommandSample(...)
- addCommandSample(sampleList)
Helper method to add a collection of samples to the command
sample buffers for this device. This MUST be called by all
command-oriented devices to add a new sample.
Post-condition:
The given samples are added to the buffers.
Arguments:
sampleList -- The list of newly collected samples as a
gadget.DigitalDataVec object.
- config(...)
- config(element) -> Boolean
Configures this command-oriented device.
Arguments:
element -- The config element for a command-oriented device.
It must derive from the base config element type
'command_device'.
- getCommandData(...)
- getCommandData(devNum = 0) -> gadget.CommandData object
Returns command data.
Keyword arguments:
devNum -- The device unit numbmer to access. This parameter
optional. It defaults to 0.
- getCommandDataBuffer(...)
- getCommandDataBuffer() -> list of lists of CommandData objects
Returns the current stable sample buffers for this device.
- getInputTypeName(...)
- readObject(...)
- readObject(reader) -> vpr.ReturnStatus object
De-serializes this object.
- swapCommandBuffers(...)
- swapCommandBuffers()
Swaps the command data buffers.
Post-condition:
If the ready queue has values, then those values are copied
from the ready queue to the stable queue. If not, the stable
queue is not changed.
- writeObject(...)
- writeObject(writer) -> vpr.ReturnStatus object
Serializes this object.
Data and other attributes defined here:
- __instance_size__ = 80
Data and other attributes inherited from Boost.Python.instance:
- __dict__ = <dictproxy object>
- __new__ = <built-in method __new__ of Boost.Python.class object>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
- __weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>
|
class CommandInterface(Boost.Python.instance) |
| |
Wrapper to provide an easier way to access command-oriented
proxy objects from within user applications. Users can simply
declare a local interface variable and use it as a smart pointer
for the proxy.
|
| |
- Method resolution order:
- CommandInterface
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- __init__(...)
- getData(...)
- getData() -> int
Gets the current command data value from the device.
- getProxy(...)
- getProxy() -> gadget.DigitalProxy object
Returns the underlying proxy to which we are connected.
- getProxyName(...)
- getProxyName() -> string object
Returns the name of the proxy.
- getTimeStamp(...)
- getTimeStamp() -> vpr.Interval object
Returns the time of the last update.
- init(...)
- init(proxyName)
Initializes this object.
Arguments:
proxyName -- String name of the command-oriented proxy to
connect to.
- isConnected(...)
- isConnected() -> Boolean
Identifies whether this device interface is connected to a
proxy.
- refresh(...)
- refresh()
Refreshes the interface based on the current configuration.
Post-conditions:
(mProxyIndex == -1) ==> Proxy not initialized yet.
(mProxyIndex !- -1) ==> mProxyName has name of device and
local proxy pionter is set to the
command-oriented device.
Data and other attributes defined here:
- __instance_size__ = 64
Data and other attributes inherited from Boost.Python.instance:
- __dict__ = <dictproxy object>
- __new__ = <built-in method __new__ of Boost.Python.class object>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
- __weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>
|
class CommandProxy(Boost.Python.instance) |
| |
A proxy class to command-oriented devices used by the Input
Manager.
A command proxy always points to a command-oriented device and a
unit number within that device. The Input Manager can therefore
keep an array of these around and treat them as command-oriented
devices that only return a single sub-device's amount of data (one
int).
|
| |
- Method resolution order:
- CommandProxy
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- __init__(...)
- config(...)
- config(element) -> Boolean
Configures this proxy using the given jccl.ConfigElement
instance.
- getCommandData(...)
- getCommandPtr(...)
- getCommandPtr() -> gadget.Command object
- getData(...)
- getData() -> float
Gets the current command data value.
- getDeviceName(...)
- getDeviceName() -> string object
Gets the name of the device that we are proxying.
- getName(...)
- getName() -> string object
Gets the name of the proxy.
- getTimeStamp(...)
- getTimeStamp() -> vpr.Interval object
Returns the time of the last update.
- getUnit(...)
- getUnit() -> int
Returns the unit index into the command device from which this
proxy is reading data.
- isStupefied(...)
- isStupefied() -> Boolean
Is the proxy currently stupefied?
If the device we are proxying does not exist, then this will
return True.
- isStupified(...)
- isStupified() -> Boolean
Is the proxy currently stupefied?
If the device we are proxying does not exist, then this will
return True.
NOTE: The name of this method is spelled incorrectly, and it
will be removed in PyJuggler 1.2. Use isStupefied()
instead.
- refresh(...)
- refresh() -> Boolean
Refreshes the proxy. This attempts to lookup the device that
we are proxying. If the lookup fails, then we become
stupefied. If not, then the proxy is pointed at this
potentially new device.
- set(...)
- set(devName, devPtr)
Sets the proxy to point to the given type-specific device.
Pre-condition:
devPtr must be a valid device of type gadget.Command
Post-condition:
The proxy now references the given device. The device name we
are proxying is set to devPtr.getInstanceName().
Arguments:
devName -- The name of the device at which we are pointing.
devPtr -- Pointer to the device. For gadget.Command,
this points to an instance of gadget.Command.
- setName(...)
- setName(name)
Sets the name of the proxy.
Arguments:
name -- The name for this proxy as a string object.
- stupefy(...)
- stupefy(newState = True)
Sets the stupefication state of this proxy.
Keyword arguments:
newState -- The new state of stupefication.
- stupify(...)
- stupify(newState = True)
Sets the stupefication state of this proxy.
Keyword arguments:
newState -- The new state of stupefication.
NOTE: The name of this method is spelled incorrectly, and it
will be removed in PyJuggler 1.2. Use stupefy() instead.
- updateData(...)
- updateData()
Updates the cached data copy from the device.
Static methods defined here:
- getElementType(...)
- getElementType() -> string object
Data and other attributes defined here:
- __instance_size__ = 48
Data and other attributes inherited from Boost.Python.instance:
- __dict__ = <dictproxy object>
- __new__ = <built-in method __new__ of Boost.Python.class object>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
- __weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>
|
class Digital(Boost.Python.instance) |
| |
gadget.Digital is the abstract base class from which devices
returning digital data must derive. This is in addition to
gadget.Input. gadget.Input provides pure virtual function
constraints in the following functions: startSampling(),
stopSampling(), sample(), and updateData().
gadget.Digital adds the function getDigitalDdta() for retrieving
the received digital data. This is similar to the additions made
by gadget.Position and gadget.Analog.
|
| |
- Method resolution order:
- Digital
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- __init__(...)
- addDigitalSample(...)
- addDigitalSample(sampleList)
Helper method to add a collection of samples to the digital
sample buffers for this device. This MUST be called by all
digital devices to add a new sample.
Post-condition:
The given samples are added to the buffers.
Arguments:
sampleList -- The list of newly collected samples as a
gadget.DigitalDataVec object.
- config(...)
- config(element) -> Boolean
Configures this digital device.
Arguments:
element -- The config element for a digital device. It must
derive from the base config element type
'digital_device'.
- getDigitalData(...)
- getDigitalData(devNum = 0) -> gadget.DigitalData object
Returns digital data.
Keyword arguments:
devNum -- The device unit numbmer to access. This parameter
optional. It defaults to 0.
- getDigitalDataBuffer(...)
- getDigitalDataBuffer() -> list of lists of DigitalData objects
Returns the current stable sample buffers for this device.
- getInputTypeName(...)
- readObject(...)
- readObject(reader) -> vpr.ReturnStatus object
De-serializes this object.
- swapDigitalBuffers(...)
- swapDigitalBuffers()
Swaps the digital data buffers.
Post-condition:
If the ready queue has values, then those values are copied
from the ready queue to the stable queue. If not, the stable
queue is not changed.
- writeObject(...)
- writeObject(writer) -> vpr.ReturnStatus object
Serializes this object.
Data and other attributes defined here:
- State = <class '__main__.PyJuggler.gadget.State'>
- __instance_size__ = 80
Data and other attributes inherited from Boost.Python.instance:
- __dict__ = <dictproxy object>
- __new__ = <built-in method __new__ of Boost.Python.class object>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
- __weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>
|
class DigitalData(Boost.Python.instance) |
| |
gadget.InputData subclass for digital data.
|
| |
- Method resolution order:
- DigitalData
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- __init__(...)
- getDigital(...)
- getTime(...)
- setDigital(...)
- setTime(...)
Data and other attributes defined here:
- __instance_size__ = 20
Data and other attributes inherited from Boost.Python.instance:
- __dict__ = <dictproxy object>
- __new__ = <built-in method __new__ of Boost.Python.class object>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
- __weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>
|
class DigitalInterface(Boost.Python.instance) |
| |
Wrapper to provide an easier way to access digital proxy objects
from within user applications. Users can simply declare a local
interface variable and use it as a smart pointer for the proxy.
|
| |
- Method resolution order:
- DigitalInterface
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- __init__(...)
- getData(...)
- getData() -> gadget.Digital.State value
Gets the current digital data value from the device.
- getProxy(...)
- getProxy() -> gadget.DigitalProxy object
Returns the underlying proxy to which we are connected.
- getProxyName(...)
- getProxyName() -> string object
Returns the name of the proxy.
- getTimeStamp(...)
- getTimeStamp() -> vpr.Interval object
Returns the time of the last update.
- init(...)
- init(proxyName)
Initializes this object.
Arguments:
proxyName -- String name of the digital proxy to connect to.
- isConnected(...)
- isConnected() -> Boolean
Identifies whether this device interface is connected to a
proxy.
- refresh(...)
- refresh()
Refreshes the interface based on the current configuration.
Post-conditions:
(mProxyIndex == -1) ==> Proxy not initialized yet.
(mProxyIndex !- -1) ==> mProxyName has name of device and
local proxy pionter is set to the
digital device.
Data and other attributes defined here:
- __instance_size__ = 64
Data and other attributes inherited from Boost.Python.instance:
- __dict__ = <dictproxy object>
- __new__ = <built-in method __new__ of Boost.Python.class object>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
- __weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>
|
class DigitalProxy(Boost.Python.instance) |
| |
A proxy class to digital devices used by the Input Manager.
A digital proxy always points to a digital device and a unit
number within that device. The Input Manager can therefore keep
an array of these around and treat them as digital devices that
only return a single sub-device's amount of data (one int).
|
| |
- Method resolution order:
- DigitalProxy
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- __init__(...)
- config(...)
- config(element) -> Boolean
Configures this proxy using the given jccl.ConfigElement
instance.
- getData(...)
- getData() -> float
Gets the current digital data value.
- getDeviceName(...)
- getDeviceName() -> string object
Gets the name of the device that we are proxying.
- getDigitalData(...)
- getDigitalPtr(...)
- getDigitalPtr() -> gadget.Digital object
- getName(...)
- getName() -> string object
Gets the name of the proxy.
- getTimeStamp(...)
- getTimeStamp() -> vpr.Interval object
Returns the time of the last update.
- getUnit(...)
- getUnit() -> int
Returns the unit index into the digital device from which this
proxy is reading data.
- isStupefied(...)
- isStupefied() -> Boolean
Is the proxy currently stupefied?
If the device we are proxying does not exist, then this will
return True.
- isStupified(...)
- isStupified() -> Boolean
Is the proxy currently stupefied?
If the device we are proxying does not exist, then this will
return True.
NOTE: The name of this method is spelled incorrectly, and it
will be removed in PyJuggler 1.2. Use isStupefied()
instead.
- refresh(...)
- refresh() -> Boolean
Refreshes the proxy. This attempts to lookup the device that
we are proxying. If the lookup fails, then we become
stupefied. If not, then the proxy is pointed at this
potentially new device.
- set(...)
- set(devName, devPtr)
Sets the proxy to point to the given type-specific device.
Pre-condition:
devPtr must be a valid device of type gadget.Digital
Post-condition:
The proxy now references the given device. The device name we
are proxying is set to devPtr.getInstanceName().Arguments:
devName -- The name of the device at which we are pointing.
devPtr -- Pointer to the device. For gadget.Digital,
this points to an instance of gadget.Digital.
- setName(...)
- setName(name)
Sets the name of the proxy.
Arguments:
name -- The name for this proxy as a string object.
- stupefy(...)
- stupefy(newState = True)
Sets the stupefication state of this proxy.
Keyword arguments:
newState -- The new state of stupefication.
- stupify(...)
- stupify(newState = True)
Sets the stupefication state of this proxy.
Keyword arguments:
newState -- The new state of stupefication.
NOTE: The name of this method is spelled incorrectly, and it
will be removed in PyJuggler 1.2. Use stupefy() instead.
- updateData(...)
- updateData()
Updates the cached data copy from the device.
Static methods defined here:
- getElementType(...)
- getElementType() -> string object
Data and other attributes defined here:
- __instance_size__ = 48
Data and other attributes inherited from Boost.Python.instance:
- __dict__ = <dictproxy object>
- __new__ = <built-in method __new__ of Boost.Python.class object>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
- __weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>
|
class Event(Boost.Python.instance) |
| |
Base event type that an event source may generate. This class
cannot be used directly. Subclasses must be used instead.
|
| |
- Method resolution order:
- Event
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- __init__(...)
- readObject(...)
- readObject(reader) -> vpr.ReturnStatus object
De-serializes this object.
- setType(...)
- setType(type)
Sets the type of this event. This is needed because, while
using an object reader to de-serialize a gadget.Event object,
we cannot set the type during construction. We must set the
event type after creating this event using the EventFactory.Arguments:
type -- A gadget.EventType object or a subclass thereof.
- time(...)
- time() -> int
Returns the time at which the event occurred.
- type(...)
- type() -> gadget.EventType object
Returns the type of this event. This can be used for dynamic
casting to more specific event types.
- writeObject(...)
- writeObject(writer) -> vpr.ReturnStatus object
Serializes this object.
Data and other attributes defined here:
- __instance_size__ = 28
Data and other attributes inherited from Boost.Python.instance:
- __dict__ = <dictproxy object>
- __new__ = <built-in method __new__ of Boost.Python.class object>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
- __weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>
|
class InputManager(Boost.Python.instance) |
| |
The Input Manager holds and managed all Gadgeteer input devices.
The Input Manager handles all the details behind organizing the
input devices in the library. It provides an API for adding
devices by their JCCL config element and deleting them by their
element (or just their string name).
Proxies are used to abstract away from the devices so any type and
number of devices may be accessed in the same way. These proxies
are also set up by config elements and should be accessed by
number rather than by name (for speed reasons).
|
| |
- Method resolution order:
- InputManager
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- addDevice(...)
- addDevice(devPtr) -> Boolean
Addds the given device to the Input Manager. The given device
should not already be in the array of registered devices.
Post-condition:
mDevTable ' = union of mDevTable and devPtr
Arguemnts:
devPtr -- An object whose base type is gadget.Input.
Returns:
False is returned if device addition fails.
- addProxy(...)
- addProxy(proxy) -> Boolean
Adds the given gadget.Proxy object to the proxy table.
Arguments:
proxy -- The given proxy object to add. It is added using the
name returned by proxy.getName()
Returns:
True is returned if the proxy was added correctly.
- addRemoteDevice(...)
- Adds a remote device to the Input Manager. The given device
should not already be in the array of registered devices.
Post-condition:
mDevTable ' = union of mDevTable and devPtr
Arguemnts:
devPtr -- An object whose base type is gadget.Input.
Returns:
False is returned if device addition fails.
- configAdd(...)
- configAdd(element) -> Boolean
Adds the element to the configuration.
Pre-condition:
configCanHandle(element) == True
- configCanHandle(...)
- configCanHandle(element) -> Boolean
Can we handle the given element?
Returns:
True is returned if we can handle the given element. False
is returned otherwise.
- configProcessPending(...)
- configProcessPending(element) -> Boolean
Checks if this handler can process the given config element.
Typically, an implementation of this method will check the
element's definition ID to decide if it knows how to deal with
it.
Arguments:
element -- The current config element that is ready to be
processed.
Returns:
True is returned if and only if this handler can process the
given element.
- configRemove(...)
- configRemove(element) -> Boolean
Removes the element from the current configuration.
Pre-condition:
configCanHandle(element) == True
Post-condition:
(element is proxy) ==> (returns == False)
(element is device) ==> (device is removed && proxies are
stupefied)
(element is proxy_alias) ==> (proxy_alias is removed &&
devInterfaces.refreshAll())
- configureDevice(...)
- configureDevice(element) -> Boolean
Loads the device for the given element.
Returns:
True is returned if the device was configured and added.
- getDevice(...)
- getDevice(deviceName) -> gadget.Input object
Returns a gadget.Input object to the named device.
Returns:
None is returned if the device is not found.
- getDisplaySystemElement(...)
- getDisplaySystemElement() -> jccl.ConfigElement object
- getInputLogger(...)
- getInputLogger() -> gadget.InputLogger object
Gets the input logger connected to the Input Manager.
- getProxy(...)
- getProxy(proxyName) -> gadget.Proxy object
Gets a proxy having the given name (or alias).
Arguments:
proxyName -- A string identifier that is a proxy name or alias.
Returns:
None is returned if the named proxy is not found.
- refreshAllProxies(...)
- refreshAllProxies()
Refreshes all the proxies to have them update the device at
which they point.
- removeDevice(...)
- remoteDevice(devName) -> Boolean
Removes the named device from the Input Manager.
Post-condition:
mDevTable[devName] == None
Arguments:
devName -- A string naming the device to be removed.
Returns:
True is returned on success.
removeDevice(devPtr) -> Boolean
Removes the device identified by the given gadget.Input
object.
Arguments:
devPtr -- The device object to remove.
- updateAllDevices(...)
- updateAllDevices()
Updates the data in all the devices. This calls updateData()
on all the devices in the device table.
- updateAllProxies(...)
- updateAllProxies()
Updates all proxies by grabbing the correct data and
transforming it.
Static methods defined here:
- instance(...)
- gadget.InputManager.instance() -> gadget.InputManager object
Returns the singleton Input Manager reference.
Data and other attributes defined here:
- __init__ = <built-in function __init__>
- Raises an exception
This class cannot be instantiated from Python
Data and other attributes inherited from Boost.Python.instance:
- __dict__ = <dictproxy object>
- __new__ = <built-in method __new__ of Boost.Python.class object>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
- __weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>
|
class KeyEvent(Event) |
| |
Key press or release event class.
|
| |
- Method resolution order:
- KeyEvent
- Event
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- __init__(...)
- __init__()
Default constructor needed in order to use the templated
EventFactory without modification.
__init__(type, key, mask, time, asciiKey = 0)
Initializes data members.
Arguments:
type -- The type of this event (either key press or key
release).
key -- The platform-specific value of the key that was
pressed or released.
mask -- The mask of modifiers pressed in addition to key.
This should be constructed using the bitwise OR of
gadget.ModifierMask values.
time -- The time at which this event occurred. This should
be as accurate as possible, preferrably acquired
from the operating system or windowing event system
event data structure. The time at which the event
was processed is not an acceptable value.
asciiKey -- The ASCII value of the key associated with this
event. This paramter is optional, and it defaults
to 0 if not specified.
- getKey(...)
- getKey() -> gadget.Key object
Gets the key that was pressed while generating this event.
- getKeyChar(...)
- getKeyChar() -> character
Returns the ASCII character corresponding to the key that was
pressed.
- getModifierMask(...)
- getModifierMask() -> int
Returns the modifier mask for this event. This tells which
modifier keys (if any) were pressed at the same time as the
key that was pressed or released. The mask is the bitwise OR
of values in the enumeration gadget.ModifierMask.
- readObject(...)
- De-serializes this event using the given vpr.ObjectReader.
- setType(...)
- setType(type)
Sets the type of this event. This is needed because, while
using an object reader to de-serialize a gadget.Event object,
we cannot set the type during construction. We must set the
event type after creating this event using the EventFactory.
Arguments:
type -- A gadget.EventType object or a subclass thereof.
- time(...)
- time() -> int
Returns the time at which the event occurred.
- type(...)
- type() -> gadget.EventType object
Returns the type of this event. This can be used for dynamic
casting to more specific event types.
- writeObject(...)
- writeObject(writer) -> vpr.ReturnStatus object
Serializes this event using the given vpr.ObjectWriter.
Data and other attributes defined here:
- __instance_size__ = 40
Data and other attributes inherited from Boost.Python.instance:
- __dict__ = <dictproxy object>
- __new__ = <built-in method __new__ of Boost.Python.class object>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
- __weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>
|
class KeyboardMouse(Boost.Python.instance) |
| |
gadget.KeyboardMouse is an abstract class for interfacing with
keyboard and mouse devices. Informally, a keyboard/mouse device
can be thought of as a map of keyboard and mouse events (presses,
releases, and movements) to integers. The integers indicate the
number of times the event occurred since the last update. That is
to say, gadget.KeyboardMouse counts the number of keyboard and
mouse events between updates. Updates in Juggler occur once per
frame.
|
| |
- Method resolution order:
- KeyboardMouse
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- __init__(...)
- addEvent(...)
- addEvent(event)
Adds the given event object to the in-progress queue.Arguments:
event -- The gadget.Event object that is the new event.
- config(...)
- config(element) -> Boolean
Configures this keyboard/mouse device.
Arguments:
element -- The config element for an keyboard/mouse device.
- getEventQueue(...)
- getEventQueue() -> tuple of gadget.Event objects
Returns a copy of the current queue of events for this device.
- getInputTypeName(...)
- getKeyName(...)
- getKeyName(keyId) -> string object
Returns the symbolic Gadgeteer name associated with the given
key identifier. For example, getKeyName(gadget.Keys.KEY_UP)
returns "KEY_UP".
Arguments:
keyId -- A value from gadget.Keys identifiing the key whose
name will be returned.
Returns:
A string that is the symbolic name of the given key.
- getSyncTime(...)
- getSyncTime -> vpr.Interval object
Gets the interval that will be used for synchronization while
only sharing keyboard data across the cluster.
- keyPressed(...)
- keyPressed(keyId) -> int
Returns the number of times the given key was pressesd during
the last frame. This can be used in a conditional expression
to determine if the key was pressed at all.Arguments:
keyId -- A value from gadget.Keys identifiing the key whose
state will be queried.
Returns:
The number of times the named key was pressed since the last
update.
- modifierOnly(...)
- modifierOnly(modKey) -> Boolean
Determines if the given modifier key is the only modifier
pressed.
Pre-conditions:
The given key identifier must be one of gadget.Keys.NONE,
gadget.Keys.KEY_ALT, gadget.Keys.KEY_CTRL, or
gadget.Keys.KET_SHIFT.
Arguments:
modKey -- A gadget.Keys value that must be one of
gadget.Keys.NONE, gadget.Keys.KEY_ALT,
gadget.Keys.KEY_CTRL, or gadget.Keys.KEY_SHIFT.
Returns:
True is returned if the given modifier is the only modifier
key pressed.
- readObject(...)
- readObject(reader) -> vpr.ReturnStatus object
Reads mCurKeys and mCurEventQueueLock from a stream using the
given object reader.
- writeObject(...)
- writeObject(writer) -> vpr.ReturnStatus object
Writes both mCurKeys and mCurEventQueueLock to a stream using
the given object writer.
Data and other attributes defined here:
- __instance_size__ = 692
Data and other attributes inherited from Boost.Python.instance:
- __dict__ = <dictproxy object>
- __new__ = <built-in method __new__ of Boost.Python.class object>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
- __weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>
|
class KeyboardMouseInterface(Boost.Python.instance) |
| |
Wrapper to provide an easier way to access keyboard/mouse proxy
objects from within user applications. Users can simply declare
a local interface variable and use it as a smart pointer for the
proxy.
|
| |
- Method resolution order:
- KeyboardMouseInterface
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- __init__(...)
- getEventQueue(...)
- getEventQueue() -> list of gadget.Event objects
Returns a copy of the current queue of events for the proxied
device.
- getProxy(...)
- getProxy() -> gadget.KeyboardMouseProxy object
Returns the underlying proxy to which we are connected.
- getProxyName(...)
- getProxyName() -> string object
Returns the name of the proxy.
- getTimeStamp(...)
- getTimeStamp() -> vpr.Interval object
Returns the time of the last update.
- init(...)
- init(proxyName)
Initializes this object.
Arguments:
proxyName -- String name of the keyboard/mouse proxy to connect to.
- isConnected(...)
- isConnected() -> Boolean
Identifies whether this device interface is connected to a
proxy.
- keyPressed(...)
- keyPressed(keyId) -> int
Returns the number of times the given key was pressesd during
the last frame. This can be used in a conditional expression
to determine if the key was pressed at all.Arguments:
keyId -- A value from gadget.Keys identifiing the key whose
state will be queried.
Returns:
The number of times the named key was pressed since the last
update.
- modifierOnly(...)
- modifierOnly(modKey) -> Boolean
Determines if the given modifier key is the only modifier
pressed.
Pre-conditions:
The given key identifier must be one of gadget.Keys.NONE,
gadget.Keys.KEY_ALT, gadget.Keys.KEY_CTRL, or
gadget.Keys.KET_SHIFT.
Arguments:
modKey -- A gadget.Keys value that must be one of
gadget.Keys.NONE, gadget.Keys.KEY_ALT,
gadget.Keys.KEY_CTRL, or gadget.Keys.KEY_SHIFT.
Returns:
True is returned if the given modifier is the only modifier
key pressed.
- refresh(...)
- refresh()
Refreshes the interface based on the current configuration.
Post-conditions:
(mProxyIndex == -1) ==> Proxy not initialized yet.
(mProxyIndex !- -1) ==> mProxyName has name of device and
local proxy pionter is set to the
position device.
Data and other attributes defined here:
- __instance_size__ = 48
Data and other attributes inherited from Boost.Python.instance:
- __dict__ = <dictproxy object>
- __new__ = <built-in method __new__ of Boost.Python.class object>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
- __weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>
|
class KeyboardMouseProxy(Boost.Python.instance) |
| |
A proxy class to keyboard/mouse devices used by the Input Manager.
A keyboard/mouse proxy always points to a keyboard/mouse device
and a unit number within that device. The Input Manager can
therefore keep an array of these around and treat them as
keyboard/mouse devices that only return a single sub-device's
amount of data (an event queue and individual keys).
|
| |
- Method resolution order:
- KeyboardMouseProxy
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- __init__(...)
- config(...)
- config(element) -> Boolean
Configures this proxy using the given jccl.ConfigElement
instance.
- getDeviceName(...)
- getDeviceName() -> string object
Gets the name of the device that we are proxying.
- getEventQueue(...)
- getEventQueue() -> list of gadget.Event objects
Returns a copy of the current queue of events for the proxied
device.
- getKeyboardMousePtr(...)
- getKeyboardMousePtr() -> gadget.KeyboardMouse object
Returns the gadget.KeyboardMouse object held by this proxy.
- getName(...)
- getName() -> string object
Gets the name of the proxy.
- getTimeStamp(...)
- getTimeStamp() -> vpr.Interval object
Returns the time of the last update.
- isStupefied(...)
- isStupefied() -> Boolean
Is the proxy currently stupefied?
If the device we are proxying does not exist, then this will
return True.
- isStupified(...)
- isStupified() -> Boolean
Is the proxy currently stupefied?
If the device we are proxying does not exist, then this will
return True.
NOTE: The name of this method is spelled incorrectly, and it
will be removed in PyJuggler 1.2. Use isStupefied()
instead.
- keyPressed(...)
- keyPressed(keyId) -> int
Returns the number of times the given key was pressesd during
the last frame. This can be used in a conditional expression
to determine if the key was pressed at all.Arguments:
keyId -- A value from gadget.Keys identifiing the key whose
state will be queried.
Returns:
The number of times the named key was pressed since the last
update.
- modifierOnly(...)
- modifierOnly(modKey) -> Boolean
Determines if the given modifier key is the only modifier
pressed.
Pre-conditions:
The given key identifier must be one of gadget.Keys.NONE,
gadget.Keys.KEY_ALT, gadget.Keys.KEY_CTRL, or
gadget.Keys.KET_SHIFT.
Arguments:
modKey -- A gadget.Keys value that must be one of
gadget.Keys.NONE, gadget.Keys.KEY_ALT,
gadget.Keys.KEY_CTRL, or gadget.Keys.KEY_SHIFT.
Returns:
True is returned if the given modifier is the only modifier
key pressed.
- refresh(...)
- refresh() -> Boolean
Refreshes the proxy. This attempts to lookup the device that
we are proxying. If the lookup fails, then we become
stupefied. If not, then the proxy is pointed at this
potentially new device.
- set(...)
- set(devName, devPtr)
Sets the proxy to point to the given type-specific device.
Pre-condition:
devPtr must be a valid device of type gadget.Digital
Post-condition:
The proxy now references the given device. The device name we
are proxying is set to devPtr.getInstanceName().Arguments:
devName -- The name of the device at which we are pointing.
devPtr -- Pointer to the device. For gadget.Digital,
this points to an instance of gadget.Digital.
- setName(...)
- setName(name)
Sets the name of the proxy.
Arguments:
name -- The name for this proxy as a string object.
- stupefy(...)
- stupefy(newState = True)
Sets the stupefication state of this proxy.
Keyword arguments:
newState -- The new state of stupefication.
- stupify(...)
- stupify(newState = True)
Sets the stupefication state of this proxy.
Keyword arguments:
newState -- The new state of stupefication.
NOTE: The name of this method is spelled incorrectly, and it
will be removed in PyJuggler 1.2. Use stupefy() instead.
- updateData(...)
- updateData()
Updates the cached data copy from the device. Copies the
device data to local storage and transforms it if necessary.
Static methods defined here:
- getElementType(...)
Data and other attributes defined here:
- __instance_size__ = 32
Data and other attributes inherited from Boost.Python.instance:
- __dict__ = <dictproxy object>
- __new__ = <built-in method __new__ of Boost.Python.class object>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
- __weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>
|
class MouseEvent(Event) |
| |
Mouse event class. This captures the state of the mouse when any
mouse event occurs. This includes button presses, button
releases, and mouse motion.
|
| |
- Method resolution order:
- MouseEvent
- Event
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- __init__(...)
- __init__()
Default constructor needed in order to use the templated
EventFactory without modification.
__init__(type, button, x, y, globalX, globalY, state, time)
Initializes data members.
Arguments:
type -- The type of this event (a mouse button press, a mouse
a mouse button release, or a mouse move).
button -- The button that generated the event.
x -- The X coordinate of the mouse within the window.
y -- The Y coordinate of the mouse within the window.
globalX -- The X coordinate of the mouse relative to the root
window (i.e., the desktop).
globalY -- The Y coordinate of the mouse relative to the root
window (i.e., the desktop).
state -- The mask of mouse buttons and any modifiers being
pressed. This should be constructed using the
bitwise OR of gadget.ModifierMask and
gadget.ButtonMask values.
time -- The time at which this event occurred. This should
be as accurate as possible, preferrably acquired
from the operating system or windowing event system
event data structure. The time at which the event
was processed is not an acceptable value.
- getButton(...)
- getButton() -- gadget.Keys value
- getGlobalX(...)
- getGlobalX() -> int
Returns the X coordinate of the mouse pointer relative to the
root window (i.e., the desktop).
- getGlobalY(...)
- getGlobalY() -> int
Returns the Y coordinate of the mouse pointer relative to the
root window (i.e., the desktop).
- getState(...)
- getState() -> int
Returns the state of the mouse buttons and keyboard modifier
keys (CTRL, ALT, and SHIFT).
- getX(...)
- getX() -> int
Returns the X coordinate of the mouse pointer relative to the
window.
- getY(...)
- getY() -> int
Returns the Y coordinate of the mouse pointer relative to the
window.
- readObject(...)
- readObject(reader) -> vpr.ReturnStatus object
De-serializes this event using the given vpr.ObjectReader.
- setType(...)
- setType(type)
Sets the type of this event. This is needed because, while
using an object reader to de-serialize a gadget.Event object,
we cannot set the type during construction. We must set the
event type after creating this event using the EventFactory.
Arguments:
type -- A gadget.EventType object or a subclass thereof.
- time(...)
- time() -> int
Returns the time at which the event occurred.
- type(...)
- type() -> gadget.EventType object
Returns the type of this event. This can be used for dynamic
casting to more specific event types.
- writeObject(...)
- writeObject(writer) -> vpr.ReturnStatus object
Serializes this event using the given vpr.ObjectWriter.
Data and other attributes defined here:
- __instance_size__ = 52
Data and other attributes inherited from Boost.Python.instance:
- __dict__ = <dictproxy object>
- __new__ = <built-in method __new__ of Boost.Python.class object>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
- __weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>
|
class Position(Boost.Python.instance) |
| |
gadget.Position is the abstract base class from which devices
returning positional (translation and/or rotation) data must
derive. This is in addition to gadget.Input. gadget.Input
provides pure virtual function constraints in the following
functions: startSampling(), stopSampling(), sample(), and
updateData()
gadget.Position adds the function getPositionDdta() for retrieving
the received positional data. This is similar to the additions
made by gadget.Analog and gadget.Digital.
|
| |
- Method resolution order:
- Position
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- __init__(...)
- addPositionSample(...)
- addDigitalSample(sampleList)
Helper method to add a collection of positional samples to the
sample buffers for this device. This MUST be called by all
positional devices to add a new sample. The data samples
passed in will then be modified by any local filt
| |