Class PclDocument
- Namespace
- PclIO
- Assembly
- PclIO.dll
Abstract base class representing an opened point cloud file or dataset.
public abstract class PclDocument : IDisposableInheritance
Derived
Implements
Inherited Members
Constructors
PclDocument(string, long)
Initializes the base document.
protected PclDocument(string filePath, long fileSize)Parameters
filePathstring-
Path the document was opened from.
fileSizelong-
Size in bytes reported by PclIO.PclDocument.FileSize.
Fields
_metadata
Backing store for PclIO.PclDocument.Metadata; format readers add to it while opening.
protected readonly Dictionary<string, string> _metadataField Value
_warnings
Backing store for PclIO.PclDocument.Warnings; format readers add to it while opening.
protected readonly List<string> _warningsField Value
Properties
CoordinateSystem
Coordinate system name stored in the file, or null when the file does not state one.
public virtual string? CoordinateSystem { get; protected set; }Property Value
FilePath
The path this document was opened from, as given by the caller.
public string FilePath { get; }Property Value
FileSize
Size in bytes of the main file the reader parsed, as reported by the format reader.
public long FileSize { get; }Property Value
Kind
The format kind of this document.
public abstract PclFileKind Kind { get; }Property Value
Metadata
Format-specific key/value metadata (keys are case-insensitive).
public IReadOnlyDictionary<string, string> Metadata { get; }Property Value
OverallBounds
Union of the non-empty scan bounds, or PclIO.PclBounds.Empty when no scan declares bounds.
public virtual PclBounds OverallBounds { get; }Property Value
Scans
The scans contained in the document, in file order.
public abstract IReadOnlyList<PclScan> Scans { get; }Property Value
TotalPointCount
Sum of PclIO.PclScan.PointCount over all scans. Each scan reports the count its format reader declares or derives (see the reader's own documentation); the value is not verified against the stored points. The sum saturates at System.Int64.MaxValue instead of overflowing, and negative counts add nothing.
public virtual long TotalPointCount { get; }Property Value
Warnings
Non-fatal problems found while reading. The library never writes diagnostics to the console.
public IReadOnlyList<string> Warnings { get; }Property Value
Methods
Dispose()
Releases resources held by the document. The base class holds none.
public virtual void Dispose()ReadAllPoints(PclReadOptions?)
Streams the points of all scans in order. PclIO.PclReadOptions.MaxPoints limits the total across all scans.
public virtual IEnumerable<PclPoint> ReadAllPoints(PclReadOptions? options = null)Parameters
optionsPclReadOptions?-
Read options, or null for PclIO.PclReadOptions.Default.