DDD_AttributeByteBuffer.h

/*! \file DDD_AttributeString.h
  \brief  The DDD_AttributeString class.  String attribute
  \par Copyright Information

  Copyright (c) 2012 The DiSTI Corporation.<br>
  11301 Corporate Blvd; Suite 100<br>
  Orlando, Florida 32817<br>
  USA<br>
  <br>
  All rights reserved.<br>

  This Software contains proprietary trade secrets of DiSTI and may not be
reproduced, in whole or part, in any form, or by any means of electronic,
mechanical, or otherwise, without the written permission of DiSTI.  Said
permission may be derived through the purchase of applicable DiSTI product
licenses which detail the distribution rights of this content and any
Derivative Works based on this or other copyrighted DiSTI Software.

  NO WARRANTY. THE SOFTWARE IS PROVIDED "AS-IS," WITHOUT WARRANTY OF ANY KIND,
AND ANY USE OF THIS SOFTWARE PRODUCT IS AT YOUR OWN RISK. TO THE MAXIMUM EXTENT
PERMITTED BY APPLICABLE LAW, DISTI AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES
AND CONDITIONS, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND/OR FITNESS FOR A
PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT, WITH REGARD TO THE SOFTWARE.

  LIMITATION OF LIABILITY. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW,
IN NO EVENT SHALL DISTI OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION,
DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS
INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR
INABILITY TO USE THE SOFTWARE, EVEN IF DISTI HAS BEEN ADVISED OF THE POSSIBLITY
OF SUCH DAMAGES.  DISTI'S ENTIRE LIABILITY AND YOUR EXCLUSIVE REMEDY SHALL NOT
EXCEED FIVE DOLLARS (US$5.00).

  The aforementioned terms and restrictions are governed by the laws of the
State of Florida and the United States of America.

*/

#ifndef _DDD_AttributeByteBuffer_h_
#define _DDD_AttributeByteBuffer_h_

#include "DDD_AttributeBase.h"

namespace disti
{

/** \brief  DataDirector attribute class corresponding to a character array datatype. 
  * \ingroup GroupAttributes
  */
class DDD_EXPORT DDD_AttributeByteBuffer : public DDD_AttributeBase
{
public:

    /** constructor
      * \param name                     The attribute's name
      * \param initialVal               The attribute's initial value
      * \param length                   The bytebuffer's initial value's length
      * \param container                The container that will "own" this attribute
      * \param validConnectionStates    Valid connection states for the attribute (INPUT,OUTPUT, IN_OUT); see DDD_AttributeBase::ConnectionState
      * \param persistent               True if it's a persistent attribute
      * \param revertable               If not NULL, it's a pointer to the revertable attribute for this attribute
      */
    DDD_AttributeByteBuffer(const std::string &name,char* initialVal,unsigned int length,DDD_AttributeContainer *container, int validConnectionStates,bool persistent,DDD_AttributeBase *revertable);

    /** destructor */
    ~DDD_AttributeByteBuffer();

    // DDD_AttributeBase methods
    virtual DataType GetPreferredDataType() const;

    virtual std::string GetValueString() const;
    virtual void SetValueString(const std::string &value,bool notify, DDD_AttributeObserver *originator);

    virtual int GetValueInt(void) const;
    virtual void SetValueInt(const int value,bool notify, DDD_AttributeObserver *originator);

    virtual unsigned int GetValueUInt(void) const;
    virtual void SetValueUInt(const unsigned int value,bool notify, DDD_AttributeObserver *originator);

    virtual double GetValueDouble(void) const;
    virtual void SetValueDouble(const double value,bool notify, DDD_AttributeObserver *originator);

    virtual bool GetValueBool(void) const;
    virtual void SetValueBool(const bool value,bool notify, DDD_AttributeObserver *originator);

    virtual void SetValueByteBuffer(const char *buffer, unsigned int length, bool notify, DDD_AttributeObserver *originator);
    virtual void GetValueByteBuffer(char **buffer, unsigned int &length);

    static void RemoveNullChars(char* buff, unsigned int length, char replaceWith = ' ');

protected:
    /** Deletes the value buffer and sets it to NULL, sets the lengh to zero */
    void SafeDeleteValue();

    /** Safely reallocates the buffer if newLength != _length */
    void ResizeBuffer(unsigned int newLength);

protected:
    char *_value;
    unsigned int _length;
};


}   // end namespace disti

#endif  // _DDD_AttributeByteBuffer_h_