fedReader1516e.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 1992-2010 MAK Technologies, Inc
** All rights reserved.
*********************************************************************/
#ifndef fedReader1516e_h__
#define fedReader1516e_h__




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

#include <vlutil/vlFedTarget.h>
#include <vlutil/vlFilename.h>
#include "mtl/fedReader.h"
#include <vlutil/vlString.h>
#include "libxml/tree.h"
#include <set>
#include <map>

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 DtFedReader1516e : public DtFedReader
   {
   public:

      DtFedReader1516e();

      virtual ~DtFedReader1516e();

   private:

      DtFedReader1516e( const DtFedReader1516e& );
      DtFedReader1516e& operator=( const DtFedReader1516e& );

   public:

      virtual DtFedReadStatus readFedFilePtr(FILE* filePointer, DtFedTarget *fedTarget, 
         DtFilename fileName, unsigned int strictCheckingMask=DtFedReadStrictDisabled, bool useDTD=false, bool dontParseSwitches=false );


      virtual void setSchemaValidationEnabled(bool enabled);

   protected:

      virtual DtFedReadStatus processXmlDocPtr( xmlDocPtr xmlDocument ) ;
      virtual DtFedReadStatus parseTimeTree( xmlNode* currentNode );
      virtual DtFedReadStatus parseSynchronizationsTree( xmlNode* currentNode );
      DtFedReadStatus getSharingType( xmlNode*  currentNode, DtSharingType& sharingType );
      DtFedReadStatus getSemantics( xmlNode*  currentNode, DtString& semanticsVal );
      DtFedReadStatus getNotes( xmlNode*  currentNode, DtString& notesVal );
      DtFedReadStatus getOwnershipType( xmlNode*  currentNode, DtOwnershipType& ownershipVal );
      DtFedReadStatus getUpdateCondition( xmlNode*  currentNode, DtString& updateConditionVal );
      DtFedReadStatus getUpdateType( xmlNode* currentNode, DtFomUpdateType& updateTypeVal );

      virtual bool schemaValidate(xmlDoc* pDoc, const char * schemaFile);

      static xmlNode* getNodeByName( xmlNode* currentNode,
                                    const xmlChar* nodeName );

      virtual DtFedReadStatus processFed( xmlNode* fedObj );

      virtual DtFedReadStatus parseTransportationsList( xmlNode* currentNode );

      virtual DtFedReadStatus processModelIdentification( 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 parseUpdateRates( xmlNode* currentNode );

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

      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);

      static const xmlChar* childContentByName( xmlNode* node, const xmlChar *name) ;

      virtual bool getChildContentByName( xmlNode* node, const xmlChar *name,
         DtString& childContent);

      virtual DtFedReadStatus getTransportType( xmlNode* currentNode,
         DtTransportType& transportType, DtNameTypePair nameType, bool isAttribute );

      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

   public:

      static bool isEvolvedFormat(void* fedFilePtr);
      bool getChildrenContent(xmlNode* node, DtString& content) const;
      DtString getChildrenContent(xmlNode* node) const;

      typedef DtString FOMDependency;

   protected:

      // Whether or not schema validation should be performed
      bool mySchemaValidationEnabled;


      bool myReplacedObjectRoot;
      bool myReplacedInteractionRoot;
   };

#ifdef DtUSE_UTILITIES_NAMESPACE
} 
#endif


#endif // fedReader1516e_h__