SMTK  @SMTK_VERSION@
Simulation Modeling Tool Kit
Public Member Functions | Static Public Attributes | List of all members
smtk::operation::InternalGroup Class Reference

A group for operations that are used internally, and should therefore not be displayed to the user as an available operation. More...

#include <InternalGroup.h>

Inheritance diagram for smtk::operation::InternalGroup:
[legend]
Collaboration diagram for smtk::operation::InternalGroup:
[legend]

Public Member Functions

 InternalGroup (std::shared_ptr< smtk::operation::Manager > manager)
 
bool registerOperation (const std::string &)
 
bool registerOperation (const Operation::Index &)
 
template<typename OperationType >
bool registerOperation ()
 
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::string operationLabel (const Operation::Index &) const
 Given an operation index, return the operation's label.
 
std::string operationName (const Operation::Index &) const
 Given an operation index, return the operation's name.
 
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.
 

Static Public Attributes

static constexpr const char *const type_name = "internal"
 

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.
 
- Protected Attributes inherited from smtk::operation::Group
std::weak_ptr< smtk::operation::Managerm_manager
 

Detailed Description

A group for operations that are used internally, and should therefore not be displayed to the user as an available operation.


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