.TH "SoReadError" 3 "Tue Dec 26 2023 17:59:22" "Version 4.0.2" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SoReadError \- The \fBSoReadError\fP class is used during model import operations\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <Inventor/errors/SoReadError\&.h>\fP
.PP
Inherits \fBSoError\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBvirtual\fP \fBSoType\fP \fBgetTypeId\fP (\fBvoid\fP) \fBconst\fP"
.br
.in -1c

Public Member Functions inherited from \fBSoError\fP
.in +1c
.ti -1c
.RI "\fBvirtual\fP \fB~SoError\fP ()"
.br
.ti -1c
.RI "\fBconst\fP \fBSbString\fP & \fBgetDebugString\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBisOfType\fP (\fBconst\fP \fBSoType\fP type) \fBconst\fP"
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBsetHandlerCallback\fP (SoErrorCB *\fBconst\fP function, \fBvoid\fP *\fBconst\fP data)"
.br
.ti -1c
.RI "\fBstatic\fP SoErrorCB * \fBgetHandlerCallback\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP * \fBgetHandlerData\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBpost\fP (\fBconst\fP \fBSoInput\fP *\fBconst\fP input, \fBconst\fP char *\fBconst\fP format,\&.\&.\&.)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)"
.br
.in -1c

Static Public Member Functions inherited from \fBSoError\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBsetHandlerCallback\fP (SoErrorCB *\fBconst\fP func, \fBvoid\fP *\fBconst\fP data)"
.br
.ti -1c
.RI "\fBstatic\fP SoErrorCB * \fBgetHandlerCallback\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP * \fBgetHandlerData\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBpost\fP (\fBconst\fP char *\fBconst\fP format,\&.\&.\&.)"
.br
.ti -1c
.RI "\fBstatic\fP \fBSbString\fP \fBgetString\fP (\fBconst\fP \fBSoNode\fP *\fBconst\fP node)"
.br
.ti -1c
.RI "\fBstatic\fP \fBSbString\fP \fBgetString\fP (\fBconst\fP \fBSoPath\fP *\fBconst\fP path)"
.br
.ti -1c
.RI "\fBstatic\fP \fBSbString\fP \fBgetString\fP (\fBconst\fP \fBSoEngine\fP *\fBconst\fP \fBengine\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClasses\fP (\fBvoid\fP)"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "\fBvirtual\fP SoErrorCBPtr \fBgetHandler\fP (\fBvoid\fP *&data) \fBconst\fP"
.br
.in -1c

Protected Member Functions inherited from \fBSoError\fP
.in +1c
.ti -1c
.RI "\fBvoid\fP \fBsetDebugString\fP (\fBconst\fP char *\fBconst\fP str)"
.br
.ti -1c
.RI "\fBvoid\fP \fBappendToDebugString\fP (\fBconst\fP char *\fBconst\fP str)"
.br
.ti -1c
.RI "\fBvoid\fP \fBhandleError\fP (\fBvoid\fP)"
.br
.in -1c
.SS "Additional Inherited Members"


Static Protected Member Functions inherited from \fBSoError\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBdefaultHandlerCB\fP (\fBconst\fP \fBSoError\fP *\fBerror\fP, \fBvoid\fP *userdata)"
.br
.in -1c
.SH "Detailed Description"
.PP 
The \fBSoReadError\fP class is used during model import operations\&. 

During model file import, this class will be used to output any error or warning messages\&.
.PP
Depending on your application, setting up your own error handler callbacks for \fBSoReadError\fP might be a good idea\&. 
.SH "Member Function Documentation"
.PP 
.SS "\fBvoid\fP SoReadError::setHandlerCallback (SoErrorCB *\fBconst\fP function, \fBvoid\fP *\fBconst\fP data)\fC [static]\fP"
This method sets the error handler callback for messages posted via this class\&.
.PP
Note that this will not override the error/debug message handler for subclasses, these will have to be overridden by calling the subclass' \fBsetHandlerCallback()\fP method\&.
.PP
\fBSee also\fP
.RS 4
\fBdefaultHandlerCB()\fP   
.RE
.PP

.SS "SoErrorCB * SoReadError::getHandlerCallback (\fBvoid\fP)\fC [static]\fP"
Returns the error handler callback for messages posted via this class\&.   
.SS "\fBvoid\fP * SoReadError::getHandlerData (\fBvoid\fP)\fC [static]\fP"
This method returns the pointer used for passing data back to the callback handler method\&.   
.SS "\fBSoType\fP SoReadError::getClassTypeId (\fBvoid\fP)\fC [static]\fP"
This static method returns the \fBSoType\fP for this class\&.
.PP
\fBSee also\fP
.RS 4
\fBgetTypeId()\fP   
.RE
.PP

.SS "\fBSoType\fP SoReadError::getTypeId (\fBvoid\fP) const\fC [virtual]\fP"
This method returns the \fBSoType\fP of a particular object instance\&.
.PP
\fBSee also\fP
.RS 4
\fBgetClassTypeId()\fP 
.RE
.PP

.PP
Reimplemented from \fBSoError\fP\&.
.SS "\fBvoid\fP SoReadError::post (\fBconst\fP \fBSoInput\fP *\fBconst\fP in, \fBconst\fP char *\fBconst\fP format,  \&.\&.\&.)\fC [static]\fP"
Method used from import code to post error or warning messages for model files which are not 100% compliant to the format specification\&.
.PP
The messages will be wrapped within information on line number, file offset etc\&. 
.SS "SoErrorCB * SoReadError::getHandler (\fBvoid\fP *& data) const\fC [protected]\fP, \fC [virtual]\fP"
This is just a convenience wrapper around the \fBgetHandlerCallback()\fP and \fBgetHandlerData()\fP methods\&. 
.PP
Reimplemented from \fBSoError\fP\&.

.SH "Author"
.PP 
Generated automatically by Doxygen for Coin from the source code\&.