Provides diagnostics reported during a model read operation. More...

Inheritance diagram for cadex.ModelData.ModelReaderDiagnostics:

Public Member Functions
	ModelReaderDiagnostics (global::System.IntPtr cPtr, bool cMemoryOwn)

	ModelReaderDiagnostics ()
	Constructs an empty diagnostics collection.

cadex.Collections.ModelReaderDiagnosticsDataList	GetData ()
	Returns a constant reference to the diagnostic records.

Public Member Functions inherited from cadex.BaseObject
	BaseObject (global::System.IntPtr cPtr, bool cMemoryOwn)

void	Dispose ()

bool	IsNull ()

ulong	Id ()
	Return unique identifier of public object.

bool	IsEqual (cadex.BaseObject theObj)

override int	GetHashCode ()

override bool	Equals (System.Object o)

Protected Member Functions
override void	Dispose (bool disposing)

Detailed Description

Provides diagnostics reported during a model read operation.

ModelReader exposes its diagnostics through ModelReader.Diagnostics(). The collection contains diagnostics from the most recent ModelReader.Read() operation at the time the snapshot was created.

Diagnostics can be inspected after ModelReader.Read() completes, including when it returns false. GetData() returns a constant reference to the diagnostic records in this snapshot.

See also: ModelReader, ModelReaderDiagnosticsData.

Constructor & Destructor Documentation

◆ ModelReaderDiagnostics()

cadex.ModelData.ModelReaderDiagnostics.ModelReaderDiagnostics ( )

inline

Constructs an empty diagnostics collection.

Member Function Documentation

◆ Dispose()

override void cadex.ModelData.ModelReaderDiagnostics.Dispose ( bool disposing )

inlineprotectedvirtual

Reimplemented from cadex.BaseObject.

◆ GetData()

cadex.Collections.ModelReaderDiagnosticsDataList cadex.ModelData.ModelReaderDiagnostics.GetData ( )

inline

Returns a constant reference to the diagnostic records.

The returned reference remains valid while this diagnostics collection is alive and unchanged. Keep the diagnostics collection alive while accessing its records:

auto aDiagnostics = aReader.Diagnostics();

const auto& aData = aDiagnostics.GetData();