Skip to content
  • PresetTemplateAssociation
  • class Esri::ArcGISRuntime::PresetTemplateAssociation

    Identifies an association between two preset template features. More...

    Header: #include <PresetTemplateAssociation.h>
    Since: Esri::ArcGISRuntime 300.0
    Inherits: Esri::ArcGISRuntime::Object

    Public Functions

    virtual ~PresetTemplateAssociation() override
    Esri::ArcGISRuntime::UtilityAssociationType associationType() const
    double fractionAlongEdge() const
    int fromFeatureIndex() const
    int fromTerminalId() const
    bool isContainmentVisible() const
    int toFeatureIndex() const
    int toTerminalId() const

    Detailed Description

    Determines the type of association between two features identified by their index in PresetTemplateDefinition::presetTemplateFeatures and properties relevant to the association; such as terminal selection for connectivity, content visibility for containment, or fraction along value for mid-span connectivity.

    Member Function Documentation

    [override virtual noexcept] PresetTemplateAssociation::~PresetTemplateAssociation()

    Destructor.

    Esri::ArcGISRuntime::UtilityAssociationType PresetTemplateAssociation::associationType() const

    Returns the UtilityAssociationType of this association.

    double PresetTemplateAssociation::fractionAlongEdge() const

    Returns the relative location along the non-spatial edge where the junction is (logically) located.

    If this is a junction in a non-spatial edge connectivity association, this property represents the relative location of the junction along the non-spatial edge, ranging from 0.0 (the edge's start point) to 1.0 (the edge's end point).

    For a UtilityAssociationType::JunctionEdgeObjectConnectivityToSide association, the value is 0.0; if UtilityAssociationType::JunctionEdgeObjectConnectivityMidspan, the value is between 0.0 and 1.0; and if UtilityAssociationType::JunctionEdgeObjectConnectivityFromSide, the value is 1.0.

    The default value is 0.0.

    int PresetTemplateAssociation::fromFeatureIndex() const

    Returns the position of the first participant in a UtilityAssociation within PresetTemplateDefinition::presetTemplateFeatures.

    For a containment association, this property represents the container. For a structural attachment association, this property represents the structure.

    int PresetTemplateAssociation::fromTerminalId() const

    Returns the ID of the terminal from which a connectivity association is made. The default value is -1.

    bool PresetTemplateAssociation::isContainmentVisible() const

    Returns for a containment association, this indicates whether the content is visible.

    int PresetTemplateAssociation::toFeatureIndex() const

    Returns the position of the second participant in a UtilityAssociation within PresetTemplateDefinition::presetTemplateFeatures.

    For a containment association, this property represents the content. For a structural attachment association, this property represents the attached item.

    int PresetTemplateAssociation::toTerminalId() const

    Returns the ID of the terminal to which a connectivity association is made. The default value is -1.

    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.