cadex.ModelData.ModelReaderDiagnosticsData Class Reference

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

Inheritance diagram for cadex.ModelData.ModelReaderDiagnosticsData:

Public Types
enum	SeverityType { Warning = 0 , Error = 1 }
	Specifies the severity of a diagnostic. More...
enum	CategoryType { Parsing = 0 , Conversion = 1 }
	Specifies the stage of the import process that reported a diagnostic. More...
enum	CodeType { UnsupportedVersion = 0 , UnsupportedFileType = 1 , GenericGeometryError = 2 , Unknown = 3 }
	Specifies a machine-readable diagnostic code. More...

Public Member Functions
	ModelReaderDiagnosticsData (global::System.IntPtr cPtr, bool cMemoryOwn)
	ModelReaderDiagnosticsData (cadex.ModelData.ModelReaderDiagnosticsData.SeverityType theSeverity, cadex.ModelData.ModelReaderDiagnosticsData.CategoryType theCategory, cadex.ModelData.ModelReaderDiagnosticsData.CodeType theCode, cadex.UTF16String theMessage)
	Constructs a diagnostic record.
cadex.ModelData.ModelReaderDiagnosticsData.SeverityType	Severity ()
	Returns the severity of the diagnostic.
cadex.ModelData.ModelReaderDiagnosticsData.CategoryType	Category ()
	Returns the stage of the import process that reported the diagnostic.
cadex.ModelData.ModelReaderDiagnosticsData.CodeType	Code ()
	Returns the machine-readable diagnostic code.
cadex.UTF16String	Message ()
	Returns the human-readable diagnostic message.
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

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 cadex.ModelData.ModelReaderDiagnosticsData.CategoryType

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

CodeType

enum cadex.ModelData.ModelReaderDiagnosticsData.CodeType

Specifies a machine-readable diagnostic code.

SeverityType

enum cadex.ModelData.ModelReaderDiagnosticsData.SeverityType

Specifies the severity of a diagnostic.

Constructor & Destructor Documentation

ModelReaderDiagnosticsData()

cadex.ModelData.ModelReaderDiagnosticsData.ModelReaderDiagnosticsData ( cadex.ModelData.ModelReaderDiagnosticsData.SeverityType theSeverity, cadex.ModelData.ModelReaderDiagnosticsData.CategoryType theCategory, cadex.ModelData.ModelReaderDiagnosticsData.CodeType theCode, cadex.UTF16String theMessage )

inline

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

cadex.ModelData.ModelReaderDiagnosticsData.CategoryType cadex.ModelData.ModelReaderDiagnosticsData.Category ( )

inline

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

Code()

cadex.ModelData.ModelReaderDiagnosticsData.CodeType cadex.ModelData.ModelReaderDiagnosticsData.Code ( )

inline

Returns the machine-readable diagnostic code.

Dispose()

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

inlineprotectedvirtual

Reimplemented from cadex.BaseObject.

Message()

cadex.UTF16String cadex.ModelData.ModelReaderDiagnosticsData.Message ( )

inline

Returns the human-readable diagnostic message.

Severity()

cadex.ModelData.ModelReaderDiagnosticsData.SeverityType cadex.ModelData.ModelReaderDiagnosticsData.Severity ( )

inline

Returns the severity of the diagnostic.