SMTK
@SMTK_VERSION@
Simulation Modeling Tool Kit
|
Public Member Functions | |
smtkTypeMacro (smtk::markup::URL) | |
smtkSuperclassMacro (smtk::markup::Label) | |
template<typename... Args> | |
URL (Args &&... args) | |
bool | setLocation (const smtk::string::Token &location) |
Set/get the actual URL; either a filename or a full resource locator with protocol. | |
smtk::string::Token | location () const |
bool | setType (const smtk::string::Token &mimeType) |
Set/get the type of data present at the URL (if known). May be an empty token. | |
smtk::string::Token | type () const |
std::string | extensionForType () const |
Return the default file extension to use for the mime type. More... | |
ArcEndpointInterface< arcs::URLsToData, ConstArc, OutgoingArc > | data () const |
Return the components instantiated from data in this URL. | |
ArcEndpointInterface< arcs::URLsToData, NonConstArc, OutgoingArc > | data () |
Public Member Functions inherited from smtk::markup::Label | |
smtkTypeMacro (smtk::markup::Label) | |
smtkSuperclassMacro (smtk::markup::Component) | |
template<typename... Args> | |
Label (Args &&... args) | |
void | initialize (const nlohmann::json &data, smtk::resource::json::Helper &helper) override |
Provide an initializer for resources to call after construction. | |
ArcEndpointInterface< arcs::LabelsToSubjects, ConstArc, OutgoingArc > | subjects () const |
Return the container of components that this label references. | |
ArcEndpointInterface< arcs::LabelsToSubjects, NonConstArc, OutgoingArc > | subjects () |
Public Member Functions inherited from smtk::markup::Component | |
smtkTypeMacro (smtk::markup::Component) | |
smtkSuperclassMacro (smtk::graph::Component) | |
template<typename... Args> | |
Component (Args &&... args) | |
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 () |
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 component. 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 |
Public Member Functions inherited from smtk::resource::Component | |
smtkTypeMacro (smtk::resource::Component) | |
smtkSuperclassMacro (smtk::resource::PersistentObject) | |
smtkSharedFromThisMacro (smtk::resource::PersistentObject) | |
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. | |
Additional Inherited Members | |
Public Types inherited from smtk::markup::Component | |
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 |
Static Public Attributes inherited from smtk::markup::Component | |
static const Component::Index | type_index |
A unique integer corresponding to the component type. | |
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 inherited from smtk::markup::Component | |
std::string | m_name |
Protected Attributes inherited from smtk::graph::Component | |
smtk::WeakReferenceWrapper< smtk::graph::ResourceBase > | m_resource |
smtk::common::UUID | m_id |
std::string smtk::markup::URL::extensionForType | ( | ) | const |
Return the default file extension to use for the mime type.
If the location is set, this returns its extension. If not, a file type is generated from the mime type.
The returned value will either be an empty string (if no mime type is set and the location is unset or has no extension) or an extension that begins with a period ('.')