SMTK
@SMTK_VERSION@
Simulation Modeling Tool Kit
|
Classes | |
struct | CopyInfo |
Public Member Functions | |
smtkTypeMacroBase (smtk::attribute::ItemDefinition) | |
const std::string & | name () const |
virtual Item::Type | type () const =0 |
const std::string & | label () const |
void | setLabel (const std::string &newLabel) |
int | version () const |
void | setVersion (int myVersion) |
bool | isOptional () const |
void | setIsOptional (bool isOptionalValue) |
bool | isEnabledByDefault () const |
void | setIsEnabledByDefault (bool isEnabledByDefaultValue) |
const smtk::common::Categories & | categories () const |
Returns the categories (both explicitly assigned and inherited) associated to the Item Definition. More... | |
smtk::common::Categories::Expression & | localCategories () |
Returns the categories::Expression explicitly assigned to the Items Definition. | |
const smtk::common::Categories::Expression & | localCategories () const |
void | setLocalCategories (const smtk::common::Categories::Expression &catExp) |
Sets the local categories. More... | |
unsigned int | advanceLevel (int mode=0) const |
unsigned int | localAdvanceLevel (int mode=0) const |
void | setLocalAdvanceLevel (int mode, unsigned int level) |
void | setLocalAdvanceLevel (unsigned int level) |
void | unsetLocalAdvanceLevel (int mode=0) |
bool | hasLocalAdvanceLevelInfo (int mode=0) const |
const std::string & | detailedDescription () const |
void | setDetailedDescription (const std::string &text) |
const std::string & | briefDescription () const |
void | setBriefDescription (const std::string &text) |
const Tags & | tags () const |
return the smtk::attribute::Tags associated with the Definition | |
const shared_ptr< units::System > & | unitsSystem () const |
Return the unitsSystem of the Definition. | |
virtual smtk::attribute::ItemPtr | buildItem (Attribute *owningAttribute, int itemPosition) const =0 |
virtual smtk::attribute::ItemPtr | buildItem (Item *owningItem, int position, int subGroupPosition) const =0 |
virtual smtk::attribute::ItemDefinitionPtr | createCopy (smtk::attribute::ItemDefinition::CopyInfo &info) const =0 |
smtk::common::Categories::CombinationMode | categoryInheritanceMode () const |
Determines how the Definition should combine its local category Set with the category constraints being inherited from it's owning Attribute or Item Definition. | |
void | setCategoryInheritanceMode (smtk::common::Categories::CombinationMode mode) |
Determines how the Definition should combine its local category Set with the category constraints being inherited from it's owning Attribute or Item Definition. | |
const Tag * | tag (const std::string &name) const |
Return a pointer to a smtk::attribute::Tag with a given name. If the Tag does not exist, return a null pointer. | |
Tag * | tag (const std::string &name) |
Return a pointer to a smtk::attribute::Tag with a given name. If the Tag does not exist, return a null pointer. | |
bool | addTag (const Tag &tag) |
Add/Remove a smtk::attribute::Tag from a Definition. | |
bool | removeTag (const std::string &name) |
Add/Remove a smtk::attribute::Tag from a Definition. | |
Protected Member Functions | |
ItemDefinition (const std::string &myname) | |
void | copyTo (ItemDefinitionPtr def) const |
virtual void | applyCategories (const smtk::common::Categories::Stack &inheritedFromParent, smtk::common::Categories &inheritedToParent) |
virtual void | applyAdvanceLevels (const unsigned int &readLevelFromParent, const unsigned int &writeLevelFromParent) |
virtual void | setUnitsSystem (const shared_ptr< units::System > &unitsSystem) |
Set the unitsSystem of the Definition. More... | |
Protected Attributes | |
int | m_version |
bool | m_isOptional |
bool | m_isEnabledByDefault |
std::string | m_label |
common::Categories::Expression | m_localCategories |
common::Categories | m_categories |
std::string | m_detailedDescription |
std::string | m_briefDescription |
bool | m_hasLocalAdvanceLevelInfo [2] |
unsigned int | m_localAdvanceLevel [2] |
unsigned int | m_advanceLevel [2] |
attribute::Tags | m_tags |
smtk::common::Categories::CombinationMode | m_combinationMode |
std::shared_ptr< units::System > | m_unitsSystem |
Friends | |
class | Definition |
class | GroupItemDefinition |
class | ReferenceItemDefinition |
class | ValueItemDefinition |
|
inline |
Returns the categories (both explicitly assigned and inherited) associated to the Item Definition.
The categories that the attribute applies to. Typically a category will be a simulation type like heat transfer, fluid flow, etc.
|
inline |
Sets the local categories.
This method is intended for use by Python applications, because Python code cannot manipulate the reference returned by the localCategories() method.
|
protectedvirtual |
Set the unitsSystem of the Definition.
Note that this should be done before units are specified in the Definition
Reimplemented in smtk::attribute::ValueItemDefinition, smtk::attribute::ReferenceItemDefinition, and smtk::attribute::GroupItemDefinition.