Class RasterDatasetNameClass
- Namespace
- ESRI.ArcGIS.Geodatabase
- Assembly
- ESRI.Server.Geodatabase.dll
[ClassInterface(ClassInterfaceType.None)]
[Guid("75BCE6E2-8AF5-478E-8892-FA45CA50AF4D")]
public class RasterDatasetNameClass : RasterDatasetName, IName, IDatasetName, IPersistStream, IPersist, IRasterDatasetName, IMetadata, IMetadataEdit, INativeTypeInfo, IDatasetNameFileStat, IDatasetNameFileSize, IRasterDatasetContainerName, IDocumentVersionSupportGEN
- Inheritance
-
RasterDatasetNameClass
- Implements
- Inherited Members
Constructors
RasterDatasetNameClass()
public RasterDatasetNameClass()
Explicit Interface Implementations
CanEditMetadata
Indicates if metadata can be edited.
virtual bool CanEditMetadata { get; }
Returns
Remarks
This property is available to those objects that support metadata.
Category
The category of the dataset.
virtual string Category { get; set; }
Returns
ConvertToSupportedObject(esriArcGISVersion)
Convert the object to another object that is supported.
virtual object ConvertToSupportedObject(esriArcGISVersion docVersion)
Parameters
docVersionesriArcGISVersion
Returns
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.
GetClassID(out Guid)
virtual void GetClassID(out Guid pClassID)
Parameters
pClassIDGuid
GetSizeMax(out _ULARGE_INTEGER)
virtual void GetSizeMax(out _ULARGE_INTEGER pcbSize)
Parameters
pcbSize_ULARGE_INTEGER
IsDirty()
virtual void IsDirty()
IsSupportedAtVersion(esriArcGISVersion)
Is this object valid at the given document version.
virtual bool IsSupportedAtVersion(esriArcGISVersion docVersion)
Parameters
docVersionesriArcGISVersion
Returns
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.
Load(IStream)
virtual void Load(IStream pstm)
Parameters
pstmIStream
Metadata
The PropertySet containing metadata.
virtual IPropertySet Metadata { get; set; }
Returns
Remarks
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.
Name
The name of the dataset.
virtual string Name { get; set; }
Returns
NameString
The name string of the object.
virtual string NameString { get; set; }
Returns
Remarks
The NameString property is reserved for future use. When implemented, it will return a string representation of the locational component of the name object that may be persisted by applications.
NativeType
The native type.
virtual INativeType NativeType { get; }
Returns
Open()
Opens the object referred to by this name.
virtual object Open()
Returns
Remarks
The Open method lets you instantiate the actual object given the name object.
Note: Opening a feature class that participates in a topology or geometric network will also open all other feature classes participating in the topology or geometric network in memory.
RasterBandNames
The band names in the RasterDataset.
virtual IEnumDatasetName RasterBandNames { get; }
Returns
Save(IStream, int)
virtual void Save(IStream pstm, int fClearDirty)
Parameters
Size64
The size. 64bit Value
virtual ulong Size64 { get; }
Returns
StatMode
The access mode.
virtual esriDatasetFileStatAccessMode StatMode { get; set; }
Returns
StatSize
Obsolete. Use StatSize64.
virtual int StatSize { get; set; }
Returns
StatTime[esriDatasetFileStatTimeMode]
Obsolete. Use StatTime64.
virtual int StatTime[esriDatasetFileStatTimeMode dateMode] { get; set; }
Parameters
dateModeesriDatasetFileStatTimeMode
Returns
Remarks
The time is set and returned as the number of seconds since 12:00:00, 1 January 1970 UTC.
To convert the type of value returned from this method to a .NET DateTime struct, a function like the following can be used:
public DateTime GetFileCreationTime(IName name)
{
IDatasetNameFileStat datasetNameFileStat = (IDatasetNameFileStat)name;
int ticks = datasetNameFileStat.get_StatTime(esriDatasetFileStatTimeMode.esriDatasetFileStatTimeCreation);
DateTime baseTime = new DateTime(1970, 1, 1, 0, 0, 0, DateTimeKind.Utc);
DateTime fileTime = baseTime.AddSeconds(ticks);
return fileTime.ToLocalTime();
}
SubsetNames
Subset names contained within this dataset name.
virtual IEnumDatasetName SubsetNames { get; }
Returns
Synchronize(esriMetadataSyncAction, int)
Updates metadata with the current properties; may create metadata if it doesn't already exist.
virtual void Synchronize(esriMetadataSyncAction action, int interval)
Parameters
actionesriMetadataSyncActionintervalint
Remarks
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.
Type
The type of the dataset.
virtual esriDatasetType Type { get; }
Returns
WorkspaceName
The WorkspaceName of the DatasetName.
virtual IWorkspaceName WorkspaceName { get; set; }
Returns
Remarks
<P><FONT face=Verdana size=2>A workspace name specifies a workspace object and can be used to instantiate it. The workspace is specified using the connection properties for the workspace. </FONT><FONT face=Verdana size=2>A workspace name is a key component of any dataset name for datasets in the workspace.</FONT></P> <P></P>