fomInteractionXmlBlock.h

Go to the documentation of this file.

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

#include <rtiMsConfig.h>
#include "spyXmlBlock.h"
#include <mtl/env.h>
#include "webSpyUtils.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( DtFomInteractionXmlTag );
DtDECLARE_SPY_XML_TAG( DtFomParameterXmlTag );
DtDECLARE_SPY_XML_TAG( DtInterTransportXmlTag );
DtDECLARE_SPY_XML_TAG( DtInterOrderXmlTag );
DtDECLARE_SPY_XML_TAG( DtInterHandleXmlTag );
DtDECLARE_SPY_XML_TAG( DtParamHandleXmlTag );


class DtFomInteractionXmlBlock;
class DtFomParameterXmlBlock;
typedef DtBoost::shared_ptr<DtFomInteractionXmlBlock> DtFomInteractionXmlBlockSP;
typedef DtBoost::weak_ptr<DtFomInteractionXmlBlock>   DtFomInteractionXmlBlockWP;
typedef DtBoost::shared_ptr<DtFomParameterXmlBlock> DtFomParameterXmlBlockSP;
typedef DtBoost::weak_ptr<DtFomParameterXmlBlock>   DtFomParameterXmlBlockWP;


// The DtFomParameterXmlBlock holds a single FOM interaction class parameter
// Helper class to DtFomInteractionXmlBlock.
class DT_DLL_WWW DtFomParameterXmlBlock : public DtSpyXmlBlock
{
public:
   
   static DtSpyXmlBlockSP create( DtNodeAndParentPair xmlNodeAndParent );

public:
   DtFomParameterXmlBlock( DtEnvValueSP existingNode, DtEnvValueSP root );
   DtFomParameterXmlBlock( const DtString& name, unsigned long handle, DtEnvValueSP root );
   virtual ~DtFomParameterXmlBlock();

   inline unsigned long handle() const;
   
protected:
   
   DtSpyXmlBlockElement< unsigned long, true > myHandle;
};



// The DtFomInteractionXmlBlock holds a complete WWW request message
class DT_DLL_WWW DtFomInteractionXmlBlock : public DtSpyXmlBlock
{
public:
   typedef std::set< DtFomParameterXmlBlockSP > FomParameterXmlBlockSet;
   typedef std::set< DtFomInteractionXmlBlockSP > FomStateInteractionXmlBlockSet;

   static DtSpyXmlBlockSP create( DtNodeAndParentPair xmlNodeAndParent );

public:
   DtFomInteractionXmlBlock( DtEnvValueSP existingNode, DtEnvValueSP root );
   DtFomInteractionXmlBlock( const DtString& name, unsigned long handle, DtTransportType transport, DtOrderType order, DtEnvValueSP root );
   virtual ~DtFomInteractionXmlBlock();

   inline unsigned long handle() const;
   inline DtTransportType transport() const;
   inline DtOrderType order() const;

   // Add and Remove parameters from the list
   virtual DtFomParameterXmlBlockSP addParameter( const DtString& name, unsigned long handle );
   virtual DtFomParameterXmlBlockSP removeParameter( const DtString& name );
   virtual void removeParameter( DtFomParameterXmlBlockSP parameterSP );

   // List the parameter classes
   virtual FomParameterXmlBlockSet parameters();

   // Add and Remove child 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 child interaction classes
   virtual FomStateInteractionXmlBlockSet interactions();   

protected:

   DtSpyXmlBlockElement< unsigned long, true > myHandle;
   DtSpyXmlBlockElement< unsigned long, true > myTransport;
   DtSpyXmlBlockElement< unsigned long, true > myOrder;    
};

inline DtTransportType DtFomInteractionXmlBlock::transport() const { return (DtTransportType) static_cast<unsigned long>( myTransport ); }
inline DtOrderType DtFomInteractionXmlBlock::order() const { return (DtOrderType) static_cast<unsigned long>( myOrder ); }
inline unsigned long DtFomParameterXmlBlock::handle() const { return myHandle; }
inline unsigned long DtFomInteractionXmlBlock::handle() const { return myHandle; }

#endif // DtFomInteractionXmlBlock_H_