ArcGIS Pro 3.6 API Reference Guide
ArcGIS.Core.CIM Namespace / CIMFilteredFindPathsConfiguration Class
Properties Methods Events


In This Topic
    CIMFilteredFindPathsConfiguration Class Members
    In This Topic

    The following tables list the members exposed by CIMFilteredFindPathsConfiguration.

    Public Constructors
    Public Properties
     NameDescription
    Public Property Gets or sets the closed path policy, i.e whether we allow, forbid, or require that the start and end vertices of a path are equal. When the value is KGClosedPathPolicy.Require, the DestinationEntities field is ignored and destinations entities are the same as origin entities.  
    Public Property Gets or sets the default relationship cost. If the default relationship cost is negative, it is replaced by zero.  
    Public Property Gets or sets the default traversal direction which is used for any relationship type that is not defined in the traversal directions list.  
    Public Property Gets or sets the destination entities. This field is ignored when ClosedPathPolicy is KGClosedPathPolicy.Require.  
    Public Property Gets or sets the usage of origin/destination entities in the filtered find paths algorithm.  
    Public Property Gets or sets the max number of paths the filtered find paths algorithm returns. This parameter is only taken into account when PathMode is KGPathMode.All.  
    Public Property Gets or sets the maximum path cost. The maximum cost is only enforced when the value is positive.  
    Public Property Gets or sets the maximum path length. The default of 0 means the value is unlimited.  
    Public Property Gets or sets the minimum path cost.  
    Public Property Gets or sets the minimum path length.  
    Public Property Gets or sets the name of the configuration.  
    Public Property Gets or sets the behaviour when a negative cost is found.  
    Public Property Gets or sets the origin entities.  
    Public Property Gets or sets the path filters.  
    Public Property Gets or sets whether the filtered find paths algorithm searches for shortest paths, for lowest cost paths or for all paths.  
    Public PropertyGets or sets the name of the property representing the cost of a relationship. If a relationship lacks this property, the property is not of a numeric type, or the property value is null, the cost of the relationship will be DefaultRelationshipCost. Only positive costs are supported. Any strictly negative cost will be converted to a positive cost based on NegativeCostBehaviour.  
    Public Property Gets or sets the time filter.  
    Public Property Gets or sets the traversal directions.  
    Top
    Public Methods
     NameDescription
    Public Method Creates a deep copy of CIMFilteredFindPathsConfiguration.  
    Public Methodstatic (Shared in Visual Basic) Reconstructs the CIMFilteredFindPathsConfiguration with a specified state from a JSON encoding.  
    Public Method Not implemented, reserved for future use. (Inherited from ArcGIS.Core.CIM.CIMObject)
    Public Method Reads the element inside the reader. (Inherited from ArcGIS.Core.CIM.CIMObject)
    Public MethodOverridden.  Creates a JSON encoding of the CIMFilteredFindPathsConfiguration and its current state.  
    Public Method Writes the element inside the writer. (Inherited from ArcGIS.Core.CIM.CIMObject)
    Top
    Protected Methods
     NameDescription
    Protected Method Called from a property setter to notify the framework that an Object member has changed. (Inherited from ArcGIS.Core.CIM.CIMObject)
    Protected MethodOverridden.  Reads the child element inside the reader.  
    Protected MethodOverridden.  Writes a child element to the writer.  
    Top
    Public Events
     NameDescription
    Public Event Occurs when a property value changes. (Inherited from ArcGIS.Core.CIM.CIMObject)
    Top
    See Also