Base class for all BSAPI interfaces. More...
#include <bsapi.h>
Public Member Functions | |
| virtual unsigned int BSAPI_METHOD | AddRef ()=0 |
| Increase the reference counter by one. | |
| virtual unsigned int BSAPI_METHOD | Release ()=0 |
| Decrease the reference counter by one. If the number of references is zero, the instance is destroyed itself. | |
| virtual unsigned int BSAPI_METHOD | GetIID ()=0 |
| Returns interface identification number. | |
| virtual void BSAPI_METHOD | SetErrorHandler (SErrorCallbackI *pErrorHandler)=0 |
| Set error handler. | |
| virtual SErrorCallbackI *BSAPI_METHOD | GetErrorHandler ()=0 |
| Get error handler. | |
Detailed Description
Base class for all BSAPI interfaces.
The BSCORE classes can not be created directly but they are requested using the BSAPICreateInstance() function. Each class has its interface (a class with I at the end of name which form the API) and its own interface identification number. The SUnknownI is a basic class for all BSAPI interfaces. It contains functions for returning interface identification number, for counting references and for setting an error handler. If nobody refers the instance. The instance should destroy itself.
- Examples:
-
error_handler.cpp, gid.cpp, kws.cpp, lid.cpp, offlinerec3.cpp, sid.cpp, vpcompare.cpp, and vpextract.cpp.
Member Function Documentation
| virtual unsigned int BSAPI_METHOD SUnknownI::AddRef | ( | ) | [pure virtual] |
Increase the reference counter by one.
- Returns:
- Number of references (users of the instance).
| virtual SErrorCallbackI* BSAPI_METHOD SUnknownI::GetErrorHandler | ( | ) | [pure virtual] |
Get error handler.
- Returns:
- pointer to instance of error handler
| virtual unsigned int BSAPI_METHOD SUnknownI::GetIID | ( | ) | [pure virtual] |
Returns interface identification number.
All interface identification numbers can be found in BSAPI Interface Identification Numbers.
- Returns:
- unique number that characterize BSCORE class.
- Examples:
- error_handler.cpp, gid.cpp, kws.cpp, lid.cpp, offlinerec3.cpp, sid.cpp, vpcompare.cpp, and vpextract.cpp.
| virtual unsigned int BSAPI_METHOD SUnknownI::Release | ( | ) | [pure virtual] |
Decrease the reference counter by one. If the number of references is zero, the instance is destroyed itself.
- Returns:
- Number of references (users of the instance).
- Examples:
- error_handler.cpp, first_step.cpp, gid.cpp, kws.cpp, lid.cpp, offlinerec3.cpp, sid.cpp, vpcompare.cpp, and vpextract.cpp.
| virtual void BSAPI_METHOD SUnknownI::SetErrorHandler | ( | SErrorCallbackI * | pErrorHandler | ) | [pure virtual] |
Set error handler.
Some functions of the BSCORE classes signalize success by true and failure by false. But it is usually necessary to know a cause of an error in detail. The default behaviour of the BSCORE classes is to send an error code and text message to a callback to allow to log the error or to display the error to a user when the error happened. The error handler also receives warnings and log messages. If the error handler is not set, the messages are printed to the standard output.
- Parameters:
-
pErrorHandler pointer to instance of error handler
Implemented in SPhoneticLabelExpansionI.
- Examples:
- error_handler.cpp, gid.cpp, kws.cpp, lid.cpp, offlinerec3.cpp, sid.cpp, vpcompare.cpp, and vpextract.cpp.
The documentation for this class was generated from the following file:
