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

Versioned outcome of a native operation: mesh validation, file I/O, or a job (as the base of JobReport). More...

#include <meshkit/mesh.hpp>

Inheritance diagram for meshkit::OperationReport:
Collaboration diagram for meshkit::OperationReport:

Public Member Functions

bool complete () const noexcept
 Whether the operation delivered a result.
 

Public Attributes

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).
 

Detailed Description

Versioned outcome of a native operation: mesh validation, file I/O, or a job (as the base of JobReport).

Member Function Documentation

◆ complete()

bool meshkit::OperationReport::complete ( ) const
inlinenoexcept

Whether the operation delivered a result.

Returns
true for RunStatus::Complete and RunStatus::CompleteWithExceptions.

Member Data Documentation

◆ code

std::string meshkit::OperationReport::code

Short machine-readable outcome code, e.g.

"valid", "complete", "units" or "cancelled".

◆ counts

Counts meshkit::OperationReport::counts

Vertex and cell counters of the operation; -1 where unavailable.

◆ message

std::string meshkit::OperationReport::message

Human-readable description of the outcome.

◆ record

std::uint64_t meshkit::OperationReport::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.

◆ schemaVersion

std::uint32_t meshkit::OperationReport::schemaVersion = 1

Report schema version; 1 in this release.

◆ seconds

double meshkit::OperationReport::seconds = 0

Elapsed time of the operation in seconds (steady clock).

◆ status

RunStatus meshkit::OperationReport::status = RunStatus::Failed

Final status; Failed until the operation sets it.

◆ work

std::uint64_t meshkit::OperationReport::work = 0

Work units used by the operation's own counter (see Limits::maxWork).


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