#include <mlg_field.h>

Collaboration diagram for MLG::Entries::Field:

[legend]

Public Member Functions
template<typename TValue , int TMult, int TDiv>
LOG_FIELD_CONSTNESS_SPECIFIER_METHODS	Field (const scaled_channel< TValue, TMult, TDiv > &toRead, const char name, const char units, int8_t digits, const char *category="none")

template<typename TValue , typename = typename std::enable_if<std::is_arithmetic_v<TValue>>::type>
LOG_FIELD_CONSTNESS_SPECIFIER_METHODS	Field (TValue &toRead, const char name, const char units, int8_t digits, const char *category="none")

template<typename TValue >
LOG_FIELD_CONSTNESS_SPECIFIER_METHODS	Field (TValue &toRead, const uint32_t bitsBlockOffset, const uint8_t bitNumber, const char name, const char units, const char *category="none")

constexpr size_t	getSize () const

constexpr const void *	getAddr () const

size_t	writeHeader (Writer &outBuffer) const

size_t	writeData (char buffer, void offset) const

Static Private Member Functions
static void	memcpy_swapend (void dest, const void src, size_t const size, void *offset)

static void	copyFloat (char *buffer, float value)

Private Attributes
const float	m_multiplier

const void *const	m_addr

const uint8_t	m_type_id

const int8_t	m_digits

const uint8_t	m_size

const char *const	m_name

const char *const	m_units

const char *const	m_category

const bool	m_isBitField

const uint32_t	m_bitsBlockOffset

const uint8_t	m_bitNumber

Detailed Description

Definition at line 27 of file mlg_field.h.

Constructor & Destructor Documentation

◆ Field() [1/3]

template<typename TValue , int TMult, int TDiv>

LOG_FIELD_CONSTNESS_SPECIFIER_METHODS MLG::Entries::Field::Field	(	const scaled_channel< TValue, TMult, TDiv > &	toRead,
		const char *	name,
		const char *	units,
		int8_t	digits,
		const char *	category = `"none"`
	)

inline

Definition at line 31 of file mlg_field.h.

        : m_multiplier(float(TDiv) / TMult)
        , m_addr(toRead.getFirstByteAddr())
        , m_type_id(static_cast<std::underlying_type_t<Types::Field::Scalar>>(Types::Field::resolveBuiltInNumberType<TValue>()))
        , m_digits(digits)
        , m_size(Types::Field::sizeForType<Types::Field::resolveBuiltInNumberType<TValue>()>())
        , m_name(name)
        , m_units(units)
        , m_category(category)
        , m_isBitField(false)
        , m_bitsBlockOffset(0)
        , m_bitNumber(0)
    {
    }

◆ Field() [2/3]

template<typename TValue , typename = typename std::enable_if<std::is_arithmetic_v<TValue>>::type>

LOG_FIELD_CONSTNESS_SPECIFIER_METHODS MLG::Entries::Field::Field	(	TValue &	toRead,
		const char *	name,
		const char *	units,
		int8_t	digits,
		const char *	category = `"none"`
	)

inline

Definition at line 49 of file mlg_field.h.

        : m_multiplier(1)
        , m_addr(&toRead)
        , m_type_id(static_cast<std::underlying_type_t<Types::Field::Scalar>>(Types::Field::resolveBuiltInNumberType<TValue>()))
        , m_digits(digits)
        , m_size(Types::Field::sizeForType<Types::Field::resolveBuiltInNumberType<TValue>()>())
        , m_name(name)
        , m_units(units)
        , m_category(category)
        , m_isBitField(false)
        , m_bitsBlockOffset(0)
        , m_bitNumber(0)
    {
    }

◆ Field() [3/3]

template<typename TValue >

LOG_FIELD_CONSTNESS_SPECIFIER_METHODS MLG::Entries::Field::Field	(	TValue &	toRead,
		const uint32_t	bitsBlockOffset,
		const uint8_t	bitNumber,
		const char *	name,
		const char *	units,
		const char *	category = `"none"`
	)

inline

Definition at line 67 of file mlg_field.h.

     : m_multiplier(1)
        , m_addr(&toRead)
        , m_type_id(static_cast<std::underlying_type_t<Types::Field::Scalar>>(Types::Field::Scalar::U08))
        , m_digits(0)
        , m_size(1)
        , m_name(name)
        , m_units(units)
        , m_category(category)
        , m_isBitField(true)
        , m_bitsBlockOffset(bitsBlockOffset)
        , m_bitNumber(bitNumber)
    {
    }

Member Function Documentation

◆ copyFloat()

static void MLG::Entries::Field::copyFloat	(	char *	buffer,
		float	value
	)

inlinestaticprivate

Definition at line 162 of file mlg_field.h.

                                                     {
        memcpy_swapend(buffer, &value, sizeof(float), nullptr);
    }

Referenced by writeHeader().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAddr()

constexpr const void * MLG::Entries::Field::getAddr ( ) const

inlineconstexpr

Definition at line 89 of file mlg_field.h.

89{ return m_addr; }

Referenced by MLG::writeSdBlock().

Here is the caller graph for this function:

◆ getSize()

constexpr size_t MLG::Entries::Field::getSize ( ) const

inlineconstexpr

Definition at line 88 of file mlg_field.h.

88{ return m_size; }

Referenced by MLG::computeFieldsRecordLength().

Here is the caller graph for this function:

◆ memcpy_swapend()

static void MLG::Entries::Field::memcpy_swapend	(	void *	dest,
		const void *	src,
		size_t const	size,
		void *	offset
	)

inlinestaticprivate

Definition at line 153 of file mlg_field.h.

                                                                                             {
        const char* src2 = reinterpret_cast<const char*>(src);
        char* dest2 = reinterpret_cast<char*>(dest);
        for (size_t i = 0; i < size; i++) {
            // Endian swap - copy the end to the beginning
            dest2[i] = src2[size - 1 - i + (uint64_t)offset];
        }
    }

Referenced by copyFloat(), and writeData().

Here is the caller graph for this function:

◆ writeData()

size_t MLG::Entries::Field::writeData	(	char *	buffer,
		void *	offset
	)		const

inline

Definition at line 136 of file mlg_field.h.

                                                       {
        if (m_isBitField) {
            const char* const bitsBlockAddr = static_cast<const char*>(m_addr) + m_bitsBlockOffset;
            const char* const byteWithBitAddr = bitsBlockAddr + m_bitNumber / 8;
            unsigned char byteWithBit = 0;
            memcpy_swapend(&byteWithBit, byteWithBitAddr, m_size, offset);
            const uint8_t bitNumberInByte = m_bitNumber % 8;
            buffer[0] = static_cast<char>(static_cast<bool>(byteWithBit & (1 << bitNumberInByte)));
        } else {
            memcpy_swapend(buffer, m_addr, m_size, offset);
        }
 
        return m_size;
    }

Referenced by MLG::writeSdBlock().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeHeader()

size_t MLG::Entries::Field::writeHeader ( Writer & outBuffer ) const

inline

Definition at line 93 of file mlg_field.h.

                                                {
        char buffer[Types::Field::DescriptorSize];
 
        // Offset 0, length 1 = type
        buffer[0] = static_cast<char>(m_type_id);
 
        // Offset 1, length 34 = name
        strncpy(&buffer[1], m_name, 34);
 
        // Offset 35, length 10 = units
        strncpy(&buffer[35], m_units, 10);
 
        // Offset 45, length 1 = Display style
        // value 0 -> floating point number
        buffer[45] = 0;
 
        // Offset 46, length 4 = Scale
        copyFloat(buffer + 46, m_multiplier);
 
        // Offset 50, length 4 = shift before scaling (always 0)
        copyFloat(buffer + 50, 0);
 
        // Offset 54, size 1 = digits to display (signed int)
        buffer[54] = m_digits;
 
        // Offset 55, (optional) category string
        if (m_category) {
            size_t categoryLength = strlen(m_category);
            size_t lengthAfterCategory = 34 - categoryLength;
            memcpy(&buffer[55], m_category, categoryLength);
            memset(&buffer[55] + categoryLength, 0, lengthAfterCategory);
        } else {
            memset(&buffer[55], 0, 34);
        }
 
        // Total size = 89
        outBuffer.write(buffer, Types::Field::DescriptorSize);
 
        return Types::Field::DescriptorSize;
    }

Referenced by MLG::writeFileHeader().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ m_addr

const void* const MLG::Entries::Field::m_addr

private

Definition at line 167 of file mlg_field.h.

Referenced by getAddr(), and writeData().

◆ m_bitNumber

const uint8_t MLG::Entries::Field::m_bitNumber

private

Definition at line 178 of file mlg_field.h.

Referenced by writeData().

◆ m_bitsBlockOffset

const uint32_t MLG::Entries::Field::m_bitsBlockOffset

private

Definition at line 177 of file mlg_field.h.

Referenced by writeData().

◆ m_category

const char* const MLG::Entries::Field::m_category

private

Definition at line 174 of file mlg_field.h.

Referenced by writeHeader().

◆ m_digits

const int8_t MLG::Entries::Field::m_digits

private

Definition at line 169 of file mlg_field.h.

Referenced by writeHeader().

◆ m_isBitField

const bool MLG::Entries::Field::m_isBitField

private

Definition at line 176 of file mlg_field.h.

Referenced by writeData().

◆ m_multiplier

const float MLG::Entries::Field::m_multiplier

private

Definition at line 166 of file mlg_field.h.

Referenced by writeHeader().

◆ m_name

const char* const MLG::Entries::Field::m_name

private

Definition at line 172 of file mlg_field.h.

Referenced by writeHeader().

◆ m_size

const uint8_t MLG::Entries::Field::m_size

private

Definition at line 170 of file mlg_field.h.

Referenced by getSize(), and writeData().

◆ m_type_id

const uint8_t MLG::Entries::Field::m_type_id

private

Definition at line 168 of file mlg_field.h.

Referenced by writeHeader().

◆ m_units

const char* const MLG::Entries::Field::m_units

private

Definition at line 173 of file mlg_field.h.

Referenced by writeHeader().

The documentation for this class was generated from the following file:

console/binary_mlg_log/mlg_field.h

Public Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Field() [1/3]

◆ Field() [2/3]

◆ Field() [3/3]

Member Function Documentation

◆ copyFloat()

◆ getAddr()

◆ getSize()

◆ memcpy_swapend()

◆ writeData()

◆ writeHeader()

Field Documentation

◆ m_addr

◆ m_bitNumber

◆ m_bitsBlockOffset

◆ m_category

◆ m_digits

◆ m_isBitField

◆ m_multiplier

◆ m_name

◆ m_size

◆ m_type_id

◆ m_units