|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.datasourcesraster.FunctionRasterDataset
public class FunctionRasterDataset
A class for a function raster dataset.
Constructor Summary | |
---|---|
FunctionRasterDataset()
Constructs a FunctionRasterDataset using ArcGIS Engine. |
|
FunctionRasterDataset(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. FunctionRasterDataset theFunctionRasterDataset = (FunctionRasterDataset) obj; |
Method Summary | |
---|---|
void |
add(IRasterBand element,
int index)
Adds a RasterBand to the band collection. |
void |
alterDefinition()
Saves any changes made to this dataset. |
void |
appendBand(IRasterBand element)
Appends a RasterBand to the band collection. |
void |
appendBands(IRasterBandCollection bands)
Appends a collection of RasterBands to the band collection. |
boolean |
canCopy()
Returns true if this dataset can be copied. |
boolean |
canDelete()
True if this dataset can be deleted. |
boolean |
canRename()
True if this dataset can be renamed. |
void |
clear()
Removes all the elements in the collection. |
void |
clearCache()
Clear the cache. |
IGeometry |
computeFootprint(int maximumVertices)
Computes the footprint. |
IDataset |
copy(String copyName,
IWorkspace copyWorkspace)
Copies this dataset to a new dataset with the specified name. |
IRaster |
createDefaultRaster()
Creates a raster object with the default properties for this dataset. |
IRaster |
createFullRaster()
Creates a raster containing all bands in this raster dataset. |
IRaster |
createRaster()
Creates an empty raster. |
void |
delete()
Deletes this dataset. |
boolean |
equals(Object o)
Compare this object with another |
void |
findMemberFunctionsArgumentsByCLSID(IUID functionArgumentsCLSID,
IArray ppMatchingFunctionArguments)
Finds raster function arguments in this dataset that match the given function arguments CLSID. |
IArray |
findMemberFunctionsByCLSID(IUID rasterFunctionCLSID)
Finds raster functions in this dataset that match the given function CLSID. |
IArray |
findMemberFunctionsByName(String rasterFunctionName)
Finds raster functions in this dataset that match the given function name. |
Object |
getArguments()
The raster function arguments. |
IRasterBand |
getBandByName(String name)
A RasterBand given its name. |
int |
getBandIndex(String name)
The index of a RasterBand given its name. |
IEnumRasterBand |
getBands()
All the bands in the collection as an interface to the RasterBands enumerator object. |
int |
getBlockHeight()
The native block height. |
int |
getBlockWidth()
The native block width. |
String |
getBrowseName()
The browse name of the dataset. |
String |
getCategory()
The category of the dataset. |
void |
getClassID(GUID[] pClassID)
getClassID |
static String |
getClsid()
getClsid. |
String |
getCompleteName()
The full path of the RasterDataset. |
String |
getCompressionType()
The compression technique applied to this RasterDataset. |
int |
getCount()
The number of bands in the collection. |
IEnvelope |
getExtent()
The extent of the GeoDataset. |
void |
getFiles(IGeometry pGeometry,
IStringArray ppFiles)
Gets source files within a given clipping geometry. |
int |
getFirstPyramidLevel()
The first available pyramid level. |
String |
getFormat()
The format of this RasterRataset. |
IName |
getFullName()
The associated name object. |
IRasterFunction |
getFunction()
The raster function. |
IGeodataXform |
getGeodataXform()
The geodata transformation of the GeoDataset. |
IRasterLODInfos |
getLODInfos()
The custom LOD infos. |
int |
getMaximumPyramidLevel()
The maximum available pyramid level. |
IArray |
getMemberDatasetNames()
The constituent datasets names referenced by this function raster dataset. |
IArray |
getMemberRasterDatasets()
The constituent raster datasets in this function raster dataset. |
IPropertySet |
getMetadata()
The PropertySet containing metadata. |
String |
getName()
The name of the Dataset. |
IEnvelope |
getNativeExtent()
The native extent of the GeoDataset (before transformation applied). |
ISpatialReference |
getNativeSpatialReference()
The native spatial reference of the GeoDataset (before transformation applied). |
INativeType |
getNativeType()
The native type. |
IStringArray |
getPaths()
Returns all paths associated with the object. |
IPropertySet |
getProperties()
The function raster dataset proprties. |
IPropertySet |
getPropertySet()
The set of properties for the dataset. |
IRasterInfo |
getRasterInfo()
The raster information. |
String |
getSensorType()
The sensor type used for this RasterDataset. |
void |
getSizeMax(_ULARGE_INTEGER[] pcbSize)
getSizeMax |
ISpatialReference |
getSpatialReference()
The spatial reference of the GeoDataset. |
IRasterDataset |
getSubRasterDatasetByID(int subdatasetID)
The given subdataset by id. |
IRasterDataset |
getSubRasterDatasetByName(String subdatasetName)
The given subdataset by name. |
String |
getSubRasterDatasetCompleteName(int subdatasetID)
The given subdataset's complete name. |
int |
getSubRasterDatasetCount()
The number of subdatasets. |
IName |
getSubRasterDatasetFullName(int subdatasetID)
The given subdataset's full name. |
String |
getSubRasterDatasetName(int subdatasetID)
The given subdataset's name. |
IEnumDataset |
getSubsets()
Datasets contained within this dataset. |
int |
getType()
The type of the Dataset. |
IWorkspace |
getWorkspace()
The workspace containing this dataset. |
int |
hashCode()
the hashcode for this object |
void |
init(IRasterFunction pFunction,
Object pArguments)
Initializes this function raster dataset. |
boolean |
isCacheStale()
Indicates if the raster cache is stale and needs to be refreshed. |
boolean |
isCanEditMetadata()
Indicates if metadata can be edited. |
boolean |
isCanWrite()
Indicates if this RasterDataset is writable. |
void |
isDirty()
isDirty |
boolean |
isDynamic()
Indicates the collection is dynamic. |
boolean |
isEmpty()
Indicates whether the raster dataset is empty. |
boolean |
isTemporary()
Indicates if the dataset is temporary. |
IRasterBand |
item(int bandIndex)
Returns a RasterBand given its index. |
void |
load(IStream pstm)
load |
void |
makePermanent()
Persists this temporary dataset permanent. |
IDataset |
makePermanentAs(String new_name,
IWorkspace workspace,
String format)
Persists this temporary dataset to a new permanent dataset. |
void |
precalculateStats(Object index_list)
Calculates statistics and histograms for specified bands. |
void |
read(IPnt tlc,
IRaster raster,
IPixelBlock pixelBlock)
Reads a block of pixels starting from the top left corner. |
void |
readExternal(ObjectInput in)
|
void |
readPyramid(IPnt tlc,
int pyramidLevel,
IRaster raster,
IPixelBlock pixelBlock)
Reads a block of pixels at a given pyramid level. |
void |
refresh()
Refreshes opened RasterDataset. |
void |
refreshCache()
Refresh raster cache. |
void |
remove(int index)
Removes an element from the collection. |
void |
rename(String name)
Renames this Dataset. |
void |
replacePaths(IStringArray pOldPaths,
IStringArray pNewPaths)
Updates all paths associated with the object using the specified mapping rule. |
void |
save(IStream pstm,
int fClearDirty)
save |
IDataset |
saveAs(String new_name,
IWorkspace worksp,
String format)
Creates a new persistent RasterDataset with the bands in the collection. |
void |
setArgumentsByRef(Object ppArguments)
The raster function arguments. |
void |
setBrowseName(String name)
The browse name of the dataset. |
void |
setFullNameByRef(IName rhs1)
The name of this function raster dataset. |
void |
setFunctionByRef(IRasterFunction ppFunction)
The raster function. |
void |
setMetadata(IPropertySet ppPropertySet)
The PropertySet containing metadata. |
void |
setPropertiesByRef(IPropertySet ppProperties)
The function raster dataset proprties. |
void |
simplify()
Simplifies the function raster dataset by removing redundant raster functions. |
void |
synchronize()
Synchronizes changes. |
void |
synchronize(int action,
int interval)
Updates metadata with the current properties; may create metadata if it doesn't already exist. |
void |
write(IPnt tlc,
IRaster raster,
int mode,
IPixelBlock pixelBlock)
Writes a block of pixels starting from the top left corner. |
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 |
---|
public FunctionRasterDataset() throws IOException, UnknownHostException
IOException
- if there are interop problems
UnknownHostException
- if there are interop problemspublic FunctionRasterDataset(Object obj) throws IOException
FunctionRasterDataset theFunctionRasterDataset = (FunctionRasterDataset) obj;
obj
to FunctionRasterDataset
.
obj
- an object returned from ArcGIS Engine or Server
IOException
- if there are interop problemsMethod Detail |
---|
public static String getClsid()
public boolean equals(Object o)
equals
in class Object
public int hashCode()
hashCode
in class Object
public void setFullNameByRef(IName rhs1) throws IOException, AutomationException
setFullNameByRef
in interface IFunctionRasterDataset
rhs1
- A reference to a com.esri.arcgis.system.IName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void init(IRasterFunction pFunction, Object pArguments) throws IOException, AutomationException
init
in interface IFunctionRasterDataset
pFunction
- A reference to a com.esri.arcgis.datasourcesraster.IRasterFunction (in)pArguments
- A reference to another Object (IUnknown) (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IRasterFunction getFunction() throws IOException, AutomationException
getFunction
in interface IFunctionRasterDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setFunctionByRef(IRasterFunction ppFunction) throws IOException, AutomationException
setFunctionByRef
in interface IFunctionRasterDataset
ppFunction
- A reference to a com.esri.arcgis.datasourcesraster.IRasterFunction (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public Object getArguments() throws IOException, AutomationException
getArguments
in interface IFunctionRasterDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setArgumentsByRef(Object ppArguments) throws IOException, AutomationException
setArgumentsByRef
in interface IFunctionRasterDataset
ppArguments
- A reference to another Object (IUnknown) (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IPropertySet getProperties() throws IOException, AutomationException
getProperties
in interface IFunctionRasterDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setPropertiesByRef(IPropertySet ppProperties) throws IOException, AutomationException
setPropertiesByRef
in interface IFunctionRasterDataset
ppProperties
- A reference to a com.esri.arcgis.system.IPropertySet (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IRasterInfo getRasterInfo() throws IOException, AutomationException
getRasterInfo
in interface IFunctionRasterDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void alterDefinition() throws IOException, AutomationException
alterDefinition
in interface IFunctionRasterDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IArray getMemberRasterDatasets() throws IOException, AutomationException
getMemberRasterDatasets
in interface IFunctionRasterDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IArray getMemberDatasetNames() throws IOException, AutomationException
getMemberDatasetNames
in interface IFunctionRasterDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IArray findMemberFunctionsByCLSID(IUID rasterFunctionCLSID) throws IOException, AutomationException
findMemberFunctionsByCLSID
in interface IFunctionRasterDataset
rasterFunctionCLSID
- A reference to a com.esri.arcgis.system.IUID (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IArray findMemberFunctionsByName(String rasterFunctionName) throws IOException, AutomationException
findMemberFunctionsByName
in interface IFunctionRasterDataset
rasterFunctionName
- The rasterFunctionName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void findMemberFunctionsArgumentsByCLSID(IUID functionArgumentsCLSID, IArray ppMatchingFunctionArguments) throws IOException, AutomationException
findMemberFunctionsArgumentsByCLSID
in interface IFunctionRasterDataset
functionArgumentsCLSID
- A reference to a com.esri.arcgis.system.IUID (in)ppMatchingFunctionArguments
- A reference to a com.esri.arcgis.system.IArray (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void simplify() throws IOException, AutomationException
simplify
in interface IFunctionRasterDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IGeometry computeFootprint(int maximumVertices) throws IOException, AutomationException
computeFootprint
in interface IFunctionRasterDataset2
maximumVertices
- The maximumVertices (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void refreshCache() throws IOException, AutomationException
refreshCache
in interface IFunctionRasterDataset2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void clearCache() throws IOException, AutomationException
clearCache
in interface IFunctionRasterDataset2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isCacheStale() throws IOException, AutomationException
isCacheStale
in interface IFunctionRasterDataset2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getFiles(IGeometry pGeometry, IStringArray ppFiles) throws IOException, AutomationException
getFiles
in interface IFunctionRasterDataset2
pGeometry
- A reference to a com.esri.arcgis.geometry.IGeometry (in)ppFiles
- A reference to a com.esri.arcgis.system.IStringArray (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void synchronize() throws IOException, AutomationException
synchronize
in interface IFunctionRasterDataset2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getFormat() throws IOException, AutomationException
getFormat
in interface IRasterDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getSensorType() throws IOException, AutomationException
getSensorType
in interface IRasterDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getCompressionType() throws IOException, AutomationException
getCompressionType
in interface IRasterDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IRaster createDefaultRaster() throws IOException, AutomationException
The CreateDefaultRaster method creates a Raster that has a square cell size and contains only three raster bands if the dataset has more than three bands. The three bands are the default bands used in raster RGB renderer and are determined by the settings for default raster behavior made on the RasterDefaultsEnv object in esriCarto library.
createDefaultRaster
in interface IRasterDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean canCopy() throws IOException, AutomationException
canCopy
in interface IDataset
canCopy
in interface IRasterDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IDataset copy(String copyName, IWorkspace copyWorkspace) throws IOException, AutomationException
copy
in interface IDataset
copy
in interface IRasterDataset
copyName
- The copyName (in)copyWorkspace
- A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void precalculateStats(Object index_list) throws IOException, AutomationException
precalculateStats
in interface IRasterDataset
index_list
- A Variant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getCompleteName() throws IOException, AutomationException
getCompleteName
in interface IRasterDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IRaster createRaster() throws IOException, AutomationException
An empty raster means that properties of the Raster are not defined. The width, height, and the number of bands of the raster are all 0. It can not be used before populating pixels to it.
createRaster
in interface IRasterDataset2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IRaster createFullRaster() throws IOException, AutomationException
createFullRaster
in interface IRasterDataset2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isEmpty() throws IOException, AutomationException
An empty raster means that properties of the Raster are not defined. The width, height, and the number of bands of the raster are all 0. It can not be used before populating pixels to it.
Co-create a Raster and IRasterDataset2::CreateRaster create an empty raster.
IRasterBandCollection::AppendBands or AppendBand allows you to populate this raster.
isEmpty
in interface IRasterDataset2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getBlockWidth() throws IOException, AutomationException
getBlockWidth
in interface IRasterDataset3
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getBlockHeight() throws IOException, AutomationException
getBlockHeight
in interface IRasterDataset3
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getMaximumPyramidLevel() throws IOException, AutomationException
getMaximumPyramidLevel
in interface IRasterDataset3
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getFirstPyramidLevel() throws IOException, AutomationException
getFirstPyramidLevel
in interface IRasterDataset3
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IRasterLODInfos getLODInfos() throws IOException, AutomationException
getLODInfos
in interface IRasterDataset3
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isCanWrite() throws IOException, AutomationException
isCanWrite
in interface IRasterDataset3
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void read(IPnt tlc, IRaster raster, IPixelBlock pixelBlock) throws IOException, AutomationException
read
in interface IRasterDataset3
tlc
- A reference to a com.esri.arcgis.geodatabase.IPnt (in)raster
- A reference to a com.esri.arcgis.geodatabase.IRaster (in)pixelBlock
- A reference to a com.esri.arcgis.geodatabase.IPixelBlock (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void write(IPnt tlc, IRaster raster, int mode, IPixelBlock pixelBlock) throws IOException, AutomationException
write
in interface IRasterDataset3
tlc
- A reference to a com.esri.arcgis.geodatabase.IPnt (in)raster
- A reference to a com.esri.arcgis.geodatabase.IRaster (in)mode
- A com.esri.arcgis.geodatabase.esriRasterWriteMode constant (in)pixelBlock
- A reference to a com.esri.arcgis.geodatabase.IPixelBlock (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void refresh() throws IOException, AutomationException
refresh
in interface IRasterDataset3
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void readPyramid(IPnt tlc, int pyramidLevel, IRaster raster, IPixelBlock pixelBlock) throws IOException, AutomationException
readPyramid
in interface IRasterDataset3
tlc
- A reference to a com.esri.arcgis.geodatabase.IPnt (in)pyramidLevel
- The pyramidLevel (in)raster
- A reference to a com.esri.arcgis.geodatabase.IRaster (in)pixelBlock
- A reference to a com.esri.arcgis.geodatabase.IPixelBlock (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getName() throws IOException, AutomationException
getName
in interface IDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IName getFullName() throws IOException, AutomationException
getFullName
in interface IDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getBrowseName() throws IOException, AutomationException
getBrowseName
in interface IDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setBrowseName(String name) throws IOException, AutomationException
setBrowseName
in interface IDataset
name
- The name (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getType() throws IOException, AutomationException
// Assume we have a reference to an IfeatureClass (pFeatureClass) IDataset pDataset = null;
pDataset = new IDatasetProxy(pFeatureClass);
System.out.println(pDataset.getName() + " " + pDataset.getType());
if(pFeatureClass != null){
pDataset = pFeatureClass.getFeatureDataset();
System.out.println(pDataset.getName() + " " + pDataset.getType());
}
pDataset = new IDatasetProxy(pDataset.getWorkspace());
System.out.println(pDataset.getName() + " " +
pDataset.getType());
getType
in interface IDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getCategory() throws IOException, AutomationException
IDataset::Category returns a description of the category of the dataset. The description returned from the Category property is the same value that is displayed in the Type column within the Contents tab in ArcCatalog. The value will contain a description of the dataset such as "Topology" prefixed with a description of the type of workspace containing the dataset such as "File Geodatabase".
The description returned from IDataset::Category may change between releases of ArcGIS. In addition to this, returned strings are localized, meaning that code relying on a specific string being provided may fail when deployed with a different version of ArcGIS than it was developed with, or when deployed to a client using a different language than it was developed with.
getCategory
in interface IDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IEnumDataset getSubsets() throws IOException, AutomationException
The Subsets property returns other Dataset objects contained in this dataset.
IDataset::Subsets is not supported for Graph objects such as a Geometric Network. To return the feature classes contained in a Geometric Network, use the IFeatureClassContainer interface.
getSubsets
in interface IDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IWorkspace getWorkspace() throws IOException, AutomationException
The Workspace property returns the containing workspace for this dataset.
getWorkspace
in interface IDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IPropertySet getPropertySet() throws IOException, AutomationException
The PropertySet property is used to return any additional intrinsic properties (but not metadata properties) that may apply to the dataset. One use of this property is to distinguish between the types of File Geodatabase datafile formats. If called on a Feature Class or Table in a File Geodatabase the Datafile Format property can either be esriFGDBStandardDatafile or esriFGDBCompressedDatafile.
Most datasets do not implement this property and will either raise an error or return a null value if it's called. There are a handful of exceptions that will return property sets; these include the datasets from file geodatabases (as mentioned above) and coverages.
Examples of intrinsic properties for which explicit methods exist include the SpatialReference and the Extent methods available on the IGeoDataset interface. In most cases this PropertySet will be empty.
IDataset::PropertySet is not supported for Graph objects such as a Geometric Network.
getPropertySet
in interface IDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean canDelete() throws IOException, AutomationException
The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods. For example, you may not delete a network feature class nor can you use the Copy method on a Geodatabase feature class. To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.
canDelete
in interface IDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void delete() throws IOException, AutomationException
Certain feature classes, such as network and topology feature classes, cannot be deleted until their containing objects are deleted.
delete
in interface IDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean canRename() throws IOException, AutomationException
The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods. For example, you may not delete or rename a network feature class nor can you use the Copy method on a Geodatabase feature class. To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.
canRename
in interface IDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void rename(String name) throws IOException, AutomationException
IDataset::Rename does not support the renaming of Graph objects such as a Geometric Network. In addition, certain feature classes, such as network feature classes, cannot be renamed.
rename
in interface IDataset
name
- The name (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ISpatialReference getSpatialReference() throws IOException, AutomationException
This property is read only. For layers, when the first layer is added to ArcMap, its spatial reference is read by this property, and the map is set to this spatial reference.
Instances of the esriCarto.GroupLayer class will return null for this property, as a group layer can contain multiple datasets with different spatial references.
Modifications to a spatial reference returned by this property will not be persisted. To modify the spatial reference of a dataset, the IGeoDatasetSchemaEdit and IGeoDatasetSchemaEdit2 interfaces should be used.
getSpatialReference
in interface IGeoDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IEnvelope getExtent() throws IOException, AutomationException
The IGeoDataset::Extent property returns an envelope representing the maximum extent of data which has been stored in the dataset.
Consider the following scenario. A new feature class has features added to it. The IGeoDataset::Extent is then requested and an envelope is returned. The extents of the envelope returned are represented by the red box in the image below.
If a portion of the features were then deleted and the extent is again requested an envelope with the exact same extents as during the first request would be returned (see image below). This is because the deletion of features does not shrink the extent. However all additions of features outside the red box would increase the envelope returned to encompass the newly added features.
If you would like to update the IGeoDataset::Extent property to reflect the current features in your dataset please see IFeatureClassManage::UpdateExtent (also see IFeatureClassLoad). In the image below the extent has been updated and a new envelope is being returned.
ESRI's GroupLayer implements this property differently from most other layer coclasses. When you instantiate a new GroupLayer, this property will return a valid envelope with zero height and width. With most other newly instantiated layers (for example FeatureLayer, RasterLayer, TinLayer), this property initally returns Nothing.
getExtent
in interface IGeoDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IGeodataXform getGeodataXform() throws IOException, AutomationException
getGeodataXform
in interface IGeoDataset2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ISpatialReference getNativeSpatialReference() throws IOException, AutomationException
getNativeSpatialReference
in interface IGeoDataset2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IEnvelope getNativeExtent() throws IOException, AutomationException
getNativeExtent
in interface IGeoDataset2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void add(IRasterBand element, int index) throws IOException, AutomationException
This method is only applicable to work with a Raster, not with a RasterDataset.
add
in interface IRasterBandCollection
element
- A reference to a com.esri.arcgis.datasourcesraster.IRasterBand (in)index
- The index (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getCount() throws IOException, AutomationException
getCount
in interface IRasterBandCollection
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void clear() throws IOException, AutomationException
This method is only applicable to work with a Raster, not with a RasterDataset.
clear
in interface IRasterBandCollection
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void remove(int index) throws IOException, AutomationException
This method is only applicable to work with a Raster, not with a RasterDataset.
remove
in interface IRasterBandCollection
index
- The index (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getBandIndex(String name) throws IOException, AutomationException
getBandIndex
in interface IRasterBandCollection
name
- The name (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IRasterBand getBandByName(String name) throws IOException, AutomationException
getBandByName
in interface IRasterBandCollection
name
- The name (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IEnumRasterBand getBands() throws IOException, AutomationException
getBands
in interface IRasterBandCollection
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IRasterBand item(int bandIndex) throws IOException, AutomationException
item
in interface IRasterBandCollection
bandIndex
- The bandIndex (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IDataset saveAs(String new_name, IWorkspace worksp, String format) throws IOException, AutomationException
The SaveAs method can create a raster dataset in Imagine, TIFF, GRID, JPEG2000, JPEG, BMP, GIF, PNG, PCI Raster, USGS ASCII DEM, X11 Pixmap, Memory Raster and geodatabase raster.
The format strings used for the supported formats are below, and they are case sensitive:
Format Name | String Used |
---|---|
Imagine | "IMAGINE Image" |
TIFF | "TIFF" |
GRID | "GRID" |
JPEG | "JPG" |
JP2000 | "JP2" |
BMP | "BMP" |
PNG | "PNG" |
GIF | "GIF" |
PCI Raster | "PIX" |
X11 Pixmap | "XPM" |
PCRaster | "MAP" |
Memory Raster | "MEM" |
HDF4 | "HDF4" |
BIL | "BIL" |
BIP | "BIP" |
BSQ | "BSQ" |
Idrisi Raster Format | "RST" |
ENVI Raster Format | "ENVI" |
Geodatabase Raster | "GDB" |
The format string "TIFF" creates a TIFF file with ".tif" extension. ArcGIS also supports TIFF format with ".tiff" and ".tff" extensions. A format string "TIF" creates a TIFF file with ".tiff" extention and a format string "TFF" creates a TIFF file with ".tff" extension.
Note, SaveAs will return a RasterDataset, to prevent from SaveAs holding the output, .NET ReleaseCOMObject needs to be called to release the referene to the output raster dataset:
System.Runtime.InteropServices.Marshal.ReleaseComObject(outRasterDS);
saveAs
in interface IRasterBandCollection
new_name
- The new_name (in)worksp
- A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)format
- The format (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void appendBand(IRasterBand element) throws IOException, AutomationException
This method is only applicable to work with a Raster, not with a RasterDataset.
appendBand
in interface IRasterBandCollection
element
- A reference to a com.esri.arcgis.datasourcesraster.IRasterBand (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void appendBands(IRasterBandCollection bands) throws IOException, AutomationException
This method is only applicable to work with a Raster, not with a RasterDataset.
appendBands
in interface IRasterBandCollection
bands
- A reference to a com.esri.arcgis.datasourcesraster.IRasterBandCollection (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IStringArray getPaths() throws IOException, AutomationException
getPaths
in interface IItemPaths
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void replacePaths(IStringArray pOldPaths, IStringArray pNewPaths) throws IOException, AutomationException
replacePaths
in interface IItemPaths
pOldPaths
- A reference to a com.esri.arcgis.system.IStringArray (in)pNewPaths
- A reference to a com.esri.arcgis.system.IStringArray (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public INativeType getNativeType() throws IOException, AutomationException
getNativeType
in interface INativeTypeInfo
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IPropertySet getMetadata() throws IOException, AutomationException
The variable to hold the data must be of IPropertySet data type.
The metadata property is frequently used to save, or update, changes to metadata documents that have taken place through methods available on the IPropertySet, IXmlPropertySet, and/or IXmlPropertySet2 interfaces.
getMetadata
in interface IMetadata
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMetadata(IPropertySet ppPropertySet) throws IOException, AutomationException
setMetadata
in interface IMetadata
ppPropertySet
- A reference to a com.esri.arcgis.system.IPropertySet (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void synchronize(int action, int interval) throws IOException, AutomationException
The Synchronize method is used to extract metadata properties from an object and write those properties to the metadata .xml. Depending on the value of the esriMetaSyncAction, the Synchronize method may generate a new set of metadata if it doesn't already exist.
The following actions will result in synchronization given each of the listed conditions:
Action | Metadata status | Esri/Sync element | Interval parameter |
---|---|---|---|
esriMSAAccessed | Doesn't matter | Must not be FALSE | Must be less than actual interval |
esriMSAAlways | Doesn't matter | Doesn't matter | Doesn't matter |
esriMSACreated | Must not exist | Must not be FALSE | Must be less than actual interval |
esriMSANotCreated | Must exist | Must not be FALSE | Must be less than actual interval |
esriMSAOverwrite | Doesn't matter | Doesn't matter | Doesn't matter |
The difference between esriMSAAlways and esriMSAOverwrite lies in which elements are synchronized. esriMSAAlways will honor the removal or value change of an element's Sync attribute (to disable synchronization), whereas using esriMSAOverwrite is equivalent to setting the IXmlPropertySet2.OverwriteSyncAttribute to true for the metadata's property set, meaning that even elements without a Sync attribute of TRUE will be synchronized.
synchronize
in interface IMetadata
action
- A com.esri.arcgis.geodatabase.esriMetadataSyncAction constant (in)interval
- The interval (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isCanEditMetadata() throws IOException, AutomationException
This property is available to those objects that support metadata.
isCanEditMetadata
in interface IMetadataEdit
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isTemporary() throws IOException, AutomationException
isTemporary
in interface ITemporaryDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void makePermanent() throws IOException, AutomationException
makePermanent
in interface ITemporaryDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IDataset makePermanentAs(String new_name, IWorkspace workspace, String format) throws IOException, AutomationException
makePermanentAs
in interface ITemporaryDataset
new_name
- The new_name (in)workspace
- A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)format
- The format (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isDynamic() throws IOException, AutomationException
isDynamic
in interface IRasterDatasetContainer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getSubRasterDatasetCount() throws IOException, AutomationException
getSubRasterDatasetCount
in interface IRasterDatasetContainer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getSubRasterDatasetName(int subdatasetID) throws IOException, AutomationException
getSubRasterDatasetName
in interface IRasterDatasetContainer
subdatasetID
- The subdatasetID (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getSubRasterDatasetCompleteName(int subdatasetID) throws IOException, AutomationException
getSubRasterDatasetCompleteName
in interface IRasterDatasetContainer
subdatasetID
- The subdatasetID (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IName getSubRasterDatasetFullName(int subdatasetID) throws IOException, AutomationException
getSubRasterDatasetFullName
in interface IRasterDatasetContainer
subdatasetID
- The subdatasetID (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IRasterDataset getSubRasterDatasetByID(int subdatasetID) throws IOException, AutomationException
getSubRasterDatasetByID
in interface IRasterDatasetContainer
subdatasetID
- The subdatasetID (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IRasterDataset getSubRasterDatasetByName(String subdatasetName) throws IOException, AutomationException
getSubRasterDatasetByName
in interface IRasterDatasetContainer
subdatasetName
- The subdatasetName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getClassID(GUID[] pClassID) throws IOException, AutomationException
IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.
getClassID
in interface IPersist
pClassID
- A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void isDirty() throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
isDirty
in interface IPersistStream
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void load(IStream pstm) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
load
in interface IPersistStream
pstm
- A reference to a com.esri.arcgis.system.IStream (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void save(IStream pstm, int fClearDirty) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
save
in interface IPersistStream
pstm
- A reference to a com.esri.arcgis.system.IStream (in)fClearDirty
- The fClearDirty (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getSizeMax(_ULARGE_INTEGER[] pcbSize) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
getSizeMax
in interface IPersistStream
pcbSize
- A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void writeExternal(ObjectOutput out) throws IOException
writeExternal
in interface Externalizable
IOException
public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException
readExternal
in interface Externalizable
IOException
ClassNotFoundException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |