Loading...
Searching...
No Matches
meshkit::IOReport Struct Reference

Outcome of one read or write: status, code, message, counts, timing and byte total. More...

#include <meshkit/io.hpp>

Inheritance diagram for meshkit::IOReport:
Collaboration diagram for meshkit::IOReport:

Public Attributes

std::uint64_t bytes = 0
 Bytes written or read (MKB includes the checksum footer; a 2DM read reports the file size measured by its first pass).
 
std::uint64_t ignoredRecords = 0
 read2dm() only: cards skipped under UnknownRecords::IgnoreWithReport.
 
std::uint64_t reorientedCells = 0
 read2dm() only: clockwise cells whose corner order was reversed.
 
std::vector< std::string > losses
 Bounded codes, with total ignored-record count above.
 
- Public Attributes inherited from meshkit::OperationReport
std::uint32_t schemaVersion = 1
 Report schema version; 1 in this release.
 
RunStatus status = RunStatus::Failed
 Final status; Failed until the operation sets it.
 
std::string code
 Short machine-readable outcome code, e.g.
 
std::string message
 Human-readable description of the outcome.
 
Counts counts
 Vertex and cell counters of the operation; -1 where unavailable.
 
std::uint64_t work = 0
 Work units used by the operation's own counter (see Limits::maxWork).
 
std::uint64_t record = 0
 Record reached by a file reader (the SMS 2DM line number, or the number of MeshKit binary records read), which locates a read error; 0 for operations that read no records.
 
double seconds = 0
 Elapsed time of the operation in seconds (steady clock).
 

Additional Inherited Members

- Public Member Functions inherited from meshkit::OperationReport
bool complete () const noexcept
 Whether the operation delivered a result.
 

Detailed Description

Outcome of one read or write: status, code, message, counts, timing and byte total.

Member Data Documentation

◆ bytes

std::uint64_t meshkit::IOReport::bytes = 0

Bytes written or read (MKB includes the checksum footer; a 2DM read reports the file size measured by its first pass).

Set only on success, otherwise 0.

◆ ignoredRecords

std::uint64_t meshkit::IOReport::ignoredRecords = 0

read2dm() only: cards skipped under UnknownRecords::IgnoreWithReport.

◆ losses

std::vector<std::string> meshkit::IOReport::losses

Bounded codes, with total ignored-record count above.

◆ reorientedCells

std::uint64_t meshkit::IOReport::reorientedCells = 0

read2dm() only: clockwise cells whose corner order was reversed.


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