DDD_XMLConfigMgr.h

Go to the documentation of this file.

/*! \file DDD_XMLConfigMgr.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.

*/

#ifndef DDD_XMLConfigMgr_H_
#define DDD_XMLConfigMgr_H_

#include <string>
#include "DDD_AssetBase.h"
#include "DDD_AssetList.h"
#include "DDD_Connection.h"
#include "DDD_ConnectionList.h"
#include "DDD_ProgressPublisher.h"
#include "DDD_LogFacade.h"

// LMX Parser classes
class c_WindowSettings;
class c_AssetParams;
class c_Assets;
class c_Connection;
class c_Connections;
class c_Endpoint;
class c_Converter;

namespace disti
{

typedef struct
{
    std::string title;
    unsigned int width;
    unsigned int height;
    int initialX;
    int initialY;
    std::string drawRate;
} WindowAttributes;

/** \brief  Abstract base class for any object that uses DDD_XMLConfigMgr */
class DDD_EXPORT XMLConfigTarget : public DDD_LogFacade
{
public:
    /* Add asset to this target. Generally called from DDD_XMLConfigMgr whenever loading a new asset from XML.
     * \param instanceName Asset instance name string. It must be a unique identifier.
     * \param className Asset class name string.
     * \param libName Filename of Dynamic library that contains this class. Only required if classname differs from libName.
     * \param params List of attributes used for Asset initialization.
     * \return Instance to new Asset if successful; NULL otherwise.
     */
    virtual DDD_AssetBase* AddAsset(const std::string &instanceName, const std::string &className, const std::string &libName, const DDD_AttributeList& params) = 0;

    /* Add connection to this target. Generally called from DDD_XMLConfigMgr whenever loading a new connection from XML.
     * \param connection New Connection instance. 
     * \note Target is assumed to "own" connection pointer, and will be responsible for its deallocation.
     */
    virtual void AddConnection(DDD_Connection *connection) = 0;

    /* Finds asset instance by asset name.
     * \param assetInstance String containing asset name.
     * \return Pointer to asset if found; NULL otherwise.
     */
    virtual DDD_AssetBase* FindAsset(const std::string &assetInstance) = 0;

    /* Gets the Target's own asset list. Generally called from DDD_XMLConfigMgr whenever saving assets to XML.
     * \return Reference to Target's internal asset list.
     */
    virtual DDD_AssetList &GetAssetList() = 0 ;

    /* Gets the Target's own connections list. Generally called from DDD_XMLConfigMgr whenever saving connections to XML.
     * \return Reference to Target's internal connections list.
     */
    virtual DDD_ConnectionList &GetConnectionList() = 0;

    /* Sets the Window Attributes in the target.
     * \param attribs The attributes to set
     * \param currentWindow Number indicating which window these attributes correspond to.
     */
    virtual void AddXMLWindowAttributes( const WindowAttributes &attribs, unsigned int currentWindow ) {}

    /* \return Gets Window Attributes from target.  
     * \param currentWindow Number indicating which window these attributes correspond to.
     */
    virtual WindowAttributes GetXMLWindowAttributes( unsigned int currentWindow )
    {
        WindowAttributes attribs;

        attribs.height   = 0;
        attribs.width    = 0;
        attribs.initialX = 0;
        attribs.initialY = 0;

        return attribs;
    }
};


/** \brief  Object that encapsulates XML loading and saving methods */
class DDD_EXPORT DDD_XMLConfigMgr : public DDD_ProgressPublisher, public DDD_LogFacade
{
private:
    XMLConfigTarget *_target;  /**< Current target for loading to and saving from. */
    bool _readGUISettings;     /**< If the target has a Viewer, GUI, or supports loading/saving window settings. */

public:
    /** Constructor */
    DDD_XMLConfigMgr();

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

    /** Populates target with data given by XML file
     * \param target Target instance that is currently using this XMLConfigMgr
     * \param xmlFile Filename of XML file that is to be loaded.
     * \param readGUISettings (Optional) If Target has a GUI or contains a DDD_Viewer, this should be true.
     * \return true if configuration is successfully loaded, false otherwise.
     */
    bool LoadXML(XMLConfigTarget *target, const char *xmlFile, bool readGUISettings = false);

    /** Populates XML file with data given by target
     * \param target Target instance that is currently using this XMLConfigMgr
     * \param xmlFile Filename of XML file that is to be saved.
     * \param readGUISettings (Optional) If Target has a GUI or contains a DDD_Viewer, this should be true.
     * \return true if configuration is successfully saved, false otherwise.
     */
    bool SaveXML(XMLConfigTarget *target, const char *xmlFile, bool saveGUISettings = false);

private:
    // XML Parsing methods
    void ReadWindowSettings(c_WindowSettings *windowSettings);
    void ReadAssetParams(c_AssetParams *xmlParams,DDD_AttributeList &assetParams);
    bool ReadAssets(c_Assets *assets);
    void ReadEndpoint(c_Endpoint *endpoint,DDD_Connection *connection);
    bool ReadConverter(c_Converter *converter,DDD_Connection *connection);
    void ReadConnection(c_Connection *connection);
    void ReadConnections(c_Connections *connections);

    /** Parses an expression that represents a connection and populates the connection
      * \param connection  The connection to populate
      * \param expression The string containing the expression
      */
    void ParseExpression(DDD_Connection *connection,const char *expression);
};


}   // end namespace disti
#endif