DDD_RevertableAttribute.h

Go to the documentation of this file.

#ifndef _DDD_RevertableAttribute_h_
#define _DDD_RevertableAttribute_h_

/*! \file DDD_RevertableAttribute.h
  \brief  The DDD_RevertableAttribute class.  Container for 

  \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_Base.h"
#include "DDD_AttributeBase.h"
#include "dynamic_array.h"
#include <string>

namespace disti
{

/** \brief  Revertable attribute; for dynamic attributes that can be reset to a default value. */
class DDD_EXPORT DDD_RevertableAttribute
{
public:
    /** Constructor */
    DDD_RevertableAttribute(DDD_AttributeBase *defaultAttribute, DDD_AttributeBase *attribute) : _defaultAttribute(defaultAttribute), _attribute(attribute) {}

    /** DefaultAttribute accessor
     * \return  default attribute
     */
    DDD_AttributeBase* DefaultAttribute() { return _defaultAttribute; }

    /** Attribute accessor
     * \return  attribute
     */
    DDD_AttributeBase* Attribute() { return _attribute; }

    /** Attribute mutator
     * \param  attribute Attribute instance to store in this class
     */
    void SetAttribute(DDD_AttributeBase *attribute) { _attribute = attribute; }

    /** Reverts the state of this attribute.
     * \post  _attribute should share the same value as _defaultAttribute
     */
    void Revert();

private:
    DDD_AttributeBase *_attribute;         /**< attribute instance */
    DDD_AttributeBase *_defaultAttribute;  /**< default value */
};

/** \brief  List of revertable attributes */
class DDD_EXPORT DDD_RevertableAttributeList : public DynamicPtrArray<DDD_RevertableAttribute *>
{
public:
    /** Destructor */
    ~DDD_RevertableAttributeList();

    /** Inserts a new attribute into the list using both attributes.
     * \param defaultAttribute  Attribute with default value- this will not be changed by either this list
     *        or DDD_RevertableAttribute
     * \param attribute  Attribute to be reverted.
     */
    void Insert(DDD_AttributeBase *defaultAttribute, DDD_AttributeBase *attribute);

    /** \param attribute 
     */
    void RemoveAttribute(DDD_AttributeBase* attribute);

    /** Resets all attributes based on param values.
     */
    void RevertAll();

    /** Sets the attribute, either by searching for Param name
     * \param attribute  New attribute instance replacement. By default, the name of this
                         attribute is matched to the corresponding param name.
     * \param param  If this is specified, this method does a quicker check based on
                     the param pointer.
     */
    void SetAttribute(DDD_AttributeBase* attribute, DDD_AttributeBase *param = NULL);

    /** Clears the attributes, default attributes remain however 
     */
    void ClearAllAttributes();

    /** Finds the revertable attribute by name
     * \param name  Name to look for.
     * \return Pointer to revertable attribute with matching name; NULL if not found
     */
    DDD_RevertableAttribute *Find(const std::string &name);

    /** Finds the revertable attribute by default attribute instance. This is more efficient
     *  than the Find() method since it uses faster pointer comparisons.
     * \param defaultAttr  Default attribute to look for.
     * \return Pointer to revertable attribute with matching default attribute; NULL if not found
     */
    DDD_RevertableAttribute *FindByDefaultAttribute(const DDD_AttributeBase *defaultAttr);

    /** Finds the revertable attribute by attribute instance.
     * \param attr  Attribute instance to look for.
     * \return Pointer to revertable attribute with matching attribute; NULL if not found
     */
    DDD_RevertableAttribute *FindByAttribute(const DDD_AttributeBase *attr);
};


} // namespace disti

#endif