A class for adding python operations to the current session. More...
#include <ImportPythonOperation.h>
Inheritance diagram for smtk::operation::ImportPythonOperation:
Collaboration diagram for smtk::operation::ImportPythonOperation:
Public Member Functions | |
| smtkTypeMacro (smtk::operation::ImportPythonOperation) | |
| smtkCreateMacro (ImportPythonOperation) | |
| smtkSharedFromThisMacro (smtk::operation::Operation) | |
| smtkSuperclassMacro (smtk::operation::Operation) | |
| bool | ableToOperate () override |
| Check if the operation's attribute resource is valid. More... | |
 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... | |
| 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 |
| virtual bool | threadSafe () const |
| Is this type of operation safe to launch in a thread? | |
| 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(). | |
Static Public Member Functions | |
| static std::vector< std::string > | importOperationsFromModule (const std::string &, Manager &) |
| static bool | importOperation (smtk::operation::Manager &manager, const std::string &moduleName, const std::string &opName) |
Protected Member Functions | |
| Result | operateInternal () override |
| Perform the actual operation and construct the result. | |
| void | generateSummary (Result &) override |
| 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... | |
| typedef std::size_t | Index |
| typedef std::shared_ptr< smtk::attribute::Attribute > | Parameters |
| typedef std::shared_ptr< smtk::attribute::Attribute > | Result |
| typedef std::shared_ptr< smtk::attribute::Resource > | Specification |
| 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
A class for adding python operations to the current session.
Given a python file that describes an operation, this operation loads the python operation into the current session. The new operation is ready for use upon the successful completion of this operation (the session does not need to be restarted).
Member Function Documentation
◆ ableToOperate()
|
overridevirtual |
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/ImportPythonOperation.h
- /home/docs/checkouts/readthedocs.org/user_builds/smtk/checkouts/latest/smtk/operation/operators/ImportPythonOperation.cxx
