SMTK  @SMTK_VERSION@
Simulation Modeling Tool Kit
Classes | Public Member Functions | Protected Attributes | Static Protected Attributes | List of all members
smtk::operation::ResourceIOGroup Class Reference
Inheritance diagram for smtk::operation::ResourceIOGroup:
[legend]
Collaboration diagram for smtk::operation::ResourceIOGroup:
[legend]

Classes

class  FileItemName
 

Public Member Functions

 ResourceIOGroup (const std::string &name, std::shared_ptr< smtk::operation::Manager > manager)
 
virtual bool requiresFileItem () const
 
template<typename ResourceType >
bool registerOperation (const std::string &, const std::string &fileItemName=m_defaultFileItemName)
 Register an IO operation identified by it's unique name, the type of resource it handles and the file item name.
 
template<typename ResourceType >
bool registerOperation (const Operation::Index &, const std::string &fileItemName=m_defaultFileItemName)
 Register an IO operation identified by its type index, the type of resource it handles and the file item name.
 
template<typename ResourceType , typename OperationType >
bool registerOperation (const std::string &fileItemName=m_defaultFileItemName)
 Register an IO operation identified by its class type, the name of the resource it reads and the file item name.
 
std::string fileItemNameForOperation (const std::string &) const
 Obtain the file item name associated with an operation identified by its unique name.
 
std::string fileItemNameForOperation (const Operation::Index &) const
 Obtain the file item name associated with the operation identified by its type index.
 
smtk::attribute::FileItemDefinition::Ptr fileItemDefinitionForOperation (const std::string &) const
 Obtain the file item definition associated with an operation identified by its unique name.
 
smtk::attribute::FileItemDefinition::Ptr fileItemDefinitionForOperation (const Operation::Index &) const
 Obtain the file item definition associated with the operation identified by its type index.
 
std::set< Operation::Index > operationsForResource (const std::string &resourceName) const
 Given a resource name, return the set of operators that were associated with the resource during registration.
 
std::string resourceForOperation (const Operation::Index &) const
 Given an operation index, return the resource associated with the operation.
 
template<typename ResourceType >
std::set< Operation::Index > operationsForResource () const
 Given a resource type, return the set of operators that were associated with the resource during registration.
 
std::set< std::string > supportedResources () const
 
template<typename OperationType >
std::string fileItemNameForOperation () const
 Obtain the file item associated with the operation identified by its class type.
 
bool contains (const std::string &) const
 Check if an operation identified by it's unique name is in the group.
 
bool contains (const Operation::Index &) const
 Check if an operation identified by its type index is in the group.
 
template<typename OperationType >
bool contains () const
 Check if an operation identified by its class type is in the group.
 
std::set< std::string > operationNames () const
 Return a set of operation unique names that belong to this group.
 
std::set< Operation::Index > operations () const
 Return a set of operation indices that belong to this group.
 
bool unregisterOperation (const std::string &)
 Unregister an operation identified by its unique name.
 
bool unregisterOperation (const Operation::Index &)
 Unregister an operation identified by its type index.
 
template<typename OperationType >
bool unregisterOperation ()
 Unregister an operation identified by its class type.
 

Protected Attributes

FileItemName m_fileItemName
 
- Protected Attributes inherited from smtk::operation::Group
std::weak_ptr< smtk::operation::Managerm_manager
 

Static Protected Attributes

static const std::string m_defaultFileItemName = "filename"
 

Additional Inherited Members

- Protected Types inherited from smtk::operation::Group
typedef GroupObserver Observer
 
typedef GroupObservers Observers
 
- Protected Member Functions inherited from smtk::operation::Group
std::size_t operationObjectDistance (const Operation::Index &index, const smtk::resource::PersistentObject &obj) const
 Return a "degree of fit" measure indicating how well an operation matches an object. More...
 
smtk::attribute::ConstReferenceItemDefinitionPtr operationAssociationsRule (const Operation::Index &index) const
 A utility to fetch association rules for a given operation (used in operationObjectDistance).
 
 Group (const std::string &name, std::shared_ptr< smtk::operation::Manager > manager)
 
const std::string & name () const
 
bool registerOperation (const std::string &, std::set< std::string > values=std::set< std::string >())
 Register an operation identified by its unique name and give it values.
 
bool registerOperation (const Operation::Index &, std::set< std::string > values=std::set< std::string >())
 Register an operation identified by its type index and give it values.
 
template<typename OperationType >
bool registerOperation (std::set< std::string > values=std::set< std::string >())
 Register an operation identified by its class type and give it values.
 
bool unregisterOperation (const std::string &)
 Unregister an operation identified by its unique name.
 
bool unregisterOperation (const Operation::Index &)
 Unregister an operation identified by its type index.
 
template<typename OperationType >
bool unregisterOperation ()
 Unregister an operation identified by its class type.
 
Operation::Specification specification (const std::string &) const
 Access the specification of an operation identified by its unique name.
 
Operation::Specification specification (const Operation::Index &) const
 Access the specification of an operation identified by its type index.
 
template<typename OperationType >
Operation::Specification specification () const
 Access the specification of an operation identified by its class type.
 
bool contains (const std::string &) const
 Check if an operation identified by it's unique name is in the group.
 
bool contains (const Operation::Index &) const
 Check if an operation identified by its type index is in the group.
 
template<typename OperationType >
bool contains () const
 Check if an operation identified by its class type is in the group.
 
std::set< std::string > values (const std::string &) const
 Obtain values for an operation identified by it's unique name is in the group.
 
std::set< std::string > values (const Operation::Index &) const
 Obtain values for an operation identified by its type index is in the group.
 
template<typename OperationType >
std::set< std::string > values () const
 Obtain values for an operation identified by its class type is in the group.
 
std::set< Operation::Index > operations () const
 Return a set of operation indices that belong to this group.
 
std::set< std::string > operationNames () const
 Return a set of operation unique names that belong to this group.
 
std::string operationName (const Operation::Index &) const
 Given an operation index, return the operation's name.
 
std::string operationLabel (const Operation::Index &) const
 Given an operation index, return the operation's label.
 

The documentation for this class was generated from the following files: