xmlFedReader.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 1992-2010 VT MAK
** All rights reserved.
*********************************************************************/

#ifndef xmlFedReader_H_
#define xmlFedReader_H_


#include <stdio.h>
#include <string>

#include <vlutil/vlFedTarget.h>
#include "fedReader.h"
#include <vlutil/vlString.h>



struct _xmlNode;
struct _xmlDoc;
typedef unsigned char xmlChar;
typedef struct _xmlNode xmlNode;
typedef struct _xmlDoc xmlDoc;

#ifdef DtUSE_UTILITIES_NAMESPACE
namespace DtUSE_UTILITIES_NAMESPACE
{
#endif

class DT_DLL_MTL DtXmlFedReader : public DtFedReader
{
public:

   DtXmlFedReader();

   virtual ~DtXmlFedReader();

private:

   DtXmlFedReader( const DtXmlFedReader& );
   DtXmlFedReader& operator=( const DtXmlFedReader& );

public:

   virtual DtFedReadStatus readFedFilePtr(FILE* filePointer, DtFedTarget *fedTarget, 
      DtFilename fileName, bool strictCheckingEnabled=false, bool useDTD=false, bool dontParseSwitches=false );

   


protected:

   virtual bool dtdValidate(xmlDoc* pDoc, const char * dtdFile);

   virtual DtFedReadStatus openFile(const char *fedFileName,
                                    xmlDoc  **newXmlDocTree);

   virtual xmlNode* getNodeByName( xmlNode* currentNode,
                                   const xmlChar* nodeName );
   virtual DtFedReadStatus processFed( xmlNode* fedObj );
   
   virtual DtFedReadStatus parseTransportationsList( xmlNode* currentNode );

   virtual DtFedReadStatus processObjects( xmlNode* currentNode );

   virtual DtFedReadStatus processInteractions( xmlNode* currentNode );

   virtual DtFedReadStatus parseObjectTree( xmlNode* currentNode,
                                            const DtString& parentName );

   virtual DtFedReadStatus parseAttribute( xmlNode* currentNode,
                                           const DtString& parentName );

   virtual DtFedReadStatus parseAttributeDimensions( xmlNode* currentNode,
      DtString const& objectClass, DtString const& attribute);

   virtual DtFedReadStatus parseInteractionTree( xmlNode* currentNode,
                                                 const DtString& parentName );

   virtual DtFedReadStatus parseInteractionDimensions( xmlNode *currentNode,
      DtString const& interactionClass );

   virtual DtFedReadStatus parseDimensionList( xmlNode* currentNode );

   virtual DtFedReadStatus parseDimension( xmlNode* currentNode );

   virtual DtFedReadStatus parseSwitches( xmlNode* currentNode );

   virtual DtFedReadStatus parseParameter( xmlNode* currentNode,
                                           const DtString& parentName );

   virtual DtFedReadStatus parseTransportationTree( xmlNode* currentNode );

   virtual DtFedReadStatus parseDataTypeTree( xmlNode* currentNode );

   virtual DtFedReadStatus parseNotesTree( xmlNode* currentNode );

   virtual DtFedReadStatus parseTagsTree( xmlNode* currentNode );

   virtual DtFedReadStatus parseBasicDataTypesTree( xmlNode* currentNode );

   virtual DtFedReadStatus parseSimpleDataTypesTree( xmlNode* currentNode );

   virtual DtFedReadStatus parseArrayDataTypesTree( xmlNode* currentNode );

   virtual DtFedReadStatus parseEnumeratedDataTypesTree( xmlNode* currentNode );

   virtual DtFedReadStatus parseFixedRecordDataTypesTree( xmlNode* currentNode );

   virtual DtFedReadStatus parseVariantRecordDataTypesTree( xmlNode* currentNode );

   virtual void appendNodeProperties(xmlNode*  currentNode, DtString& output) const;

   virtual void appendNodeContent(xmlNode*  node, DtString& output) const;

   virtual bool isBlankText(xmlNode*  node) const;

   virtual const xmlChar* propertyByName( xmlNode* node, const xmlChar *name);

   virtual bool getPropertyByName( xmlNode* node, const xmlChar *name,
      DtString& propertyContent);

   virtual DtFedReadStatus getTransportType( xmlNode* currentNode,
                                             DtTransportType& transportType );

   virtual DtFedReadStatus getOrderType( xmlNode* currentNode,
                                         DtOrderType& orderType );

   bool convertStringToULong(std::string numericString,
      unsigned long& value);
#ifdef __sgi__
   void clipPrefix(std::string& valueSpec, char c);
#else
   template<typename operandType> void clipPrefix(std::string& valueSpec,
      operandType c);
#endif

protected:

   DtFedTarget* myFedTarget;

};

#ifdef DtUSE_UTILITIES_NAMESPACE
} 
#endif

#endif  //! xmlFedReader_H_