|
OpenTop 1.3 | |||||
PREV NAMESPACE NEXT NAMESPACE | FRAMES NO FRAMES |
Class Summary | |
ArrayAutoPtr |
A variation of std::auto_ptr which holds a pointer to an array and uses the associated delete [] syntax when it needs to destroy the array. |
AtomicCounter |
Integer value that can be incremented and decremented. In a multi-threaded environment, access to the counter is synchronized to prevent lost updates. |
AutoBuffer |
An efficient buffer that will automatically grow to hold the required data. |
AutoLock |
Acquires a lock on initialization and releases it on destruction. |
AutoUnlock |
Releases a lock on initialization and re-acquires it on destruction. |
Character |
Represents a Unicode character using an internal sequence of one or more CharType characters. |
CodeConverterBase |
Base class that contains enums, values and static methods used by all CodeConverter sub-classes. |
ConditionVariable |
Provides a means for a thread to be signalled when a condition becomes true. |
FastMutex |
Variety of mutex that is optimized and may offer better performance on some platforms. |
ManagedObject |
Common base class for all classes that rely on reference-counting to perform automatic object lifetime management. |
MessageFactory |
Abstract 'interface' class used by OpenTop for locating error and information messages. |
Monitor |
A base class providing both synchronization and notification. |
Mutex |
Multi-threaded synchronization object that enables mutually exclusive access to a protected resource. |
NumUtils |
Class module containing functions to convert numbers into Strings and vice versa. |
ObjectManager |
Manages the lifetime of ManagedObject instances that need to exist for the duration of the application. |
RecursiveMutex |
Variety of mutex that can be locked multiple times by the same thread without blocking. |
RefPtr |
Template class that helps to implement the ManagedObject reference-counting scheme. |
RefPtrMember |
Template class designed to be used as a member variable within a class that needs to store object references, possibly even a reference to itself. |
Runnable |
Abstract 'interface' class which should be implemented by any class whose instances are intended to be executed by a Thread. The derived class must implement the pure virtual run() method. |
StringIterator |
Iterator class that will iterate over each Unicode character contained within a controlled sequence of CharType characters encoded according to the internal OpenTop encoding. |
StringUtils |
Class module containing functions to compare and manipulate strings. |
SynchronizedObject |
A Base class facilitating synchronized concurrent access from multiple threads. |
System |
Class module providing useful system-level functions as well as providing a well-known and accessible root from which to navigate to other essential services. |
SystemCodeConverter |
Class module for converting Unicode strings to and from the internal character encoding. |
SystemMonitor |
Application helper class to terminate the OpenTop library cleanly. |
Thread |
Class to start and control threads of execution. |
ThreadId |
Represents an abstract thread identifier. |
ThreadLocal |
Provides a class interface to native thread-local storage which provides each thread with its own copy of a variable. |
Tracer |
Provides an abstraction for a run-time tracing service. |
UnicodeCharacterType |
Class module for determining the characteristics of a given Unicode character. |
Exception Summary | |
Exception |
Base class for all exceptions thrown from the OpenTop library. |
IllegalArgumentException |
Thrown when an illegal argument is passed to a OpenTop method. |
IllegalCharacterException |
Thrown when an illegal character value is detected. |
IllegalMonitorStateException |
Thrown when a Mutex is not in the correct locked state for an operation. |
IllegalStateException |
Thrown when a method is called for an object that is not in the correct state for that operation. |
IllegalThreadStateException |
Thrown when a Thread object is not in the correct state for the method being called. For example, a Thread cannot be started more than once. |
InterruptedException |
Thrown when a thread is waiting, sleeping, or otherwise paused for a long time and another thread interrupts it using Thread::interrupt(). |
NullPointerException |
Thrown when a null pointer is passed to a method that requires a valid pointer to be passed. |
OSException |
Thrown when OpenTop makes a system call which results in an unexpected return code. |
RuntimeException |
Base class for exceptions that can be thrown by almost all methods and which are not normally documented in the reference material. |
UnsupportedOperationException |
Thrown when an operation is attempted that is not supported on the current platform. |
Typedef Summary | |
String |
This typedef determines the String type used by OpenTop. |
ByteString |
This typedef determines the ByteString type used by OpenTop. |
CharType |
Determines the character type used by OpenTop. |
UCharType |
Unsigned version of CharType. |
Byte |
Represents a byte which is an unsigned 8-bit value with a range of 0-255. |
UCS4Char |
Represents an integer type that is capable of holding the code-points for all Unicode characters in the range U+0000 to U+10FFFF. |
UShort |
Convenient type used as an unsigned short integer. |
IntType |
Type used as the return type in operations that need to return either a CharType or -1 which might not be a legal CharType value. |
Typedefs |
typedef unsigned char Byte
Represents a byte which is an unsigned 8-bit value with a range of 0-255.
Bytes are used as the value type when reading or writing external media or communicating with other systems. Bytes are typically converted to and from characters using some form of encoding.
typedef OT_BYTE_STRING_TYPE ByteString
This typedef determines the ByteString type used by OpenTop.
The type is set equal to the value of the pre-processor symbol OT_BYTE_STRING_TYPE which is normally set to std::string.The library requires that the ByteString type supports a set of operations equivalent to those provided by the standard C++ string std::basic_string<char>.
typedef OT_CHAR_TYPE CharType
Determines the character type used by OpenTop.
The type is set equal to the value of the pre-processor symbol OT_CHAR_TYPE which is set equal to char unless the OT_WCHAR pre-processor symbol is specified, in which case it is set to wchar_t.As char is normally only 8-bits wide and wchar_t is only 16-bits wide on some platforms, it is not always possible to store a Unicode character into one CharType character. In this case OpenTop represents Unicode characters using a multi-character encoding.
If CharType is char then the internal encoding used is UTF-8. If CharType is a 16-bit wchar_t then UTF-16 is used (not UCS-2). If CharType is a 32-bit value then no encoding is required as characters are UCS4 already.
typedef OT_INT_TYPE IntType
Type used as the return type in operations that need to return either a CharType or -1 which might not be a legal CharType value.
typedef OT_STRING_TYPE String
This typedef determines the String type used by OpenTop.
The type is set equal to the value of the pre-processor symbol OT_STRING_TYPE which is normally set to std::string (or std::wstring if the OT_WCHAR pre-processor symbol is defined).The library requires that the String type supports a set of operations equivalent to those provided by the standard C++ string std::basic_string<T>.
typedef OT_UCHAR_TYPE UCharType
Unsigned version of CharType.
As CharType is supposed to represent character values, ideally it should be an unsigned value. This is the case on some platforms but not on others. Functions that must use an unsigned value use UCharType in place of CharType.On platforms where CharType is already unsigned, CharType and UCharType represent the same type.
typedef unsigned long UCS4Char
Represents an integer type that is capable of holding the code-points for all Unicode characters in the range U+0000 to U+10FFFF.
This range requires an integer at least 21 bits wide, so UCS4Char is normally implemented using a 32-bit value.On some platforms (such as Linux) wchar_t is a 32-bit integer, so UCS4Char and wchar_t are the same. However, on other platforms (such as Microsoft Windows) wchar_t is a 16-bit integer and is therefore incapable of representing the required Unicode range.
typedef unsigned short UShort
Convenient type used as an unsigned short integer.
|
OpenTop 1.3 | |||||
PREV NAMESPACE NEXT NAMESPACE | FRAMES NO FRAMES |