Nix (Dev) 3.5.10
dev - 3.5.10 - 1af9301
Loading...
Searching...
No Matches
iv::comms::canJ1939::SpnInfo Struct Reference

#include <structs.hpp>

Public Member Functions

bool read (const JSON &pgnJSON, iv::types::comms::spn spn)
 
bool write (JSON &pgnJSON) const
 

Public Attributes

iv::types::comms::spn m_spn
 
std::string m_name
 
std::string m_description
 
bool m_isSigned
 
iv::eEndianType m_endianness
 
iv::types::channelValue m_factor {1.}
 
iv::types::channelValue m_offset {0.}
 
uint32_t m_startingBit
 
uint32_t m_length
 
std::optional< iv::types::channelValuem_min {std::nullopt}
 
std::optional< iv::types::channelValuem_max {std::nullopt}
 
iv::eMeasurementUnit m_unit {iv::eMeasurementUnit::NoUnit}
 

Member Function Documentation

◆ read()

bool iv::comms::canJ1939::SpnInfo::read ( const JSON & pgnJSON,
iv::types::comms::spn spn )

TODO: Check how to work with units and weather it's really useful

◆ write()

bool iv::comms::canJ1939::SpnInfo::write ( JSON & pgnJSON) const

Member Data Documentation

◆ m_description

std::string iv::comms::canJ1939::SpnInfo::m_description

◆ m_endianness

iv::eEndianType iv::comms::canJ1939::SpnInfo::m_endianness

◆ m_factor

iv::types::channelValue iv::comms::canJ1939::SpnInfo::m_factor {1.}

◆ m_isSigned

bool iv::comms::canJ1939::SpnInfo::m_isSigned

◆ m_length

uint32_t iv::comms::canJ1939::SpnInfo::m_length

◆ m_max

std::optional<iv::types::channelValue> iv::comms::canJ1939::SpnInfo::m_max {std::nullopt}

◆ m_min

std::optional<iv::types::channelValue> iv::comms::canJ1939::SpnInfo::m_min {std::nullopt}

◆ m_name

std::string iv::comms::canJ1939::SpnInfo::m_name

◆ m_offset

iv::types::channelValue iv::comms::canJ1939::SpnInfo::m_offset {0.}

◆ m_spn

iv::types::comms::spn iv::comms::canJ1939::SpnInfo::m_spn

◆ m_startingBit

uint32_t iv::comms::canJ1939::SpnInfo::m_startingBit

◆ m_unit

iv::eMeasurementUnit iv::comms::canJ1939::SpnInfo::m_unit {iv::eMeasurementUnit::NoUnit}

The documentation for this struct was generated from the following files: