class decoder_t
{
- public:
- /* Public: Parse the signal's bitfield from the given data and return the raw
- * value.
- *
- * signal - The signal to parse from the data.
- * data - The data to parse the signal from.
- * length - The length of the data array.
- *
- * Returns the raw value of the signal parsed as a bitfield from the given byte
- * array.
- */
- static float parseSignalBitfield(can_signal_t& signal, const can_message_t& message);
-
- /* Public: Find and return the corresponding string state for a CAN signal's
- * raw integer value.
- *
- * This is an implementation of the SignalDecoder type signature, and can be
- * used directly in the can_signal_t.decoder field.
- *
- * signal - The details of the signal that contains the state mapping.
- * signals - The list of all signals.
- * signalCount - the length of the signals array.
- * value - The numerical value that should map to a state.
- * send - An output argument that will be set to false if the value should
- * not be sent for any reason.
- *
- * Returns a DynamicField with a string value if a matching state is found in
- * the signal. If an equivalent isn't found, send is sent to false and the
- * return value is undefined.
- */
- static openxc_DynamicField stateDecoder(can_signal_t& signal, const std::vector<can_signal_t>& signals,
- float value, bool* send);
-
- /* Public: Coerces a numerical value to a boolean.
- *
- * This is an implementation of the SignalDecoder type signature, and can be
- * used directly in the can_signal_t.decoder field.
- *
- * signal - The details of the signal that contains the state mapping.
- * signals - The list of all signals
- * signalCount - The length of the signals array
- * value - The numerical value that will be converted to a boolean.
- * send - An output argument that will be set to false if the value should
- * not be sent for any reason.
- *
- * Returns a DynamicField with a boolean value of false if the raw signal value
- * is 0.0, otherwise true. The 'send' argument will not be modified as this
- * decoder always succeeds.
- */
- static openxc_DynamicField booleanDecoder(can_signal_t& signal, const std::vector<can_signal_t>& signals,
- float value, bool* send);
-
- /* Public: Update the metadata for a signal and the newly received value.
- *
- * This is an implementation of the SignalDecoder type signature, and can be
- * used directly in the can_signal_t.decoder field.
- *
- * This function always flips 'send' to false.
- *
- * signal - The details of the signal that contains the state mapping.
- * signals - The list of all signals.
- * signalCount - The length of the signals array.
- * value - The numerical value that will be converted to a boolean.
- * send - This output argument will always be set to false, so the caller will
- * know not to publish this value to the pipeline.
- *
- * The return value is undefined.
- */
- static openxc_DynamicField ignoreDecoder(can_signal_t& signal, const std::vector<can_signal_t>& signals,
- float value, bool* send);
-
- /* Public: Wrap a raw CAN signal value in a DynamicField without modification.
- *
- * This is an implementation of the SignalDecoder type signature, and can be
- * used directly in the can_signal_t.decoder field.
- *
- * signal - The details of the signal that contains the state mapping.
- * signals - The list of all signals
- * signalCount - The length of the signals array
- * value - The numerical value that will be wrapped in a DynamicField.
- * send - An output argument that will be set to false if the value should
- * not be sent for any reason.
- *
- * Returns a DynamicField with the original, unmodified raw CAN signal value as
- * its numeric value. The 'send' argument will not be modified as this decoder
- * always succeeds.
- */
- static openxc_DynamicField noopDecoder(can_signal_t& signal, const std::vector<can_signal_t>& signals,
- float value, bool* send);
-
-
- /* Public: Parse a signal from a CAN message, apply any required transforations
- * to get a human readable value and public the result to the pipeline.
- *
- * If the can_signal_t has a non-NULL 'decoder' field, the raw CAN signal value
- * will be passed to the decoder before publishing.
- *
- * signal - The details of the signal to decode and forward.
- * message - The received CAN message that should contain this signal.
- * signals - an array of all active signals.
- *
- * The decoder returns an openxc_DynamicField, which may contain a number,
- * string or boolean.
- */
- static openxc_DynamicField translateSignal(can_signal_t& signal, can_message_t& message,
- const std::vector<can_signal_t>& signals);
-
- /* Public: Parse a signal from a CAN message and apply any required
- * transforations to get a human readable value.
- *
- * If the can_signal_t has a non-NULL 'decoder' field, the raw CAN signal value
- * will be passed to the decoder before returning.
- *
- * signal - The details of the signal to decode and forward.
- * message - The CAN message that contains the signal.
- * signals - an array of all active signals.
- * send - An output parameter that will be flipped to false if the value could
- * not be decoded.
- *
- * The decoder returns an openxc_DynamicField, which may contain a number,
- * string or boolean. If 'send' is false, the return value is undefined.
- */
- static openxc_DynamicField decodeSignal(can_signal_t& signal, const can_message_t& message,
- const std::vector<can_signal_t>& signals, bool* send);
-
- /* Public: Decode a transformed, human readable value from an raw CAN signal
- * already parsed from a CAN message.
- *
- * This is the same as decodeSignal(const can_signal_t&, CanMessage*, const can_signal_t&, int,
- * bool*) but you must parse the bitfield value of the signal from the CAN
- * message yourself. This is useful if you need that raw value for something
- * else.
- */
- static openxc_DynamicField decodeSignal(can_signal_t& signal, float value,
+public:
+ static float parseSignalBitfield(can_signal_t& signal, const can_message_t& message);
+
+ static openxc_DynamicField stateDecoder(can_signal_t& signal, const std::vector<can_signal_t>& signals,
+ float value, bool* send);
+ static openxc_DynamicField booleanDecoder(can_signal_t& signal, const std::vector<can_signal_t>& signals,
+ float value, bool* send);
+ static openxc_DynamicField ignoreDecoder(can_signal_t& signal, const std::vector<can_signal_t>& signals,
+ float value, bool* send);
+ static openxc_DynamicField noopDecoder(can_signal_t& signal, const std::vector<can_signal_t>& signals,
+ float value, bool* send);
+
+ static openxc_DynamicField translateSignal(can_signal_t& signal, can_message_t& message,
+ const std::vector<can_signal_t>& signals);
+
+ static openxc_DynamicField decodeSignal(can_signal_t& signal, const can_message_t& message,
const std::vector<can_signal_t>& signals, bool* send);
+
+ static openxc_DynamicField decodeSignal(can_signal_t& signal, float value,
+ const std::vector<can_signal_t>& signals, bool* send);
};
\ No newline at end of file
Code Review / apps / low-level-can-service.git / blobdiff