Inheritance diagram for smtk::attribute::StringItem:
Collaboration diagram for smtk::attribute::StringItem:
Public Member Functions | |
| smtkTypeMacro (smtk::attribute::StringItem) | |
| Item::Type | type () const override |
| bool | isSecure () const |
| bool | setValueFromString (std::size_t element, const std::string &val) override |
| 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) |
 Public Member Functions inherited from smtk::attribute::ValueItemTemplate< std::string > | |
| std::vector< std::string >::const_iterator | begin () const |
| std::vector< std::string >::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 std::string &val) |
| virtual bool | setValue (std::size_t element, const std::string &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) |
| virtual bool | appendValue (const std::string &val) |
| virtual bool | removeValue (std::size_t element) |
| 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 |
| std::string | defaultValue () const |
| const std::vector< std::string > & | 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 |
| std::string | value (std::size_t element=0) const |
| Returns a value of the item in the units specified in the units of its definition. | |
| std::string | value (smtk::io::Logger &log) const |
| Returns a value of the item in the units specified in the units of its definition. | |
| std::string | 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 | |
| StringItem (Attribute *owningAttribute, int itemPosition) | |
| StringItem (Item *owningItem, int myPosition, int mySubGroupPosition) | |
| Protected Member Functions inherited from smtk::attribute::ValueItemTemplate< std::string > | |
| 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 std::string &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) |
Friends | |
| class | StringItemDefinition |
Additional Inherited Members | |
| Public Types inherited from smtk::attribute::ValueItemTemplate< std::string > | |
| typedef std::string | DataType |
| typedef std::vector< std::string > | 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) |
| Protected Attributes inherited from smtk::attribute::ValueItemTemplate< std::string > | |
| std::vector< std::string > | m_values |
| const std::vector< std::string > | 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 |
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.
The documentation for this class was generated from the following files:
- /home/docs/checkouts/readthedocs.org/user_builds/smtk/checkouts/latest/smtk/attribute/StringItem.h
- /home/docs/checkouts/readthedocs.org/user_builds/smtk/checkouts/latest/smtk/attribute/StringItem.cxx
