com.esri.arcgis.schematic
Interface INgPole

All Superinterfaces:

Serializable

All Known Implementing Classes:

INgPoleProxy, NgPole

public interface INgPole
extends Serializable

Provides access to members that control the pole.

Description

A pole is an object that symbolizes the connection between a flag and the network element it is associated with. It is represented by a vector segment.

For maximum quality graphics, pole ports, or special (hidden) points onto which flag poles are to be connected, can be defined for node and flag symbols. The pole will then be calculated so as to automatically snap to the nearest flag and associated element pole ports.

Product Availability

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

Method Summary

Object	getEffect(int effect) Returns the effect 'effect' set for the pole (see esriNgPoleEffect).
INgPoint	getExtremityPoint(INgView view) Returns the end point of the pole in the view 'view'.
INgPoint	getOriginPoint(INgView view) Returns the origin point of the pole in the view 'view'.
boolean	isEffectSet(int effect) Indicates if the effect 'effect' related to the pole is set (see esriNgPoleEffect).
void	removeEffect(int effect) Removes the effect or restores the default effect 'effect' set for the pole (see esriNgPoleEffect).
void	setEffect(int effect, Object effValue) Modifies the effect 'effect' set for the pole (see esriNgPoleEffect).

Method Detail

getEffect

Object getEffect(int effect)
                 throws IOException,
                        AutomationException

Returns the effect 'effect' set for the pole (see esriNgPoleEffect).

Product Availability

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

Parameters:

effect - A com.esri.arcgis.schematic.esriNgPoleEffect constant (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgPole.setEffect(int, java.lang.Object), INgPole.removeEffect(int), INgPole.isEffectSet(int)

setEffect

void setEffect(int effect,
               Object effValue)
               throws IOException,
                      AutomationException

Modifies the effect 'effect' set for the pole (see esriNgPoleEffect).

Description

A pole is an object that symbolizes the connection between a flag and the network element it is associated with. It is represented by a vector segment.

For maximum quality graphics, pole ports, or special (hidden) points onto which flag poles are to be connected, can be defined for node and flag symbols. The pole will then be calculated so as to automatically snap to the nearest flag and associated element pole ports.

Product Availability

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

Parameters:

effect - A com.esri.arcgis.schematic.esriNgPoleEffect constant (in)

effValue - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgPole.removeEffect(int), INgPole.getEffect(int), INgPole.isEffectSet(int)

removeEffect

void removeEffect(int effect)
                  throws IOException,
                         AutomationException

Removes the effect or restores the default effect 'effect' set for the pole (see esriNgPoleEffect).

Description

Note that when removing an effect that is always set, the pole default effect value is automatically restored; and removing an effect that is not set by default, really removes the pole effect.

Product Availability

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

Parameters:

effect - A com.esri.arcgis.schematic.esriNgPoleEffect constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgPole.setEffect(int, java.lang.Object), INgPole.getEffect(int), INgPole.isEffectSet(int)

isEffectSet

boolean isEffectSet(int effect)
                    throws IOException,
                           AutomationException

Indicates if the effect 'effect' related to the pole is set (see esriNgPoleEffect).

Description

By default, Schematics automatically sets default values for some pole effects (see the List of the pole default effect values, below). For all these effects, the IsEffectSet method returns True. For the other effects (those that are not automatically set by default), the IsEffectSet method returns True only if the effect has been set:

- Either when defining the pole's characteristics in ArcGIS Schematics Designer

- Or by calling the SetEffect method in the code project.

List of the pole effect default values

esriNgPoleDetectability: esriNgDetectable

esriNgPoleHighlightedState: esriNgNotHighlighted

esriNgPolePriority: 50 or more

esriNgPoleSelectability: esriNgSelectable

esriNgPoleVisibility: esriNgVisible

For more details, see Pole Effects Definition.

Product Availability

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

Parameters:

effect - A com.esri.arcgis.schematic.esriNgPoleEffect constant (in)

Returns:

The isSet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgPole.setEffect(int, java.lang.Object), INgPole.removeEffect(int), INgPole.getEffect(int)

getOriginPoint

INgPoint getOriginPoint(INgView view)
                        throws IOException,
                               AutomationException

Returns the origin point of the pole in the view 'view'.

Description

You can specify the view where the pole is displayed. In fact, if your pole appears in two views (for example, one view and its associated view) and if symbol scaling is different in these views, the origin point of the pole could be different in the two views.

Product Availability

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

Parameters:

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgPole.getExtremityPoint(com.esri.arcgis.schematic.INgView)

getExtremityPoint

INgPoint getExtremityPoint(INgView view)
                           throws IOException,
                                  AutomationException

Returns the end point of the pole in the view 'view'.

Description

You can specify the view where the pole is displayed. In fact, if your pole appears in two views (for example, one view and its associated view) and if symbol scaling is different in these views, the end point of the pole could be different in the two views.

Product Availability

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

Parameters:

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgPole.getOriginPoint(com.esri.arcgis.schematic.INgView)