fomObjectXmlBlock.h

Go to the documentation of this file.

/*********************************************************************
 ** Copyright (c) 2006 MaK Technologies, Inc.
 ** All rights reserved.
 *********************************************************************/
/*******************************************************************************
 ** $RCSfile: fomObjectXmlBlock.h,v $ $Revision: 1.7 $ $State: Exp $
 *******************************************************************************/
#ifndef DtFomObjectXmlBlock_H_
#define DtFomObjectXmlBlock_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( DtFomObjectXmlTag );
DtDECLARE_SPY_XML_TAG( DtFomAttributeXmlTag );
DtDECLARE_SPY_XML_TAG( DtAttrTransportXmlTag );
DtDECLARE_SPY_XML_TAG( DtAttrOrderXmlTag );
DtDECLARE_SPY_XML_TAG( DtObjHandleXmlTag );
DtDECLARE_SPY_XML_TAG( DtAttrHandleXmlTag );

class DtFomObjectXmlBlock;
class DtFomAttributeXmlBlock;
typedef DtBoost::shared_ptr<DtFomObjectXmlBlock> DtFomObjectXmlBlockSP;
typedef DtBoost::weak_ptr<DtFomObjectXmlBlock>   DtFomObjectXmlBlockWP;
typedef DtBoost::shared_ptr<DtFomAttributeXmlBlock> DtFomAttributeXmlBlockSP;
typedef DtBoost::weak_ptr<DtFomAttributeXmlBlock>   DtFomAttributeXmlBlockWP;


// The DtFomAttributeXmlBlock holds a single FOM object class attribute
// Helper class to DtFomObjectXmlBlock.
class DT_DLL_WWW DtFomAttributeXmlBlock : public DtSpyXmlBlock
{
public:
   
   static DtSpyXmlBlockSP create( DtNodeAndParentPair xmlNodeAndParent );

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

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

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

   

// The DtFomObjectXmlBlock holds a complete WWW request message
class DT_DLL_WWW DtFomObjectXmlBlock : public DtSpyXmlBlock
{
public:
   typedef std::set< DtFomAttributeXmlBlockSP > FomAttributeXmlBlockSet;
   typedef std::set< DtFomObjectXmlBlockSP > FomStateObjectXmlBlockSet;   

   static DtSpyXmlBlockSP create( DtNodeAndParentPair xmlNodeAndParent );

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

   inline unsigned long handle() const;
   
   // Add and Remove attributes from the list
   virtual DtFomAttributeXmlBlockSP addAttribute( const DtString& name, unsigned long handle, DtTransportType transport, DtOrderType order );
   virtual DtFomAttributeXmlBlockSP removeAttribute( const DtString& name );
   virtual void removeAttribute( DtFomAttributeXmlBlockSP attrSP );

   // List the attribute classes
   virtual FomAttributeXmlBlockSet attributes();

   // Add and Remove child 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 child object classes
   virtual FomStateObjectXmlBlockSet objects();

protected:

   DtSpyXmlBlockElement< unsigned long, true > myHandle;
   
};

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

#endif // DtFomObjectXmlBlock_H_