SMTK  @SMTK_VERSION@
Simulation Modeling Tool Kit
Classes | Typedefs | Enumerations | Functions
smtk::attribute Namespace Reference

Define attributes describing simulation inputs. More...

Classes

class  Analyses
 Represents a set of Analyses defined within an Attribute Resource. More...
 
class  Associate
 Associate a resource to an attribute resource. More...
 
class  AssociationRule
 A subclass used to differentiate between rule types during registration. More...
 
class  AssociationRuleFactory
 A factory for generating association rules. More...
 
class  AssociationRuleManager
 A Manager for registering/unregistering Association and Dissocation rule types. More...
 
class  AssociationRules
 A class for holding the state and encapsulating the logic behind custom association rules for an attribute resource. More...
 
class  Attribute
 Represent a (possibly composite) value according to a definition. More...
 
class  Categories
 Represents the category constraints associated with an Attribute, Attribute Definition, Item or Item Definition. More...
 
class  ComponentItem
 Hold resource components as an attribute value. More...
 
class  ComponentItemDefinition
 A definition for attribute items that store component UUIDs as values. More...
 
class  CustomItem
 Custom items inherit from a specialization of this template class, using the corresponding custom item type as the template parameter. More...
 
class  CustomItemBase
 A base class for custom (i.e. More...
 
class  CustomItemBaseDefinition
 A base class for custom (i.e. More...
 
class  CustomItemDefinition
 Custom item definitions inherit from from a specialization of this template class, using the corresponding custom item type as the template parameter. More...
 
class  DateTimeItem
 
class  DateTimeItemDefinition
 
class  Definition
 
class  DirectoryItem
 
class  DirectoryItemDefinition
 
class  Dissociate
 Dissociate a resource from an attribute resource. More...
 
class  DissociationRule
 A subclass used to differentiate between rule types during registration. More...
 
class  DoubleItem
 
class  DoubleItemDefinition
 
class  Evaluator
 
class  EvaluatorFactory
 
class  EvaluatorManager
 
class  Export
 Export an attribute resource. More...
 
class  FileInfo
 
class  FileItem
 
class  FileItemDefinition
 
class  FileSystemItem
 
class  FileSystemItemDefinition
 
class  GroupItem
 A group item represents an array of structures in SMTK. More...
 
class  GroupItemDefinition
 A GroupItemDefinition represents a collection of Item Definitions. More...
 
class  Import
 Import an attribute resource. More...
 
class  InfixExpressionEvaluator
 
class  IntItem
 
class  IntItemDefinition
 
class  Item
 
class  ItemDefinition
 
class  ItemDefinitionManager
 A manager for custom (i.e. More...
 
class  ModelEntityItem
 
class  ModelEntityItemDefinition
 
class  PythonRule
 A custom rule type that evaluates a Python function to determine the validity of association or dissociation. More...
 
class  qtColorButton
 
class  qtNewAttributeWidget
 
class  Read
 Read an attribute resource. More...
 
class  ReferenceItem
 Hold associations that link resources or components as an attribute value. More...
 
class  ReferenceItemDefinition
 A definition for attribute items that store smtk::resource::PersistentObjectPtr as values. More...
 
class  Registrar
 
class  Resource
 Store information about attribute definitions and instances. More...
 
class  ResourceItem
 Hold resources as an attribute value. More...
 
class  ResourceItemDefinition
 A definition for attribute items that store Resources as values. More...
 
class  Rule
 A base class for custom (i.e. More...
 
struct  SelectionFootprint
 An API for determining which components to render to display a selection. More...
 
class  Signal
 A "dummy" operation used to mark an attribute as created, modified, or expunged. More...
 
class  StringItem
 
class  StringItemDefinition
 
struct  SymbolDependencyStorage
 
class  Tag
 
class  UnsetValueError
 An exception for dereferencing an iterator to an unset Item value. More...
 
class  ValueItem
 
class  ValueItemDefinition
 
class  ValueItemDefinitionTemplate
 
class  ValueItemTemplate
 
class  VoidItem
 
class  VoidItemDefinition
 
class  Write
 Write an attribute resource. More...
 

Typedefs

typedef smtk::shared_ptr< smtk::attribute::DefinitionDefinitionPtr
 
typedef smtk::shared_ptr< const smtk::attribute::DefinitionConstDefinitionPtr
 
typedef smtk::weak_ptr< smtk::attribute::DefinitionWeakDefinitionPtr
 
typedef smtk::shared_ptr< smtk::attribute::AttributeAttributePtr
 
typedef smtk::shared_ptr< const smtk::attribute::AttributeConstAttributePtr
 
typedef smtk::weak_ptr< smtk::attribute::AttributeWeakAttributePtr
 
typedef smtk::weak_ptr< const smtk::attribute::AttributeConstWeakAttributePtr
 
typedef std::vector< smtk::attribute::AttributePtrAttributes
 
typedef smtk::shared_ptr< smtk::attribute::ItemItemPtr
 
typedef smtk::shared_ptr< const smtk::attribute::ItemConstItemPtr
 
typedef smtk::weak_ptr< smtk::attribute::ItemWeakItemPtr
 
typedef smtk::shared_ptr< smtk::attribute::ItemDefinitionItemDefinitionPtr
 
typedef smtk::shared_ptr< const smtk::attribute::ItemDefinitionConstItemDefinitionPtr
 
typedef smtk::weak_ptr< smtk::attribute::ItemDefinitionWeakItemDefinitionPtr
 
typedef smtk::shared_ptr< smtk::attribute::ValueItemValueItemPtr
 
typedef smtk::shared_ptr< const smtk::attribute::ValueItemConstValueItemPtr
 
typedef smtk::shared_ptr< smtk::attribute::ValueItemDefinitionValueItemDefinitionPtr
 
typedef smtk::shared_ptr< smtk::attribute::DateTimeItemDateTimeItemPtr
 
typedef smtk::shared_ptr< smtk::attribute::DateTimeItemDefinitionDateTimeItemDefinitionPtr
 
typedef smtk::shared_ptr< smtk::attribute::DirectoryItemDirectoryItemPtr
 
typedef smtk::shared_ptr< smtk::attribute::DirectoryItemDefinitionDirectoryItemDefinitionPtr
 
typedef smtk::shared_ptr< smtk::attribute::DoubleItemDoubleItemPtr
 
typedef smtk::shared_ptr< smtk::attribute::DoubleItemDefinitionDoubleItemDefinitionPtr
 
typedef smtk::shared_ptr< smtk::attribute::FileItemFileItemPtr
 
typedef smtk::shared_ptr< smtk::attribute::FileItemDefinitionFileItemDefinitionPtr
 
typedef smtk::shared_ptr< smtk::attribute::FileSystemItemFileSystemItemPtr
 
typedef smtk::shared_ptr< smtk::attribute::FileSystemItemDefinitionFileSystemItemDefinitionPtr
 
typedef smtk::shared_ptr< smtk::attribute::GroupItemGroupItemPtr
 
typedef smtk::weak_ptr< smtk::attribute::GroupItemWeakGroupItemPtr
 
typedef smtk::shared_ptr< smtk::attribute::GroupItemDefinitionGroupItemDefinitionPtr
 
typedef smtk::shared_ptr< smtk::attribute::IntItemIntItemPtr
 
typedef smtk::shared_ptr< smtk::attribute::IntItemDefinitionIntItemDefinitionPtr
 
typedef smtk::shared_ptr< smtk::attribute::StringItemStringItemPtr
 
typedef smtk::shared_ptr< smtk::attribute::StringItemDefinitionStringItemDefinitionPtr
 
typedef smtk::shared_ptr< smtk::attribute::ModelEntityItemModelEntityItemPtr
 
typedef smtk::shared_ptr< const smtk::attribute::ModelEntityItemDefinitionConstModelEntityItemDefinitionPtr
 
typedef smtk::shared_ptr< smtk::attribute::ModelEntityItemDefinitionModelEntityItemDefinitionPtr
 
typedef smtk::shared_ptr< smtk::attribute::VoidItemVoidItemPtr
 
typedef smtk::shared_ptr< smtk::attribute::VoidItemDefinitionVoidItemDefinitionPtr
 
typedef smtk::shared_ptr< smtk::attribute::ReferenceItemReferenceItemPtr
 
typedef smtk::shared_ptr< smtk::attribute::ReferenceItemDefinitionReferenceItemDefinitionPtr
 
typedef smtk::shared_ptr< smtk::attribute::ResourceItemResourceItemPtr
 
typedef smtk::shared_ptr< smtk::attribute::ResourceItemDefinitionResourceItemDefinitionPtr
 
typedef smtk::shared_ptr< smtk::attribute::ComponentItemComponentItemPtr
 
typedef smtk::shared_ptr< smtk::attribute::ComponentItemDefinitionComponentItemDefinitionPtr
 
typedef smtk::shared_ptr< const smtk::attribute::DateTimeItemConstDateTimeItemPtr
 
typedef smtk::shared_ptr< const smtk::attribute::DateTimeItemDefinitionConstDateTimeItemDefinitionPtr
 
typedef smtk::shared_ptr< const smtk::attribute::DirectoryItemConstDirectoryItemPtr
 
typedef smtk::shared_ptr< const smtk::attribute::DirectoryItemDefinitionConstDirectoryItemDefinitionPtr
 
typedef smtk::shared_ptr< const smtk::attribute::DoubleItemConstDoubleItemPtr
 
typedef smtk::shared_ptr< const smtk::attribute::DoubleItemDefinitionConstDoubleItemDefinitionPtr
 
typedef smtk::shared_ptr< const smtk::attribute::FileItemConstFileItemPtr
 
typedef smtk::shared_ptr< const smtk::attribute::FileItemDefinitionConstFileItemDefinitionPtr
 
typedef smtk::shared_ptr< const smtk::attribute::FileSystemItemConstFileSystemItemPtr
 
typedef smtk::shared_ptr< const smtk::attribute::FileSystemItemDefinitionConstFileSystemItemDefinitionPtr
 
typedef smtk::shared_ptr< const smtk::attribute::GroupItemConstGroupItemPtr
 
typedef smtk::shared_ptr< const smtk::attribute::GroupItemDefinitionConstGroupItemDefinitionPtr
 
typedef smtk::shared_ptr< const smtk::attribute::IntItemConstIntItemPtr
 
typedef smtk::shared_ptr< const smtk::attribute::IntItemDefinitionConstIntItemDefinitionPtr
 
typedef smtk::shared_ptr< const smtk::attribute::StringItemConstStringItemPtr
 
typedef smtk::shared_ptr< const smtk::attribute::StringItemDefinitionConstStringItemDefinitionPtr
 
typedef smtk::shared_ptr< const smtk::attribute::ModelEntityItemConstModelEntityItemPtr
 
typedef smtk::shared_ptr< const smtk::attribute::ReferenceItemConstReferenceItemPtr
 
typedef smtk::shared_ptr< const smtk::attribute::ReferenceItemDefinitionConstReferenceItemDefinitionPtr
 
typedef smtk::shared_ptr< const smtk::attribute::ResourceItemConstResourceItemPtr
 
typedef smtk::shared_ptr< const smtk::attribute::ResourceItemDefinitionConstResourceItemDefinitionPtr
 
typedef smtk::shared_ptr< const smtk::attribute::ComponentItemConstComponentItemPtr
 
typedef smtk::shared_ptr< const smtk::attribute::ComponentItemDefinitionConstComponentItemDefinitionPtr
 
typedef smtk::shared_ptr< const smtk::attribute::VoidItemConstVoidItemPtr
 
typedef smtk::shared_ptr< const smtk::attribute::VoidItemDefinitionConstVoidItemDefinitionPtr
 
typedef smtk::shared_ptr< smtk::attribute::ResourceResourcePtr
 
typedef smtk::shared_ptr< const smtk::attribute::ResourceConstResourcePtr
 
typedef smtk::weak_ptr< smtk::attribute::ResourceWeakResourcePtr
 
typedef std::set< attribute::WeakAttributePtr, smtk::owner_less< attribute::WeakAttributePtr > > WeakAttributePtrSet
 
typedef std::set< attribute::WeakDefinitionPtr, smtk::owner_less< attribute::WeakDefinitionPtr > > WeakDefinitionPtrSet
 
typedef std::set< attribute::WeakItemDefinitionPtr, smtk::owner_less< attribute::WeakItemDefinitionPtr > > WeakItemDefinitionPtrSet
 
typedef std::set< attribute::WeakItemPtr, smtk::owner_less< attribute::WeakItemPtr > > WeakItemPtrSet
 
typedef AssociationRuleFactory DissociationRuleFactory
 
typedef std::vector< FileInfoDirectoryInfo
 
typedef smtk::common::Factory< ItemDefinition, std::string > CustomItemDefinitionFactory
 
typedef std::set< TagTags
 

Enumerations

enum  SearchStyle {
  IMMEDIATE = 0, NO_CHILDREN = 0, RECURSIVE = 1, ALL_CHILDREN,
  IMMEDIATE_ACTIVE = 2, RECURSIVE_ACTIVE = 3, ACTIVE_CHILDREN = 3
}
 How should searches for items be conducted? More...
 

Functions

ReferenceItem::const_iterator::difference_type operator- (const ReferenceItem::const_iterator &a, const ReferenceItem::const_iterator &b)
 
bool operator< (const ReferenceItem::const_iterator &it1, const ReferenceItem::const_iterator &it2)
 
bool operator> (const ReferenceItem::const_iterator &it1, const ReferenceItem::const_iterator &it2)
 
bool operator<= (const ReferenceItem::const_iterator &it1, const ReferenceItem::const_iterator &it2)
 
bool operator>= (const ReferenceItem::const_iterator &it1, const ReferenceItem::const_iterator &it2)
 
bool operator== (const ReferenceItem::const_iterator &it1, const ReferenceItem::const_iterator &it2)
 
bool operator!= (const ReferenceItem::const_iterator &it1, const ReferenceItem::const_iterator &it2)
 
template<>
bool ReferenceItem::iteratorIsSet< ReferenceItem::const_iterator > (const ReferenceItem::const_iterator &iterator) const
 
smtk::resource::ResourcePtr read (const std::string &filename, const std::shared_ptr< smtk::common::Managers > &managers)
 
bool write (const smtk::resource::ResourcePtr &resource, const std::shared_ptr< smtk::common::Managers > &managers)
 

Detailed Description

Define attributes describing simulation inputs.

Typedef Documentation

◆ AttributePtr

◆ Attributes

◆ ComponentItemDefinitionPtr

◆ ComponentItemPtr

◆ ConstAttributePtr

◆ ConstComponentItemDefinitionPtr

◆ ConstComponentItemPtr

◆ ConstDateTimeItemDefinitionPtr

◆ ConstDateTimeItemPtr

◆ ConstDefinitionPtr

◆ ConstDirectoryItemDefinitionPtr

◆ ConstDirectoryItemPtr

◆ ConstDoubleItemDefinitionPtr

◆ ConstDoubleItemPtr

◆ ConstFileItemDefinitionPtr

◆ ConstFileItemPtr

◆ ConstFileSystemItemDefinitionPtr

◆ ConstFileSystemItemPtr

◆ ConstGroupItemDefinitionPtr

◆ ConstGroupItemPtr

◆ ConstIntItemDefinitionPtr

◆ ConstIntItemPtr

◆ ConstItemDefinitionPtr

◆ ConstItemPtr

typedef smtk::shared_ptr<const smtk::attribute::Item> smtk::attribute::ConstItemPtr

◆ ConstModelEntityItemDefinitionPtr

◆ ConstModelEntityItemPtr

◆ ConstReferenceItemDefinitionPtr

◆ ConstReferenceItemPtr

◆ ConstResourceItemDefinitionPtr

◆ ConstResourceItemPtr

◆ ConstResourcePtr

◆ ConstStringItemDefinitionPtr

◆ ConstStringItemPtr

◆ ConstValueItemPtr

◆ ConstVoidItemDefinitionPtr

◆ ConstVoidItemPtr

◆ ConstWeakAttributePtr

◆ DateTimeItemDefinitionPtr

◆ DateTimeItemPtr

◆ DefinitionPtr

◆ DirectoryItemDefinitionPtr

◆ DirectoryItemPtr

◆ DoubleItemDefinitionPtr

◆ DoubleItemPtr

◆ FileItemDefinitionPtr

◆ FileItemPtr

◆ FileSystemItemDefinitionPtr

◆ FileSystemItemPtr

◆ GroupItemDefinitionPtr

◆ GroupItemPtr

◆ IntItemDefinitionPtr

◆ IntItemPtr

◆ ItemDefinitionPtr

◆ ItemPtr

◆ ModelEntityItemDefinitionPtr

◆ ModelEntityItemPtr

◆ ReferenceItemDefinitionPtr

◆ ReferenceItemPtr

◆ ResourceItemDefinitionPtr

◆ ResourceItemPtr

◆ ResourcePtr

◆ StringItemDefinitionPtr

◆ StringItemPtr

◆ ValueItemDefinitionPtr

◆ ValueItemPtr

◆ VoidItemDefinitionPtr

◆ VoidItemPtr

◆ WeakAttributePtr

◆ WeakAttributePtrSet

◆ WeakDefinitionPtr

◆ WeakDefinitionPtrSet

◆ WeakItemDefinitionPtr

◆ WeakItemDefinitionPtrSet

◆ WeakItemPtr

◆ WeakItemPtrSet

◆ WeakResourcePtr

Enumeration Type Documentation

◆ SearchStyle

How should searches for items be conducted?

Used by find methods in Attribute and Item derived classes

Enumerator
IMMEDIATE 

Search only the top level items of an item or attribute.

NO_CHILDREN 

Search only the top level items of an item or attribute (Deprecated!)

RECURSIVE 

Recursively search for the item regardless if it is active or not.

ALL_CHILDREN 

Recursively search for the item regardless if it is active or not (Deprecated!)

IMMEDIATE_ACTIVE 

Search only the top level active items of an item or attribute.

RECURSIVE_ACTIVE 

Recursively search for an active item.

ACTIVE_CHILDREN 

Recursively search for an active item (Depricated!)