SMTK  @SMTK_VERSION@
Simulation Modeling Tool Kit
CopyAssignmentOptions.h
1 //=========================================================================
2 // Copyright (c) Kitware, Inc.
3 // All rights reserved.
4 // See LICENSE.txt for details.
5 //
6 // This software is distributed WITHOUT ANY WARRANTY; without even
7 // the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
8 // PURPOSE. See the above copyright notice for more information.
9 //=========================================================================
10 
11 #ifndef smtk_attribute_CopyAssignmentOptions_h
12 #define smtk_attribute_CopyAssignmentOptions_h
13 
14 #include "smtk/CoreExports.h"
15 
16 #include <string>
17 
18 namespace smtk
19 {
20 namespace attribute
21 {
22 
27 
28 class SMTKCORE_EXPORT AttributeCopyOptions
29 {
30 public:
37  bool copyUUID() const { return m_copyUUID; }
38  void setCopyUUID(bool val) { m_copyUUID = val; }
40 
49  bool copyDefinition() const { return m_copyDefinition; }
50  void setCopyDefinition(bool val) { m_copyDefinition = val; }
52 
54  std::string convertToString(const std::string& prefix = "") const;
55 
56 protected:
57  bool m_copyUUID = false;
58  bool m_copyDefinition = false;
59 };
60 
65 class SMTKCORE_EXPORT AttributeAssignmentOptions
66 {
67 public:
77  bool ignoreMissingItems() const { return m_ignoreMissingItems; }
78  void setIgnoreMissingItems(bool val) { m_ignoreMissingItems = val; }
80 
87  bool copyAssociations() const { return m_copyAssociations; }
88  void setCopyAssociations(bool val) { m_copyAssociations = val; }
90 
97  bool allowPartialAssociations() const { return m_allowPartialAssociations; }
98  void setAllowPartialAssociations(bool val) { m_allowPartialAssociations = val; }
100 
108  bool doNotValidateAssociations() const { return m_doNotValidateAssociations; }
109  void setDoNotValidateAssociations(bool val) { m_doNotValidateAssociations = val; }
111 
112  std::string convertToString(const std::string& prefix = "") const;
113 
114 protected:
115  bool m_ignoreMissingItems = false;
116  bool m_copyAssociations = false;
117  bool m_allowPartialAssociations = false;
118  bool m_doNotValidateAssociations = false;
119 };
120 
125 class SMTKCORE_EXPORT ItemAssignmentOptions
126 {
127 public:
137  bool ignoreMissingChildren() const { return m_ignoreMissingChildren; }
138  void setIgnoreMissingChildren(bool val) { m_ignoreMissingChildren = val; }
140 
147  bool allowPartialValues() const { return m_allowPartialValues; }
148  void setAllowPartialValues(bool val) { m_allowPartialValues = val; }
150 
156  bool ignoreExpressions() const { return m_ignoreExpressions; }
157  void setIgnoreExpressions(bool val) { m_ignoreExpressions = val; }
159 
165  bool ignoreReferenceValues() const { return m_ignoreReferenceValues; }
166  void setIgnoreReferenceValues(bool val) { m_ignoreReferenceValues = val; }
168 
175  bool doNotValidateReferenceInfo() const { return m_doNotValidateReferenceInfo; }
176  void setDoNotValidateReferenceInfo(bool val) { m_doNotValidateReferenceInfo = val; }
178 
194  bool disableCopyAttributes() const { return m_disableCopyAttributes; }
195  void setDisableCopyAttributes(bool val) { m_disableCopyAttributes = val; }
197 
199  std::string convertToString(const std::string& prefix = "") const;
200 
201 protected:
202  bool m_ignoreMissingChildren = false;
203  bool m_allowPartialValues = false;
204  bool m_ignoreExpressions = false;
205  bool m_ignoreReferenceValues = false;
206  bool m_doNotValidateReferenceInfo = false;
207  bool m_disableCopyAttributes = false;
208 };
209 
211 class SMTKCORE_EXPORT CopyAssignmentOptions
212 {
213 public:
214  AttributeCopyOptions copyOptions;
215  AttributeAssignmentOptions attributeOptions;
216  ItemAssignmentOptions itemOptions;
217 
219  std::string convertToString(const std::string& prefix = "") const;
220 };
221 
222 }; // namespace attribute
223 }; // namespace smtk
224 #endif // smtk_attribute_CopyAssignmentOptions_h
smtk
The main namespace for the Simulation Modeling Tool Kit (SMTK).
Definition: doc.h:33
smtk::attribute::ItemAssignmentOptions::setIgnoreReferenceValues
void setIgnoreReferenceValues(bool val)
Methods to set and retrieve the ignoreReferenceValues Option.
Definition: CopyAssignmentOptions.h:166
smtk::attribute::ItemAssignmentOptions::setIgnoreExpressions
void setIgnoreExpressions(bool val)
Methods to set and retrieve the ignoreExpressions Option.
Definition: CopyAssignmentOptions.h:157
smtk::attribute::CopyAssignmentOptions
Class used to specify copy and assignment options.
Definition: CopyAssignmentOptions.h:211
smtk::attribute::AttributeAssignmentOptions::setIgnoreMissingItems
void setIgnoreMissingItems(bool val)
Methods to set and retrieve the ignoreMissingItems Option.
Definition: CopyAssignmentOptions.h:78
smtk::attribute::ItemAssignmentOptions::setIgnoreMissingChildren
void setIgnoreMissingChildren(bool val)
Methods to set and retrieve the ignoreMissingChildren Option.
Definition: CopyAssignmentOptions.h:138
smtk::attribute::ItemAssignmentOptions::ignoreReferenceValues
bool ignoreReferenceValues() const
Methods to set and retrieve the ignoreReferenceValues Option.
Definition: CopyAssignmentOptions.h:165
smtk::attribute::ItemAssignmentOptions
Class used to control how an item's information is assigned to another item.
Definition: CopyAssignmentOptions.h:125
smtk::attribute::AttributeAssignmentOptions::setCopyAssociations
void setCopyAssociations(bool val)
Methods to set and retrieve the copyAssociations Option.
Definition: CopyAssignmentOptions.h:88
smtk::attribute::ItemAssignmentOptions::ignoreExpressions
bool ignoreExpressions() const
Methods to set and retrieve the ignoreExpressions Option.
Definition: CopyAssignmentOptions.h:156
smtk::attribute::ItemAssignmentOptions::setDisableCopyAttributes
void setDisableCopyAttributes(bool val)
Methods to set and retrieve the disableCopyAttributes Option.
Definition: CopyAssignmentOptions.h:195
smtk::attribute::AttributeCopyOptions::copyDefinition
bool copyDefinition() const
Methods to set and retrieve the copyDefinition Option.
Definition: CopyAssignmentOptions.h:49
smtk::attribute::AttributeAssignmentOptions::ignoreMissingItems
bool ignoreMissingItems() const
Methods to set and retrieve the ignoreMissingItems Option.
Definition: CopyAssignmentOptions.h:77
smtk::attribute::AttributeAssignmentOptions::setAllowPartialAssociations
void setAllowPartialAssociations(bool val)
Methods to set and retrieve the allowPartialAssociations Option.
Definition: CopyAssignmentOptions.h:98
smtk::attribute::AttributeAssignmentOptions::allowPartialAssociations
bool allowPartialAssociations() const
Methods to set and retrieve the allowPartialAssociations Option.
Definition: CopyAssignmentOptions.h:97
smtk::attribute::AttributeAssignmentOptions::setDoNotValidateAssociations
void setDoNotValidateAssociations(bool val)
Methods to set and retrieve the doNotValidateAssociations Hint Option.
Definition: CopyAssignmentOptions.h:109
smtk::attribute::ItemAssignmentOptions::ignoreMissingChildren
bool ignoreMissingChildren() const
Methods to set and retrieve the ignoreMissingChildren Option.
Definition: CopyAssignmentOptions.h:137
smtk::attribute::AttributeCopyOptions::setCopyUUID
void setCopyUUID(bool val)
Methods to set and retrieve the copyUUID Option.
Definition: CopyAssignmentOptions.h:38
smtk::attribute::ItemAssignmentOptions::setDoNotValidateReferenceInfo
void setDoNotValidateReferenceInfo(bool val)
Methods to set and retrieve the doNotValidateReferenceInfo Hint Option.
Definition: CopyAssignmentOptions.h:176
smtk::attribute::AttributeAssignmentOptions
Class used to control how an attribute's information is assigned to another attribute.
Definition: CopyAssignmentOptions.h:65
smtk::attribute::AttributeAssignmentOptions::copyAssociations
bool copyAssociations() const
Methods to set and retrieve the copyAssociations Option.
Definition: CopyAssignmentOptions.h:87
smtk::attribute::AttributeCopyOptions::copyUUID
bool copyUUID() const
Methods to set and retrieve the copyUUID Option.
Definition: CopyAssignmentOptions.h:37
smtk::attribute::AttributeAssignmentOptions::doNotValidateAssociations
bool doNotValidateAssociations() const
Methods to set and retrieve the doNotValidateAssociations Hint Option.
Definition: CopyAssignmentOptions.h:108
smtk::attribute::AttributeCopyOptions::setCopyDefinition
void setCopyDefinition(bool val)
Methods to set and retrieve the copyDefinition Option.
Definition: CopyAssignmentOptions.h:50
smtk::attribute::ItemAssignmentOptions::disableCopyAttributes
bool disableCopyAttributes() const
Methods to set and retrieve the disableCopyAttributes Option.
Definition: CopyAssignmentOptions.h:194
smtk::attribute::ItemAssignmentOptions::setAllowPartialValues
void setAllowPartialValues(bool val)
Methods to set and retrieve the allowPartialValues Option.
Definition: CopyAssignmentOptions.h:148
smtk::attribute::AttributeCopyOptions
Class used to control how an attribute is to be copied.
Definition: CopyAssignmentOptions.h:28
smtk::attribute::ItemAssignmentOptions::allowPartialValues
bool allowPartialValues() const
Methods to set and retrieve the allowPartialValues Option.
Definition: CopyAssignmentOptions.h:147
smtk::attribute::ItemAssignmentOptions::doNotValidateReferenceInfo
bool doNotValidateReferenceInfo() const
Methods to set and retrieve the doNotValidateReferenceInfo Hint Option.
Definition: CopyAssignmentOptions.h:175