Class NFEInteractionEngine


  • public class NFEInteractionEngine
    extends java.lang.Object
    NFE component used to detect interaction between elements such as network or feature elements
    • Constructor Detail

      • NFEInteractionEngine

        public NFEInteractionEngine​(NFEModel model)
        Creates a new interaction engine instance
        Parameters:
        model - the current NFE model
    • Method Detail

      • findIntersections

        public java.util.List<Intersection<NFEFeatureElement>> findIntersections​(NFEFeatureElement tgrFeatElem,
                                                                                 java.util.Collection<NFEFeatureElement> ignoredFeatElems,
                                                                                 double tolerance)
        Retrieves all the intersections of the given Feature Element. If the passed Feature Element is a point, the resulting list will contain only one intersection of two or more feature elements. If the passed Feature Element is a line, the resulting list will contain all the intersection points sorted from first to end line point.
        Parameters:
        tgrFeatElem - The target Feature Element. All the intersections with this Feature Element will be retrieved
        ignoredFeatElems - Elements in this list will be ignored when interacting with the main Feature Element
        tolerance - tolerance used to determine if two points can be considered the same
        Returns:
      • findIntersections

        public java.util.List<Intersection<NFEFeatureElement>> findIntersections​(NFEFeatureElement tgrFeatElem,
                                                                                 JGeometry tgrGeom,
                                                                                 java.util.Collection<NFEFeatureElement> ignoredFeatElems,
                                                                                 double tolerance)
        Retrieves all the intersections of the given Feature Element, supposing the given geometry is the feature element's geometry. If the passed Feature Element is a point, the resulting list will contain only one intersection of two or more feature elements. If the passed Feature Element is a line, the resulting list will contain all the intersection points sorted from first to end line point.
        Parameters:
        tgrFeatElem - The target Feature Element. All the intersections with this Feature Element will be retrieved
        tgrGeom - the feature element's geometry. It does not have to be the actual feature element's geometry but it has to be a suitable type for the feature element, that is, a line feature element requires a line geometry and so on.
        ignoredFeatElems - Elements in this list will be ignored when interacting with the main Feature Element
        tolerance - tolerance used to determine if two points can be considered the same
        Returns:
      • addConnectableHierarchies

        public void addConnectableHierarchies​(int[] connHierarchies)
        Sets which hierarchy levels allows inter-hierarchy interactions, that is, interactions between members of different hierarchies
        Parameters:
        connHierarchies - an array of hierarchy levels
      • removeConnectableHierarchies

        public void removeConnectableHierarchies​(int[] connHierarchies)
        Removes hierarchy levels for inter-hierarchy interactions
        Parameters:
        connHierarchies - an array of hierarchy levels
      • clearConnectableHierarchies

        public void clearConnectableHierarchies()
        Removes all the hierarchy levels for inter-hierarchy interactions.