SMTK
@SMTK_VERSION@
Simulation Modeling Tool Kit
|
Class used to control how an item's information is assigned to another item. More...
#include <CopyAssignmentOptions.h>
Public Member Functions | |
std::string | convertToString (const std::string &prefix="") const |
Converts the current option state into a string that is prefixed by prefix. | |
bool | ignoreMissingChildren () const |
Methods to set and retrieve the ignoreMissingChildren Option. More... | |
void | setIgnoreMissingChildren (bool val) |
Methods to set and retrieve the ignoreMissingChildren Option. More... | |
bool | allowPartialValues () const |
Methods to set and retrieve the allowPartialValues Option. More... | |
void | setAllowPartialValues (bool val) |
Methods to set and retrieve the allowPartialValues Option. More... | |
bool | ignoreExpressions () const |
Methods to set and retrieve the ignoreExpressions Option. More... | |
void | setIgnoreExpressions (bool val) |
Methods to set and retrieve the ignoreExpressions Option. More... | |
bool | ignoreReferenceValues () const |
Methods to set and retrieve the ignoreReferenceValues Option. More... | |
void | setIgnoreReferenceValues (bool val) |
Methods to set and retrieve the ignoreReferenceValues Option. More... | |
bool | doNotValidateReferenceInfo () const |
Methods to set and retrieve the doNotValidateReferenceInfo Hint Option. More... | |
void | setDoNotValidateReferenceInfo (bool val) |
Methods to set and retrieve the doNotValidateReferenceInfo Hint Option. More... | |
bool | disableCopyAttributes () const |
Methods to set and retrieve the disableCopyAttributes Option. More... | |
void | setDisableCopyAttributes (bool val) |
Methods to set and retrieve the disableCopyAttributes Option. More... | |
Class used to control how an item's information is assigned to another item.
This is primarily used by smtk::attribute::Item::assign but can be also indirectly by smtk::attribute::Attribute::assign and smtk::attribute::Resource::copyAttribute.
|
inline |
Methods to set and retrieve the allowPartialValues Option.
If set, this indicates that not all of the source item's values must be copied to the target item. If this option ** is not set ** then all of the source item's values must be copied, else the assignment process will return failure.
|
inline |
Methods to set and retrieve the disableCopyAttributes Option.
If set, this indicates that no attributes should be created when doing item assignments. An item assignment can cause an attribute to be created in two situations.
First - A source Value item is set to an expression attribute that resides in the same resource and the target item resides in a different one. In this case the default behavior is to also copy the expression attribute to the target item's resource and assign the copied attribute to the target item.
Second - A source Reference item refers to an attribute that resides in the same resource and the target item resides in a different one. In this case the default behavior is to also copy the referenced attribute to the target item's resource and assign the copied attribute to the target item.
|
inline |
Methods to set and retrieve the doNotValidateReferenceInfo Hint Option.
The doNotValidateReferenceInfo hint indicates that if it possible to assign a source Reference item's values to a target item without accessing the corresponding persistent object, then do so without validation.
|
inline |
Methods to set and retrieve the ignoreExpressions Option.
If set, this indicates that if a source Value item that have been assigned an expression attribute, it's corresponding target item should be left unset.
|
inline |
Methods to set and retrieve the ignoreMissingChildren Option.
If set, this indicates that not all of the source item's children items must exist in the target item. This can occur if the target item's definition is a variation of the source item's.
Note : the assignment process will fail if this option is not set and if not all of the source item's children items are not present in the target.
|
inline |
Methods to set and retrieve the ignoreReferenceValues Option.
If set, this indicates that a target Reference item should not be assigned the values of the corresponding source item.
|
inline |
Methods to set and retrieve the allowPartialValues Option.
If set, this indicates that not all of the source item's values must be copied to the target item. If this option ** is not set ** then all of the source item's values must be copied, else the assignment process will return failure.
|
inline |
Methods to set and retrieve the disableCopyAttributes Option.
If set, this indicates that no attributes should be created when doing item assignments. An item assignment can cause an attribute to be created in two situations.
First - A source Value item is set to an expression attribute that resides in the same resource and the target item resides in a different one. In this case the default behavior is to also copy the expression attribute to the target item's resource and assign the copied attribute to the target item.
Second - A source Reference item refers to an attribute that resides in the same resource and the target item resides in a different one. In this case the default behavior is to also copy the referenced attribute to the target item's resource and assign the copied attribute to the target item.
|
inline |
Methods to set and retrieve the doNotValidateReferenceInfo Hint Option.
The doNotValidateReferenceInfo hint indicates that if it possible to assign a source Reference item's values to a target item without accessing the corresponding persistent object, then do so without validation.
|
inline |
Methods to set and retrieve the ignoreExpressions Option.
If set, this indicates that if a source Value item that have been assigned an expression attribute, it's corresponding target item should be left unset.
|
inline |
Methods to set and retrieve the ignoreMissingChildren Option.
If set, this indicates that not all of the source item's children items must exist in the target item. This can occur if the target item's definition is a variation of the source item's.
Note : the assignment process will fail if this option is not set and if not all of the source item's children items are not present in the target.
|
inline |
Methods to set and retrieve the ignoreReferenceValues Option.
If set, this indicates that a target Reference item should not be assigned the values of the corresponding source item.