SMTK
@SMTK_VERSION@
Simulation Modeling Tool Kit
|
Import geometric and ontological data into a resource. More...
#include <Import.h>
Public Member Functions | |
smtkTypeMacro (smtk::markup::Import) | |
smtkCreateMacro (Import) | |
smtkSharedFromThisMacro (smtk::operation::Operation) | |
smtkSuperclassMacro (smtk::operation::XMLOperation) | |
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... | |
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 |
Perform the actual operation and construct the result. | |
Specification | createSpecification () override |
const char * | xmlDescription () const override |
virtual bool | importVTKImage (const std::shared_ptr< Resource > &resource, const std::string &filename) |
virtual bool | importVTKMesh (const std::shared_ptr< Resource > &resource, const std::string &filename) |
virtual bool | importOWL (const std::shared_ptr< Resource > &resource, const std::string &filename) |
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... | |
virtual void | postProcessResult (Result &) |
virtual void | markModifiedResources (Result &) |
virtual bool | unmanageResources (Result &) |
virtual void | generateSummary (Result &) |
Specification | createBaseSpecification () const |
Static Protected Member Functions | |
static std::map< std::string, std::set< std::string > > | supportedVTKFileFormats () |
Protected Attributes | |
Result | m_result |
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 |
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 |
Import geometric and ontological data into a resource.
The import filter creates UnstructuredData, Ontology, and OntologyIdentifier nodes.
For each UnstructuredData node, two URL nodes are created and attached: one links the data to the filename/URL from which the data was imported, while the other links the data to an unspecified location where the imported data will be written in a native format. The latter location is set by the markup::Write operation when the data is saved.
For Ontology nodes, only the import URL is created (because ontology data is saved as part of the graph resource rather than in an external file).