FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kEncoder.h
Go to the documentation of this file.
1 
8 #ifndef K_FIRESYNC_ENCODER_H
9 #define K_FIRESYNC_ENCODER_H
10 
11 #include <kFireSync/kNodeDef.h>
12 
19 //typedef kObject kEncoder; --forward-declared in kFsDef.x.h
20 
28 kFsFx(kStatus) kEncoder_ClearAll(kEncoder encoder);
29 
40 kFsFx(kStatus) kEncoder_Enable(kEncoder encoder, kBool enable);
41 
49 kFsFx(kBool) kEncoder_IsEnabled(kEncoder encoder);
50 
59 kFsFx(kStatus) kEncoder_SetDirection(kEncoder encoder, kEncoderDirection direction);
60 
69 
78 kFsFx(kStatus) kEncoder_DirectionInfo(kEncoder encoder, kInfoBits* info);
79 
88 kFsFx(kStatus) kEncoder_EnableIndexReset(kEncoder encoder, kBool enabled);
89 
98 
108 
117 kFsFx(kStatus) kEncoder_EnableSimulation(kEncoder encoder, kBool enabled);
118 
127 
137 
146 kFsFx(kStatus) kEncoder_SetSimulationDirection(kEncoder encoder, kBool direction);
147 
156 
166 
177 kFsFx(kStatus) kEncoder_SetSimulationPeriod(kEncoder encoder, k64u period);
178 
188 kFsFx(k64u) kEncoder_SimulationPeriod(kEncoder encoder);
189 
199 
208 kFsFx(kStatus) kEncoder_SetSimulationResolution(kEncoder encoder, k32u resolution);
209 
218 
228 
238 
247 
257 
270 
278 kFsFx(k32u) kEncoder_SnapshotSourceId(kEncoder encoder);
279 
288 kFsFx(kStatus) kEncoder_SnapshotSourceIdInfo(kEncoder encoder, kInfo* info);
289 
300 kFsFx(kStatus) kEncoder_Reset(kEncoder encoder);
301 
302 #include <kFireSync/Client/kEncoder.x.h>
303 
304 #endif
kBool kEncoder_SimulationDirection(kEncoder encoder)
Reports the simulation direction.
kStatus kEncoder_SetDirection(kEncoder encoder, kEncoderDirection direction)
Sets the current interpretation of encoder A/B signals to yield forward/reverse direction.
kEncoderDirection kEncoder_Direction(kEncoder encoder)
Gets the current interpretation of encoder A/B signals to yield forward/reverse direction.
kStatus kEncoder_SetSnapshotSourceId(kEncoder encoder, k32u id)
Sets the snapshot source id for an encoder.
kEncoderSnapshotSource kEncoder_SnapshotSource(kEncoder encoder)
Retrieves the snapshot source.
Represents constraint and validity information for a bit flag setting.
Definition: kInfo.h:544
Represents encoder snapshot source.
kBool kEncoder_IndexResetEnabled(kEncoder encoder)
Reports whether reset-on-index is enabled.
Represents configuration for a node's local encoder.
kStatus kEncoder_SetSnapshotSource(kEncoder encoder, kEncoderSnapshotSource source)
Sets the snapshot source for an encoder.
kStatus kEncoder_SetSimulationResolution(kEncoder encoder, k32u resolution)
Sets the simulation resolution.
kStatus kEncoder_Reset(kEncoder encoder)
Resets the counter of this encoder module.
k32u kEncoder_SnapshotSourceId(kEncoder encoder)
Gets the snapshot source id for an encoder.
Essential declarations related to FireSync nodes.
kStatus kEncoder_SimulationEnabledInfo(kEncoder encoder, kInfoBool *info)
Reports constraint and validity information for the SimulationEnabled setting.
kStatus kEncoder_SimulationDirectionInfo(kEncoder encoder, kInfoBool *info)
Reports constraint and validity information for the SimulationDirection setting.
kStatus kEncoder_SetSimulationPeriod(kEncoder encoder, k64u period)
Sets the simulation period, in nanoseconds.
k32u kEncoder_SimulationResolution(kEncoder encoder)
Gets the simulation resolution.
kStatus kEncoder_Enable(kEncoder encoder, kBool enable)
Enables or disables the encoder.
Represents constraint and validity information for a 64-bit unsigned integer setting.
Definition: kInfo.h:234
kStatus kEncoder_EnableIndexReset(kEncoder encoder, kBool enabled)
Enables reset-on-index.
kStatus kEncoder_SimulationPeriodInfo(kEncoder encoder, kInfo64u *info)
Reports constraint and validity information for the SimulationPeriod setting.
kStatus kEncoder_IndexResetEnabledInfo(kEncoder encoder, kInfoBool *info)
Reports constraint and validity information for the IndexResetEnabled setting.
Represents encoder A/B signal interpretation.
kStatus kEncoder_SnapshotSourceIdInfo(kEncoder encoder, kInfo *info)
Reports constraint and validity information for the SnapshotSourceId setting.
kStatus kEncoder_SnapshotSourceInfo(kEncoder encoder, kInfoBits *info)
Reports constraint and validity information for the Snapshot Source setting.
Represents constraint and validity information for a 32-bit unsigned integer setting.
Definition: kInfo.h:98
kStatus kEncoder_ClearAll(kEncoder encoder)
Resets encoder device settings to defaults.
kBool kEncoder_SimulationEnabled(kEncoder encoder)
Reports whether encoder simulation is enabled.
kBool kEncoder_IsEnabled(kEncoder encoder)
Reports whether the encoder is currently enabled.
kStatus kEncoder_SetSimulationDirection(kEncoder encoder, kBool direction)
Sets the encoder simulation direction.
kStatus kEncoder_EnableSimulation(kEncoder encoder, kBool enabled)
Enables encoder simulation.
kStatus kEncoder_DirectionInfo(kEncoder encoder, kInfoBits *info)
Reports constraint and validity information for the Direction setting.
kStatus kEncoder_SimulationResolutionInfo(kEncoder encoder, kInfo32u *info)
Reports constraint and validity information for the SimulationResolution setting. ...
Represents constraint and validity information for a general setting.
Definition: kInfo.h:64
Represents constraint and validity information for a boolean setting.
Definition: kInfo.h:493
k64u kEncoder_SimulationPeriod(kEncoder encoder)
Gets the simulation period, in nanoseconds.