DDD_ConnectionEndpoint.h

Go to the documentation of this file.

#ifndef _DDD_ConnectionEndpoint_h_
#define _DDD_ConnectionEndpoint_h_

/*! \file DDD_ConnectionEndpoint.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_AssetBase.h"
#include "DDD_AttributeBase.h"
#include "DDD_AssetBase.h"
#include <string>

namespace disti
{

/** \brief  The DDD_ConnectionEndpoint class. Endpoints are used as inputs and outputs to connections.
    */
class DDD_EXPORT DDD_ConnectionEndpoint
{
public:
    /** Constructor.
      * \param attribute A pointer to the Attribute that will be connected
      * \param converterPoint   The name of the converter "pin" that this will be connected to
      */
    DDD_ConnectionEndpoint(DDD_AttributeBase *attribute, std::string converterPoint);

    /** Destructor */
    ~DDD_ConnectionEndpoint();

    /** \return Returns true if this endpoint is valid, i.e. if it references
      *         a valid attribute of a valid, loaded asset.
      */
    bool Valid();

    /** \return Returns the name of the attribute associated with this endpoint */
    std::string AttributeName();

    /** \return Returns the name of the asset associated with this endpoint */
    std::string AssetName();

    /** \return Returns the name of the converter point associated with this endpoint */
    std::string ConverterPointName();

    /** Set the converter point name for this endpoint
      * \ param converterPoint  The name of the converter "pin" this endpoint is connected to
      */
    void SetConverterPointName(const std::string& converterPoint);

    /** Set the attribute that this endpoint is connected to 
      * \param attribute  Pointer to the attribute to connect to
      */
    void SetAttribute(DDD_AttributeBase *attribute);

    /** \return Returns a pointer to the attribute this endpoint is connected to */
    DDD_AttributeBase* GetAttribute();

    /** Invalidates this endpoint, i.e. after this call this endpoint will no longer
      * be associated with an instance of an attribute, it will be disconnected. */
    void Invalidate();
    
    /** Called by the framework when an asset is deleted.  If the attribute container (asset) 
      * specified matches the container for this endpoint, then the endpoint is invalidated
      * \param attContainer  The asset that is being deleted
      * \return True if this endpoint was invalidated by this call
      */
    bool DisconnectAsset(DDD_AttributeContainer *attContainer);

    /** Called by the framework when an asset is renamed.  If the asset specified in oldName
      * matches the asset name associated with this endpoint, then the endpoint is updated to
      * reference the newName
      * \param oldname  The old name of the asset
      * \param newname  The new name of the asset
      */
    void NotifyAssetNameChange(const std::string& oldname, const std::string& newname);

private:
    DDD_AttributeBase *_attribute;   /**< The attribute associated with this endpoint, or NULL */
    std::string _attributeName;      /**< The name of the attribute associated with this endpoint */
    std::string _assetName;          /**< The name of the asset associated with this endpoint */
    std::string _converterPointName; /**< The name of the converter point associated with this endpoint */
};

/** \brief The DDD_EndpintList class.  A list of DDD_Endpoints */
class DDD_EXPORT DDD_EndpointList : public DynamicPtrArray<DDD_ConnectionEndpoint*> 
{
public:
    /** Constructor */
    DDD_EndpointList() {}

    /**  Returns which index within this EndpointList the attribute is at
      * \param attr  The attribute to find
      * \return The (first) index the attribute is at or -1 if it is not in the list
      */
    int ConnectedAttributeIndex(DDD_AttributeBase *attr);

    /** \return Returns the number of times the specified attribute is referenced 
      * \param attr  The attribute to search for
      */
    unsigned int NumberOfReferences(DDD_AttributeBase *attr);
};


}   // end namespace disti
#endif