Remove an SMTK resource from its resource manager. More...
#include <RemoveResource.h>
Inheritance diagram for smtk::operation::RemoveResource:
Collaboration diagram for smtk::operation::RemoveResource:
Public Member Functions | |
| smtkTypeMacro (smtk::operation::RemoveResource) | |
| smtkSharedPtrCreateMacro (smtk::operation::Operation) | |
| smtkSuperclassMacro (smtk::operation::XMLOperation) | |
| bool | threadSafe () const override |
| Linked resources and attribute resources need this to run on the main thread to update the UI properly. | |
 Public Member Functions inherited from smtk::operation::XMLOperation | |
| smtkTypeMacro (XMLOperation) | |
| smtkSharedFromThisMacro (smtk::operation::Operation) | |
| Public Member Functions inherited from smtk::operation::Operation | |
| smtkTypeMacroBase (smtk::operation::Operation) | |
| virtual Index | index () const |
| virtual bool | configure (const smtk::attribute::AttributePtr &changedAttribute=smtk::attribute::AttributePtr(), const smtk::attribute::ItemPtr &changedItem=smtk::attribute::ItemPtr()) |
| Update the operation's specification and operations to be consistent. More... | |
| Result | operate () |
| Execute the operation, log its outcome and return its results. More... | |
| Outcome | safeOperate () |
| Execute the operation in an asynchronous environment. More... | |
| Outcome | safeOperate (Handler handler) |
| virtual bool | releaseResult (Result &result) |
Release the operation result returned by operate(). More... | |
| virtual smtk::io::Logger & | log () const |
| Retrieve the operation's logger. More... | |
| Specification | specification () |
| This accessor facilitates the lazy construction of the specification, allowing for derived implementations of its creation. More... | |
| Parameters | parameters () |
| Access the operation's input parameters, constructing them if necessary. More... | |
| Parameters | parameters () const |
| Result | createResult (Outcome) |
| Create an attribute representing this operation's result type. More... | |
| void | addHandler (Handler handler, Priority priority) |
| Pass a handler to invoke after the operation's completion (successful or not). More... | |
| bool | removeHandler (Handler handler, Priority priority) |
| Remove a handler from the operation. | |
| bool | clearHandlers () |
| Clear all handlers from the operation. | |
| ManagerPtr | manager () const |
| Operations that are managed have a non-null pointer to their manager. | |
| bool | restoreTrace (const std::string &trace) |
| restore operation parameters from the trace of a previously run operation. | |
| void | setManagers (const std::shared_ptr< smtk::common::Managers > &m) |
| Operations may be passed application state in the form of a Managers type-container. | |
| std::shared_ptr< smtk::common::Managers > | managers () const |
| smtk::resource::ManagerPtr | resourceManager () |
| retrieve the resource manager, if available. | |
| Result | operate (const BaseKey &key) |
| Run an operation given a key returned by Operation::childKey(). | |
Protected Member Functions | |
| bool | ableToOperate () override |
| Check if the operation's attribute resource is valid. More... | |
| Result | operateInternal () override |
| Perform the actual operation and construct the result. | |
| void | generateSummary (Result &) override |
| Do not report success as the base class prints specific console messages after operateInternal() completes. | |
| const char * | xmlDescription () const override |
| Protected Member Functions inherited from smtk::operation::XMLOperation | |
| Specification | createSpecification () override |
| Protected Member Functions inherited from smtk::operation::Operation | |
| virtual ResourceAccessMap | identifyLocksRequired () |
| Identify resources to lock, and whether to lock them for reading or writing. More... | |
| const ResourceAccessMap & | lockedResources () const |
| Returns the set of resources that are currently locked by this operation. | |
| virtual void | postProcessResult (Result &) |
| virtual void | markModifiedResources (Result &) |
| virtual bool | unmanageResources (Result &) |
| Specification | createBaseSpecification () const |
Additional Inherited Members | |
| Public Types inherited from smtk::operation::Operation | |
| enum | Outcome { Outcome::UNABLE_TO_OPERATE, Outcome::CANCELED, Outcome::FAILED, Outcome::SUCCEEDED, Outcome::UNKNOWN = -1 } |
| enum | LockOption { LockAll, ParentLocksOnly, SkipLocks } |
| When running a nested operation, specify how resource locks should be handled. More... | |
| enum | ObserverOption { InvokeObservers, SkipObservers } |
| When running a nested operation, specify whether observers should be invoked. More... | |
| enum | ParametersOption { Validate, SkipValidation } |
| When running a nested operation, specify whether to call the operation's ableToOperate() method or skip it. More... | |
| using | Priority = int |
| A priority for Handlers. | |
| typedef std::size_t | Index |
| A hash value uniquely representing the operation. | |
| typedef std::shared_ptr< smtk::attribute::Attribute > | Parameters |
| An attribute describing the operation's input. | |
| typedef std::shared_ptr< smtk::attribute::Attribute > | Result |
| An attribute containing the operation's result. | |
| typedef std::shared_ptr< smtk::attribute::Resource > | Specification |
| An attribute resource containing the operation's execution definition result definition. | |
| typedef std::shared_ptr< smtk::attribute::Definition > | Definition |
| Public Attributes inherited from smtk::operation::Operation | |
| friend | Manager |
| friend | ImportPythonOperation |
| Protected Attributes inherited from smtk::operation::Operation | |
| int | m_debugLevel { 0 } |
| std::weak_ptr< Manager > | m_manager |
| std::shared_ptr< smtk::common::Managers > | m_managers |
Detailed Description
Remove an SMTK resource from its resource manager.
Removed resources will still exist in memory for as long as the operation result is held. Additionally, any other classes that hold a shared pointer to the resource will keep the resource in memory.
Member Function Documentation
◆ ableToOperate()
|
overrideprotectedvirtual |
Check if the operation's attribute resource is valid.
Derived operations may implement more task-specific checks to ensure that the operation is in a valid state.
Reimplemented from smtk::operation::Operation.
The documentation for this class was generated from the following files:
- /home/docs/checkouts/readthedocs.org/user_builds/smtk/checkouts/latest/smtk/operation/operators/RemoveResource.h
- /home/docs/checkouts/readthedocs.org/user_builds/smtk/checkouts/latest/smtk/operation/operators/RemoveResource.cxx
