fomStateXmlBlock.h

Go to the documentation of this file.

/*********************************************************************
 ** Copyright (c) 2006 MaK Technologies, Inc.
 ** All rights reserved.
 *********************************************************************/
/*******************************************************************************
 ** $RCSfile: fomStateXmlBlock.h,v $ $Revision: 1.6 $ $State: Exp $
 ******************************************************************************/
#ifndef DtFomStateXmlBlock_H_
#define DtFomStateXmlBlock_H_

#include <rtiMsConfig.h>
#include "spyXmlBlock.h"
#include <mtl/env.h>
#include "webSpyUtils.h"
#include "fomObjectXmlBlock.h"
#include "fomInteractionXmlBlock.h"
#include <fomMgr.h>
#include <objClassInfo.h>
#include <intClassInfo.h>

#include <vlutil/vlFedTarget.h>
#include <vlutil/vlString.h>
#include <vlutil/vlFilename.h>
#include <vlutil/vlSmartPointers.h>

#include <iosfwd>
#include <map>

// Define the XML tags used by this block
DtDECLARE_SPY_XML_TAG( DtFomStateXmlTag );
                      
class DtFomStateXmlBlock;
typedef DtBoost::shared_ptr<DtFomStateXmlBlock> DtFomStateXmlBlockSP;
typedef DtBoost::weak_ptr<DtFomStateXmlBlock>   DtFomStateXmlBlockWP;


// The DtFomStateXmlBlock holds a complete WWW request message
class DT_DLL_WWW DtFomStateXmlBlock : public DtSpyXmlBlock
{
public:
   typedef std::set< DtFomObjectXmlBlockSP > FomStateObjectXmlBlockSet;
   typedef std::set< DtFomInteractionXmlBlockSP > FomStateInteractionXmlBlockSet;

   static DtSpyXmlBlockSP create( DtNodeAndParentPair xmlNodeAndParent );

public:
   DtFomStateXmlBlock( DtEnvValueSP existingNode, DtEnvValueSP root );
   DtFomStateXmlBlock( DtEnvValueSP root );
   virtual ~DtFomStateXmlBlock();

   // Load objects and interactions from an existing fom manager
   virtual void setFom(const DtFomClassMgr& fom);   

   // Add and Remove objects from the list
   virtual DtFomObjectXmlBlockSP addObject( const DtString& name, unsigned long handle );
   virtual DtFomObjectXmlBlockSP removeObject( const DtString& name );
   virtual void removeObject( DtFomObjectXmlBlockSP objectSP );

   // List the object classes
   virtual FomStateObjectXmlBlockSet objects();

   // Add and Remove interactions from the list
   virtual DtFomInteractionXmlBlockSP addInteraction( const DtString& name, unsigned long handle, DtTransportType transport, DtOrderType order );
   virtual DtFomInteractionXmlBlockSP removeInteraction( const DtString& name );
   virtual void removeInteraction( DtFomInteractionXmlBlockSP objectSP );

   // List the interaction classes
   virtual FomStateInteractionXmlBlockSet interactions();

protected:
   
   // Add sub-classes from existing class infos
   void initObjects( const DtObjectClassInfo* fomParent, DtFomObjectXmlBlockSP xmlParent );
   void initInteractions( const DtInteractionClassInfo* fomParent, DtFomInteractionXmlBlockSP xmlParent );
};


#endif // DtFomStateXmlBlock_H_