federateStateContainerXmlBlock.h

Go to the documentation of this file.

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

#include <rtiMsConfig.h>
#include "spyXmlBlock.h"
#include "spyXmlBlockElements.h"
#include "federateStateXmlBlock.h"
#include <mtl/env.h>
#include <vlutil/vlString.h>
#include <vlutil/vlSmartPointers.h>


// Declare the XML tags used by this block
DtDECLARE_SPY_XML_TAG( DtFederateStateContainerXmlTag );
DtDECLARE_SPY_XML_TAG( DtFederateStateContainerFederationNameXmlTag );
DtDECLARE_SPY_XML_TAG( DtFederateStateContainerFederationHandleXmlTag );
DtDECLARE_SPY_XML_TAG( DtFederateStateContainerFedFileNameXmlTag );
DtDECLARE_SPY_XML_TAG( DtFederateStateContainerRidFileNameXmlTag );
DtDECLARE_SPY_XML_TAG( DtFederateStateContainerRtiVersionXmlTag );

class DtFederateStateContainerXmlBlock;
typedef DtBoost::shared_ptr<DtFederateStateContainerXmlBlock> DtFederateStateContainerXmlBlockSP;
typedef DtBoost::weak_ptr<DtFederateStateContainerXmlBlock>   DtFederateStateContainerXmlBlockWP;


// The DtFederateStateContainerXmlBlock holds the current state info for a single federation
class DT_DLL_WWW DtFederateStateContainerXmlBlock : public DtSpyXmlBlock
{
public:
   
   static DtSpyXmlBlockSP create( DtNodeAndParentPair xmlNodeAndParent );

public:
   DtFederateStateContainerXmlBlock( DtEnvValueSP existingNode, DtEnvValueSP root );
   DtFederateStateContainerXmlBlock( DtEnvValueSP root );
   virtual ~DtFederateStateContainerXmlBlock();   
   
   // Set/Get the contained Federate State XML block
   // Set adds federateSP as a child of the container block
   void setFederate( DtFederateStateXmlBlockSP federateSP );
   DtFederateStateXmlBlockSP federate();

   // Set and get federation name and handle
   // (these may not be available initially)
   inline void setFederationName( const DtString& name );
   inline DtString federationName() const;
   inline void setFederationHandle( unsigned long handle );
   inline unsigned long federationHandle() const;
   
   // Set and get fed and rid file names
   // (these may not be available initially)
   inline void setFedFileName( const DtString& name );
   inline DtString fedFileName() const;
   inline void setRidFileName( const DtString& name );
   inline DtString ridFileName() const;
   

   // Get the RTI Version string
   inline DtString rtiVersion() const;

protected:

   DtFederateStateXmlBlockSP myFederateState;

   DtSpyXmlBlockElement< DtString, true > myFederationName;
   DtSpyXmlBlockElement< unsigned long, true >  myFederationHandle;    
   DtSpyXmlBlockElement< DtString, true > myFedFile;
   DtSpyXmlBlockElement< DtString, true > myRidFile;
   DtSpyXmlBlockElement< DtString, true > myRtiVersion;
};

void DtFederateStateContainerXmlBlock::setFederationName( const DtString& name ) { myFederationName = name; }
DtString DtFederateStateContainerXmlBlock::federationName() const { return myFederationName; }
void DtFederateStateContainerXmlBlock::setFederationHandle( unsigned long handle ) { myFederationHandle = handle; }
unsigned long DtFederateStateContainerXmlBlock::federationHandle() const { return myFederationHandle; }

void DtFederateStateContainerXmlBlock::setFedFileName( const DtString& name ) { myFedFile = name; }
DtString DtFederateStateContainerXmlBlock::fedFileName() const { return myFedFile; }
void DtFederateStateContainerXmlBlock::setRidFileName( const DtString& name ) { myRidFile = name; }
DtString DtFederateStateContainerXmlBlock::ridFileName() const { return myRidFile; }
DtString DtFederateStateContainerXmlBlock::rtiVersion() const { return myRtiVersion; }


#endif // DtFederateStateContainerXmlBlock_H_