DDD_StructuredMemoryAsset.h

Go to the documentation of this file.

/*! \file DDD_StructuredMemoryAsset.h
  \brief  The DDD_StructuredMemoryAsset. Data Director asset 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.

*/

#ifndef _DDD_StructuredMemoryAsset_h_
#define _DDD_StructuredMemoryAsset_h_

#include "DDD_AssetBase.h"
#include <string>
#include "timer.h"
#include "ChunkProducer.h"

namespace disti
{
class DDD_AttributeDouble;
class DDD_AttributeString;
class DDD_AttributeBool;
class DDD_AttributeUInt;

class DDD_EXPORT DDD_StructuredMemoryAsset : public DDD_AssetBase, public DDD_AttributeObserver
{
protected:

public:

    static const char* DDD_STRUCTURED_MEMORY_ASSET_CLASS_NAME;

    /** Constructor 
      * \param container  The container that owns this asset 
      */
    DDD_StructuredMemoryAsset(DDD_AssetContainer *container);

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

    /** Describes the Asset (for UI) */
    virtual const char *Description() { return DDD_STRUCTURED_MEMORY_ASSET_CLASS_NAME;  }

    /** Poll asset, put all "discovered" assets into _attributeList
      * \pre   _attributeList is empty
      * \post  _attributeList will contain the list of attributes discovered from the asset
      */
    virtual void PopulateAttributeList();

    /** calculate to pump the asset */
    virtual void Calculate(double time);

    /** Start asset */
    virtual void Start();

    /** Stop asset */
    virtual void Stop();

    /** Pause asset */
    virtual void Pause();

    /** Resume asset */
    virtual void Resume();

    /** Is this asset currently running? */
    virtual bool Live();

    /** Returns asset type (class) name */ 
    virtual const char* ClassName();

    /** A callback method that will be called when the attribute being observed changes 
      * if this observer has registered to be notified on attribute change
      * \param attribute  A pointer to the attribute that changed
      */
    void OnAttributeChanged(DDD_AttributeBase *attribute);

    /** 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.
      */
    void SetParams(const DDD_AttributeList &params);

protected:
    /** Creates a DataDirector attribute for the specified ChunkAttribute and also inserts it into 
      * the asset's attribute list and sets the back pointer between the StructuredMemory atribute and the 
      * DataDirector attribute
      * \param attrName  The name of the attribute, e.g. "datagram.attribute"
      * \param attr  The StructuredMemory attribute as specified by the XML config file
      * \param receiveMode  True if this attribute is a receive attribute (i.e. it gets set by an inbound chunk)
      *                     False if this attribute is a send attribute (i.e. it gets set from an outbound chunk)
      */
    void CreateAttribute(std::string &attrName,ChunkAttribute *attr,bool receiveMode);

    /** Gets an attribute from the assets internal dictionary and add it to the list of 
      * published attributes for the asset.
      * \param  attributeName  The name of the attribute to get
      * \return A pointer to the attribute or NULL if it doesn't exist.
      */
    virtual DDD_AttributeBase* GetDictionaryAttribute(const char *attributeName);

    /**  Add the exposed params to the attribute list
      */
    void AddExposedParamsAsAttributes();

    /** Processes the passed in params, copies into newParams only the params that are not also
      * listed in the internal member variable _params
      * \param  params  A list of parameters passed to the asset
      * \param  newParams  The new list (returned) containing only what wasn't listed in _params
      */
    void RemoveBaseClassParams(const DDD_AttributeList &params,DDD_AttributeList &newParams);

private:
    /** Load the config file specified
      * \param str  The filename to of the file to load
      */
    void LoadConfigFile(const char *str);


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

    /** Temporaty list that has the combination of the StructuredMemory asset's params and the ChunkProducer's params */
    DDD_AttributeList _mergedParams;

    DDD_AttributeString *_fileName;           /**< Name of the data file to load */
    DDD_AttributeDouble *_frameRate;          /**< Frame rate of the data as a parameter */
    DDD_AttributeDouble *_frameRateAtt;       /**< Frame rate of the data as an exposed attribute */
    DDD_AttributeBool   *_receiveMode;        /**< True if asset is receiving packets, false if it is sending */
    DDD_AttributeUInt   *_debugMode;          /**< Type of debugging information to display in the console 
                                                   0=None, 1=Light, 2=Verbose   */
    DDD_AttributeString *_dataBuffer;         /**< .*/ 
    DDD_AttributeString *_dataBufferAttrib;   /**< .*/ 
    DDD_AttributeUInt   *_bufferLength;        /**< .*/ 
    DDD_AttributeUInt   *_bufferLengthAttrib; /**< .*/ 

    Timer                _frameTimer;       /**< Timer used for polling port */

    ChunkProducer       *_chunkProducer;    /**< Produces attribute updates when chunks are received and
                                              *  decoded. */
    
    bool                _reloadFile;        /**< When changing an asset parameter, gets set to true when 
                                              *  the file needs to be reloaded */

    bool                _paused;            /**< True when the asset is paused */

    bool                _setParamsMode;     /**< True for the duration of the SetParams call */ 

    unsigned char       *_dataBufferPtr;    /**< Buffer for the structured memory, copy of a pointer passed in by the user.*/ 
};

}   // end namespace disti
#endif