include/vrfobjparam/vrfRadioDescriptor.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2007 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: vrfRadioDescriptor.h,v $ $Revision: 1.4 $ $State: Exp $
*******************************************************************************/



#ifndef vrfRadioDescriptor_h
#define vrfRadioDescriptor_h

#include "vrfutil/rdrWritr.h"
#include "vrfutil/rwString.h"
#include "vrfutil/rwReal.h"
#include "vrfobjparam/vrfobjparamDefines.h"
#include "tdbutil/stringKeyFactory.h"
#include "vrfobjparam/vrfRadioTransmitterParams.h"
#include "vrfutil/rwBoolean.h"
#include "vrfutil/rwReal.h"

class DtVrfRadioDescriptor;

typedef DtStringKeyFactory<DtVrfRadioDescriptor> DtVrfRadioDescriptorFactory;

class DtReaderWriterRegistry;
class DtFilename;

class DT_DLL_vrfobjparam DtVrfRadioDescriptor : public DtReaderWriter
{
public:
   DtVrfRadioDescriptor(const DtString& name, 
      DtReaderWriterRegistry* parentRegistry = NULL);

   DtVrfRadioDescriptor(const DtSymbolString& name, 
      DtReaderWriterRegistry* parentRegistry = NULL);

   DtVrfRadioDescriptor(const DtVrfRadioDescriptor& orig,
      DtReaderWriterRegistry* parentRegistry = NULL);

   DtVrfRadioDescriptor& operator=(
      const DtVrfRadioDescriptor& orig);

   virtual ~DtVrfRadioDescriptor();

   virtual DtString type() const;

   virtual DtVrfRadioDescriptor* clone(
      DtReaderWriterRegistry* parentRegistry = NULL) const;


   virtual void setRadioType(const DtString& typeString);
   virtual DtString radioType() const;


   virtual void setCommModelName(const DtString& name);
   virtual DtString commModelName() const;


   virtual void setPublishTransmitter(bool value);
   virtual bool publishTransmitter() const;



   virtual DtVrfRadioTransmitterParams& transmitterParams();
   virtual const DtVrfRadioTransmitterParams& transmitterParams() const;
   virtual bool transmitterParamsSpecified() const;


   virtual void setSampleRate(double value);
   virtual double sampleRate() const;

   virtual void putData(FILE* fp, int indentLevel = 0);

   virtual DtlObjPtr getData(DtlObjPtr args, const DtFilename& searchPath,
      const DtVariableBindingsList& variableBindings);

   virtual bool init();

   static DtVrfRadioDescriptorFactory* factory();
   static void setFactory(DtVrfRadioDescriptorFactory* factory);


   static DtVrfRadioDescriptor* createRadioDescriptor(
      DtlObjPtr mtlStream, const DtFilename& searchPath, const DtVariableBindingsList& variableBindings);

   static DtVrfRadioDescriptor* createRadioDescriptor(
      const char* typeString);

   static DtVrfRadioDescriptor* creator();

private:
   DtVrfRadioDescriptor();

protected:


   DtRwString myRadioType;

   DtRwString myCommModelName;

   DtRwBoolean myPublishTransmitter;

   DtVrfRadioTransmitterParams myTransmitterParams;

   DtRwReal mySampleRate;

   static DtVrfRadioDescriptorFactory* theFactory;
};

#endif