lmx_utils.h

Go to the documentation of this file.

/*! \file lmx_utils.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 _lmx_utils_h
#define _lmx_utils_h

#include "lmxtypes.h"
#include "lmxparse.h"

/** read an XML into an LMX generated XML binding class
  * \param xmlBind LMX generated XML binding class to receive data on success
  * \param fname filname of XML file to read (!=NULL)
  * \param errMsg [out] receives error msg on failure
  * \return true on success else false
  */
template< class T > static bool ReadXMLFile( T &xmlBind, const char *fname, std::string &errMsg )
{
    bool success = false;

    // try to open file
    lmx::c_xml_reader_file xmlReader( fname );
    if( xmlReader.is_open() )
    {
        // try to read file
        success = ( lmx::ELMX_OK == xmlBind.unmarshal( xmlReader ) );
        if( !success )
        {
            // get error msg
            std::string readerError;
            xmlReader.get_error_message( &readerError );

            // format err msg
            errMsg =  "Error reading file \"";
            errMsg +=  fname;
            errMsg += "\" :\n";
            errMsg += readerError + '\n';
        }
    }
    else  // could not open file
    {
        errMsg =  "Error opening file \"";
        errMsg +=  fname ;
        errMsg += "\"\n";
    }

    return( success );
}

/** read an XML into an LMX generated XML binding class
  * \param xmlBind LMX generated XML binding class to receive data on success
  * \param data  Pointer to character buffer
  * \param length  Length of the buffer
  * \param errMsg [out] receives error msg on failure
  * \return true on success else false
  */
template< class T > static bool ReadXMLData( T &xmlBind, const char *data,unsigned int length,std::string &errMsg )
{
    bool success = false;

    lmx::c_xml_reader_memory xmlReader(data,length);

    // try to read data
    success = ( lmx::ELMX_OK == xmlBind.unmarshal( xmlReader ) );
    if( !success )
    {
        // get error msg
        std::string readerError;
        xmlReader.get_error_message( &readerError );

        // format err msg
        errMsg =  "Error parsing metadata: \n";
        errMsg += readerError + '\n';
    }

    return( success );
}


#endif