blob: b96d8c8c0758c9dd8330427fbb9c7f0a9d756bb3 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
|
# $Id$
# Documentation for SCA_ISensor
from SCA_ILogicBrick import *
class SCA_ISensor(SCA_ILogicBrick):
"""
Base class for all sensor logic bricks.
"""
def isPositive():
"""
True if this sensor brick has been activated.
"""
def getUsePosPulseMode():
"""
True if the sensor is in positive pulse mode.
"""
def setUsePosPulseMode(pulse):
"""
Sets positive pulse mode.
@type pulse: boolean
@param pulse: If True, will activate positive pulse mode for this sensor.
"""
def getFrequency():
"""
The frequency for pulse mode sensors.
@rtype: integer
@return: the pulse frequency in 1/50 sec.
"""
def setFrequency(freq):
"""
Sets the frequency for pulse mode sensors.
@type freq: integer
@return: the pulse frequency in 1/50 sec.
"""
def getUseNegPulseMode():
"""
True if the sensor is in negative pulse mode.
"""
def setUseNegPulseMode(pulse):
"""
Sets negative pulse mode.
@type pulse: boolean
@param pulse: If True, will activate negative pulse mode for this sensor.
"""
def getInvert():
"""
True if this sensor activates on negative events.
"""
def setInvert(invert):
"""
Sets if this sensor activates on positive or negative events.
@type invert: boolean
@param invert: true if activates on negative events; false if activates on positive events.
"""
|
