A specialization of smtk::operation::Operation for operations whose specifications are defined by an XML description that is accessible at compile time. More...
#include <XMLOperation.h>
Inherits smtk::operation::Operation.
Inherited by smtk::attribute::Associate, smtk::attribute::Dissociate, smtk::attribute::Export, smtk::attribute::Import, smtk::attribute::Read, smtk::attribute::Signal, smtk::attribute::Write, smtk::extension::delaunay::TessellateFaces, smtk::extension::delaunay::TriangulateFaces, smtk::geometry::DataSetInfoInspector, smtk::geometry::ImageInspector, smtk::geometry::MeshInspector, smtk::markup::Create, smtk::markup::CreateAnalyticShape, smtk::markup::CreateGroup, smtk::markup::DumpGraph, smtk::markup::Import, smtk::markup::Read, smtk::markup::SetName, smtk::markup::TagIndividual, smtk::markup::Ungroup, smtk::markup::Write, smtk::mesh::DeleteMesh, smtk::mesh::ElevateMesh, smtk::mesh::Export, smtk::mesh::ExtractAdjacency, smtk::mesh::ExtractByDihedralAngle, smtk::mesh::ExtractSkin, smtk::mesh::GenerateHotStartData, smtk::mesh::Import, smtk::mesh::InterpolateOntoMesh, smtk::mesh::MergeCoincidentPoints, smtk::mesh::PrintMeshInformation, smtk::mesh::Read, smtk::mesh::ReadResource, smtk::mesh::SelectCells, smtk::mesh::SetMeshName, smtk::mesh::Subtract, smtk::mesh::Transform, smtk::mesh::UndoElevateMesh, smtk::mesh::Write, smtk::mesh::WriteResource, smtk::model::AddAuxiliaryGeometry, smtk::model::CloseModel, smtk::model::CreateInstances, smtk::model::Delete, smtk::model::DivideInstance, smtk::model::EntityGroupOperation, smtk::model::ExportEdgesToVTK, smtk::model::ExportModelJSON, smtk::model::GroupAuxiliaryGeometry, smtk::model::MergeInstances, smtk::model::SetInstancePrototype, smtk::model::TerrainExtraction, smtk::operation::AssignColors, smtk::operation::CoordinateTransform, smtk::operation::CreateResource, smtk::operation::EditProperties, smtk::operation::ReadResource, smtk::operation::RemoveResource, smtk::operation::SetProperty, smtk::operation::WriteResource, smtk::project::Operation, smtk::session::mesh::CreateUniformGrid, smtk::session::mesh::EulerCharacteristicRatio, smtk::session::mesh::Export, smtk::session::mesh::Import, smtk::session::mesh::Merge, smtk::session::mesh::Print, smtk::session::mesh::Read, smtk::session::mesh::Transform, smtk::session::mesh::Write, smtk::session::oscillator::CreateModel, smtk::session::oscillator::EditDomain, smtk::session::oscillator::EditSource, smtk::session::oscillator::Export, smtk::session::oscillator::Read, smtk::session::oscillator::Write, smtk::session::polygon::ImportPPG, smtk::session::polygon::Operation, smtk::session::vtk::Operation, and smtk::view::RespondToVTKSelection.
Public Member Functions | |
| 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... | |
| virtual bool | ableToOperate () |
| Check if the operation's attribute resource is valid. 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 (Key) |
Protected Member Functions | |
| Result | operateInternal () override=0 |
| Specification | createSpecification () override |
| Protected Member Functions inherited from smtk::operation::Operation | |
| virtual void | postProcessResult (Result &) |
| virtual void | markModifiedResources (Result &) |
| virtual bool | unmanageResources (Result &) |
| virtual void | generateSummary (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 } |
| 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 specialization of smtk::operation::Operation for operations whose specifications are defined by an XML description that is accessible at compile time.
The documentation for this class was generated from the following files:
- /home/docs/checkouts/readthedocs.org/user_builds/smtk/checkouts/latest/smtk/operation/XMLOperation.h
- /home/docs/checkouts/readthedocs.org/user_builds/smtk/checkouts/latest/smtk/operation/XMLOperation.cxx
