Skip to content

Egg3 Docs Error: Data Format Type #33

@nsoblath

Description

@nsoblath

The docs list the data format type for both the stream and channel headers as:

  • data_format_type (uint32) – Whether the data is analog or digitized
    • 0 == digitized
    • 1 == analog

Meanwhile the actual constant is defined in M3Constants.hh as:

    /// Data Format
    /// Specifies whether the data is digitized (unsigned or signed) or analog
    static const uint32_t sInvalidFormat = std::numeric_limits< uint32_t >::max();
    static const uint32_t sDigitizedUS = 0;
    static const uint32_t sDigitizedS = 1;
    static const uint32_t sAnalog = 2;

Clearly the documentation is wrong, and needs to be fixed. The code is the same all the way back to Monarch v3.0.0, so all versions of the Egg-standard documentation need to be updated, EggStandard.v3.0.0.rst, EggStandard.v3.1.0.rst, and EggStandard.v3.2.0.rst.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions