DDD_AssetList.h

Go to the documentation of this file.

#ifndef _DDD_AssetList_h_
#define _DDD_AssetList_h_

/*! \file DDD_AssetList.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 "dynamic_ptr_array.h"
#include "DDD_AssetBase.h"

namespace disti
{

/** \brief  The DDD_AssetList class.  Maintains a list of Data Director assets.
    */
class DDD_EXPORT DDD_AssetList : public DynamicPtrArray<DDD_AssetBase*>
{
public:
    /** Constructor */
    DDD_AssetList();

    /** Destructor 
      * The DDD_AssetList does NOT manage the storage of its assets.
      * Prior to calling this destructor, the calling code should free
      * all of the assets in this list.
      */
    ~DDD_AssetList();

    /** \return Returns a pointer to the asset with the given instance name
      *         Returns NULL if the asset is not found
      * \param name  The name of the asset to find
      */
    DDD_AssetBase *Find(const std::string &name);

    /** Searches list for asset with given instance name; unlike Find(), this is const-safe
    * \param name  The name of the asset to find
    * \return  true if asset with matching instance name found; false otherwise
    */
    bool InList(const std::string &name) const;

    /** Finds the asset with the given name and replaces it with the supplied asset
      * \param name  The name of the asset to find
      * \param newAsset  Pointer to the asset that will replace the asset
      */
    void Replace(const std::string &name,DDD_AssetBase *newAsset);

    /** Moves an asset "UP" in the list, which means it gets moved further towards
      * the end of the list.  (It moves "UP" in draw order so it draws later)
      * \param  newAsset  The asset to reorder
      * \return True if if the asset was moved, false otherwise
      */
    bool MoveUp(DDD_AssetBase *newAsset);

    /** Moves an asset "DOWN" in the list, which means it gets moved closer towards
      * the beginning of the list.  (It moves "DOWN" in draw order so it draws earlier)
      * \param  newAsset  The asset to reorder
      * \return True if if the asset was moved, false otherwise
      */    
    bool MoveDown(DDD_AssetBase *newAsset);
};

} // namespace disti
#endif