com.esri.arcgis.schematic
Class SchematicAlgoReduceVertices

java.lang.Object
  com.esri.arcgis.schematic.SchematicAlgoReduceVertices

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, ISchematicAlgoReduceVertices, ISchematicAlgorithm, ISchematicAlgorithmParameters, ISupportErrorInfo, Serializable

public class SchematicAlgoReduceVertices
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISchematicAlgoReduceVertices, ISchematicAlgorithm, ISchematicAlgorithmParameters, ISupportErrorInfo

Reduce Vertices schematic algorithm object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

See Also:

Serialized Form

Constructor Summary

SchematicAlgoReduceVertices()
Constructs a SchematicAlgoReduceVertices using ArcGIS Engine.

SchematicAlgoReduceVertices(Object obj)
Construct a SchematicAlgoReduceVertices using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

boolean	equals(Object o) Compare this object with another
void	execute(INgView view, INgCancelTracker tracker) Executes the schematic algorithm.
String	getAlgorithmCLSID() CLSID of the schematic algorithm.
double	getAngleThreshold() Angle formed by the incident segments over which a vertex related to these segments is reduced.
static String	getClsid() getClsid.
int	getIteration() Number of Reduce Vertices algorithm iterations that will be executed before the final result is shown.
String	getLabel() Label for the schematic algorithm that displays in the Layout Task dropdown list.
INgNames	getParameterNames() List of the names for the schematic algorithm parameters.
Object	getParameterValue(String name) List of the values for the schematic algorithm parameters.
INgProject	getProject() Project the schematic algorithm is related to.
double	getSegmentRatio() The algorithm detects the longest segment of a link and computes ratios between each segment length and this longest segment.
int	hashCode() the hashcode for this object
void	initialize(INgProject wrk) Initializes the schematic algorithm for the specified project.
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	isAvailable() Indicates if the schematic algorithm is available from the Layout Task dropdown list.
boolean	isEnabled(INgView view) Indicates if the schematic algorithm is enabled.
void	setAngleThreshold(double dAngle) Angle formed by the incident segments over which a vertex related to these segments is reduced.
void	setAvailable(boolean pVal) Indicates if the schematic algorithm is available from the Layout Task dropdown list.
void	setIteration(int iIteration) Number of Reduce Vertices algorithm iterations that will be executed before the final result is shown.
void	setLabel(String pVal) Label for the schematic algorithm that displays in the Layout Task dropdown list.
void	setParameterValue(String name, Object value) List of the values for the schematic algorithm parameters.
void	setSegmentRatio(double dAngle) The algorithm detects the longest segment of a link and computes ratios between each segment length and this longest segment.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

SchematicAlgoReduceVertices

public SchematicAlgoReduceVertices()
                            throws IOException,
                                   UnknownHostException

Constructs a SchematicAlgoReduceVertices using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

SchematicAlgoReduceVertices

public SchematicAlgoReduceVertices(Object obj)
                            throws IOException

Construct a SchematicAlgoReduceVertices using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to SchematicAlgoReduceVertices.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems SchematicAlgoReduceVertices theSchematicAlgoReduceVertices = (SchematicAlgoReduceVertices) obj;

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

setAngleThreshold

public void setAngleThreshold(double dAngle)
                       throws IOException,
                              AutomationException

Angle formed by the incident segments over which a vertex related to these segments is reduced.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setAngleThreshold in interface ISchematicAlgoReduceVertices

Parameters:

dAngle - The dAngle (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAngleThreshold

public double getAngleThreshold()
                         throws IOException,
                                AutomationException

Angle formed by the incident segments over which a vertex related to these segments is reduced.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getAngleThreshold in interface ISchematicAlgoReduceVertices

Returns:

The dAngle

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSegmentRatio

public void setSegmentRatio(double dAngle)
                     throws IOException,
                            AutomationException

The algorithm detects the longest segment of a link and computes ratios between each segment length and this longest segment. If the computed ratio is lower than the specified Segment ratio, the vertex at the origin of the segment is removed.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setSegmentRatio in interface ISchematicAlgoReduceVertices

Parameters:

dAngle - The dAngle (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSegmentRatio

public double getSegmentRatio()
                       throws IOException,
                              AutomationException

The algorithm detects the longest segment of a link and computes ratios between each segment length and this longest segment. If the computed ratio is lower than the specified Segment ratio, the vertex at the origin of the segment is removed.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getSegmentRatio in interface ISchematicAlgoReduceVertices

Returns:

The dAngle

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIteration

public void setIteration(int iIteration)
                  throws IOException,
                         AutomationException

Number of Reduce Vertices algorithm iterations that will be executed before the final result is shown.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setIteration in interface ISchematicAlgoReduceVertices

Parameters:

iIteration - The iIteration (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIteration

public int getIteration()
                 throws IOException,
                        AutomationException

Number of Reduce Vertices algorithm iterations that will be executed before the final result is shown.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getIteration in interface ISchematicAlgoReduceVertices

Returns:

The iIteration

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

execute

public void execute(INgView view,
                    INgCancelTracker tracker)
             throws IOException,
                    AutomationException

Executes the schematic algorithm.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

execute in interface ISchematicAlgorithm

Parameters:

view - A reference to a com.esri.arcgis.schematic.INgView (in, optional, pass 0 if not required)

tracker - A reference to a com.esri.arcgis.schematic.INgCancelTracker (in, optional, pass 0 if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEnabled

public boolean isEnabled(INgView view)
                  throws IOException,
                         AutomationException

Indicates if the schematic algorithm is enabled. That is, if the Apply button is available.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

isEnabled in interface ISchematicAlgorithm

Parameters:

view - A reference to a com.esri.arcgis.schematic.INgView (in, optional, pass 0 if not required)

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAvailable

public boolean isAvailable()
                    throws IOException,
                           AutomationException

Indicates if the schematic algorithm is available from the Layout Task dropdown list.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

isAvailable in interface ISchematicAlgorithm

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAvailable

public void setAvailable(boolean pVal)
                  throws IOException,
                         AutomationException

Indicates if the schematic algorithm is available from the Layout Task dropdown list.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setAvailable in interface ISchematicAlgorithm

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabel

public String getLabel()
                throws IOException,
                       AutomationException

Label for the schematic algorithm that displays in the Layout Task dropdown list.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getLabel in interface ISchematicAlgorithm

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabel

public void setLabel(String pVal)
              throws IOException,
                     AutomationException

Label for the schematic algorithm that displays in the Layout Task dropdown list.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setLabel in interface ISchematicAlgorithm

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

initialize

public void initialize(INgProject wrk)
                throws IOException,
                       AutomationException

Initializes the schematic algorithm for the specified project.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

initialize in interface ISchematicAlgorithm

Parameters:

wrk - A reference to a com.esri.arcgis.schematic.INgProject (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAlgorithmCLSID

public String getAlgorithmCLSID()
                         throws IOException,
                                AutomationException

CLSID of the schematic algorithm.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getAlgorithmCLSID in interface ISchematicAlgorithm

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProject

public INgProject getProject()
                      throws IOException,
                             AutomationException

Project the schematic algorithm is related to.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getProject in interface ISchematicAlgorithm

Returns:

A reference to a com.esri.arcgis.schematic.INgProject

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParameterNames

public INgNames getParameterNames()
                           throws IOException,
                                  AutomationException

List of the names for the schematic algorithm parameters.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getParameterNames in interface ISchematicAlgorithmParameters

Returns:

A reference to a com.esri.arcgis.schematic.INgNames

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicAlgorithmParameters.setParameterValue(String, java.lang.Object)

setParameterValue

public void setParameterValue(String name,
                              Object value)
                       throws IOException,
                              AutomationException

List of the values for the schematic algorithm parameters.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setParameterValue in interface ISchematicAlgorithmParameters

Parameters:

name - The name (in)

value - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParameterValue

public Object getParameterValue(String name)
                         throws IOException,
                                AutomationException

List of the values for the schematic algorithm parameters.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getParameterValue in interface ISchematicAlgorithmParameters

Parameters:

name - The name (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.