SMTK  @SMTK_VERSION@
Simulation Modeling Tool Kit
Public Types | Public Member Functions | List of all members
smtk::markup::arcs::ReferencesToPrimaries Struct Reference

Arcs connecting spatial data to the domains over which they are defined. More...

#include <ReferencesToPrimaries.h>

Public Types

using FromType = SpatialData
 
using ToType = SpatialData
 
using Directed = std::true_type
 

Public Member Functions

bool contains (const SpatialData *from, const SpatialData *to) const
 Are the from and \to nodes connected? More...
 
std::size_t outDegree (const SpatialData *from) const
 Return the number of shapes participating in the domain.
 
std::size_t inDegree (const SpatialData *to) const
 Return the number domains this shape participates in.
 
template<typename Functor >
smtk::common::Visited outVisitor (const SpatialData *domain, Functor ff) const
 Visit each shape participating in the domain.
 
template<typename Functor >
smtk::common::Visited inVisitor (const SpatialData *shape, Functor ff) const
 Visit each domain this shape participates in.
 
template<typename ResourcePtr , typename Functor >
smtk::common::Visited visitAllOutgoingNodes (ResourcePtr rr, Functor ff) const
 Visit all domains in the resource which have arcs to one or more shapes.
 
template<typename ResourcePtr , typename Functor >
smtk::common::Visited visitAllIncomingNodes (ResourcePtr rr, Functor ff) const
 Visit all shapes in the resource which have arcs to one or more domains.
 

Detailed Description

Arcs connecting spatial data to the domains over which they are defined.

These arcs are implicit since we can infer them from the ID assignments held by DiscreteGeometry. Currently, we do not implement ParameterSpace domains; once we do, similar arcs will exist for parametric shapes.

Member Function Documentation

◆ contains()

bool smtk::markup::arcs::ReferencesToPrimaries::contains ( const SpatialData from,
const SpatialData to 
) const

Are the from and \to nodes connected?

When a domain and shape (spatial data object) are connected, the from domain mathematically covers the to shape (i.e., the shape is a subset of the domain).


The documentation for this struct was generated from the following files: