Phidgets.Events.Events (version 2.1.9, May 17 2010)
index
 

Copyright 2010 Phidgets Inc.
This work is licensed under the Creative Commons Attribution 2.5 Canada License. 
To view a copy of this license, visit http://creativecommons.org/licenses/by/2.5/ca/

 
Classes
       
AccelerationChangeEventArgs
AttachEventArgs
BackEMFEventArgs
BridgeDataEventArgs
CurrentChangeEventArgs
CurrentUpdateEventArgs
DetachEventArgs
EncoderPositionChangeEventArgs
EncoderPositionUpdateEventArgs
ErrorEventArgs
FrequencyCounterCountEventArgs
GPSPositionChangeEventArgs
GPSPositionFixStatusChangeEventArgs
IRCodeEventArgs
IRLearnEventArgs
IRRawDataEventArgs
InputChangeEventArgs
KeyChangeEventArgs
OutputChangeEventArgs
PHChangeEventArgs
PositionChangeEventArgs
SensorChangeEventArgs
SensorUpdateEventArgs
ServerConnectArgs
ServerDisconnectArgs
SpatialDataEventArgs
StepperPositionChangeEventArgs
TagEventArgs
TemperatureChangeEventArgs
VelocityChangeEventArgs

 
class AccelerationChangeEventArgs
    Acceleration Change Event data and information will be stored in this class.
 
Data specific to this event args class are the index of the axis that is changing and the acceleration value read.
 
Properties:
    device<object>: Reference to the Phidget object from which this event originated
    index<int>: The reference to the axis index from which this event originated.
    acceleration<double>: The reference to the acceleration value that was read to generate the event.
 
  Methods defined here:
__init__(self, device, index, acceleration)

 
class AttachEventArgs
    Attach event data and information will be stored in this class.
 
The data stored in this event args class is a reference to the Phidget object that triggered the event.
 
Properties:
    device<object>: Reference to the Phidget object from which this event originated
 
  Methods defined here:
__init__(self, device)

 
class BackEMFEventArgs
     Methods defined here:
__init__(self, device, index, voltage)

 
class BridgeDataEventArgs
     Methods defined here:
__init__(self, device, index, value)

 
class CurrentChangeEventArgs
    Current Change Event data and information will be stored in this class.
 
Data specific to this event args class are the index of the motor whose current draw is changing and the current value read.
 
Properties:
    device<object>: Reference to the Phidget object from which this event originated
    index<int>: The reference to the index of the motor.
    current<double>: The reference the current of the motor.
 
  Methods defined here:
__init__(self, device, index, current)

 
class CurrentUpdateEventArgs
    Current Update Event data and information will be stored in this class.
 
Data specific to this event args class are the index of the motor whose current draw is changing and the current value read.
 
Properties:
    device<object>: Reference to the Phidget object from which this event originated
    index<int>: The reference to the index of the motor.
    current<double>: The reference the current of the motor.
 
  Methods defined here:
__init__(self, device, index, current)

 
class DetachEventArgs
    Detach event data and information will be stored in this class.
 
The data stored in this event args class is a reference to the Phidget object that triggered the event.
 
Properties:
    device<object>: Reference to the Phidget object from which this event originated
 
  Methods defined here:
__init__(self, device)

 
class EncoderPositionChangeEventArgs
    Encoder Position Change Event data and information will be stored in this class.
 
Data specific to this event args class are the index of the encoder that is changing, the position change value read,
and the elapsed time between position changes.
 
Properties:
    device<object>: Reference to the Phidget object from which this event originated
    index<int>:  The reference to the encoder index from which this event originated. 
    time<int>: The reference to the elapsed time between change events.
    positionChange<int>: The reference to the position change value that was read to generate the event.
 
  Methods defined here:
__init__(self, device, index, time, positionChange)

 
class EncoderPositionUpdateEventArgs
    Encoder Position Update Event data and information will be stored in this class.
 
Data specific to this event args class are the index of the encoder that is changing, the position change value read.
 
Properties:
    device<object>: Reference to the Phidget object from which this event originated
    index<int>:  The reference to the encoder index from which this event originated.
    positionChange<int>: The reference to the position change value that was read to generate the event.
 
  Methods defined here:
__init__(self, device, index, positionChange)

 
class ErrorEventArgs
    Error event data and information will be stored in this class.
 
The data stored in this event args class is the error description and the error code.
 
Properties:
    device<object>: Reference to the Phidget object from which this event originated
    description<string>:  The reference to the error description string generated by the event. 
    eCode<int>: The reference to the error code value generated by the event.
 
  Methods defined here:
__init__(self, device, description, eCode)

 
class FrequencyCounterCountEventArgs
     Methods defined here:
__init__(self, device, index, time, counts)

 
class GPSPositionChangeEventArgs
     Methods defined here:
__init__(self, device, latitude, longitude, altitude)

 
class GPSPositionFixStatusChangeEventArgs
     Methods defined here:
__init__(self, device, status)

 
class IRCodeEventArgs
     Methods defined here:
__init__(self, device, code, repeat)

 
class IRLearnEventArgs
     Methods defined here:
__init__(self, device, code, codeInfo)

 
class IRRawDataEventArgs
     Methods defined here:
__init__(self, device, rawData)

 
class InputChangeEventArgs
    Input Change Event data and information will be stored in this class.
 
Data specific to this event args class are the index of the digital input that is changing and the state value read.
 
Properties:
    device<object>: Reference to the Phidget object from which this event originated
    index<int>: The reference to the digital input index from which this event originated.
    value<int>: The reference to the bool state value that was read to generate the event.
 
  Methods defined here:
__init__(self, device, index, state)

 
class KeyChangeEventArgs
    Key Event data and information will be stored in this class.
 
Data specific to this event args class is the value data and the key.
 
Properties:
    device<object>: Reference to the Phidget object from which this event originated
    key<string>: The Key that is changing in the Dictionary.
    value<string>: The value data that is being associated with that key in the Dictionary.
 
  Methods defined here:
__init__(self, device, key, value, reason)

 
class OutputChangeEventArgs
    Output Change Event data and information will be stored in this class.
 
Data specific to this event args class are the index of the digital output that is changing and the state value read.
 
Properties:
    device<object>: Reference to the Phidget object from which this event originated
    index<int>: The reference to the index of the output.
    value<int>: The reference to the state of the output.
 
  Methods defined here:
__init__(self, device, index, state)

 
class PHChangeEventArgs
    PH Change Event data and information will be stored in this class.
 
Data specific to this event args class is the PH value read.
 
Properties:
    device<object>: Reference to the Phidget object from which this event originated
    PH<double>: The reference pH value.
 
  Methods defined here:
__init__(self, device, PH)

 
class PositionChangeEventArgs
    Servo Position Change Event data and information will be stored in this class.
 
Data specific to this event args class are the index of the motor whose position is changing and the position value read.
 
Properties:
    device<object>: Reference to the Phidget object from which this event originated
    index<int>: The reference to the index of the motor.
    position<double>: The reference to the position of the servo motor.
 
  Methods defined here:
__init__(self, device, index, position)

 
class SensorChangeEventArgs
    Analog Sensor Change Event data and information will be stored in this class.
 
Data specific to this event args class are the index of the analog sensor input that is changing and the sensor value read.
 
Properties:
    device<object>: Reference to the Phidget object from which this event originated
    index<int>: The reference to the analog sensor input index from which this event originated.
    value<int>: The reference to the value of the sensor.
 
  Methods defined here:
__init__(self, device, index, value)

 
class SensorUpdateEventArgs
    Analog Sensor Update Event data and information will be stored in this class.
 
Data specific to this event args class are the index of the analog sensor input that is changing and the sensor value read.
 
Properties:
    device<object>: Reference to the Phidget object from which this event originated
    index<int>: The reference to the analog sensor input index from which this event originated.
    value<int>: The reference to the value of the sensor.
 
  Methods defined here:
__init__(self, device, index, value)

 
class ServerConnectArgs
    Server connect event data and information will be stored in this class.
 
The data stored in this event args class is a reference to the Phidget, or Dictionary, or Manager object that triggered the event.
 
Properties:
    device<object>: Reference to the Phidget, or Dictionary, or Manager object from which this event originated
 
  Methods defined here:
__init__(self, device)

 
class ServerDisconnectArgs
    Server Disconnect event data and information will be stored in this class.
 
The data stored in this event args class is a reference to the Phidget, or Dictionary, or Manager object that triggered the event.
 
Properties:
    device<object>: Reference to the Phidget, or Dictionary, or Manager object from which this event originated
 
  Methods defined here:
__init__(self, device)

 
class SpatialDataEventArgs
    Properties:
    spatialData<list of objects>: list of spatialData objects
 
  Methods defined here:
__init__(self, device, spatialDataCollection)

 
class StepperPositionChangeEventArgs
    Stepper Position Change Event data and information will be stored in this class.
 
Data specific to this event args class are the index of the stepper motor whose position is changing and the position value read.
 
Properties:
    device<object>: Reference to the Phidget object from which this event originated
    index<int>: The reference to the index of the stepper motor.
    position<double>: The reference to the position of the stepper motor.
 
  Methods defined here:
__init__(self, device, index, position)

 
class TagEventArgs
    Tag Event data and information will be stored in this class.
 
Data specific to this event args class is the Tag data that is read.
 
Properties:
    device<object>: Reference to the Phidget object from which this event originated
    tag<string>: The reference to the gained or lost tag.
 
  Methods defined here:
__init__(self, device, tag)

 
class TemperatureChangeEventArgs
    Temperature Change Event data and information will be stored in this class.
 
Data specific to this event args class is the index of the temperature sensor and the temperature data.
 
Properties:
    device<object>: Reference to the Phidget object from which this event originated
    index<int>: The reference to the index of the sensor.
    temperature<double>: The reference to the temperature of the sensor.
    potential<double>: The reference to the potential of the sensor.
 
  Methods defined here:
__init__(self, device, index, temperature, potential)

 
class VelocityChangeEventArgs
    Velocity Change Event data and information will be stored in this class.
 
Data specific to this event args class are the index of the motor whose velocity is changing and the velocity value read.
 
Properties:
    device<object>: Reference to the Phidget object from which this event originated
    index<int>:  The reference to the index of the motor.
    velocity<double>: The reference to the velocity of the motor.
 
  Methods defined here:
__init__(self, device, index, velocity)

 
Functions
       
FormatError(...)
FormatError([integer]) -> string
 
Convert a win32 error code into a string. If the error code is not
given, the return value of a call to GetLastError() is used.
Lock = allocate_lock(...)
allocate_lock() -> lock object
(allocate() is an obsolete synonym)
 
Create a new lock object.  See LockType.__doc__ for information about locks.
POINTER(...)
addressof(...)
addressof(C instance) -> integer
Return the address of the C instance internal buffer
alignment(...)
alignment(C type) -> integer
alignment(C instance) -> integer
Return the alignment requirements of a C instance
byref(...)
byref(C instance[, offset=0]) -> byref-object
Return a pointer lookalike to a C instance, only usable
as function argument
get_errno(...)
get_last_error(...)
pointer(...)
resize(...)
Resize the memory buffer of a ctypes instance
set_conversion_mode(...)
set_conversion_mode(encoding, errors) -> (previous-encoding, previous-errors)
 
Set the encoding and error handling ctypes uses when converting
between unicode and strings.  Returns the previous values.
set_errno(...)
set_last_error(...)
sizeof(...)
sizeof(C type) -> integer
sizeof(C instance) -> integer
Return the size in bytes of a C instance
stack_size(...)
stack_size([size]) -> size
 
Return the thread stack size used when creating new threads.  The
optional size argument specifies the stack size (in bytes) to be used
for subsequently created threads, and must be 0 (use platform or
configured default) or a positive integer value of at least 32,768 (32k).
If changing the thread stack size is unsupported, a ThreadError
exception is raised.  If the specified size is invalid, a ValueError
exception is raised, and the stack size is unmodified.  32k bytes
 currently the minimum supported stack size value to guarantee
sufficient stack space for the interpreter itself.
 
Note that some platforms may have particular restrictions on values for
the stack size, such as requiring a minimum stack size larger than 32kB or
requiring allocation in multiples of the system memory page size
- platform documentation should be referred to for more information
(4kB pages are common; using multiples of 4096 for the stack size is
the suggested approach in the absence of more specific information).

 
Data
        DEFAULT_MODE = 0
GetLastError = <_FuncPtr object at 0x009C4990>
RTLD_GLOBAL = 0
RTLD_LOCAL = 0
__author__ = 'Adam Stelmack'
__date__ = 'May 17 2010'
__package__ = 'Phidgets.Events'
__version__ = '2.1.9'
cdll = <ctypes.LibraryLoader object at 0x00AF68B0>
memmove = <CFunctionType object at 0x009C4A08>
memset = <CFunctionType object at 0x009C4BE8>
oledll = <ctypes.LibraryLoader object at 0x00AF6950>
pydll = <ctypes.LibraryLoader object at 0x00AF68D0>
pythonapi = <PyDLL 'python dll', handle 1e000000 at af68f0>
windll = <ctypes.LibraryLoader object at 0x00AF6910>

 
Author
        Adam Stelmack