MAK RTIspy API Documentation for HLA 1.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
assistantConnectionConfigurationInfo.h
Go to the documentation of this file.
1 /****************************************************************************
2  * Copyright (c) 2016 VT MAK
3  * All rights reserved.
4  ****************************************************************************/
5 
9 
10 #pragma once
11 
12 #include <rtiUtil.h>
13 #include <vlutil/vlString.h>
14 #include <vlutil/vlMutex.h>
15 #include "assistantUtil.h"
16 
18 
21 {
22 public:
23 
25  : myName( MAKRti::DtString::nullString() )
26  , myIsSaved( false )
27  , myIsChosen( false )
28  , myIsPredefined( false )
29  {
30  }
31 
32  DtRtiAssociatedConfigurationData( const MAKRti::DtString& name,
33  bool saved, bool chosen, bool predefined )
34  : myName( name )
35  , myIsSaved( saved )
36  , myIsChosen( chosen )
37  , myIsPredefined( predefined )
38  {
39  }
40 
42  MAKRti::DtString myName;
43 
45  bool myIsSaved;
46 
48  bool myIsChosen;
49 
52 };
53 
55 typedef std::map<DtRtiConnectionConfigurationInfo,DtRtiAssociatedConfigurationData> DtRtiConfigurationInfoDataMap;
56 
58 typedef std::pair<DtRtiConnectionConfigurationInfo,DtRtiAssociatedConfigurationData> DtRtiConfigurationInfoDataPair;
59 
62 {
63 public:
64 
67 
69  DtRtiConnectionConfigurationInfo( bool forceFullCompliance );
70 
73 
79  virtual bool operator < ( const DtRtiConnectionConfigurationInfo& other ) const;
80 
83  virtual bool operator == ( const DtRtiConnectionConfigurationInfo& other ) const;
84 
87  virtual bool operator != ( const DtRtiConnectionConfigurationInfo& other ) const;
88 
91  virtual DtRtiConnectionConfigurationInfo& operator = (
92  const DtRtiConnectionConfigurationInfo& other );
93 
95  virtual MAKRti::DtString defaultName() const;
96 
98  virtual MAKRti::DtString description() const;
99 
101  virtual void setForceFullCompliance(bool compliance);
102 
104  virtual bool forceFullCompliance() const;
105 
106  virtual void setRidConfigurationName( const MAKRti::DtString& name );
107  virtual const MAKRti::DtString& ridConfigurationName() const;
108 
109  virtual void setRidIsPreconfigured( bool isPreconfigured );
110  virtual bool ridIsPreconfigured() const;
111 
112  virtual void setRidFilePath( const MAKRti::DtFilename& ridPath );
113  virtual const MAKRti::DtFilename& ridFilePath() const;
114 
115  virtual void setRidLisp( const MAKRti::DtString& lisp );
116  virtual const MAKRti::DtString& ridLisp() const;
117 
119  virtual bool isValid() const;
120 
121 public:
122 
124  virtual MAKRti::DtString constructConfigName() const;
125 
127  virtual MAKRti::DtString constructConfigDescription() const;
128 
129 protected:
130 
133  MAKRti::DtFilename myRidFilePath;
134 
137  MAKRti::DtString myRidLisp;
138 
140  MAKRti::DtString myRidConfigurationName;
141 
144 
147 
148 };
MAKRti::DtFilename myRidFilePath
The path to the RID configuration on disk (if RID is a user configuration).
Definition: assistantConnectionConfigurationInfo.h:133
bool myRidIsPreconfigured
Whether the chosen RID configuration is preconfigured or user configured.
Definition: assistantConnectionConfigurationInfo.h:143
bool myIsChosen
Whether or not this configuration is the chosen configuration.
Definition: assistantConnectionConfigurationInfo.h:48
Stores data associated with a configuration.
Definition: assistantConnectionConfigurationInfo.h:20
This file contains the declaration of Assistant Utility Functions.
DtRtiAssociatedConfigurationData(const MAKRti::DtString &name, bool saved, bool chosen, bool predefined)
Definition: assistantConnectionConfigurationInfo.h:32
bool myIsSaved
Whether this configuration has been/will be saved to file.
Definition: assistantConnectionConfigurationInfo.h:45
std::map< DtRtiConnectionConfigurationInfo, DtRtiAssociatedConfigurationData > DtRtiConfigurationInfoDataMap
Map configurations to their associated data.
Definition: assistantConnectionConfigurationInfo.h:55
MAKRti::DtString myName
The user assigned name for the configuration.
Definition: assistantConnectionConfigurationInfo.h:42
bool myIsPredefined
Whether or not this is one of the predefined connections.
Definition: assistantConnectionConfigurationInfo.h:51
#define DT_DLL_ASSISTANT
_WIN32
Definition: rtiMsConfig.h:121
MAKRti::DtString myRidLisp
Stored RID configuration (as lisp expressions).
Definition: assistantConnectionConfigurationInfo.h:137
DtRtiAssociatedConfigurationData()
Definition: assistantConnectionConfigurationInfo.h:24
MAKRti::DtString myRidConfigurationName
The name of the chosen RID configuration.
Definition: assistantConnectionConfigurationInfo.h:140
std::pair< DtRtiConnectionConfigurationInfo, DtRtiAssociatedConfigurationData > DtRtiConfigurationInfoDataPair
Pair of configuration with associated data.
Definition: assistantConnectionConfigurationInfo.h:58
Stores the information on an RTI configuration known by the Assistant.
Definition: assistantConnectionConfigurationInfo.h:61
bool myFullyCompliant
Whether this connection specifies forceFullCompliance.
Definition: assistantConnectionConfigurationInfo.h:146

Document ID: Generated on Mon Sep 7 15:40:32 EDT 2020 from SVN revision 217499
Copyright © 2005-2020 MAK Technologies Inc. All Rights Reserved (www.mak.com)