Inheritance diagram for smtk::attribute::DoubleItem:
Collaboration diagram for smtk::attribute::DoubleItem:
Public Member Functions | |
| smtkTypeMacro (smtk::attribute::DoubleItem) | |
| Item::Type | type () const override |
| Item::Status | assign (const smtk::attribute::ConstItemPtr &sourceItem, const CopyAssignmentOptions &options, smtk::io::Logger &logger) override |
| bool | setValue (std::size_t element, const double &val, const std::string &units) |
| Sets a value of the Item in the units specified. More... | |
| bool | setValueFromString (std::size_t element, const std::string &val) override |
| Sets a value from a string. More... | |
| bool | appendValue (const double &val) override |
| bool | removeValue (std::size_t element) override |
| bool | setNumberOfValues (std::size_t newSize) override |
| bool | rotate (std::size_t fromPosition, std::size_t toPosition) override |
| Rotate internal data. More... | |
| bool | setToDefault (std::size_t element=0) override |
| std::string | valueAsString (std::size_t element) const override |
| Return the value as a string. More... | |
| virtual Status | assign (const smtk::attribute::ConstItemPtr &sourceItem, const CopyAssignmentOptions &options=CopyAssignmentOptions()) |
| virtual Status | assign (const smtk::attribute::ConstItemPtr &sourceItem, const CopyAssignmentOptions &options, smtk::io::Logger &logger) |
| virtual bool | setValueFromString (const std::string &stringVal) |
| virtual bool | setValueFromString (std::size_t elementIndex, const std::string &stringVal)=0 |
| virtual std::string | valueAsString () const |
| virtual std::string | valueAsString (std::size_t elementIndex) const=0 |
| bool | setValue (std::size_t element, const double &val) override |
| Sets a value of the Item in the units defined in its definition. If the definition has no units set then the value is assumed to be unit-less. | |
 Public Member Functions inherited from smtk::attribute::ValueItemTemplate< double > | |
| std::vector< double >::const_iterator | begin () const |
| std::vector< double >::const_iterator | end () const |
| bool | setNumberOfValues (std::size_t newSize) override |
| std::string | valueAsString (std::size_t element) const override |
| virtual std::string | valueAsString () const |
| virtual std::string | valueAsString (std::size_t elementIndex) const =0 |
| virtual bool | setValue (const double &val) |
| bool | setValueFromString (std::size_t element, const std::string &val) override |
| virtual bool | setValueFromString (const std::string &stringVal) |
| virtual bool | setValueFromString (std::size_t elementIndex, const std::string &stringVal)=0 |
| bool | setValues (I vbegin, I vend) |
| void | reset () override |
| bool | rotate (std::size_t fromPosition, std::size_t toPosition) override |
| Rotate the order between specified positions. | |
| bool | setToDefault (std::size_t element=0) override |
| bool | isUsingDefault (std::size_t element) const override |
| bool | isUsingDefault () const override |
| double | defaultValue () const |
| const std::vector< double > & | defaultValues () const |
| Item::Status | assign (const smtk::attribute::ConstItemPtr &sourceItem, const CopyAssignmentOptions &options, smtk::io::Logger &logger) override |
| virtual Status | assign (const smtk::attribute::ConstItemPtr &sourceItem, const CopyAssignmentOptions &options=CopyAssignmentOptions()) |
| virtual Status | assign (const smtk::attribute::ConstItemPtr &sourceItem, const CopyAssignmentOptions &options, smtk::io::Logger &logger) |
| shared_ptr< const DefType > | concreteDefinition () const |
| double | value (std::size_t element=0) const |
| Returns a value of the item in the units specified in the units of its definition. | |
| double | value (smtk::io::Logger &log) const |
| Returns a value of the item in the units specified in the units of its definition. | |
| double | value (std::size_t element, smtk::io::Logger &log) const |
| Returns a value of the item in the units specified in the units of its definition. | |
| Public Member Functions inherited from smtk::attribute::ValueItem | |
| smtkTypeMacro (smtk::attribute::ValueItem) | |
| virtual std::size_t | numberOfValues () const |
| std::size_t | numberOfRequiredValues () const |
| std::size_t | maxNumberOfValues () const |
| std::string | valueLabel (std::size_t element) const |
| bool | isExtensible () const |
| bool | allowsExpressions () const |
| bool | isExpression () const |
| smtk::attribute::AttributePtr | expression () const |
| bool | setExpression (smtk::attribute::AttributePtr exp) |
| void | visitChildren (std::function< void(smtk::attribute::ItemPtr, bool)> visitor, bool activeChildren=true) override |
| visitChildren Invoke a function on each (or, if findInActiveChildren is true, each active) child item. More... | |
| int | discreteIndex (std::size_t elementIndex=0) const |
| bool | isDiscrete () const |
| bool | isDiscreteIndexValid (int value) const |
| bool | setDiscreteIndex (int value) |
| bool | setDiscreteIndex (std::size_t elementIndex, int value) |
| std::vector< std::string > | relevantEnums (bool includeCategories, bool includeReadAccess, unsigned int readAccessLevel) const |
| Return the enum strings that pass the Resource's active categories and/or specified advance read access level. | |
| void | detachOwningResource () override |
| Release the item's dependency on its parent attribute's Resource. | |
| virtual bool | isUsingDefault () const =0 |
| bool | hasDefault () const |
| virtual std::string | valueAsString () const |
| virtual bool | setValueFromString (const std::string &stringVal) |
| virtual bool | isSet (std::size_t elementIndex=0) const |
| virtual void | unset (std::size_t elementIndex=0) |
| smtk::attribute::ComponentItemPtr | expressionReference () const |
| std::size_t | numberOfChildrenItems () const |
| const std::map< std::string, smtk::attribute::ItemPtr > & | childrenItems () const |
| std::size_t | numberOfActiveChildrenItems () const |
| smtk::attribute::ItemPtr | activeChildItem (int i) const |
| virtual Status | assign (const smtk::attribute::ConstItemPtr &sourceItem, const CopyAssignmentOptions &options=CopyAssignmentOptions()) |
| virtual Status | assign (const smtk::attribute::ConstItemPtr &sourceItem, const CopyAssignmentOptions &options, smtk::io::Logger &logger) |
| ItemPtr | findChild (const std::string &name, smtk::attribute::SearchStyle) |
| Search the item's children - Deprecated! Please use Item::find. More... | |
| ConstItemPtr | findChild (const std::string &name, smtk::attribute::SearchStyle) const |
| Search the item's children - Deprecated! Please use Item::find. More... | |
| Public Member Functions inherited from smtk::attribute::Item | |
| smtkTypeMacroBase (smtk::attribute::Item) | |
| std::string | name () const |
| std::string | label () const |
| virtual bool | isRelevant (bool includeCatagories=true, bool includeReadAccess=false, unsigned int readAccessLevel=0) const |
| Returns true if the item is relevant. More... | |
| const smtk::attribute::ConstItemDefinitionPtr & | definition () const |
| template<typename DefType > | |
| std::shared_ptr< const DefType > | definitionAs () const |
| smtk::attribute::AttributePtr | attribute () const |
| Return the attribute that owns this item. | |
| smtk::attribute::ItemPtr | owningItem () const |
| int | position () const |
| Position is the item's location w/r to the owning item if not null or the owning attribute. More... | |
| int | subGroupPosition () const |
| bool | isOptional () const |
| Returns true if the item is optional. | |
| bool | isEnabled () const |
| An item is enabled under the following conditions: More... | |
| bool | localEnabledState () const |
| Return the state of the instance's isEnabled state. | |
| void | setIsEnabled (bool isEnabledValue) |
| Set the instance's local enabled state. | |
| const smtk::attribute::Categories & | categories () const |
| return the categories associated with the item (via its Definition) | |
| unsigned int | advanceLevel (int mode=0) const |
| Get the item 's advance level. More... | |
| void | setLocalAdvanceLevel (int mode, unsigned int level) |
| unsigned int | localAdvanceLevel (int mode=0) const |
| void | unsetLocalAdvanceLevel (int mode=0) |
| bool | hasLocalAdvanceLevelInfo (int mode=0) const |
| void | setUserData (const std::string &key, smtk::simulation::UserDataPtr value) |
| smtk::simulation::UserDataPtr | userData (const std::string &key) const |
| void | clearUserData (const std::string &key) |
| void | clearAllUserData () |
| void | detachOwningAttribute () |
| This should be used only by attributes. | |
| void | detachOwningItem () |
| This should only be called by the item that owns this one. | |
| bool | isValid (bool useActiveCategories=true) const |
| tests the validity of an item More... | |
| bool | isValid (const std::set< std::string > &categories) const |
| tests the validity of an item More... | |
| smtk::attribute::ItemPtr | find (const std::string &name, SearchStyle style=RECURSIVE_ACTIVE) |
| return a child item that matches name and satisfies the SearchStyle | |
| smtk::attribute::ConstItemPtr | find (const std::string &name, SearchStyle style=RECURSIVE_ACTIVE) const |
| return a child item that matches name and satisfies the SearchStyle | |
| template<typename T > | |
| T::Ptr | findAs (const std::string &name, SearchStyle style=RECURSIVE_ACTIVE) |
| return a child item that matches name and satisfies the SearchStyle | |
| template<typename T > | |
| T::ConstPtr | findAs (const std::string &name, SearchStyle style=RECURSIVE_ACTIVE) const |
| return a child item that matches name and satisfies the SearchStyle | |
| void | setForceRequired (bool val) |
| Controls if an item should be forced to be required regardless of its local enable property. More... | |
| bool | forceRequired () const |
| Controls if an item should be forced to be required regardless of its local enable property. More... | |
| virtual Status | assign (const smtk::attribute::ConstItemPtr &sourceItem, const CopyAssignmentOptions &options=CopyAssignmentOptions()) |
| void | setIsIgnored (bool val) |
| Controls if an item should be ignored. More... | |
| bool | isIgnored () const |
| Controls if an item should be ignored. More... | |
Protected Member Functions | |
| DoubleItem (Attribute *owningAttribute, int itemPosition) | |
| DoubleItem (Item *owningItem, int myPosition, int mySubGroupPosition) | |
| bool | initializeValues () override |
| void | updateDiscreteValue (std::size_t element) override |
| Protected Member Functions inherited from smtk::attribute::ValueItemTemplate< double > | |
| ValueItemTemplate (Attribute *owningAttribute, int itemPosition) | |
| ValueItemTemplate (Item *owningItem, int myPosition, int mySubGroupPosition) | |
| void | updateDiscreteValue (std::size_t element) override |
| bool | initializeValues () override |
| std::string | streamValue (const double &val) const |
| Protected Member Functions inherited from smtk::attribute::ValueItem | |
| ValueItem (Attribute *owningAttribute, int itemPosition) | |
| ValueItem (Item *owningItem, int myPosition, int mySubGroupPosition) | |
| bool | setDefinition (smtk::attribute::ConstItemDefinitionPtr def) override |
| smtk::attribute::ItemPtr | findInternal (const std::string &name, SearchStyle style) override |
| Internal implementation of the find method. | |
| smtk::attribute::ConstItemPtr | findInternal (const std::string &name, SearchStyle style) const override |
| virtual void | updateActiveChildrenItems () |
| bool | isValidInternal (bool useCategories, const std::set< std::string > &categories) const override |
| Internal implementation of calculating the validity of the item. More... | |
| Protected Member Functions inherited from smtk::attribute::Item | |
| Item (Attribute *owningAttribute, int itemPosition) | |
| Item (Item *owningItem, int myPosition, int mySubGroupPOsition) | |
| template<typename T > | |
| bool | rotateVector (std::vector< T > &v, std::size_t fromPosition, std::size_t toPosition) |
Protected Attributes | |
| std::vector< std::string > | m_valuesAsString |
| Protected Attributes inherited from smtk::attribute::ValueItemTemplate< double > | |
| std::vector< double > | m_values |
| const std::vector< double > | m_dummy |
| Protected Attributes inherited from smtk::attribute::ValueItem | |
| std::vector< int > | m_discreteIndices |
| std::vector< bool > | m_isSet |
| smtk::attribute::ComponentItemPtr | m_expression |
| std::map< std::string, smtk::attribute::ItemPtr > | m_childrenItems |
| std::vector< smtk::attribute::ItemPtr > | m_activeChildrenItems |
| Protected Attributes inherited from smtk::attribute::Item | |
| Attribute * | m_attribute |
| Item * | m_owningItem |
| int | m_position |
| int | m_subGroupPosition |
| bool | m_isEnabled |
| bool | m_isIgnored |
| smtk::attribute::ConstItemDefinitionPtr | m_definition |
| std::map< std::string, smtk::simulation::UserDataPtr > | m_userData |
Friends | |
| class | DoubleItemDefinition |
Additional Inherited Members | |
| Public Types inherited from smtk::attribute::ValueItemTemplate< double > | |
| typedef double | DataType |
| typedef std::vector< double > | value_type |
| typedef value_type | const_iterator |
| typedef ValueItemDefinitionTemplate< DataType > | DefType |
| Public Types inherited from smtk::attribute::Item | |
| enum | Type { AttributeRefType, DoubleType, GroupType, IntType, StringType, VoidType, FileType, DirectoryType, ColorType, ModelEntityType, MeshEntityType, DateTimeType, ReferenceType, ResourceType, ComponentType, NUMBER_OF_TYPES } |
| using | Status = smtk::common::Status |
| Static Public Member Functions inherited from smtk::attribute::Item | |
| static std::string | type2String (Item::Type t) |
| static Item::Type | string2Type (const std::string &s) |
Member Function Documentation
◆ assign() [1/2]
|
overridevirtual |
Assigns this item to be equivalent to another. Options are processed by derived item classes. The options are defined in Item.h.
This method returns a Status object that indicates both success/failure and modification/stasis. If cast to a boolean, the Status object returns true for success and false for failure.
Reimplemented from smtk::attribute::Item.
◆ assign() [2/2]
| Item::Status Item::assign |
Assigns this item to be equivalent to another. Options are processed by derived item classes. The options are defined in Item.h.
This method returns a Status object that indicates both success/failure and modification/stasis. If cast to a boolean, the Status object returns true for success and false for failure.
◆ rotate()
|
overridevirtual |
Rotate internal data.
Implementation to be added in sub-classes. Default behavior here is no-op (returns false).
Reimplemented from smtk::attribute::Item.
◆ setValue()
| bool DoubleItem::setValue | ( | std::size_t | element, |
| const double & | val, | ||
| const std::string & | units | ||
| ) |
Sets a value of the Item in the units specified.
If the units differ from its definition and can not be converted (or if the converted value is not valid) then value will not be changed and the method will fail
◆ setValueFromString()
|
overridevirtual |
Sets a value from a string.
Note that the string can consist of a value followed by an option units string.
Implements smtk::attribute::ValueItem.
◆ valueAsString()
|
overridevirtual |
Return the value as a string.
Note that the string will be based on the value set via setValue or setValueFromString and not the converted value.
Implements smtk::attribute::ValueItem.
The documentation for this class was generated from the following files:
- /home/docs/checkouts/readthedocs.org/user_builds/smtk/checkouts/latest/smtk/attribute/DoubleItem.h
- /home/docs/checkouts/readthedocs.org/user_builds/smtk/checkouts/latest/smtk/attribute/DoubleItem.cxx
