Class ExportReport

Namespace

RvtIO

Assembly

RvtIO.dll

The machine-readable report of one export run (docs/export-report.md). Serialize with RvtIO.ExportReport.ToJson.

public sealed class ExportReport

Inheritance

object

ExportReport

Inherited Members

object.Equals(object?)

object.Equals(object?, object?)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object?, object?)

object.ToString()

Fields

SchemaName

The name and version of the report format.

public const string SchemaName = "rvtio-report/1"

Field Value

string

Properties

Elements

The element table against the parsed elements; absent when the file could not be read.

public ExportReport.ReportElements? Elements { get; set; }

Property Value

ExportReport.ReportElements?

Error

Why the file could not be read; only when RvtIO.ExportReport.Status is failed.

public ExportReport.ReportError? Error { get; set; }

Property Value

ExportReport.ReportError?

ExitCode

The exit code of the process (see RvtIO.RvtExitCodes).

public int ExitCode { get; set; }

Property Value

int

Export

What the export wrote and left out; absent when nothing was exported.

public ExportReport.ReportExport? Export { get; set; }

Property Value

ExportReport.ReportExport?

Input

The input file.

public ExportReport.ReportInput Input { get; set; }

Property Value

ExportReport.ReportInput

Issues

Other findings that make the read partial.

public List<ExportReport.ReportIssue> Issues { get; set; }

Property Value

List<ExportReport.ReportIssue>

Limits

The options that bear on the limits and the limits that cut a stream.

public ExportReport.ReportLimits Limits { get; set; }

Property Value

ExportReport.ReportLimits

Schema

Always RvtIO.ExportReport.SchemaName.

public string Schema { get; set; }

Property Value

string

Status

complete, partial (a limit cut a stream, or a member of a stream did not decode) or failed.

public string Status { get; set; }

Property Value

string

Streams

The partition streams.

public List<ExportReport.ReportStream> Streams { get; set; }

Property Value

List<ExportReport.ReportStream>

Methods

Failed(string, long, string, string, int, RvtReadDiagnostics?, bool, bool, string?)

The report of a file that could not be read.

public static ExportReport Failed(string file, long bytes, string kind, string message, int exitCode, RvtReadDiagnostics? diagnostics, bool raised, bool partialAllowed, string? detail = null)

Parameters

file string

bytes long

kind string

message string

exitCode int

diagnostics RvtReadDiagnostics?

raised bool

partialAllowed bool

detail string?

Returns

ExportReport

Failed(string, long, string, string, int, RvtReadDiagnostics?, bool, bool, string?, bool)

The report of a file that could not be read.

public static ExportReport Failed(string file, long bytes, string kind, string message, int exitCode, RvtReadDiagnostics? diagnostics, bool raised, bool partialAllowed, string? detail, bool strict)

Parameters

file string

bytes long

kind string

message string

exitCode int

diagnostics RvtReadDiagnostics?

raised bool

partialAllowed bool

detail string?

strict bool

Returns

ExportReport

ForRead(string, long, RvtReadDiagnostics, bool, bool, IReadOnlyCollection<uint>, RevitFileInfo)

The report of a finished read. elementIds are the rows of the element table.

public static ExportReport ForRead(string file, long bytes, RvtReadDiagnostics diagnostics, bool raised, bool partialAllowed, IReadOnlyCollection<uint> elementIds, RevitFileInfo info)

Parameters

file string

bytes long

diagnostics RvtReadDiagnostics

raised bool

partialAllowed bool

elementIds IReadOnlyCollection<uint>

info RevitFileInfo

Returns

ExportReport

ForRead(string, long, RvtReadDiagnostics, bool, bool, IReadOnlyCollection<uint>, RevitFileInfo, bool)

The report of a finished read. elementIds are the rows of the element table.

public static ExportReport ForRead(string file, long bytes, RvtReadDiagnostics diagnostics, bool raised, bool partialAllowed, IReadOnlyCollection<uint> elementIds, RevitFileInfo info, bool strict)

Parameters

file string

bytes long

diagnostics RvtReadDiagnostics

raised bool

partialAllowed bool

elementIds IReadOnlyCollection<uint>

info RevitFileInfo

strict bool

Returns

ExportReport

SetExport(string, int, SkipLog)

Adds the export part. skipped holds the elements the export left out.

public void SetExport(string format, int exported, SkipLog skipped)

Parameters

format string

exported int

skipped SkipLog

ToJson()

The report as indented UTF-8 JSON text.

public string ToJson()

Returns

string