Class AnalogTriggerOutput
- All Implemented Interfaces:
Sendable
,AutoCloseable
public class AnalogTriggerOutput extends DigitalSource implements Sendable
The TriggerState output indicates the primary output value of the trigger. If the analog signal is less than the lower limit, the output is false. If the analog value is greater than the upper limit, then the output is true. If the analog value is in between, then the trigger output state maintains its most recent value.
The InWindow output indicates whether the analog signal is inside the range defined by the limits.
The RisingPulse and FallingPulse outputs detect an instantaneous transition from above the upper limit to below the lower limit, and vice versa. These pulses represent a rollover condition of a sensor and can be routed to an up / down counter or to interrupts. Because the outputs generate a pulse, they cannot be read directly. To help ensure that a rollover condition is not missed, there is an average rejection filter available that operates on the upper 8 bits of a 12 bit number and selects the nearest outlier of 3 samples. This will reject a sample that is (due to averaging or sampling) errantly between the two limits. This filter will fail if more than one sample in a row is errantly in between the two limits. You may see this problem if attempting to use this feature with a mechanical rollover sensor, such as a 360 degree no-stop potentiometer without signal conditioning, because the rollover transition is not sharp / clean enough. Using the averaging engine may help with this, but rotational speeds of the sensor will then be limited.
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
AnalogTriggerOutput.AnalogTriggerOutputException
Exceptions dealing with improper operation of the Analog trigger output.static class
AnalogTriggerOutput.AnalogTriggerType
Defines the state in which the AnalogTrigger triggers. -
Constructor Summary
Constructors Constructor Description AnalogTriggerOutput(AnalogTrigger trigger, AnalogTriggerOutput.AnalogTriggerType outputType)
Create an object that represents one of the four outputs from an analog trigger. -
Method Summary
Modifier and Type Method Description boolean
get()
Get the state of the analog trigger output.int
getAnalogTriggerTypeForRouting()
If this is an analog trigger.int
getChannel()
The DigitalSource channel.int
getPortHandleForRouting()
The channel routing number.void
initSendable(SendableBuilder builder)
Initializes thisSendable
object.boolean
isAnalogTrigger()
Returns true if this DigitalSource is an AnalogTrigger.
-
Constructor Details
-
AnalogTriggerOutput
public AnalogTriggerOutput(AnalogTrigger trigger, AnalogTriggerOutput.AnalogTriggerType outputType)Create an object that represents one of the four outputs from an analog trigger.Because this class derives from DigitalSource, it can be passed into routing functions for Counter, Encoder, etc.
- Parameters:
trigger
- The trigger for which this is an output.outputType
- An enum that specifies the output on the trigger to represent.
-
-
Method Details
-
get
Get the state of the analog trigger output.- Returns:
- The state of the analog trigger output.
-
getPortHandleForRouting
Description copied from class:DigitalSource
The channel routing number.- Specified by:
getPortHandleForRouting
in classDigitalSource
- Returns:
- channel routing number
-
getAnalogTriggerTypeForRouting
Description copied from class:DigitalSource
If this is an analog trigger.- Specified by:
getAnalogTriggerTypeForRouting
in classDigitalSource
- Returns:
- true if this is an analog trigger.
-
getChannel
Description copied from class:DigitalSource
The DigitalSource channel.- Specified by:
getChannel
in classDigitalSource
- Returns:
- The DigitalSource channel.
-
isAnalogTrigger
Description copied from class:DigitalSource
Returns true if this DigitalSource is an AnalogTrigger.- Specified by:
isAnalogTrigger
in classDigitalSource
- Returns:
- True if this DigitalSource is an AnalogTrigger.
-
initSendable
Description copied from interface:Sendable
Initializes thisSendable
object.- Specified by:
initSendable
in interfaceSendable
- Parameters:
builder
- sendable builder
-