RenderManAPI  24.0
RixXcpt Class Referenceabstract

The primary means to comprehend exceptional conditions within Rix is to handle messages generated by the library components. More...

#include <RixInterfaces.h>

Inherits RixInterface.

Classes

class  XcptHandler
 A base class characterizing the required interface for xcpt handlers. More...
 

Public Types

enum  Type {
  k_Float, k_Integer, k_StringV, k_Color,
  k_Normal, k_Vector, k_Point, k_HPoint,
  k_MPoint, k_Matrix
}
 

Public Member Functions

virtual void Register (XcptHandler *)=0
 Register your msg handler to receive exceptions and diagnostics produced through the use of the Rix interfaces. More...
 
virtual void Unregister (XcptHandler *)=0
 Unregister a msg handler. More...
 
virtual void SetBuiltinHandler (RtUString name)=0
 Set one of the builtin error handlers. More...
 
virtual int GetVersion () const
 Get the version number of this interface. More...
 

Protected Member Functions

 RixXcpt ()
 

Protected Attributes

int m_version
 Version number of this interface. More...
 

Detailed Description

The primary means to comprehend exceptional conditions within Rix is to handle messages generated by the library components.

Clients should subclass RixXcptandler and register the object with the RixContext. Now they must carefully monitor the msg stream for severe conditions that might effect the use of the interfaces. In addition, lower-grade diagnostics should be reported through application-specific logging facilities.

Member Enumeration Documentation

◆ Type

enum RixInterface::Type
inherited
Enumerator
k_Float 
k_Integer 
k_StringV 
k_Color 
k_Normal 
k_Vector 
k_Point 
k_HPoint 
k_MPoint 
k_Matrix 

Constructor & Destructor Documentation

◆ RixXcpt()

RixXcpt::RixXcpt ( )
inlineprotected

Member Function Documentation

◆ GetVersion()

virtual int RixInterface::GetVersion ( ) const
inlinevirtualinherited

Get the version number of this interface.

Different interfaces might have different version numbers in a given release.

References RixInterface::m_version.

◆ Register()

virtual void RixXcpt::Register ( XcptHandler )
pure virtual

Register your msg handler to receive exceptions and diagnostics produced through the use of the Rix interfaces.

Multiple handlers can be registered.

◆ SetBuiltinHandler()

virtual void RixXcpt::SetBuiltinHandler ( RtUString  name)
pure virtual

Set one of the builtin error handlers.

Parameters
nameValues are: ignore, print, printonce, abort, or conditionalabort

◆ Unregister()

virtual void RixXcpt::Unregister ( XcptHandler )
pure virtual

Unregister a msg handler.

Member Data Documentation

◆ m_version

int RixInterface::m_version
protectedinherited

Version number of this interface.

Referenced by RixInterface::GetVersion().


The documentation for this class was generated from the following file: