WOscString Class Reference

#include <WOscString.h>

List of all members.

Public Member Functions
	WOscString (const char *string="")
	WOscString (const WOscString &rhs)
	~WOscString ()
WOscString &	operator= (const char rhs)
WOscString &	operator= (const char *rhs)
WOscString &	operator= (const WOscString &rhs)
WOscString	operator+ (const WOscString &rhs)
WOscString &	operator+= (const char rhs)
WOscString &	operator+= (const char *rhs)
WOscString &	operator+= (const WOscString &rhs)
bool	operator== (const WOscString &rhs) const
bool	operator!= (const WOscString &rhs) const
bool	operator== (const char *str) const
bool	operator!= (const char *str) const
	operator const char * () const
int	GetSize ()
void	GetBuffer (char *buffer, int bufferLen)
const char *	GetBuffer () const

---

Detailed Description

Wrapping of OSC specific strings (4-byte aligned). OSC-strings must be 4-byte aligned. The interface of this class guarantees the 4-byte-alignment.

Remarks:

None.

Examples:

WOscClient.cpp, WOscServer.cpp, and WOscStreamingClient.cpp.

Definition at line 52 of file WOscString.h.

---

Constructor & Destructor Documentation

WOscString::WOscString

(

const char *

string = ""

)

Constructs an OSC-String from a string. Aligns it internally to a 4-byte boundary.

Parameters:

string

Initializing string.

Definition at line 50 of file WOscString.cpp.

References WOscUtil::GetSizeFourByteAligned(), and WOscUtil::PadStringWithZeros().

                                        {
    /* get four byte aligned size */
    m_bufferLen = WOscUtil::GetSizeFourByteAligned(string);
    /* allocate mem */
    m_buffer = new char[m_bufferLen];
    /* copy and pad */
    WOscUtil::PadStringWithZeros(m_buffer, string);
}

WOscString::WOscString

(

const WOscString &

rhs

)

Copy constructor. Allocates new memory and copies the aligned string from the referenced object.

Parameters:

rhs

Reference of an OSC-string object.

Definition at line 67 of file WOscString.cpp.

                                           {
    /*  allocate */
    m_buffer = new char[m_bufferLen = rhs.m_bufferLen];
    /* copy */
    memcpy(m_buffer,rhs.m_buffer,m_bufferLen); 
}

WOscString::~WOscString

(

)

Destructor. Frees the memory required by the internal buffer (if not empty).

Definition at line 77 of file WOscString.cpp.

{
    delete [] m_buffer;
}

---

Member Function Documentation

const char * WOscString::GetBuffer

(

)

const

Returns a pointer to an internal OSC-string-buffer. Please See remarks for safety issues.

Returns:

Pointer to the internal OSC-string buffer.

Remarks:

The pointer remains valid until the modification of this WOscString-object. The next time the object is destination of an operation (check operators) or the object will be deleted, this pointer possibly gets invalid. If you are not sure about that issue, please use the other getBuffer()- function, which copies the string.

See also:

WOscString::getBuffer(char* buffer, int bufferLen)

Definition at line 313 of file WOscString.cpp.

{
    return m_buffer;
}

void WOscString::GetBuffer	(	char *	buffer,
		int	bufferLen
	)

Fills the buffer with the internal (padded) OSC-string representation. The user must supply a buffer of apropriate size.

Parameters:

	buffer	Caller supplied destination buffer.
	bufferLen	Length of the supplied buffer.

Exceptions:

WOscException

When caller supplied buffer too small.

Remarks:

This interface makes sure that the buffer remains valid when modifying the WOscString-object afterwards. (contrary to WOscString::getBuffer() )

See also:

WOscString::getBuffer()

Examples:

WOscClient.cpp, WOscServer.cpp, WOscStreamingClient.cpp, and WOscStreamingServer.cpp.

Definition at line 287 of file WOscString.cpp.

References ERR_OSC_STR_BUFF_TOO_SMALL.

Referenced by WOscContainer::DispatchMessage(), and WOscMessage::WOscMessage().

{
    if ( bufferLen < m_bufferLen )
        throw WOscException(ERR_OSC_STR_BUFF_TOO_SMALL, __FILE__, __LINE__);

    for ( int i = 0; i < bufferLen; i++ )
        buffer[i] = m_buffer[i];
}

int WOscString::GetSize

(

)

Returns the size of the zero-padded OSC-string. Can be used to allocate memory for instance.

Returns:

Size of the internal buffer.

Remarks:

Remains valid until the content of the WOscString-object is changed. See

Definition at line 262 of file WOscString.cpp.

Referenced by WOscMessage::WOscMessage().

                       {
    return m_bufferLen;
}

WOscString::operator const char *

(

)

const

Typecast operator for convenience.

Definition at line 354 of file WOscString.cpp.

{
    return m_buffer;
}

WOscString WOscString::operator+

(

const WOscString &

rhs

)

OSC-String concatenation without assignment. Appends the right hand object to the left-hand object but does not save it in the left-hand object. The zeros from the left hand object are removed and the resulting OSC-string is padded to a multiple of 4.

Parameters:

rhs

Reference to an object to append.

Returns:

The concatenated object.

Remarks:

Since the operator does not assign, the return value can not be a reference, because its an local and automatic variable.

Definition at line 163 of file WOscString.cpp.

                                                      {
    WOscString retVal;
    if ( m_buffer ){
        retVal += *this;
        retVal += rhs;
    }else{
        retVal = rhs;
    }
    return retVal;
}

WOscString & WOscString::operator+=

(

const WOscString &

rhs

)

OSC-String concatenation with assignment. Appends the right hand object to the left-hand object and saves it in the left-hand object. The zeros from the left hand object are removed and the resulting OSC-string is padded to a multiple of 4.

Parameters:

rhs

Reference to an object to append.

Returns:

The a reference to the concatenated object.

Definition at line 220 of file WOscString.cpp.

References WOscUtil::GetSizeFourByteAligned().

                                                        {

    if ( m_buffer ){

        /* get length of both strings */
        int lenLhs = (int)strlen(m_buffer);
        int lenRhs = (int)strlen(rhs.m_buffer);

        /* get the size of the combined string aligned to four. */
        int newLen = WOscUtil::GetSizeFourByteAligned(lenRhs + lenLhs + 1);

        /* allocate memory */
        char* newBuf = new char[newLen];

        /* copy left and right hand side */
        memcpy(newBuf, m_buffer, lenLhs); 
        memcpy(newBuf+lenLhs, rhs.m_buffer, lenRhs);

        /* pad rest with zeros */
        for ( int i = lenLhs + lenRhs; i < newLen; i++ )
            newBuf[i] = '\0';

        delete [] m_buffer;     // delete old buffer
        m_buffer = newBuf;      // set new string buffer as buffer
        m_bufferLen = newLen;   // set length

    }else{
        /* if empty, just assign */
        *this = rhs;
    }
    return *this;
}

WOscString & WOscString::operator+=

(

const char *

rhs

)

String to OSC-String concatenation with assignment. Formats and appends the right hand string to the left-hand object and saves it in the left-hand object. The zeros from the left hand object are removed and the resulting OSC-string is padded to a multiple of 4.

Parameters:

rhs

String to be appended to the left hand object.

Returns:

The reference to the concatenated object.

Definition at line 203 of file WOscString.cpp.

                                                  {
    WOscString tmp(rhs);
    return *this += tmp;
}

WOscString & WOscString::operator+=

(

const char

rhs

)

Character to OSC-String concatenation with assignment. Appends the right hand char to the left-hand object and saves it in the left-hand object. The zeros from the left hand object are removed and the resulting OSC-string is padded to a multiple of 4.

Parameters:

rhs

Character to be appended to the left hand object.

Returns:

The reference to the concatenated object.

Definition at line 186 of file WOscString.cpp.

                                                 {
    char str[] = {rhs,'\0'};
    return *this += str;
}

WOscString & WOscString::operator=

(

const WOscString &

rhs

)

Assignment operator. Copies the right-hand object-reference into the left-hand object. Frees the old memory and allocates new.

Parameters:

rhs

Reference of the source object.

Returns:

Reference of the destination object.

Definition at line 135 of file WOscString.cpp.

                                                       {
    if ( m_buffer )
        delete [] m_buffer;

    m_buffer = new char[m_bufferLen = rhs.m_bufferLen];
    memcpy(m_buffer,rhs.m_buffer,m_bufferLen);

    return *this;
}

WOscString & WOscString::operator=

(

const char *

rhs

)

String to OSC-String assignment operator. Formats (padding) the right-hand string and copies it into the left-hand object. Frees the old memory and allocates new.

Parameters:

rhs

Reference of the source string.

Returns:

Reference of the destination object.

Definition at line 111 of file WOscString.cpp.

References WOscUtil::GetSizeFourByteAligned(), and WOscUtil::PadStringWithZeros().

                                                 {
    delete [] m_buffer;

    /* get four byte aligned size */
    m_bufferLen = WOscUtil::GetSizeFourByteAligned(rhs);
    /* allocate mem */
    m_buffer = new char[m_bufferLen];
    /* copy and pad */
    WOscUtil::PadStringWithZeros(m_buffer, rhs);
    
    return *this;
}

WOscString & WOscString::operator=

(

const char

rhs

)

OSC string char assignment operator. Assigns the right-hand char to the OSC string object.

Parameters:

rhs

Char beeing assigned to the current OSC string.

Returns:

Reference of the current OSC string object.

Definition at line 92 of file WOscString.cpp.

                                                {
    if ( m_buffer ){
        delete [] m_buffer;
        m_buffer = NULL;
    }
    return *this += rhs;
}

bool WOscString::operator==

(

const WOscString &

rhs

)

const

Comparison operator. Compares the right-hand OSC string reference with the current OSC object.

Parameters:

rhs

Reference of an OSC string object.

Returns:

True when equal, false when not equal.

Definition at line 330 of file WOscString.cpp.

{
    return (strcmp(m_buffer, rhs.m_buffer) == 0);
}

---

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

• WOscString.h
• WOscString.cpp