rtiObjectStateXmlBlock.h

Go to the documentation of this file.

/*********************************************************************
 ** Copyright (c) 2006 MaK Technologies, Inc.
 ** All rights reserved.
 *********************************************************************/
/*******************************************************************************
 ** $RCSfile: rtiObjectStateXmlBlock.h,v $ $Revision: 1.6 $ $State: Exp $
 *******************************************************************************/
#ifndef DtRtiObjectStateXmlBlock_H_
#define DtRtiObjectStateXmlBlock_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( DtRtiObjectStateXmlTag );
DtDECLARE_SPY_XML_TAG( DtInstanceHandleXmlTag );
DtDECLARE_SPY_XML_TAG( DtRegDiscStatusXmlTag );

class DtRtiObjectStateXmlBlock;
typedef DtBoost::shared_ptr<DtRtiObjectStateXmlBlock> DtRtiObjectStateXmlBlockSP;
typedef DtBoost::weak_ptr<DtRtiObjectStateXmlBlock>   DtRtiObjectStateXmlBlockWP;


// The DtRtiObjectStateXmlBlock represents the current state of a single
// registered or discovered object as known at a specific LRC
class DT_DLL_WWW DtRtiObjectStateXmlBlock : public DtSpyXmlBlock
{
public:
   static DtSpyXmlBlockSP create( DtNodeAndParentPair xmlNodeAndParent );

public:
   DtRtiObjectStateXmlBlock( DtEnvValueSP existingNode, DtEnvValueSP root );
   DtRtiObjectStateXmlBlock( const DtString& name, unsigned long handle, bool isRegistered, DtEnvValueSP root );
   virtual ~DtRtiObjectStateXmlBlock();
   
   inline unsigned long handle() const;
   inline bool isRegistered() const;

protected:
   
   DtSpyXmlBlockElement< unsigned long >  myHandle; 
   DtSpyXmlBlockElement< bool > myIsRegistered;
   
};

unsigned long DtRtiObjectStateXmlBlock::handle() const { return myHandle; }
bool DtRtiObjectStateXmlBlock::isRegistered() const { return myIsRegistered; }

#endif // DtRtiObjectStateXmlBlock_H_