Inheritance diagram for smtk::markup::Component:
Collaboration diagram for smtk::markup::Component:
Public Types | |
| using | Serialize = std::true_type |
| using | Index = std::size_t |
 Public Types inherited from smtk::resource::Component | |
| typedef std::function< void(const ComponentPtr &)> | Visitor |
| typedef detail::ComponentLinks | Links |
| typedef detail::ComponentProperties | Properties |
Public Member Functions | |
| smtkTypeMacro (smtk::markup::Component) | |
| smtkSuperclassMacro (smtk::graph::Component) | |
| template<typename... Args> | |
| Component (Args &&... args) | |
| virtual void | initialize (const nlohmann::json &data, smtk::resource::json::Helper &helper) |
| Provide an initializer for resources to call after construction. | |
| Component::Index | index () const |
| The index is a compile-time intrinsic of the derived resource; as such, it cannot be set. | |
| std::string | name () const override |
| Return the component's name. | |
| bool | setName (const std::string &name) |
| Set the component's name. | |
| ArcEndpointInterface< arcs::GroupsToMembers, ConstArc, IncomingArc > | groups () const |
| Return the container of groups this component belongs to. | |
| ArcEndpointInterface< arcs::GroupsToMembers, NonConstArc, IncomingArc > | groups () |
| ArcEndpointInterface< arcs::LabelsToSubjects, ConstArc, IncomingArc > | labels () const |
| Return the container of labels that reference this component. | |
| ArcEndpointInterface< arcs::LabelsToSubjects, NonConstArc, IncomingArc > | labels () |
| ArcEndpointInterface< arcs::URLsToImportedData, ConstArc, IncomingArc > | importedFrom () const |
| Return the container of URLs from which this component was imported (if any). | |
| ArcEndpointInterface< arcs::URLsToImportedData, NonConstArc, IncomingArc > | importedFrom () |
| ArcEndpointInterface< arcs::OntologyIdentifiersToIndividuals, ConstArc, IncomingArc > | ontologyClasses () const |
| Return the container of ontology identifiers this component realizes. More... | |
| ArcEndpointInterface< arcs::OntologyIdentifiersToIndividuals, NonConstArc, IncomingArc > | ontologyClasses () |
| bool | assign (const smtk::graph::Component::ConstPtr &source, smtk::resource::CopyOptions &options) override |
| Assign this node's state from source. | |
| Public Member Functions inherited from smtk::graph::Component | |
| smtkTypeMacro (smtk::graph::Component) | |
| smtkSuperclassMacro (smtk::resource::Component) | |
| const smtk::resource::ResourcePtr | resource () const override |
| Access the containing resource. | |
| smtk::resource::Resource * | parentResource () const override |
| Return a raw (not shared) pointer to the resource that owns this object. More... | |
| const smtk::common::UUID & | id () const override |
| Access the component's id. | |
| bool | setId (const smtk::common::UUID &uid) override |
| Set the component's id. | |
| template<typename ArcType > | |
| ArcEndpointInterface< ArcType, ConstArc, OutgoingArc > | outgoing () const |
| Return an endpoint-interface object for arcs of ArcType outgoing from this node. More... | |
| template<typename ArcType > | |
| ArcEndpointInterface< ArcType, NonConstArc, OutgoingArc > | outgoing () |
| template<typename ArcType > | |
| ArcEndpointInterface< ArcType, ConstArc, IncomingArc > | incoming () const |
| Return an endpoint-interface object for arcs of ArcType incoming to this node. More... | |
| template<typename ArcType > | |
| ArcEndpointInterface< ArcType, NonConstArc, IncomingArc > | incoming () |
| bool | disconnect (bool onlyExplicit=false) |
| Remove all (editable) arcs from this node. More... | |
| RuntimeArcEndpoint< NonConstArc > | outgoing (smtk::string::Token arcType) |
| Given a runtime arc type-name, return a runtime endpoint interface. More... | |
| RuntimeArcEndpoint< ConstArc > | outgoing (smtk::string::Token arcType) const |
| RuntimeArcEndpoint< NonConstArc > | incoming (smtk::string::Token arcType) |
| RuntimeArcEndpoint< ConstArc > | incoming (smtk::string::Token arcType) const |
| virtual bool | assign (const ConstPtr &source, smtk::resource::CopyOptions &options) |
| Assign state data from the source node to this instance. More... | |
| Public Member Functions inherited from smtk::resource::Component | |
| smtkTypeMacro (smtk::resource::Component) | |
| smtkSuperclassMacro (smtk::resource::PersistentObject) | |
| smtkSharedFromThisMacro (smtk::resource::PersistentObject) | |
| Resource * | parentResource () const override |
| Return a raw (not shared) pointer to the resource that owns this component. More... | |
| template<typename ResourceType > | |
| ResourceType * | parentResourceAs () const |
| This variant of parentResource casts the result to the given ResourceType. | |
| Links & | links () override |
| Return the links that connect this component to external resources/components. | |
| const Links & | links () const override |
| Properties & | properties () override |
| Return properties defined on this component. | |
| const Properties & | properties () const override |
| Public Member Functions inherited from smtk::resource::PersistentObject | |
| smtkTypeMacroBase (smtk::resource::PersistentObject) | |
| template<typename T > | |
| T::Ptr | as () |
| Attempt to cast this object to a subclass. | |
| template<typename T > | |
| T::ConstPtr | as () const |
| Attempt to cast this object to a subclass. | |
Static Public Attributes | |
| static const Component::Index | type_index |
| A unique integer corresponding to the component type. | |
Protected Member Functions | |
| bool | copyAssignment (const AssignedIds &sourceAssignment, std::shared_ptr< AssignedIds > &targetAssignment) |
| Copy the sourceAssignment's IDs into the targetAssignment. More... | |
| bool | copyBaseData (const vtkSmartPointer< vtkDataObject > &baseSourceData, vtkSmartPointer< vtkDataObject > &baseTargetData, smtk::resource::CopyOptions &options) |
| Use copyData<T>() instead. It calls this method. | |
| template<typename DataType > | |
| bool | copyData (const vtkSmartPointer< DataType > &sourceData, vtkSmartPointer< DataType > &targetData, smtk::resource::CopyOptions &options) |
| Copy the sourceData into the targetData. More... | |
| Protected Member Functions inherited from smtk::graph::Component | |
| Component (const std::shared_ptr< smtk::graph::ResourceBase > &) | |
| Component (const std::shared_ptr< smtk::graph::ResourceBase > &, const smtk::common::UUID &) | |
| const ArcImplementationBase * | arcsOfType (smtk::string::Token arcType) const |
| ArcImplementationBase * | arcsOfType (smtk::string::Token arcType) |
| virtual void | createDependentArcs () |
Protected Attributes | |
| std::string | m_name |
| Protected Attributes inherited from smtk::graph::Component | |
| smtk::WeakReferenceWrapper< smtk::graph::ResourceBase > | m_resource |
| smtk::common::UUID | m_id |
Member Function Documentation
◆ copyAssignment()
|
protected |
Copy the sourceAssignment's IDs into the targetAssignment.
sourceAssignment is assumed to originate from an external resource while targetAssignment is held by a component of this resource. The target domain is looked up by name from the source domain's name and the matching IDs are requested. On success, true is returned. If false is returned, the matching IDs could not be allocated from the target domain.
◆ copyData()
template<typename DataType >
|
inlineprotected |
Copy the sourceData into the targetData.
The options are used to determine whether to perform a shallow or deep copy.
◆ ontologyClasses()
| ArcEndpointInterface< arcs::OntologyIdentifiersToIndividuals, NonConstArc, IncomingArc > smtk::markup::Component::ontologyClasses | ( | ) | const |
Return the container of ontology identifiers this component realizes.
Any component may be marked as a member of an ontology class; return the set of classes (ontology identifiers) this component belongs to.
The documentation for this class was generated from the following files:
- /home/docs/checkouts/readthedocs.org/user_builds/smtk/checkouts/latest/smtk/markup/Component.h
- /home/docs/checkouts/readthedocs.org/user_builds/smtk/checkouts/latest/smtk/markup/Component.cxx
