VR-Forces 5.0.3 Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
commModelDescriptor.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ** Copyright (c) 2021 MAK Technologies, Inc.
3 ** All rights reserved.
4 *******************************************************************************/
5 
8 
10 
11 #pragma once
12 
14 
16 #include <readerWriter/rwString.h>
17 #include <readerWriter/rwReal.h>
18 #include <readerWriter/rwBoolean.h>
21 
23 
26 
28 class DtFilename;
29 
34 {
35 public:
37  DtCommModelDescriptor(const DtString& name,
38  DtReaderWriterRegistry* parentRegistry = NULL);
39 
41  DtReaderWriterRegistry* parentRegistry = NULL);
42 
45  DtReaderWriterRegistry* parentRegistry = NULL);
46 
49  const DtCommModelDescriptor& orig);
50 
51  virtual ~DtCommModelDescriptor();
52 
55  virtual DtString type() const;
56 
57  virtual DtCommModelDescriptor* clone(
58  DtReaderWriterRegistry* parentRegistry = NULL) const;
59 
61 
62  virtual void setCommModelType(const DtString& typeString);
63  virtual DtString commModelType() const;
65 
67 
68  virtual bool publishTransmitters() const;
69  virtual void setPublishTransmitters(bool value);
71 
73 
74  virtual bool sendReceivedCommMessageOnBroadcast() const;
75  virtual void setSendReceivedCommMessageOnBroadcast(bool);
77 
79  virtual void putData(std::string& fp, int indentLevel = 0);
80 
83  virtual DtlObjPtr getData(DtlObjPtr args, const DtReaderWriter::SearchPaths& searchPaths,
84  const DtVariableBindingsList& variableBindings);
85 
89  virtual bool init();
90 
94  static void setFactory(DtCommModelDescriptorFactory* factory);
95 
97 
98  static DtCommModelDescriptor* createCommModelDescriptor(
99  DtlObjPtr mtlStream, const DtReaderWriter::SearchPaths& searchPaths,
100  const DtVariableBindingsList& variableBindings);
101 
102  static DtCommModelDescriptor* createCommModelDescriptor(
103  const char* typeString);
105 
107  static DtCommModelDescriptor* creator();
108 
109 private:
112 
113 protected:
116 
117  DtRwString myCommModelType;
122 
130 
136 
138 };
Definition: symbolString.h:20
#define DT_DLL_vrfobjparam
This file is used to determine how to build.
Definition: vrfobjparamDefines.h:28
static DtCommModelDescriptorFactory * theFactory
Definition: commModelDescriptor.h:137
virtual DtlObjPtr getData(DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
Deriving class overrides these to get/put class specific data.
Definition: readerWriter.h:85
Description: Readable, Writable DtString Variable substitutions are done on this object when it is re...
Definition: rwString.h:20
Definition: readerWriterRegistry.h:39
DtRwBoolean mySendReceivedCommMessageOnBroadcast
Parameter Name: send-received-comm-message-on-broadcast Parameter Description: If the message being s...
Definition: commModelDescriptor.h:135
DtRwBoolean myPublishTransmitters
Parameter Name: publish-transmitters Parameter Description: Indicates whether or not radios using thi...
Definition: commModelDescriptor.h:129
static DtReaderWriterFactory * factory()
std::list< const DtRwVariableBindings * > DtVariableBindingsList
Definition: readerWriterRegistry.h:29
Factory templates DtStringKeyFactory and DtStringKeyFactoryWithParam.
std::vector< DtFilename > SearchPaths
Definition: readerWriter.h:92
Definition: stringKeyFactory.h:27
Descriptor base class for DtRadio instances. A descriptor tells what type of radio to create as well ...
Definition: commModelDescriptor.h:33
virtual void putData(std::string &fp, int indentLevel=0)
Deriving class overrides these to get/put class specific data.
Description: Readable, Writable bool.
Definition: rwBoolean.h:26
DT_DLL_DEBUGDRAWRENDERER void init(makVrv::DtDe &de)
Work function for the plugin initialization.
const DtReaderWriter & operator=(const DtReaderWriter &orig)
assignment operator
DtStringKeyFactory< DtCommModelDescriptor > DtCommModelDescriptorFactory
Factory for creating DtCommModelDescriptor instances.
Definition: commModelDescriptor.h:22

Document ID: Generated on Thu Jun 1 17:58:13 EDT 2023 from SVN revision 255404
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)