federateStateXmlBlock.h

Go to the documentation of this file.

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

#include <rtiMsConfig.h>
#include "spyXmlBlock.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( DtFederateStateXmlTag );
DtDECLARE_SPY_XML_TAG( DtFederateConnIdXmlTag );
DtDECLARE_SPY_XML_TAG( DtFederateHandleXmlTag );
DtDECLARE_SPY_XML_TAG( DtFederateHostXmlTag );
DtDECLARE_SPY_XML_TAG( DtFederateWebServerHostXmlTag );
DtDECLARE_SPY_XML_TAG( DtFederateWebServerPortXmlTag );
DtDECLARE_SPY_XML_TAG( DtTimeStateXmlTag );
DtDECLARE_SPY_XML_TAG( DtTimeRegulatingXmlTag );
DtDECLARE_SPY_XML_TAG( DtTimeConstrainedXmlTag );
DtDECLARE_SPY_XML_TAG( DtLbtsXmlTag );
DtDECLARE_SPY_XML_TAG( DtLookaheadXmlTag );
DtDECLARE_SPY_XML_TAG( DtCurrentTimeXmlTag );

class DtFederateStateXmlBlock;
class DtTimeStateXmlBlock;
typedef DtBoost::shared_ptr<DtFederateStateXmlBlock> DtFederateStateXmlBlockSP;
typedef DtBoost::weak_ptr<DtFederateStateXmlBlock>   DtFederateStateXmlBlockWP;
typedef DtBoost::shared_ptr<DtTimeStateXmlBlock>     DtTimeStateXmlBlockSP;
typedef DtBoost::weak_ptr<DtTimeStateXmlBlock>       DtTimeStateXmlBlockWP;


// Sub-block of DtFederateStateXmlBlock representing the federate's logical time
// state.  Times are represented as strings since their implementation is user-defined
class DT_DLL_WWW DtTimeStateXmlBlock : public DtSpyXmlBlock
{
public:
   static DtSpyXmlBlockSP create( DtNodeAndParentPair xmlNodeAndParent );

public:
   DtTimeStateXmlBlock( DtEnvValueSP existingNode, DtEnvValueSP root );
   DtTimeStateXmlBlock( bool regulating, bool constrained, const DtString& lbts, 
      const DtString& lookahead, const DtString& curTime, DtEnvValueSP root );
   virtual ~DtTimeStateXmlBlock();

   virtual void setTimeState( bool regulating, bool constrained, const DtString& lbts, 
      const DtString& lookahead, const DtString& curTime );

   inline bool isRegulating() const;
   inline bool isConstrained() const;
   inline DtString lbts() const;
   inline DtString lookahead() const;
   inline DtString currentTime() const;

protected:

   DtSpyXmlBlockElement< bool >  myIsRegulating; 
   DtSpyXmlBlockElement< bool > myIsConstrained;
   DtSpyXmlBlockElement< DtString >        myLbts;
   DtSpyXmlBlockElement< DtString >   myLookahead;
   DtSpyXmlBlockElement< DtString > myCurrentTime;
};

// The DtFederateStateXmlBlock represents the current state of a joined federate
// as seen by the RTI Exec.
class DT_DLL_WWW DtFederateStateXmlBlock : public DtSpyXmlBlock
{
public:
   static DtSpyXmlBlockSP create( DtNodeAndParentPair xmlNodeAndParent );

public:
   DtFederateStateXmlBlock( DtEnvValueSP existingNode, DtEnvValueSP root );
   DtFederateStateXmlBlock( unsigned long connId, const DtString& type,  
      unsigned long handle, const DtString& host, const DtString& webServerHost,
      int webServerPort, DtEnvValueSP root );
   virtual ~DtFederateStateXmlBlock();

   // A federate may contain only one TimeState block
   virtual DtTimeStateXmlBlockSP setTimeState( bool regulating, bool constrained,
      const DtString& lbts, const DtString& lookahead, const DtString& curTime );
   virtual DtTimeStateXmlBlockSP timeState();
   
   inline unsigned long connId() const;
   inline DtString host() const;
   inline DtString webServerHost() const;
   inline int webServerPort() const;

   // Set and get  federate handle
   // (may not be available initially)
   inline void setHandle( unsigned long handle );
   inline unsigned long handle() const;

protected:
   

   DtSpyXmlBlockElement< unsigned long, true >  myConnId; 
   DtSpyXmlBlockElement< unsigned long, true >  myHandle; 
   DtSpyXmlBlockElement< DtString, false > myHost;
   DtSpyXmlBlockElement< DtString, false > myWebServerHost;
   DtSpyXmlBlockElement< int, false > myWebServerPort;
};



bool DtTimeStateXmlBlock::isRegulating() const { return myIsRegulating; }
bool DtTimeStateXmlBlock::isConstrained() const { return myIsConstrained; }
DtString DtTimeStateXmlBlock::lbts() const { return myLbts; }
DtString DtTimeStateXmlBlock::lookahead() const { return myLookahead; }
DtString DtTimeStateXmlBlock::currentTime() const { return myCurrentTime; }
unsigned long DtFederateStateXmlBlock::connId() const { return myConnId; }
void DtFederateStateXmlBlock::setHandle( unsigned long handle ) { myHandle = handle; }
unsigned long DtFederateStateXmlBlock::handle() const { return myHandle; }
DtString DtFederateStateXmlBlock::host() const { return myHost; }
DtString DtFederateStateXmlBlock::webServerHost() const { return myWebServerHost; }
int DtFederateStateXmlBlock::webServerPort() const { return myWebServerPort; }

#endif // DtFederateStateXmlBlock_H_