com.esri.arcgis.display
Class GeometricEffectWave

java.lang.Object
  com.esri.arcgis.display.GeometricEffectWave

All Implemented Interfaces:

IEditInteraction, IGeometricEffect, IGraphicAttributes, IGraphicAttributes2, com.esri.arcgis.interop.RemoteObjRef, IDocumentVersionSupportGEN, IPersist, IPersistStream, Externalizable, Serializable

public class GeometricEffectWave
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGeometricEffect, IGraphicAttributes, IGraphicAttributes2, IEditInteraction, IPersist, IPersistStream, IDocumentVersionSupportGEN, Externalizable

Creates a regular wave from a curve.

Description

This object is new at ArcGIS 9.3.

Remarks

Graphic attributes defining this object are listed in the following enumeration esriGeometricEffectAttributes.

Geometric Effect is a dynamic process that alters the geometry of feature representations. Effects can be added to either a basic symbol layer or at a representation rule level making it globally applicable to all symbol layers present for that rule to create complex symbols.

This geometric effect can be managed by one of the following graphic attributes:

• esriGAWavePeriod - esriAttributeTypeSize
• esriGAWaveWidth - esriAttributeTypeSize
• esriGAWaveStyle - esriAttributeTypeEnum
• esriGAWaveSeed - esriAttributeTypeInteger

Product Availability

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

See Also:

Serialized Form

Constructor Summary

GeometricEffectWave()
Constructs a GeometricEffectWave using ArcGIS Engine.

GeometricEffectWave(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GeometricEffectWave theGeometricEffectWave = (GeometricEffectWave) obj;

Method Summary

Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
boolean	equals(Object o) Compare this object with another
String	getCaption(int attrId) Caption of the graphic attribute.
String	getClassCaption(int geomType) Caption of the object containing the graphic attributes.
void	getClassID(GUID[] pClassID) getClassID
String	getClassName() Class name of the graphic attribute.
static String	getClsid() getClsid.
int	getGraphicAttributeCount() Number of graphic attributes.
int	getID(int attrIndex) ID of graphic attributes.
int	getIDByName(String name) ID of the graphic attribute, given its name.
String	getName(int attrId) Name of the graphic attribute.
int	getOutputType(int inputType) The output type of the geometric effect.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
IGraphicAttributeType	getType(int attrId) Type of the graphic attribute.
Object	getValue(int attrId) Value of the graphic attribute.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isEditableAttribute(Object editParams, int attrIndex) Indicates if a graphic attribute is editable by a representation tool.
boolean	isSupportedAtVersion(int docVersion) Is this object valid at the given document version.
void	load(IStream pstm) load
void	modifyAttributes(Object editParams, Object attrArray) Modifies the graphic attributes according to the editing parameters of the representation tool.
IGeometry	nextGeometry() Accesses the next geometry generated by th effect.
void	readExternal(ObjectInput in)
void	reset(IGeometry geometry) Resets the collection of generated geometries.
void	save(IStream pstm, int fClearDirty) save
void	setValue(int attrId, Object val) Value of the graphic attribute.
void	writeExternal(ObjectOutput out)

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

GeometricEffectWave

public GeometricEffectWave()
                    throws IOException,
                           UnknownHostException

Constructs a GeometricEffectWave using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GeometricEffectWave

public GeometricEffectWave(Object obj)
                    throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GeometricEffectWave theGeometricEffectWave = (GeometricEffectWave) obj;

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

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

getOutputType

public int getOutputType(int inputType)
                  throws IOException,
                         AutomationException

The output type of the geometric effect.

Product Availability

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

Specified by:

getOutputType in interface IGeometricEffect

Parameters:

inputType - A com.esri.arcgis.geometry.esriGeometryType constant (in)

Returns:

A com.esri.arcgis.geometry.esriGeometryType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reset

public void reset(IGeometry geometry)
           throws IOException,
                  AutomationException

Resets the collection of generated geometries. Must be called before using NextGeometry.

Product Availability

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

Specified by:

reset in interface IGeometricEffect

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

nextGeometry

public IGeometry nextGeometry()
                       throws IOException,
                              AutomationException

Accesses the next geometry generated by th effect.

Product Availability

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

Specified by:

nextGeometry in interface IGeometricEffect

Returns:

A reference to a com.esri.arcgis.geometry.IGeometry

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGraphicAttributeCount

public int getGraphicAttributeCount()
                             throws IOException,
                                    AutomationException

Number of graphic attributes.

Product Availability

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

Specified by:

getGraphicAttributeCount in interface IGraphicAttributes

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getID

public int getID(int attrIndex)
          throws IOException,
                 AutomationException

ID of graphic attributes.

Product Availability

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

Specified by:

getID in interface IGraphicAttributes

Parameters:

attrIndex - The attrIndex (in)

Returns:

The attrId

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public String getName(int attrId)
               throws IOException,
                      AutomationException

Name of the graphic attribute.

Product Availability

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

Specified by:

getName in interface IGraphicAttributes

Parameters:

attrId - The attrId (in)

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getType

public IGraphicAttributeType getType(int attrId)
                              throws IOException,
                                     AutomationException

Type of the graphic attribute.

Product Availability

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

Specified by:

getType in interface IGraphicAttributes

Parameters:

attrId - The attrId (in)

Returns:

A reference to a com.esri.arcgis.display.IGraphicAttributeType

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getValue

public Object getValue(int attrId)
                throws IOException,
                       AutomationException

Value of the graphic attribute. To erase override, set value to NULL or to original value.

Product Availability

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

Specified by:

getValue in interface IGraphicAttributes

Parameters:

attrId - The attrId (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setValue

public void setValue(int attrId,
                     Object val)
              throws IOException,
                     AutomationException

Value of the graphic attribute. To erase override, set value to NULL or to original value.

Product Availability

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

Specified by:

setValue in interface IGraphicAttributes

Parameters:

attrId - The attrId (in)

val - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIDByName

public int getIDByName(String name)
                throws IOException,
                       AutomationException

ID of the graphic attribute, given its name.

Product Availability

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

Specified by:

getIDByName in interface IGraphicAttributes

Parameters:

name - The name (in)

Returns:

The index

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassName

public String getClassName()
                    throws IOException,
                           AutomationException

Class name of the graphic attribute.

Product Availability

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

Specified by:

getClassName in interface IGraphicAttributes

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCaption

public String getCaption(int attrId)
                  throws IOException,
                         AutomationException

Caption of the graphic attribute.

Product Availability

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

Specified by:

getCaption in interface IGraphicAttributes2

Parameters:

attrId - The attrId (in)

Returns:

The caption

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassCaption

public String getClassCaption(int geomType)
                       throws IOException,
                              AutomationException

Caption of the object containing the graphic attributes.

Product Availability

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

Specified by:

getClassCaption in interface IGraphicAttributes2

Parameters:

geomType - A com.esri.arcgis.geometry.esriGeometryType constant (in)

Returns:

The caption

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEditableAttribute

public boolean isEditableAttribute(Object editParams,
                                   int attrIndex)
                            throws IOException,
                                   AutomationException

Indicates if a graphic attribute is editable by a representation tool.

Product Availability

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

Specified by:

isEditableAttribute in interface IEditInteraction

Parameters:

editParams - A Variant (in)

attrIndex - The attrIndex (in)

Returns:

The isEditable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

modifyAttributes

public void modifyAttributes(Object editParams,
                             Object attrArray)
                      throws IOException,
                             AutomationException

Modifies the graphic attributes according to the editing parameters of the representation tool.

Product Availability

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

Specified by:

modifyAttributes in interface IEditInteraction

Parameters:

editParams - A Variant (in)

attrArray - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws IOException,
                                    AutomationException

Is this object valid at the given document version.

Remarks

Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream. This result is based on the esriArcGISVersion enumeration. In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.

Product Availability

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

Specified by:

isSupportedAtVersion in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

The supported

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public Object convertToSupportedObject(int docVersion)
                                throws IOException,
                                       AutomationException

Convert the object to another object that is supported.

Remarks

This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE. Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version. Not all objects will return a supported object; in these cases a null pointer will be returned.

Product Availability

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

Specified by:

convertToSupportedObject in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException