cadex::ModelData::ModelReaderDiagnostics Class Reference

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

#include <cadex/ModelData/ModelReaderDiagnostics.hxx>

Inheritance diagram for cadex::ModelData::ModelReaderDiagnostics:

Public Member Functions
	ModelReaderDiagnostics ()
	Constructs an empty diagnostics collection.
const std::vector< ModelReaderDiagnosticsData > &	GetData () const
	Returns a constant reference to the diagnostic records.
Public Member Functions inherited from cadex::BaseObject
size_t	Id () const
	Return unique identifier of public object.
internal::BaseObjectImpl *	Impl () const
bool	IsNull () const
	operator bool () const
template<typename T >
bool	IsOfType () const
template<typename T >
T *	Impl () const
	Reserved for internal use.

Additional Inherited Members
Public Types inherited from cadex::BaseObject
typedef std::shared_ptr< internal::BaseObjectImpl >	ImplType
Protected Member Functions inherited from cadex::BaseObject
	BaseObject (const ImplType &theImpl)

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

(

)

Constructs an empty diagnostics collection.

Member Function Documentation

GetData()

const std::vector< ModelReaderDiagnosticsData > & cadex::ModelData::ModelReaderDiagnostics::GetData

(

)

const

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();