com.esri.arcgis.datasourcesraster
Class LSRXform

java.lang.Object
  com.esri.arcgis.datasourcesraster.LSRXform

All Implemented Interfaces:

ILSRXform, IGeodataXform, ITransformation, com.esri.arcgis.interop.RemoteObjRef, IClone, IDocumentVersionSupportGEN, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, Externalizable, Serializable

public class LSRXform
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ILSRXform, ITransformation, IClone, IPersistStream, IDocumentVersionSupportGEN, IXMLSerialize, IXMLVersionSupport, Externalizable

A Local Space Rectangular transform class.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

LSRXform()
Constructs a LSRXform using ArcGIS Engine.

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

Method Summary

void	assign(IClone src) Assigns the properties of src to the receiver.
Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
IGeometryCollection	getDomains() The domains in output space.
double	getEquatorialRadius() The earth Equatorial radius.
double	getFlattening() The earth flattening.
String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
IPoint	getPerspectiveCenter() The sensor position.
Object	getRotationMatrix() The 3x3 rotation matrix.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
ISpatialReference	getSpatialReference() The output spatial reference after applying this transform.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
boolean	isIdentity() Indicates if this geodata transform is an identity transform.
boolean	isSupportedAtVersion(int docVersion) Is this object valid at the given document version.
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setEquatorialRadius(double pRadius) The earth Equatorial radius.
void	setFlattening(double pFlattening) The earth flattening.
void	setPerspectiveCenterByRef(IPoint ppCenter) The sensor position.
void	setRotationMatrix(Object pMatrix) The 3x3 rotation matrix.
void	setSpatialReferenceByRef(ISpatialReference ppSpatialRefence) The output spatial reference after applying this transform.
void	transform(int direction, int npoints, _WKSPoint[] points) Transforms a set of points in a given direction.
void	transformCellsize(int direction, double[] dx, double[] dy, IEnvelope pAreaOfInterest) Transforms a cellsize in a given direction.
void	transformExtent(int direction, IEnvelope[] pExtent) Transforms an extent in a given direction.
void	transformMeasuresFF(int direction, int cMeasures, double[] inMeasures, double[] outMeasures) Transforms floating point measures to floating point measures (or do the inverse).
void	transformMeasuresFI(int direction, int cMeasures, double[] inMeasures, int[] outMeasures) Transforms floating point measures to integer measures (or do the inverse).
void	transformMeasuresIF(int direction, int cMeasures, int[] inMeasures, double[] outMeasures) Transforms integer measures to floating point measures (or do the inverse).
void	transformMeasuresII(int direction, int cMeasures, int[] inMeasures, int[] outMeasures) Transforms integer measures to integer measures (or do the inverse).
void	transformPoints(int direction, IPointCollection[] pPoints) Transforms a point collection in a given direction
void	transformPointsFF(int direction, int cPoints, double[] inPoints, double[] outPoints) Transforms floating point points to floating point points (or do the inverse).
void	transformPointsFI(int direction, int cPoints, double[] inPoints, int[] outPoints) Transforms floating point points to integer points (or do the inverse).
void	transformPointsIF(int direction, int cPoints, int[] inPoints, double[] outPoints) Transforms integer points to floating point points (or do the inverse).
void	transformPointsII(int direction, int cPoints, int[] inPoints, int[] outPoints) Transforms integer points to integer points (or do the inverse).
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

LSRXform

public LSRXform()
         throws IOException,
                UnknownHostException

Constructs a LSRXform using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

LSRXform

public LSRXform(Object obj)
         throws IOException

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

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

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

getPerspectiveCenter

public IPoint getPerspectiveCenter()
                            throws IOException,
                                   AutomationException

The sensor position.

Product Availability

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

Specified by:

getPerspectiveCenter in interface ILSRXform

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPerspectiveCenterByRef

public void setPerspectiveCenterByRef(IPoint ppCenter)
                               throws IOException,
                                      AutomationException

The sensor position.

Remarks

The perspective center refers to both the sensor location and the origin of the local space rectangular coordinate system for the frame.

Product Availability

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

Specified by:

setPerspectiveCenterByRef in interface ILSRXform

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRotationMatrix

public Object getRotationMatrix()
                         throws IOException,
                                AutomationException

The 3x3 rotation matrix.

Product Availability

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

Specified by:

getRotationMatrix in interface ILSRXform

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRotationMatrix

public void setRotationMatrix(Object pMatrix)
                       throws IOException,
                              AutomationException

The 3x3 rotation matrix.

Description

Used to rotate the image based on the sensor orientation. See IFrameXform::putPerspectiveMatrix for additional information.

Product Availability

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

Specified by:

setRotationMatrix in interface ILSRXform

Parameters:

pMatrix - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFlattening

public double getFlattening()
                     throws IOException,
                            AutomationException

The earth flattening.

Product Availability

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

Specified by:

getFlattening in interface ILSRXform

Returns:

The pFlattening

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFlattening

public void setFlattening(double pFlattening)
                   throws IOException,
                          AutomationException

The earth flattening.

Remarks

Each ellipsoid model is defined by the equatorial radius in meters and a flattening factor, typically around 0.003 (or 1/298). The exact values for many ellipsoid models are published. Sometimes the flattening is expressed as the inverse value (298.1234), but in this case the actual flattening value is required.

Product Availability

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

Specified by:

setFlattening in interface ILSRXform

Parameters:

pFlattening - The pFlattening (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEquatorialRadius

public double getEquatorialRadius()
                           throws IOException,
                                  AutomationException

The earth Equatorial radius.

Product Availability

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

Specified by:

getEquatorialRadius in interface ILSRXform

Returns:

The pRadius

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEquatorialRadius

public void setEquatorialRadius(double pRadius)
                         throws IOException,
                                AutomationException

The earth Equatorial radius.

Remarks

See put_Flattening for more information.

Product Availability

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

Specified by:

setEquatorialRadius in interface ILSRXform

Parameters:

pRadius - The pRadius (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws IOException,
                                             AutomationException

The output spatial reference after applying this transform.

Product Availability

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

Specified by:

getSpatialReference in interface IGeodataXform

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSpatialReferenceByRef

public void setSpatialReferenceByRef(ISpatialReference ppSpatialRefence)
                              throws IOException,
                                     AutomationException

The output spatial reference after applying this transform.

Product Availability

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

Specified by:

setSpatialReferenceByRef in interface IGeodataXform

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDomains

public IGeometryCollection getDomains()
                               throws IOException,
                                      AutomationException

The domains in output space.

Description

The returned domains should a single polygon geometry or a collection of polygons.

Product Availability

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

Specified by:

getDomains in interface IGeodataXform

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentity

public boolean isIdentity()
                   throws IOException,
                          AutomationException

Indicates if this geodata transform is an identity transform.

Product Availability

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

Specified by:

isIdentity in interface IGeodataXform

Returns:

The pIsIdentity

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

transform

public void transform(int direction,
                      int npoints,
                      _WKSPoint[] points)
               throws IOException,
                      AutomationException

Transforms a set of points in a given direction.

Product Availability

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

Specified by:

transform in interface IGeodataXform

Parameters:

direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in)

npoints - The npoints (in)

points - A Structure: com.esri.arcgis.system._WKSPoint (A com.esri.arcgis.system._WKSPoint COM typedef) (in/out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

transformCellsize

public void transformCellsize(int direction,
                              double[] dx,
                              double[] dy,
                              IEnvelope pAreaOfInterest)
                       throws IOException,
                              AutomationException

Transforms a cellsize in a given direction.

Product Availability

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

Specified by:

transformCellsize in interface IGeodataXform

Parameters:

direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in)

dx - The dx (in/out: use single element array)

dy - The dy (in/out: use single element array)

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

transformExtent

public void transformExtent(int direction,
                            IEnvelope[] pExtent)
                     throws IOException,
                            AutomationException

Transforms an extent in a given direction.

Product Availability

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

Specified by:

transformExtent in interface IGeodataXform

Parameters:

direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in)

pExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in/out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

transformPoints

public void transformPoints(int direction,
                            IPointCollection[] pPoints)
                     throws IOException,
                            AutomationException

Transforms a point collection in a given direction

Product Availability

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

Specified by:

transformPoints in interface IGeodataXform

Parameters:

direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in)

pPoints - A reference to a com.esri.arcgis.geometry.IPointCollection (in/out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

transformMeasuresFF

public void transformMeasuresFF(int direction,
                                int cMeasures,
                                double[] inMeasures,
                                double[] outMeasures)
                         throws IOException,
                                AutomationException

Transforms floating point measures to floating point measures (or do the inverse).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

transformMeasuresFF in interface ITransformation

Parameters:

direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in)

cMeasures - The cMeasures (in)

inMeasures - The inMeasures (in)

outMeasures - The outMeasures (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

transformMeasuresFI

public void transformMeasuresFI(int direction,
                                int cMeasures,
                                double[] inMeasures,
                                int[] outMeasures)
                         throws IOException,
                                AutomationException

Transforms floating point measures to integer measures (or do the inverse).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

transformMeasuresFI in interface ITransformation

Parameters:

direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in)

cMeasures - The cMeasures (in)

inMeasures - The inMeasures (in)

outMeasures - The outMeasures (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

transformMeasuresIF

public void transformMeasuresIF(int direction,
                                int cMeasures,
                                int[] inMeasures,
                                double[] outMeasures)
                         throws IOException,
                                AutomationException

Transforms integer measures to floating point measures (or do the inverse).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

transformMeasuresIF in interface ITransformation

Parameters:

direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in)

cMeasures - The cMeasures (in)

inMeasures - The inMeasures (in)

outMeasures - The outMeasures (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

transformMeasuresII

public void transformMeasuresII(int direction,
                                int cMeasures,
                                int[] inMeasures,
                                int[] outMeasures)
                         throws IOException,
                                AutomationException

Transforms integer measures to integer measures (or do the inverse).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

transformMeasuresII in interface ITransformation

Parameters:

direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in)

cMeasures - The cMeasures (in)

inMeasures - The inMeasures (in)

outMeasures - The outMeasures (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

transformPointsFF

public void transformPointsFF(int direction,
                              int cPoints,
                              double[] inPoints,
                              double[] outPoints)
                       throws IOException,
                              AutomationException

Transforms floating point points to floating point points (or do the inverse).

Remarks

The cPoints parameter is the number of points you wish to transform. inPoints and outPoints are one-dimensional arrays so you must interleave coordinate pairs into the arrays.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

transformPointsFF in interface ITransformation

Parameters:

direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in)

cPoints - The cPoints (in)

inPoints - The inPoints (in)

outPoints - The outPoints (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

transformPointsFI

public void transformPointsFI(int direction,
                              int cPoints,
                              double[] inPoints,
                              int[] outPoints)
                       throws IOException,
                              AutomationException

Transforms floating point points to integer points (or do the inverse).

Remarks

The cPoints parameter is the number of points you wish to transform. inPoints and outPoints are one-dimensional arrays so you must interleave coordinate pairs into the arrays.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

transformPointsFI in interface ITransformation

Parameters:

direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in)

cPoints - The cPoints (in)

inPoints - The inPoints (in)

outPoints - The outPoints (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

transformPointsIF

public void transformPointsIF(int direction,
                              int cPoints,
                              int[] inPoints,
                              double[] outPoints)
                       throws IOException,
                              AutomationException

Transforms integer points to floating point points (or do the inverse).

Remarks

The cPoints parameter is the number of points you wish to transform. inPoints and outPoints are one-dimensional arrays so you must interleave coordinate pairs into the arrays.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

transformPointsIF in interface ITransformation

Parameters:

direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in)

cPoints - The cPoints (in)

inPoints - The inPoints (in)

outPoints - The outPoints (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

transformPointsII

public void transformPointsII(int direction,
                              int cPoints,
                              int[] inPoints,
                              int[] outPoints)
                       throws IOException,
                              AutomationException

Transforms integer points to integer points (or do the inverse).

Remarks

The cPoints parameter is the number of points you wish to transform. inPoints and outPoints are one-dimensional arrays so you must interleave coordinate pairs into the arrays.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

transformPointsII in interface ITransformation

Parameters:

direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in)

cPoints - The cPoints (in)

inPoints - The inPoints (in)

outPoints - The outPoints (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Product Availability

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

Specified by:

esri_clone in interface IClone

Returns:

A reference to a com.esri.arcgis.system.IClone

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

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.

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.

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.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException

Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException

Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinNamespaceSupported

public String getMinNamespaceSupported()
                                throws IOException,
                                       AutomationException

The minimum namespace the class can serialize to (eg the 90 namespace).

Product Availability

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

Specified by:

getMinNamespaceSupported in interface IXMLVersionSupport

Returns:

The namespaceURI

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