Export Properties

These export properties apply to all implementations of Network Adapter regardless of the third-party analysis tool. Implementations of third-party analysis tools (e.g., CYMDIST, SynerGEE, MultiSpeak) may provide export properties in addition to those listed here. If you don't need to use a specific property, do not add it to the property set.

Note: Property names are case sensitive.

The property set argument used in IMMXMLData provides additional information about how the data should be exported. The following are properties that are supported by the Analysis API:

Property MessageCallback: A reference to an object in the Implementation of type IMMMessageCallback. Allows the Analysis API to send error messages, status messages, and progress bar values back to the Implementation. Also, the Analysis API uses this object to periodically check if the Implementation wants the export stopped.

Property ClassModelName: The model name that identifies the features to be exported. The default is to export all features.

Property FieldModelName: The model name that identifies the attributes to be exported. The default is to export all attributes.

Property RelatedObjects: A value of True indicates that related objects for the features are exported. A value of False indicates that they are not exported. The default is True.

Property BackwardModelName: The model name that identifies classes that will be exported through backward relationships. No forward relationships will be exported for classes with this model name. Default behavior is to export forward relationships only.

Property TestCaseName: Indicates that the export is a load case, and identifies a name to use in checking if the load case table is dirty. Default behavior is to export normally, not as a load case.

Property LineVertexInfo: A value of True indicates that vertices for line features are exported. A value of False indicates that they are not exported. The default is False.

Property LengthSource: A value of Geographic indicates that the source of exported lengths is the calculated length attribute, and any other value identifies the field model name of an attribute containing a measured length. The default is Geographic.

Property UniqueIDField: The model name that identifies the field containing a unique identifier. By default, object ID is the unique identifier.

Property NetworkInfo: A value of True indicates that network junction information for line features is exported. Also, information associated with individual edges in a complex edge feature are exported. A value of False indicates that it is not exported. The default is True.

Property TableNameOnly: A value of True indicates that the table name of features is exported without server or schema name for SDE workspaces. A value of False indicates the full name is exported, including server and schema. The default is True.

Property FeatureShapeModelName: The model name tells Network Adapter to export the features’ associated shapes. The shape is stored as a child of the FEATURE element as a GML location element. (GML is the OpenGIS Consortium’s Geography Markup Language.) This model name can be assigned to any feature class including network features, however, edge features may already have their vertices exported under the EDGE element if the LineVertexInfo property is set to True. This model name will have no effect on standard (non-geometric) Object Classes.

Property SuppressProgID: A value of True indicates that ProgIDs are suppressed and not exported to the XML. A value of False (the default value) indicates ProgIDs are not suppressed and will be exported.

MultiSpeak Export Properties

This export property in addition to those listed above is available for MultiSpeak implementations. It is supported by the PropertySet argument to IMMXMLData::ExportDataToDOM:

Property Update: Provides a True or False value that tells the Analysis API that a previous export is being updated or a new network is being created. This property applies only to MultiSpeak exports.

Property AddMspConnectivity: This property requests that connectivity information required by Engineering Analysis applications be included in the export XML. This value may be: Section Model or Node Model.

Section Model: A value of SectionModel indicates that FEATURE elements include a sectionID element with a value equal to the ID of the feature, and a parentSectionID referring to the ID of the immediate upstream connected feature (whether that is a junction feature or an edge element). The only difference between edges and junctions in the section model is that the sectionID and parentSectionID elements are children of the EDGE element for edges, not the FEATURE element. The parentSectionID for the feature that serves as the source of the feeder is the FeederID.

In the section connectivity model, a switchable device cannot be the parent section of a conductor unless the switch is closed on at least one phase common to both features. A transformer cannot be the parent section of a conductor unless that conductor has a different operating voltage than the parent conductor of the transformer. If a trace weight is exported, it contains all the information needed to determine whether a feature is a transformer or a switchable device, and whether the feature is open or closed on a particular phase.

Node Model: A value of NodeModel indicates that the connectivity is represented by From and To node IDs, rather than parent section IDs. If this option is requested, EDGE elements will have a fromNodeID child corresponding to the ID of the upstream junction, and a toNodeID child corresponding to the ID of the downstream junction. A junction’s FEATURE element will only have nodeID and nodeName, both of which are just copies of the FEATURE element’s ID attribute. Note that the fromNodeID and the toNodeID which are appended to the EDGE element do not necessarily correspond to the NODE elements belonging to the EDGE element which are designated as From and To in their NodeType attributes.

NodeType attribute values of From and To are merely accidents of the way the feature was digitized or converted during its initial creation. The NodeType attribute distinguishes between the endpoints of an edge and its interior vertices. The fromNodeID and toNodeID elements requested by this export property belong to the EDGE element itself (not its child NODE elements), and represent the connected junction in the source and load directions along the network, respectively. It is quite common to have a reversed edge where the digitized direction points toward the source feature rather than the load end of the edge.

In the Node Model, additional features called fakeNodeSection are inserted into Network XML where generic network junction features exist in the GIS data. Since these features are usually not selected for export and are not required to carry a trace weight, they are normally not present in an exported Network XML. However, the MultiSpeak schema requires that the fromNodeID and toNodeID refer to the ID of an object in the XML. For this reason, these fakeNodeSection elements are added to the Network XML in lieu of a junction feature representing an actual device such as a transformer or switch. The fakeNodeSection elements are only needed for the Node Model.

Minerville Property Settings

The following table shows the settings for particular Export properties. The Default column displays the property's default setting. The CYMDIST, SynerGEE and MultiSpeak columns display how these properties should be set when using the Minerville model.

Export Property	Default	CYMDIST	SynerGEE	MultiSpeak
ClassModelName	null	CYMDISTEXPORT	CYMDISTEXPORT	set in Network Adapter Options
FieldModelName	null	CYMDISTEXPORT	CYMDISTEXPORT	set in Network Adapter Options
LineVertexInfo	FALSE	TRUE	TRUE	TRUE
RelatedObjects	TRUE	TRUE	TRUE	TRUE
MessageCallback	null	included	included	included
BackwardModelName	null	null	null	set in Network Adapter Options
AddMspConnectivity	null	null	null	set (Sectional or Nodal) in Network Adapter Options
Update	null	null	null	set in Export dialog