StructuredMemory_XML_Config.h

Go to the documentation of this file.

/*! \file StructuredMemory_XML_Config.h
  \brief  The StructuredMemory_XML_Config.  Utility class that parses an XML config file
  for the StructuredMemory asset and caches the list of attributes defined by the config file

  \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 _StructuredMemory_XML_Config_h_
#define _StructuredMemory_XML_Config_h_

#include "DDD_AttributeList.h"
#include "DDD_LogFacade.h"
#include "dynamic_array.h"
#include "dynamic_ptr_array.h"

#include "lmx_utils.h"
#include "../DDD_StructuredMemory.h"

namespace disti
{

class ChunkAttribute;
class ChunkProducer;
class ChunkDescription;

class DDD_EXPORT StructuredMemory_XML_Config : public DDD_LogFacade
{
protected:
    /** Adds a rule to a chunk description
      * \param producer  The producer that owns the chunk
      * \param newChunk  The chunk to add the rule to
      * \param chunk     The LMX structure defining the rule
      */
    void AddRule(ChunkProducer *producer, ChunkDescription *newChunk, tns::c_Rule &rule);

    /** Adds an attribute to a chunk description
      * \param newChunk      The chunk to add the rule to
      * \param attribute     The LMX structure defining the attribute
      * \param currentOffset The current offset within the chunk (inout parameter)
      */
    void AddAttribute(ChunkDescription *newChunk, tns::c_ChunkAttribute &attribute, unsigned int &currentOffset);

    /** Adds a chunk to a producer
      * \param producer  The producer to add the chunk to
      * \param chunk     The LMX structure defining the chunk
      */
    void AddChunkDescription(ChunkProducer *producer, tns::c_Chunk &chunk);
    
public:

    /** Creates a chunk producer by loading a configuration file
      * \param filename  The name of the file to read
      * \return A pointer to a newly created chunk producer or NULL on failure
      */
    ChunkProducer *LoadConfiguration(const char *filename);
};

} // end of namespace disti

#endif