com.esri.arcgis.schematic
Class SchematicAlgoGrid

java.lang.Object
  extended by com.esri.arcgis.schematic.SchematicAlgoGrid
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, ISchematicAlgoGrid, ISchematicAlgorithm, Serializable

public class SchematicAlgoGrid
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISchematicAlgoGrid, ISchematicAlgorithm

Grid schematic algorithm object.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
SchematicAlgoGrid()
          Constructs a SchematicAlgoGrid using ArcGIS Engine.
SchematicAlgoGrid(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SchematicAlgoGrid theSchematicAlgoGrid = (SchematicAlgoGrid) obj;
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
 void execute(ISchematicLayer schematicLayer, ITrackCancel cancelTracker)
          Execute the schematic algorithm.
 String getAlgorithmCLSID()
          The CLSID of the algorithm.
static String getClsid()
          getClsid.
 double getHorizontalStep()
          Horizontal step for the grid; that is the wide of each grid cell.
 String getLabel()
          The label of the algorithm.
 double getOriginX()
          Horizontal coordinate for the origin of the grid.
 double getOriginY()
          Vertical coordinate for the origin of the grid.
 IPropertySet getPropertySet()
          The property set of the algorithm contains a collection of its parameters and their values.
 ISchematicDiagramClassName getSchematicDiagramClassName()
          The diagram class object used to initialize the algorithm.
 double getVerticalStep()
          Vertical step for the grid; that is the wide of each grid cell.
 int hashCode()
          the hashcode for this object
 boolean isAbsoluteParameters()
          Indicates if the values set for the step parameters must be interpreted as absolute units.
 boolean isAvailable()
          Indicates if the algorithm is currently available.
 boolean isEnabled(ISchematicLayer schematicLayer)
          Indicates if the algorithm is currently enabled.
 boolean isOverridable()
          Indicates if the algorithm properties page is editable from ArcMap; that is, enabling the Layout Properties button in ArcMap.
 boolean isUseEndNode()
          Indicates if the algorithm use end nodes.
 boolean isUseRootNode()
          Indicates if the algorithm use root nodes.
 void setAbsoluteParameters(boolean pVal)
          Indicates if the values set for the step parameters must be interpreted as absolute units.
 void setAvailable(boolean available)
          Indicates if the algorithm is currently available.
 void setHorizontalStep(double pVal)
          Horizontal step for the grid; that is the wide of each grid cell.
 void setLabel(String label)
          The label of the algorithm.
 void setOriginX(double pVal)
          Horizontal coordinate for the origin of the grid.
 void setOriginY(double pVal)
          Vertical coordinate for the origin of the grid.
 void setOverridable(boolean pOverridable)
          Indicates if the algorithm properties page is editable from ArcMap; that is, enabling the Layout Properties button in ArcMap.
 void setPropertySet(IPropertySet propertySet)
          The property set of the algorithm contains a collection of its parameters and their values.
 void setSchematicDiagramClassNameByRef(ISchematicDiagramClassName schematicDiagramClassName)
          The diagram class object used to initialize the algorithm.
 void setVerticalStep(double pVal)
          Vertical step for the grid; that is the wide of each grid cell.
 
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

SchematicAlgoGrid

public SchematicAlgoGrid()
                  throws IOException,
                         UnknownHostException
Constructs a SchematicAlgoGrid using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

SchematicAlgoGrid

public SchematicAlgoGrid(Object obj)
                  throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SchematicAlgoGrid theSchematicAlgoGrid = (SchematicAlgoGrid) obj;

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

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
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

getOriginX

public double getOriginX()
                  throws IOException,
                         AutomationException
Horizontal coordinate for the origin of the grid.

Product Availability

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

Specified by:
getOriginX in interface ISchematicAlgoGrid
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ISchematicAlgoGrid.getHorizontalStep(), ISchematicAlgoGrid.getVerticalStep(), ISchematicAlgoGrid.getOriginY()

setOriginX

public void setOriginX(double pVal)
                throws IOException,
                       AutomationException
Horizontal coordinate for the origin of the grid.

Product Availability

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

Specified by:
setOriginX in interface ISchematicAlgoGrid
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOriginY

public double getOriginY()
                  throws IOException,
                         AutomationException
Vertical coordinate for the origin of the grid.

Product Availability

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

Specified by:
getOriginY in interface ISchematicAlgoGrid
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ISchematicAlgoGrid.getHorizontalStep(), ISchematicAlgoGrid.getVerticalStep(), ISchematicAlgoGrid.getOriginX()

setOriginY

public void setOriginY(double pVal)
                throws IOException,
                       AutomationException
Vertical coordinate for the origin of the grid.

Product Availability

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

Specified by:
setOriginY in interface ISchematicAlgoGrid
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHorizontalStep

public double getHorizontalStep()
                         throws IOException,
                                AutomationException
Horizontal step for the grid; that is the wide of each grid cell.

Product Availability

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

Specified by:
getHorizontalStep in interface ISchematicAlgoGrid
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ISchematicAlgoGrid.getVerticalStep(), ISchematicAlgoGrid.getOriginX(), ISchematicAlgoGrid.getOriginY()

setHorizontalStep

public void setHorizontalStep(double pVal)
                       throws IOException,
                              AutomationException
Horizontal step for the grid; that is the wide of each grid cell.

Product Availability

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

Specified by:
setHorizontalStep in interface ISchematicAlgoGrid
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getVerticalStep

public double getVerticalStep()
                       throws IOException,
                              AutomationException
Vertical step for the grid; that is the wide of each grid cell.

Product Availability

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

Specified by:
getVerticalStep in interface ISchematicAlgoGrid
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ISchematicAlgoGrid.getHorizontalStep(), ISchematicAlgoGrid.getOriginX()

setVerticalStep

public void setVerticalStep(double pVal)
                     throws IOException,
                            AutomationException
Vertical step for the grid; that is the wide of each grid cell.

Product Availability

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

Specified by:
setVerticalStep in interface ISchematicAlgoGrid
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAbsoluteParameters

public boolean isAbsoluteParameters()
                             throws IOException,
                                    AutomationException
Indicates if the values set for the step parameters must be interpreted as absolute units.

Description

When this property returns false, the parameters that define the distances are expressed as relative units to the average of the current symbols sizes used to represent the schematic nodes in the diagram; for instance, when the HorizontalStep parameter value is 2, the wide for the grid cells corresponds to the average size of two symbols placed side by side.

Product Availability

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

Specified by:
isAbsoluteParameters in interface ISchematicAlgoGrid
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAbsoluteParameters

public void setAbsoluteParameters(boolean pVal)
                           throws IOException,
                                  AutomationException
Indicates if the values set for the step parameters must be interpreted as absolute units.

Product Availability

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

Specified by:
setAbsoluteParameters in interface ISchematicAlgoGrid
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEnabled

public boolean isEnabled(ISchematicLayer schematicLayer)
                  throws IOException,
                         AutomationException
Indicates if the algorithm is currently enabled.

Product Availability

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

Specified by:
isEnabled in interface ISchematicAlgorithm
Parameters:
schematicLayer - A reference to a com.esri.arcgis.schematic.ISchematicLayer (in, optional, pass 0 if not required)
Returns:
The enabled
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 algorithm is currently available.

Product Availability

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

Specified by:
isAvailable in interface ISchematicAlgorithm
Returns:
The available
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAvailable

public void setAvailable(boolean available)
                  throws IOException,
                         AutomationException
Indicates if the algorithm is currently available.

Product Availability

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

Specified by:
setAvailable in interface ISchematicAlgorithm
Parameters:
available - The available (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isOverridable

public boolean isOverridable()
                      throws IOException,
                             AutomationException
Indicates if the algorithm properties page is editable from ArcMap; that is, enabling the Layout Properties button in ArcMap.

Product Availability

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

Specified by:
isOverridable in interface ISchematicAlgorithm
Returns:
The pOverridable
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOverridable

public void setOverridable(boolean pOverridable)
                    throws IOException,
                           AutomationException
Indicates if the algorithm properties page is editable from ArcMap; that is, enabling the Layout Properties button in ArcMap.

Product Availability

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

Specified by:
setOverridable in interface ISchematicAlgorithm
Parameters:
pOverridable - The pOverridable (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSchematicDiagramClassName

public ISchematicDiagramClassName getSchematicDiagramClassName()
                                                        throws IOException,
                                                               AutomationException
The diagram class object used to initialize the algorithm.

Product Availability

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

Specified by:
getSchematicDiagramClassName in interface ISchematicAlgorithm
Returns:
A reference to a com.esri.arcgis.schematic.ISchematicDiagramClassName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSchematicDiagramClassNameByRef

public void setSchematicDiagramClassNameByRef(ISchematicDiagramClassName schematicDiagramClassName)
                                       throws IOException,
                                              AutomationException
The diagram class object used to initialize the algorithm.

Product Availability

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

Specified by:
setSchematicDiagramClassNameByRef in interface ISchematicAlgorithm
Parameters:
schematicDiagramClassName - A reference to a com.esri.arcgis.schematic.ISchematicDiagramClassName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLabel

public String getLabel()
                throws IOException,
                       AutomationException
The label of the algorithm.

Product Availability

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

Specified by:
getLabel in interface ISchematicAlgorithm
Returns:
The label
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLabel

public void setLabel(String label)
              throws IOException,
                     AutomationException
The label of the algorithm.

Product Availability

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

Specified by:
setLabel in interface ISchematicAlgorithm
Parameters:
label - The label (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUseRootNode

public boolean isUseRootNode()
                      throws IOException,
                             AutomationException
Indicates if the algorithm use root nodes.

Product Availability

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

Specified by:
isUseRootNode in interface ISchematicAlgorithm
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUseEndNode

public boolean isUseEndNode()
                     throws IOException,
                            AutomationException
Indicates if the algorithm use end nodes.

Product Availability

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

Specified by:
isUseEndNode in interface ISchematicAlgorithm
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPropertySet

public IPropertySet getPropertySet()
                            throws IOException,
                                   AutomationException
The property set of the algorithm contains a collection of its parameters and their values.

Product Availability

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

Specified by:
getPropertySet in interface ISchematicAlgorithm
Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPropertySet

public void setPropertySet(IPropertySet propertySet)
                    throws IOException,
                           AutomationException
The property set of the algorithm contains a collection of its parameters and their values.

Product Availability

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

Specified by:
setPropertySet in interface ISchematicAlgorithm
Parameters:
propertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAlgorithmCLSID

public String getAlgorithmCLSID()
                         throws IOException,
                                AutomationException
The CLSID of the algorithm.

Product Availability

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

Specified by:
getAlgorithmCLSID in interface ISchematicAlgorithm
Returns:
The bstrCLSID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

execute

public void execute(ISchematicLayer schematicLayer,
                    ITrackCancel cancelTracker)
             throws IOException,
                    AutomationException
Execute the schematic algorithm.

Product Availability

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

Specified by:
execute in interface ISchematicAlgorithm
Parameters:
schematicLayer - A reference to a com.esri.arcgis.schematic.ISchematicLayer (in, optional, pass 0 if not required)
cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in, optional, pass 0 if not required)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.