WOscException.h File Reference

#include "WOscLib.h"
#include <string>

Go to the source code of this file.

Classes

class  WOscException

Enumerations

enum  ErrorCodes {
  ERR_NO_ERROR = 0, ERR_REMOVE_FROM_EMPTY_QUEUE, ERR_INVALID_ADDRESS_NO_SLASH, ERR_NOT_DISPATCHING_FROM_ROOT,
  ERR_PARENT_POINTER_NULL, ERR_ROOT_ALIAS, ERR_NULL_ADDRESS, ERR_OSC_STR_BUFF_TOO_SMALL,
  ERR_NULL_BUFFER, ERR_INVALID_INDEX, ERR_BUFFER_TO_SMALL, ERR_NOT_ROOT_CONTAINER,
  ERR_RECURSIVE_ALIAS, ERR_TOO_SHORT, ERR_EMPTY_BUNDLE, ERR_INVALID_TAG,
  ERR_CURRUPT_BUNDLE_LAYOUT, ERR_NO_ITEMS_IN_BUNDLE, ERR_CAN_NOT_CLONE_UNINITIALIZED_BUNDLE
}

Detailed Description

WOscException header file.

Author
cls-nebadje

( _UcfWOscLib )

Date
2009-01-13 17:23:19
Revision
1.4

Copyright (c) Weiss Engineering Ltd

Definition in file WOscException.h.


Enumeration Type Documentation

enum ErrorCodes

The error codes of all exceptions which are thrown inside the Weiss OSC Library. Refer to these defines when handling exceptions.

Enumerator:
ERR_NO_ERROR 

No exception occurred (should not happen when throwing exceptions).

ERR_REMOVE_FROM_EMPTY_QUEUE 

Trying to remove items from an empty priority queue.

See also:
WOscPriorityQueue.
ERR_INVALID_ADDRESS_NO_SLASH 

Trying to initialize a WOscMessage with a corrupt address with missing slash at the beginning.

ERR_NOT_DISPATCHING_FROM_ROOT 

Messages can only be dispatched beginning at a root container.

See also:
WOscContainer
ERR_PARENT_POINTER_NULL 

During construction of a WOscContainer or WOscMethod a NULL pointer was passed as parent or someone tried to add an OSC container alias (or an OSC method/method-alias) with NULL pointer as parent.

See also:
WOscContainer.
ERR_NULL_ADDRESS 

The root container can not be added as alias to any container. NULL-pointer argument passed to constructor of WOscMessage.

See also:
WOscMessage::WOscMessage(const char *address)
ERR_OSC_STR_BUFF_TOO_SMALL 

When using the getBuffer(char* buffer, int bufferLen) functions (included in several classes) and the passed buffer of length "bufferLen" is smaller than the object-internal data-length, this exception will be raised.

See also:
WOscMessage | WOscBundle | WOscString
ERR_NULL_BUFFER 

When passed a null pointer to the constructor of an OSC-message when constructing from a byte-stream.

See also:
WOscMessage::WOscMessage(char* buffer, int bufferLen)
ERR_INVALID_INDEX 

When extracting bundle elements (messages or bundles) from a WOscBundle object or arguments from a WOscMessage object, make sure the "idx" parameter remains in valid boundaries by getting the number of elements contained in the bundle.

See also:
WOscMessage WOscBundle::GetMessage(int idx) | WOscBundle WOscBundle::GetBundle(int idx). | WOscBundle::GetNumMessages() | WOscBundle::GetNumBundles() WOscMessage::getFloat(int idx) | WOscMessage::getInt(int idx) | WOscMessage::getString(int idx) | WOscMessage::getBlob(int idx)
ERR_BUFFER_TO_SMALL 

When using the getBuffer(char* buffer, int bufferLen) functions (included in several classes) and the passed buffer of length "bufferLen" is smaller than the object-internal data-length, this exception will be raised.

See also:
WOscBundle | WOscBundle::getBuffer(char* buffer, int bufferLen)
ERR_NOT_ROOT_CONTAINER 

Trying to set a not-root-conatiner as address-space.

See also:
WOscReceiver::setAddressSpace(WOscContainer* addrSpaceRootContainer)
ERR_RECURSIVE_ALIAS 
Todo:

Definition at line 48 of file WOscException.h.

00048                 {
00049     ERR_NO_ERROR = 0,                       /**< No exception occurred (should not happen
00050                                              * when throwing exceptions).
00051                                              */
00052     ERR_REMOVE_FROM_EMPTY_QUEUE,            /**< Trying to remove items from an empty
00053                                              * priority queue. \see WOscPriorityQueue.
00054                                              */
00055     ERR_INVALID_ADDRESS_NO_SLASH,           /**< Trying to initialize a WOscMessage with
00056                                              * a corrupt address with missing slash at the
00057                                              * beginning.
00058                                              */
00059     ERR_NOT_DISPATCHING_FROM_ROOT,          /**< Messages can only be dispatched beginning
00060                                              * at a root container.
00061                                              * \see WOscContainer
00062                                              */
00063     ERR_PARENT_POINTER_NULL,                /**< During construction of a WOscContainer or WOscMethod a NULL pointer was passed
00064                                              * as parent or someone tried to add an OSC container alias (or an
00065                                              * OSC method/method-alias) with NULL pointer as parent.
00066                                              * \see WOscContainer.
00067                                              */
00068     ERR_ROOT_ALIAS,                         /** The root container can not be added as alias to any container.
00069                                              *
00070                                              */
00071     ERR_NULL_ADDRESS,                       /**< NULL-pointer argument passed to constructor
00072                                              * of WOscMessage.
00073                                              * \see WOscMessage::WOscMessage(const char *address)
00074                                              */
00075     ERR_OSC_STR_BUFF_TOO_SMALL,             /**< When using the getBuffer(char* buffer, int bufferLen)
00076                                              * functions (included in several classes) and the
00077                                              * passed buffer of length "bufferLen" is smaller than
00078                                              * the object-internal data-length, this exception will be
00079                                              * raised.
00080                                              * \see WOscMessage | WOscBundle | WOscString
00081                                              */
00082     ERR_NULL_BUFFER,                        /**< When passed a null pointer to the constructor
00083                                              * of an OSC-message when constructing from a byte-stream.
00084                                              * \see WOscMessage::WOscMessage(char* buffer, int bufferLen)
00085                                              */
00086     ERR_INVALID_INDEX,                      /**< When extracting bundle elements (messages or bundles) from
00087                                              * a WOscBundle object or arguments from a WOscMessage object,
00088                                              * make sure the "idx" parameter remains in valid boundaries by
00089                                              * getting the number of elements contained in the bundle.
00090                                              * \see WOscMessage WOscBundle::GetMessage(int idx) |
00091                                              * WOscBundle WOscBundle::GetBundle(int idx). |
00092                                              * WOscBundle::GetNumMessages() | WOscBundle::GetNumBundles()
00093                                              * WOscMessage::getFloat(int idx) | WOscMessage::getInt(int idx) |
00094                                              * WOscMessage::getString(int idx) | WOscMessage::getBlob(int idx)
00095                                              */
00096     ERR_BUFFER_TO_SMALL,                    /**< When using the getBuffer(char* buffer, int bufferLen)
00097                                              * functions (included in several classes) and the
00098                                              * passed buffer of length "bufferLen" is smaller than
00099                                              * the object-internal data-length, this exception will be
00100                                              * raised.
00101                                              * \see WOscBundle | WOscBundle::getBuffer(char* buffer, int bufferLen)
00102                                              */
00103     ERR_NOT_ROOT_CONTAINER,                 /**< Trying to set a not-root-conatiner as address-space.
00104                                              * \see WOscReceiver::setAddressSpace(WOscContainer* addrSpaceRootContainer)
00105                                              */
00106     ERR_RECURSIVE_ALIAS,                    /**<\todo */
00107 
00108     ERR_TOO_SHORT,
00109     ERR_EMPTY_BUNDLE,
00110     ERR_INVALID_TAG,
00111     ERR_CURRUPT_BUNDLE_LAYOUT,
00112     ERR_NO_ITEMS_IN_BUNDLE,
00113     ERR_CAN_NOT_CLONE_UNINITIALIZED_BUNDLE,
00114 };

Generated on Sat Oct 23 03:05:59 2010 for WOscLib by  doxygen 1.6.3