ridParamsXmlBlock.h

Go to the documentation of this file.

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

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

class DtRIDParameters;

// Declare the XML tags used by this block
DtDECLARE_SPY_XML_TAG( DtRidParamsXmlTag );
DtDECLARE_SPY_XML_TAG( DtRidParameterXmlTag );
DtDECLARE_SPY_XML_TAG( DtRidParameterValueXmlTag );
DtDECLARE_SPY_XML_TAG( DtRidParameterEditableXmlTag );
DtDECLARE_SPY_XML_TAG( DtRidParameterTypeXmlTag );
DtDECLARE_SPY_XML_TAG( DtRidParameterRangeXmlTag );

class DtRidParamsXmlBlock;
class DtRidParameterXmlBlock;
typedef DtBoost::shared_ptr<DtRidParamsXmlBlock> DtRidParamsXmlBlockSP;
typedef DtBoost::weak_ptr<DtRidParamsXmlBlock>   DtRidParamsXmlBlockWP;
typedef DtBoost::shared_ptr<DtRidParameterXmlBlock>     DtRidParameterXmlBlockSP;
typedef DtBoost::weak_ptr<DtRidParameterXmlBlock>       DtRidParameterXmlBlockWP;


// Sub-block of DtRidParamsXmlBlock representing a single parameter/value pair
class DT_DLL_WWW DtRidParameterXmlBlock : public DtSpyXmlBlock
{
public:
   static DtSpyXmlBlockSP create( DtNodeAndParentPair xmlNodeAndParent );

public:
   DtRidParameterXmlBlock( DtEnvValueSP existingNode, DtEnvValueSP root );
   DtRidParameterXmlBlock( const DtString& name, const DtString& value, 
      const DtString& type, bool editable, const DtString& range, DtEnvValueSP root );
   virtual ~DtRidParameterXmlBlock();

   virtual void setValue( const DtString& value );
   virtual DtString value() const;

   virtual void setEditable( bool editable);
   virtual bool editable() const;

   virtual void setType( const DtString& type );
   virtual DtString type() const;

   virtual void setRange( const DtString& range );
   virtual DtString range() const;
   
protected:

   DtSpyXmlBlockElement< DtString, true > myValue;   
   DtSpyXmlBlockElement< DtString, true > myType;   
   DtSpyXmlBlockElement< bool, true > myEditable;  
   DtSpyXmlBlockElement< DtString, true > myRange;   

};

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

public:
   DtRidParamsXmlBlock( DtEnvValueSP existingNode, DtEnvValueSP root );
   DtRidParamsXmlBlock( const DtRIDParameters& params, DtEnvValueSP root );
   virtual ~DtRidParamsXmlBlock();

   // Write params from a RID file to an existing RID block
   // - will simply append if any params already exist
   virtual void addParams( const DtRIDParameters& params );

   // Return a pointer to a parameter in the RID
   virtual DtRidParameterXmlBlockSP getParam( const DtString& name );

protected:

   // Build the XML params from a RID object (non-virtual since it is used by ctor)
   void convertRidParams( const DtRIDParameters& params );
};





#endif // DtRidParamsXmlBlock_H_