com.esri.arcgis.geometry
Interface IRelationResult

All Superinterfaces:

Serializable

All Known Implementing Classes:

RelationResult

public interface IRelationResult
extends Serializable

Provides access to members that meet the specific relation between two sets of geometries. Not currently implemented for geometries containing elliptic arcs.

Product Availability

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

Method Summary

void	add(IRelationResult pRelations) Add elements of other Relation to the end of this Relations, and the set is re-sorted.
void	flipRelations() Flips the left and right indexes of all the elements of the relation.
void	getRelationElement(int i, int[] left, int[] right) The ith element of the relation.
int	getRelationElementCount() The number of pairs of geometries in the relation.
void	intersect(IRelationResult pRelations) Construct the set with only those elements that exist in both relation sets.
void	setRelationElement(int i, int left, int right) The ith element of the relation.
void	setRelationElements(int cPairs, esriRelationPair pairs) Sets RelationResult with an array of relations.
void	sortLeft() Sort the set according to the left index.
void	sortRight() Sort the set according to the right index.
void	subtract(IRelationResult pRelations) Finds elements existing in another relation set and delete them from this set.

Method Detail

getRelationElementCount

int getRelationElementCount()
                            throws IOException,
                                   AutomationException

The number of pairs of geometries in the relation.

Product Availability

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

Returns:

The resultPairCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRelationElement

void getRelationElement(int i,
                        int[] left,
                        int[] right)
                        throws IOException,
                               AutomationException

The ith element of the relation. The indexes refer to elements of the left and right operand geometry bags.

Product Availability

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

Parameters:

i - The i (in)

left - The left (out: use single element array)

right - The right (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRelationElement

void setRelationElement(int i,
                        int left,
                        int right)
                        throws IOException,
                               AutomationException

The ith element of the relation. The indexes refer to elements of the left and right operand geometry bags.

Product Availability

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

Parameters:

i - The i (in)

left - The left (in)

right - The right (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRelationElements

void setRelationElements(int cPairs,
                         esriRelationPair pairs)
                         throws IOException,
                                AutomationException

Sets RelationResult with an array of relations.

Product Availability

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

Parameters:

cPairs - The cPairs (in)

pairs - A Structure: com.esri.arcgis.geometry.esriRelationPair (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

sortRight

void sortRight()
               throws IOException,
                      AutomationException

Sort the set according to the right index.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

sortLeft

void sortLeft()
              throws IOException,
                     AutomationException

Sort the set according to the left index.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

flipRelations

void flipRelations()
                   throws IOException,
                          AutomationException

Flips the left and right indexes of all the elements of the relation.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

subtract

void subtract(IRelationResult pRelations)
              throws IOException,
                     AutomationException

Finds elements existing in another relation set and delete them from this set.

Product Availability

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

Parameters:

pRelations - A reference to a com.esri.arcgis.geometry.IRelationResult (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

intersect

void intersect(IRelationResult pRelations)
               throws IOException,
                      AutomationException

Construct the set with only those elements that exist in both relation sets.

Product Availability

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

Parameters:

pRelations - A reference to a com.esri.arcgis.geometry.IRelationResult (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

add

void add(IRelationResult pRelations)
         throws IOException,
                AutomationException

Add elements of other Relation to the end of this Relations, and the set is re-sorted.

Product Availability

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

Parameters:

pRelations - A reference to a com.esri.arcgis.geometry.IRelationResult (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.