Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Egg3 Docs Error: Data Format Type #33

Open
nsoblath opened this issue Apr 19, 2022 · 0 comments
Open

Egg3 Docs Error: Data Format Type #33

nsoblath opened this issue Apr 19, 2022 · 0 comments
Assignees

Comments

@nsoblath
Copy link
Member

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant