Skip to content

Describe the node layouts of a ReCap scan in one place - #60

Open
mahach666 wants to merge 1 commit into
feature/issue-8-faro-folder-layoutfrom
feature/issue-9-recap-node-layouts
Open

mahach666 wants to merge 1 commit into
feature/issue-8-faro-folder-layoutfrom
feature/issue-9-recap-node-layouts

Conversation

@mahach666

Copy link
Copy Markdown
Contributor

Closes #9

Based on #59 (the branch feature/issue-8-faro-folder-layout); merge the earlier pull requests first.

What changed

  • The node layout of a ReCap scan file is now described in one place per container version (RcsLayout in the code), so
    that a further version is one small, reviewable addition instead of a change in the middle of the reader. The layout of major
    version 3 is the one that is described.
  • A file of a version without a described layout is rejected with a message that names the version and the described
    versions. The file is still listed with its header, so that the metadata of the project stays visible.
  • RcsScanDocument.DecodedNodeLayoutVersions names the versions that are decoded, so that a caller can tell from the API what
    the reader supports.

Files changed

  • src/PclIO/Formats/Recap/RcsScanDocument.cs: the new RcsLayout type, the version lookup and the rejection message.
  • tests/PclIO.Tests/FormatTests.cs: new tests for the rejection message, for the decoded versions and for a truncated node table.
  • README.md, docs/public-api.md, CHANGELOG.md: the new behaviour.

Tests

  • dotnet build — 0 warnings, 0 errors.
  • dotnet test — 614 passed, 0 failed, 10 skipped (the tests that need private scan files) on .NET 8 and .NET 10.

Limits

  • The node layout of a further version is not decoded yet. A layout is described only when the files of that version may be
    used for the tests, so that its offsets can be verified; the repository has no such file, so only the layout of major version 3
    is described. Everything else — the header, the metadata, the scan list of a project — is read as before.
  • The rejection still happens when the points are read and not when the file is opened, so that a project with a scan of an
    unknown version stays readable.

@mahach666
mahach666 force-pushed the feature/issue-8-faro-folder-layout branch from d7a2b38 to 85e0f53 Compare November 17, 2026 15:01
@mahach666
mahach666 force-pushed the feature/issue-9-recap-node-layouts branch from 91f8120 to 7fc2c2b Compare November 17, 2026 15:01

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant