All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- com.supermap.services.providers.UGCNetworkAnalyst3DProvider

All Implemented Interfaces:

Disposable, NetworkAnalyst3DProvider, ProviderContextAware
```
public class UGCNetworkAnalyst3DProvider
extends java.lang.Object
implements NetworkAnalyst3DProvider, Disposable, ProviderContextAware
```
SuperMap 3D network analysis service provider.

UGCNetworkAnalyst3DProvider provides SuperMap 3D network analysis of related services, encapsulates with SuperMap 3D network analysis related to GIS functions.

Since:

7.1.0

Constructor Summary

Constructors
Constructor and Description

UGCNetworkAnalyst3DProvider()

UGCNetworkAnalyst3DProvider(UGCNetworkAnalyst3DSetting setting)

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`dispose()` Release the resource object.
`FacilityAnalyst3DResult`	`findCriticalFacilitiesUpFromEdge(int[] sourceNodeIDs, int edgeID, FacilityAnalystParameter parameter)` Upstream key facility lookup, that is, find the key facility nodes in the upstream of a given arc, return the key node ID array and its downstream arc ID array.
`FacilityAnalyst3DResult`	`findCriticalFacilitiesUpFromNode(int[] sourceNodeIDs, int nodeID, FacilityAnalystParameter parameter)` Upstream key facility lookup, that is, find the key facility nodes in the upstream of a given node, return the key node ID array and its downstream arc ID array.
`FacilityAnalyst3DResult`	`findSinkFromEdge(int edgeID, java.lang.String weightName, FacilityAnalystParameter parameter)` According to the given arc ID to find the sink, that is, starting from a given arc, find out the downstream sinks that outflow the arc according to the flow, and returns the arc, point and cost which the specified arc reach to the sink the minimum path contains.
`FacilityAnalyst3DResult`	`findSinkFromNode(int nodeID, java.lang.String weightName, FacilityAnalystParameter parameter)` According to the given node ID to find the sink, that is, from a given node, find out the downstream sinks that outflow the node according to the flow, and returns the arc, point and cost which the specified arc reach to the sink the minimum path contains.
`FacilityAnalyst3DResult`	`findSourceFromEdge(int edgeID, java.lang.String weightName, FacilityAnalystParameter parameter)` According to the given arc ID to find the source, that is, starting from a given arc, find out the network source that flow to the arc according to the flow, and returns the arc, point and cost which the specified source reach to the specified arc the minimum path contains.
`FacilityAnalyst3DResult`	`findSourceFromNode(int nodeID, java.lang.String weightName, FacilityAnalystParameter parameter)` According to the given node ID to find the source, that is, from a given node, find the network source that flow to the node according to the flow , and returns the arc, nodes and cost that the source node reach to the specified node the minimum cost path contains .
`FacilityAnalyst3DContent`	`getContent()` Gets the content information of the network data.
`java.lang.String`	`getNetworkDataName()` Gets the network data name.
`boolean`	`reloadModel()` Reloads the network data model.
`void`	`setProviderContext(ProviderContext context)` Sets the service provider context
`FacilityAnalyst3DResult`	`traceDownFromEdge(int edgeID, java.lang.String weightName, FacilityAnalystParameter parameter)` According to the given arc ID for downstream tracking, that is, to find downstream of a given arc, returns the arc, node and total cost which downstream contains.
`FacilityAnalyst3DResult`	`traceDownFromNode(int nodeID, java.lang.String weightName, FacilityAnalystParameter parameter)` According to the given node ID for downstream tracking, that is, to find downstream of a given arc, returns the arc, node and total cost which downstream contains.
`FacilityAnalyst3DResult`	`traceUpFromEdge(int edgeID, java.lang.String weightName, FacilityAnalystParameter parameter)` According to the given arc ID for upstream tracking, that is, to find upstream of a given arc, returns the arc, node and total cost which upstream contains.
`FacilityAnalyst3DResult`	`traceUpFromNode(int nodeID, java.lang.String weightName, FacilityAnalystParameter parameter)` According to the given node ID for upstream tracking, that is, to find upstream of a given arc, returns the arc, node and total cost which upstream contains.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - UGCNetworkAnalyst3DProvider
```
public UGCNetworkAnalyst3DProvider()
```
  - UGCNetworkAnalyst3DProvider
```
public UGCNetworkAnalyst3DProvider(UGCNetworkAnalyst3DSetting setting)
```
- Method Detail
  - setProviderContext
```
public void setProviderContext(ProviderContext context)
```
    Description copied from interface: ProviderContextAware
    
    Sets the service provider context
    
    Specified by:
    
    setProviderContext in interface ProviderContextAware
    
    Parameters:
    
    context - service provider context
  - dispose
```
public void dispose()
```
    Description copied from interface: Disposable
    
    Release the resource object.
    
    Specified by:
    
    dispose in interface Disposable
  - findCriticalFacilitiesUpFromEdge
```
public FacilityAnalyst3DResult findCriticalFacilitiesUpFromEdge(int[] sourceNodeIDs,
                                                       int edgeID,
                                                       FacilityAnalystParameter parameter)
```
    Description copied from interface: NetworkAnalyst3DProvider
    
    Upstream key facility lookup, that is, find the key facility nodes in the upstream of a given arc, return the key node ID array and its downstream arc ID array.
    
    Specified by:
    
    findCriticalFacilitiesUpFromEdge in interface NetworkAnalyst3DProvider
    
    Parameters:
    
    sourceNodeIDs - Specified facility node ID array can not be empty.
    
    edgeID - Specified analysis arc ID.
    
    parameter - Three - dimensional facility network analysis general parameters.
    
    Returns:
    
    Facility network analysis results. Facility network analysis results. Returns null if did not find the key facility node.
  - findCriticalFacilitiesUpFromNode
```
public FacilityAnalyst3DResult findCriticalFacilitiesUpFromNode(int[] sourceNodeIDs,
                                                       int nodeID,
                                                       FacilityAnalystParameter parameter)
```
    Description copied from interface: NetworkAnalyst3DProvider
    
    Upstream key facility lookup, that is, find the key facility nodes in the upstream of a given node, return the key node ID array and its downstream arc ID array.
    
    Specified by:
    
    findCriticalFacilitiesUpFromNode in interface NetworkAnalyst3DProvider
    
    Parameters:
    
    sourceNodeIDs - Specified facility node ID array can not be empty.
    
    nodeID - The specified analysis node ID.
    
    parameter - Three - dimensional facility network analysis general parameters.
    
    Returns:
    
    Facility network analysis results. Facility network analysis results. Returns null if did not find the key facility node.
  - findSinkFromEdge
```
public FacilityAnalyst3DResult findSinkFromEdge(int edgeID,
                                       java.lang.String weightName,
                                       FacilityAnalystParameter parameter)
```
    Description copied from interface: NetworkAnalyst3DProvider
    
    According to the given arc ID to find the sink, that is, starting from a given arc, find out the downstream sinks that outflow the arc according to the flow, and returns the arc, point and cost which the specified arc reach to the sink the minimum path contains.
    
    Specified by:
    
    findSinkFromEdge in interface NetworkAnalyst3DProvider
    
    Parameters:
    
    edgeID - Specified analysis arc ID.
    
    weightName - For the name of the specified weight field information object, see # name.
    
    parameter - Three - dimensional facility network analysis general parameters.
    
    Returns:
    
    Facility network analysis results.
  - findSinkFromNode
```
public FacilityAnalyst3DResult findSinkFromNode(int nodeID,
                                       java.lang.String weightName,
                                       FacilityAnalystParameter parameter)
```
    Description copied from interface: NetworkAnalyst3DProvider
    
    According to the given node ID to find the sink, that is, from a given node, find out the downstream sinks that outflow the node according to the flow, and returns the arc, point and cost which the specified arc reach to the sink the minimum path contains.
    
    Specified by:
    
    findSinkFromNode in interface NetworkAnalyst3DProvider
    
    Parameters:
    
    nodeID - The specified node ID.
    
    weightName - For the name of the specified weight field information object, see # name.
    
    parameter - Three - dimensional facility network analysis general parameters.
    
    Returns:
    
    Facility network analysis results.
  - traceUpFromEdge
```
public FacilityAnalyst3DResult traceUpFromEdge(int edgeID,
                                      java.lang.String weightName,
                                      FacilityAnalystParameter parameter)
```
    Description copied from interface: NetworkAnalyst3DProvider
    
    According to the given arc ID for upstream tracking, that is, to find upstream of a given arc, returns the arc, node and total cost which upstream contains.
    
    Specified by:
    
    traceUpFromEdge in interface NetworkAnalyst3DProvider
    
    Parameters:
    
    edgeID - Specified arc ID.
    
    weightName - For the name of the specified weight field information object, see # name.
    
    parameter - Three - dimensional facility network analysis general parameters.
    
    Returns:
    
    Facility network analysis results.
  - traceUpFromNode
```
public FacilityAnalyst3DResult traceUpFromNode(int nodeID,
                                      java.lang.String weightName,
                                      FacilityAnalystParameter parameter)
```
    Description copied from interface: NetworkAnalyst3DProvider
    
    According to the given node ID for upstream tracking, that is, to find upstream of a given arc, returns the arc, node and total cost which upstream contains.
    
    Specified by:
    
    traceUpFromNode in interface NetworkAnalyst3DProvider
    
    Parameters:
    
    nodeID - The specified node ID.
    
    weightName - For the name of the specified weight field information object, see # name.
    
    parameter - Three - dimensional facility network analysis general parameters.
    
    Returns:
    
    Facility network analysis results.
  - traceDownFromEdge
```
public FacilityAnalyst3DResult traceDownFromEdge(int edgeID,
                                        java.lang.String weightName,
                                        FacilityAnalystParameter parameter)
```
    Description copied from interface: NetworkAnalyst3DProvider
    
    According to the given arc ID for downstream tracking, that is, to find downstream of a given arc, returns the arc, node and total cost which downstream contains.
    
    Specified by:
    
    traceDownFromEdge in interface NetworkAnalyst3DProvider
    
    Parameters:
    
    edgeID - Specified arc ID.
    
    weightName - For the name of the specified weight field information object, see # name.
    
    parameter - Three - dimensional facility network analysis general parameters.
    
    Returns:
    
    Facility network analysis results.
  - traceDownFromNode
```
public FacilityAnalyst3DResult traceDownFromNode(int nodeID,
                                        java.lang.String weightName,
                                        FacilityAnalystParameter parameter)
```
    Description copied from interface: NetworkAnalyst3DProvider
    
    According to the given node ID for downstream tracking, that is, to find downstream of a given arc, returns the arc, node and total cost which downstream contains.
    
    Specified by:
    
    traceDownFromNode in interface NetworkAnalyst3DProvider
    
    Parameters:
    
    nodeID - The specified node ID.
    
    weightName - For the name of the specified weight field information object, see # name.
    
    parameter - Three - dimensional facility network analysis general parameters.
    
    Returns:
    
    Facility network analysis results.
  - findSourceFromEdge
```
public FacilityAnalyst3DResult findSourceFromEdge(int edgeID,
                                         java.lang.String weightName,
                                         FacilityAnalystParameter parameter)
```
    Description copied from interface: NetworkAnalyst3DProvider
    
    According to the given arc ID to find the source, that is, starting from a given arc, find out the network source that flow to the arc according to the flow, and returns the arc, point and cost which the specified source reach to the specified arc the minimum path contains.
    
    Specified by:
    
    findSourceFromEdge in interface NetworkAnalyst3DProvider
    
    Parameters:
    
    edgeID - Specified arc ID.
    
    weightName - For the name of the specified weight field information object, see # name.
    
    parameter - Three - dimensional facility network analysis general parameters.
    
    Returns:
    
    Facility network analysis results.
  - findSourceFromNode
```
public FacilityAnalyst3DResult findSourceFromNode(int nodeID,
                                         java.lang.String weightName,
                                         FacilityAnalystParameter parameter)
```
    Description copied from interface: NetworkAnalyst3DProvider
    
    According to the given node ID to find the source, that is, from a given node, find the network source that flow to the node according to the flow , and returns the arc, nodes and cost that the source node reach to the specified node the minimum cost path contains .
    
    Specified by:
    
    findSourceFromNode in interface NetworkAnalyst3DProvider
    
    Parameters:
    
    nodeID - The specified node ID.
    
    weightName - For the name of the specified weight field information object, see # name.
    
    parameter - Three - dimensional facility network analysis general parameters.
    
    Returns:
    
    Facility network analysis results.
  - reloadModel
```
public boolean reloadModel()
```
    Description copied from interface: NetworkAnalyst3DProvider
    
    Reloads the network data model.
    
    Specified by:
    
    reloadModel in interface NetworkAnalyst3DProvider
    
    Returns:
  - getNetworkDataName
```
public java.lang.String getNetworkDataName()
```
    Description copied from interface: NetworkAnalyst3DProvider
    
    Gets the network data name.
    
    Specified by:
    
    getNetworkDataName in interface NetworkAnalyst3DProvider
    
    Returns:
  - getContent
```
public FacilityAnalyst3DContent getContent()
```
    Description copied from interface: NetworkAnalyst3DProvider
    
    Gets the content information of the network data.
    
    Specified by:
    
    getContent in interface NetworkAnalyst3DProvider
    
    Returns:

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Constructors
Constructor and Description
`UGCNetworkAnalyst3DProvider()`
`UGCNetworkAnalyst3DProvider(UGCNetworkAnalyst3DSetting setting)`

Class UGCNetworkAnalyst3DProvider

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UGCNetworkAnalyst3DProvider

UGCNetworkAnalyst3DProvider

Method Detail

setProviderContext

dispose

findCriticalFacilitiesUpFromEdge

findCriticalFacilitiesUpFromNode

findSinkFromEdge

findSinkFromNode

traceUpFromEdge

traceUpFromNode

traceDownFromEdge

traceDownFromNode

findSourceFromEdge

findSourceFromNode

reloadModel

getNetworkDataName

getContent