cadex::ModelData::ModelReaderDiagnosticsData Class Reference

Describes a diagnostic reported while reading a model file. More...

#include <cadex/ModelData/ModelReaderDiagnosticsData.hxx>

Inheritance diagram for cadex::ModelData::ModelReaderDiagnosticsData:

Public Types
enum class	SeverityType { Warning = 0 , Error = 1 }
	Specifies the severity of a diagnostic. More...
enum class	CategoryType { Parsing = 0 , Conversion = 1 }
	Specifies the stage of the import process that reported a diagnostic. More...
enum class	CodeType { UnsupportedVersion = 0 , UnsupportedFileType = 1 , GenericGeometryError = 2 , Unknown = 3 }
	Specifies a machine-readable diagnostic code. More...
Public Types inherited from cadex::BaseObject
typedef std::shared_ptr< internal::BaseObjectImpl >	ImplType

Public Member Functions
	ModelReaderDiagnosticsData (SeverityType theSeverity, CategoryType theCategory, CodeType theCode, const UTF16String &theMessage)
	Constructs a diagnostic record.
SeverityType	Severity () const
	Returns the severity of the diagnostic.
CategoryType	Category () const
	Returns the stage of the import process that reported the diagnostic.
CodeType	Code () const
	Returns the machine-readable diagnostic code.
const UTF16String &	Message () const
	Returns the human-readable diagnostic message.
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
Protected Member Functions inherited from cadex::BaseObject
	BaseObject (const ImplType &theImpl)

Detailed Description

Describes a diagnostic reported while reading a model file.

A diagnostic contains a severity, an import-stage category, a machine-readable code, and a human-readable message.

See also

ModelReaderDiagnostics, ModelReader::Diagnostics().

Member Enumeration Documentation

CategoryType

enum class cadex::ModelData::ModelReaderDiagnosticsData::CategoryType

strong

Specifies the stage of the import process that reported a diagnostic.

CodeType

enum class cadex::ModelData::ModelReaderDiagnosticsData::CodeType

strong

Specifies a machine-readable diagnostic code.

SeverityType

enum class cadex::ModelData::ModelReaderDiagnosticsData::SeverityType

strong

Specifies the severity of a diagnostic.

Constructor & Destructor Documentation

ModelReaderDiagnosticsData()

cadex::ModelData::ModelReaderDiagnosticsData::ModelReaderDiagnosticsData	(	SeverityType	theSeverity,
		CategoryType	theCategory,
		CodeType	theCode,
		const UTF16String &	theMessage )

Constructs a diagnostic record.

Parameters

theSeverity	Severity of the diagnostic.
theCategory	Stage of the import process that reported the diagnostic.
theCode	Machine-readable diagnostic code.
theMessage	Human-readable details of the diagnostic.

Member Function Documentation

Category()

ModelReaderDiagnosticsData::CategoryType cadex::ModelData::ModelReaderDiagnosticsData::Category

(

)

const

Returns the stage of the import process that reported the diagnostic.

Code()

ModelReaderDiagnosticsData::CodeType cadex::ModelData::ModelReaderDiagnosticsData::Code

(

)

const

Returns the machine-readable diagnostic code.

Message()

const UTF16String & cadex::ModelData::ModelReaderDiagnosticsData::Message

(

)

const

Returns the human-readable diagnostic message.

Severity()

ModelReaderDiagnosticsData::SeverityType cadex::ModelData::ModelReaderDiagnosticsData::Severity

(

)

const

Returns the severity of the diagnostic.