Class DENetworkDatasetClass
- Namespace
- ESRI.ArcGIS.Geodatabase
- Assembly
- ESRI.Server.Geodatabase.dll
[ClassInterface(ClassInterfaceType.None)]
[Guid("FF8808B7-E50C-45FE-84EA-1C061D7431F6")]
public class DENetworkDatasetClass : DENetworkDataset, IDEDataset, IDEGeoDataset, IDENetworkDataset, IDataElement, IMetadata, IGPValue, IClone, IXMLSerialize, IPersistStream, IPersist, IGPDescribe
- Inheritance
-
DENetworkDatasetClass
- Implements
- Inherited Members
Constructors
DENetworkDatasetClass()
public DENetworkDatasetClass()
Explicit Interface Implementations
Assign(IClone)
Assigns the properties of src to the receiver.
virtual void Assign(IClone src)
Parameters
srcIClone
Attributes
Array of network attributes in this network dataset.
virtual IArray Attributes { get; set; }
Returns
Remarks
The Attributes property is used to set or get the collection of attributes associated with a network dataset. The Attributes property requires an IArray object which can be used to add, remove or iterate over the attributes.
Buildable
Indicates if this network dataset is buildable.
virtual bool Buildable { get; set; }
Returns
Remarks
The Buildable property indicates whether the network dataset can be built with the INetworkBuild.BuildNetwork method. If not set on the data element, the Buildable property will default to True.
CanVersion
Indicates if this dataset can be versioned.
virtual bool CanVersion { get; set; }
Returns
CatalogPath
The string used to retrieve the element.
virtual string CatalogPath { get; set; }
Returns
Remarks
| Dataset Type | Keyword |
|---|---|
| Feature dataset | FD |
| Feature class | FC |
| Object class | OC |
| Relationship class | RC |
| Geometric network | GN |
| Topology | TOPO |
| Raster band | RB |
| Raster dataset | RD |
| Raster catalog | RCAT |
| Toolbox | TB |
The following are sample catalog paths:
Children
The list of sub-elements.
virtual IArray Children { get; set; }
Returns
ChildrenExpanded
Indicates if the children have been expanded.
virtual bool ChildrenExpanded { get; set; }
Returns
Clone()
Clones the receiver and assigns the result to *clone.
virtual IClone Clone()
Returns
ConfigurationKeyword
The database configuration keyword for the network dataset.
virtual string ConfigurationKeyword { get; set; }
Returns
Remarks
<p>Configuration keywords can be of two types:</p> <ul> <li>esriConfigurationKeywordGeneral, which references storage parameters for creating feature classes and tables</li> <li>esriConfigurationKeywordNetwork, which references storage parameters for creating geometric networks or network datasets</li> <li>esriConfigurationKeywordTopology, which references storage parameters for creating topologies</li> </ul> <p>An enumeration of <strong>ConfigurationKeyword</strong> objects for an ArcSDE or File geodatabase workspace is returned by the <strong>IWorkspaceConfiguration</strong> interface.</p>
DSID
The id of the dataset.
virtual int DSID { get; set; }
Returns
DataType
The data type of the value object.
virtual IGPDataType DataType { get; }
Returns
Remarks
The DataType property returns the DataType object associated with this Value object.
DatasetType
Dataset type.
virtual esriDatasetType DatasetType { get; set; }
Returns
DefaultTravelModeName
Name of default network travel mode for this network dataset.
virtual string DefaultTravelModeName { get; set; }
Returns
Describe(string)
The description of the named object.
virtual object Describe(string Name)
Parameters
Namestring
Returns
Deserialize(IXMLSerializeData)
Deserializes an object from XML.
virtual void Deserialize(IXMLSerializeData data)
Parameters
dataIXMLSerializeData
Directions
The directions settings for the network dataset.
virtual INetworkDirections Directions { get; set; }
Returns
Remarks
The Directions property is used to specify or return the Directions for the network dataset. The network dataset must have certain parameters in order to specify directions:
- There must be at least one edge source
- There must be a length attribute such with units such as Meters
- At least one edge source must have a text field. This is for the Primary Name property
ElevationModel
The type of the network elevation model.
virtual esriNetworkElevationModel ElevationModel { get; set; }
Returns
Empty()
Clears the value object.
virtual void Empty()
Remarks
The Empty method clears this Value object and releases any associated objects.
Extent
The extent of the coverage.
virtual IEnvelope Extent { get; set; }
Returns
FullPropsRetrieved
Indicates if full properties have been retrieved.
virtual bool FullPropsRetrieved { get; set; }
Returns
GetAsText()
Provides the value of the value object.
virtual string GetAsText()
Returns
Remarks
The GetAsText method returns this Value object as a text string. For DataElement value objects it is the NameString. For simple value objects it is the text string for the scalar value.
GetBaseName()
File base name.
virtual string GetBaseName()
Returns
GetClassID(out Guid)
virtual void GetClassID(out Guid pClassID)
Parameters
pClassIDGuid
GetExtension()
File extension.
virtual string GetExtension()
Returns
GetFile()
File name.
virtual string GetFile()
Returns
GetPath()
File path.
virtual string GetPath()
Returns
GetSizeMax(out _ULARGE_INTEGER)
virtual void GetSizeMax(out _ULARGE_INTEGER pcbSize)
Parameters
pcbSize_ULARGE_INTEGER
HierarchyClusterAttribute
The network attribute that is used to optimize network building for hierarchical traversal.
virtual INetworkAttribute HierarchyClusterAttribute { get; set; }
Returns
Remarks
The HierarchyClusterAttribute property is used to specify or return the attribute that will be used for specifying Hierarchy. The attribute must be of type esriNAUTHierarchy.
HierarchyLevelCount
The number of hierarchy levels in the network dataset.
virtual int HierarchyLevelCount { get; set; }
Returns
Remarks
The HierarchyLevelCount property is used to return the levels supported by the hierarchy attribute. By default this value is 3, since only 3 levels of hierarchy are supported on the network dataset.
IsDirty()
virtual void IsDirty()
IsEmpty()
Indicates if the value object is empty.
virtual bool IsEmpty()
Returns
Remarks
The IsEmpty method returns if this Value object has been set or not.
IsEqual(IClone)
Indicates if the receiver and other have the same properties.
virtual bool IsEqual(IClone other)
Parameters
otherIClone
Returns
IsIdentical(IClone)
Indicates if the receiver and other are the same object.
virtual bool IsIdentical(IClone other)
Parameters
otherIClone
Returns
Load(IStream)
virtual void Load(IStream pstm)
Parameters
pstmIStream
MaxValueForHierarchy[int]
The maximum value for the specified hierarchy level in the network dataset.
virtual int MaxValueForHierarchy[int Level] { get; set; }
Parameters
Levelint
Returns
Remarks
The MaxValueForHierarchy property is used to return the maximum value for each level of hierarchy for a network dataset. Since the network dataset only supports 3 levels of hierarchy, data that has more than 3 levels must have their hierarchy levels mapped to one of the three levels.
Unless explicitly specified, Shapefile and Geodatabase network datasets will return a value of 1, 2 and 2147483647 for hierarchy levels of one, two and three.
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.
MetadataRetrieved
Indicates if the metadata has been retrieved.
virtual bool MetadataRetrieved { get; set; }
Returns
Name
The user assigned name for the element.
virtual string Name { get; set; }
Returns
NetworkType
The type of the network dataset.
virtual esriNetworkDatasetType NetworkType { get; set; }
Returns
Remarks
The NetworkType property returns the type of network dataset.
Properties
Property set of this network dataset.
virtual IPropertySet Properties { get; set; }
Returns
Save(IStream, int)
virtual void Save(IStream pstm, int fClearDirty)
Parameters
Serialize(IXMLSerializeData)
Serializes an object to XML.
virtual void Serialize(IXMLSerializeData data)
Parameters
dataIXMLSerializeData
SetAsText(string)
Provides the value of the value object with the given string value.
virtual IGPMessage SetAsText(string text)
Parameters
textstring
Returns
Remarks
The SetAsText method sets the value of this Value object as a text string. For DataElement value objects it is the NameString. For simple value objects it is the text string representing the scalar value.
Sources
Array of network sources in this network dataset.
virtual IArray Sources { get; set; }
Returns
Remarks
The Sources property is used to set or get the collection of sources associated with a network dataset. The Sources property requires an IArray object which can be used to add, remove or iterate over the attributes. Every network dataset has a system junction source; this source is added to the network dataset once the UpdateSchema method is called with the supplied data element. The system junction source is created once the first source is added to the network.
SpatialReference
The spatial reference of the geodataset.
virtual ISpatialReference SpatialReference { get; set; }
Returns
SupportsTurns
Indicates if this network dataset supports network turn elements.
virtual bool SupportsTurns { get; set; }
Returns
Remarks
The SupportsTurns property indicates whether the network dataset can support turns. Once created, the turn support property of a network dataset cannot be changed. Specifying that a network dataset can support turns will allow Turn sources to be added to the network and also allow Turn evaluators to be added to the network dataset. This will allow evaluators such as "All left hand turns will take 15 seconds" to be specified.
If not set on the data element, the SupportsTurns property will default to True for shapefile and geodatabase networks.
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.
TimeZoneAttributeName
Name of the time zone attribute.
virtual string TimeZoneAttributeName { get; set; }
Returns
TimeZoneTableName
Name of the time zone table.
virtual string TimeZoneTableName { get; set; }
Returns
TrafficData
Traffic data.
virtual ITrafficData TrafficData { get; set; }
Returns
TransitData
The transit settings for the network dataset.
virtual ITransitData TransitData { get; set; }
Returns
TravelModes
Array of network travel modes in this network dataset.
virtual IArray TravelModes { get; set; }
Returns
Type
The type of the element.
virtual string Type { get; set; }
Returns
UserData
User specified property set of this network dataset.
virtual IPropertySet UserData { get; set; }
Returns
Versioned
Indicates if this dataset is versioned.
virtual bool Versioned { get; }