DDD_Base.h

Go to the documentation of this file.

#ifndef _DDD_Base_h_
#define _DDD_Base_h_

/*! \file DDD_Base.h

  \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.

*/

#include "DDD_Include.h"
#include "DDD_AttributeList.h"
#include "DDD_LogFacade.h"
#include <string>

namespace disti
{

/**  \brief  The DDD_Base class.  Base class for Data Director objects.
    */
class DDD_EXPORT DDD_Base : public DDD_LogFacade
{
protected:
    std::string _instanceName;     /**< The instance name of this object */

    /** The parameters of this object
     * \warning  Any parameter stored in this list will get deallocated in DDD_Base's
     * destructor. Be wary of dangling pointers!
     */
    DDD_AttributeList  _params;
public:

    /** Constructor */
    DDD_Base() 
    {
    }

    /** Destructor */
    virtual ~DDD_Base();

    /** \return Returns the instance name for this asset
      */
    const char* GetInstanceName() const { return _instanceName.c_str(); }
    
    /** Set the instance name for this asset
      * \param name  The instance name to set 
      */
    virtual void SetInstanceName(const char *name) { _instanceName = name; }

    /** Sets the initialization parameters.  The params specified will be merged with the parameters 
      * in the asset.  Parameters that don't exist will be added.  Parameters that do exist will be updated.
      * \param params   A set of parameter values to update or add.
      */
    virtual void SetParams(const DDD_AttributeList &params);

    /** \return Gets the list of initialization parameters for the object */
    virtual DDD_AttributeList &GetParams() { return _params; }
};

} // namespace disti

#endif