ArcFM Engine Developer Guide
Miner.Interop Namespace (Miner.Interop.Framework)
Inheritance Hierarchy
Classes
 ClassDescription
ClassD8CuTypeClass This object is typically used as a placeholder for other list item types (e.g., MMCompatibleUnit, MMFavorites, MMTargets, MMGisUnits, etc.). It implements ID8ListItem and ID8List.
ClassD8FeatureClass  
ClassD8FeSelTopLevelEventsClass  
ClassD8LayerClass  
ClassD8ListClass  
ClassD8ListItemClass  
ClassID8FeSelTopLevelEvents_SinkHelper  
ClassMMDesignEventsClass  
ClassMMElectricTraceSettingsClass  
ClassMMFeederCreateAUClass  
ClassMMFeederGenericWtAUClass  
ClassMMFeederTracerClass  
ClassMMFrameworkLoginObjectClass  
ClassmmFrameworkUtilitiesClass  
ClassmmMapUtilsClass  
ClassMMValidationErrorClass  
ClassSwizzleJoinClass  
Interfaces
 InterfaceDescription
InterfaceD8Feature  
InterfaceD8FeSelTopLevelEvents  
InterfaceD8Layer  
InterfaceD8List When a design is open, the Design tab in the Attribute Editor is populated with a tree. As with all ArcFM trees, the Design tab is driven by a list - known as the D8List/D8ListItem structure. The D8List functions as a container for list items, which are objects that implement ID8ListItem.
InterfaceD8ListItem When a design is open, the Design tab in the Attribute Editor is populated with a tree. As with all ArcFM trees, the Design tab is driven by a list - known as the D8List/D8ListItem structure. The D8List functions as a container for list items, which are objects that implement ID8ListItem.
InterfaceID8CuDefAttrib This interface provides access to an attribute's name and value.
InterfaceID8CuDefinition Use this interface to define a compatible unit (CU).
InterfaceID8Feature  
InterfaceID8FeSelTopLevelEvents  
InterfaceID8FeSelTopLevelEvents_Event  
InterfaceID8GeoAssoc Any object that relates to a GeoObject in the geodatabase must implement this interface. This implementation provides all of the code necessary for getting and setting an association with an IObject.
InterfaceID8GeoAssocJoin  
InterfaceID8GeoAssocProperties  
InterfaceID8Layer This interface creates the layer that contains an ID8Feature object. For example, the Attribute Editor Selection tab may display a node called Support Structure. If you expand the Support Structure node, it may contain another node such as SUPPT176. The Support Structure node is the ID8Layer object and SUPPT176 is the ID8Feature object.
InterfaceID8Layer2 This interface extends the ID8Layer interface. It provides the ability to retrieve an IFeatureLayer object.
InterfaceID8WorkFlow Gets or sets the work flow status using a long integer or a value from the mmD8WorkFlowStatus enumeration.
InterfaceID8WorkFunction  
InterfaceIMMArcGISRuntimeEnvironment This interface provides access to commonly used objects such as maps.
InterfaceIMMArcGISRuntimeEnvironment2  
InterfaceIMMAttributedDefinition This interface specifies the table name and subtype that a compatible unit (CU) represents.
InterfaceIMMAttributes This interface requires an attribute name in order to access the attribute value on various types of objects.
InterfaceIMMAttributesList Use this interface to return a list of attributes on a given object.
InterfaceIMMAuxiliaryFieldBuilder  
InterfaceIMMCurrentStatus

Feeder Manager generally performs a trace using the Normal Status values stored in the geodatabase. IMMCurrentStatus allows you to override the geodatabase or network values and inform the trace how to behave at every single junction and edge encountered.

InterfaceIMMDesignAttributes
Gets the metadata for a list item.
InterfaceIMMDesignAttributes2
Gets the extended data for a list item.
InterfaceIMMDesignEvents3  
InterfaceIMMDuctCable This interface describes the cable associated with a duct.
InterfaceIMMDuctPhase This interface provides quick access to specific attributes of a cable associated with a duct.
InterfaceIMMEditTask In ArcFM, you can assign an edit task to a feature class so that when the feature is added, the edit task will execute. This allows you to customize the process of adding a certain feature.
InterfaceIMMEidSearchResults  
InterfaceIMMElectricNetworkTracing  
InterfaceIMMElectricNetworkTracingWithCurrentStatus  
InterfaceIMMElectricTraceSettings This interface allows you to set specific settings regarding tracing.
InterfaceIMMElectricTracing This interface performs the trace as specified by the arguments on the FindFeedPaths and TraceDownstream methods. These methods are the most useful electrical tracing methods exposed by Feeder Manager and offer a great degree of flexibility. Traces may be further customized using the IMMElectricTraceSettings and IMMCurrentStatus interfaces. The IMMElectricTracing interface may not be called from VB6. If you wish to call this interface from VB6, use  IMMElectricTracingExinterface instead.
InterfaceIMMElectricTracing2

IMMElectricTracing2 is an obsolete interface and no longer supported. It has been replaced by IMMElectricTracingEx. IMMElectricTracing2 may not be used with VB6.

InterfaceIMMElectricTracingEx This interface performs the trace as specified by the arguments on the FindFeedPaths and TraceDownstream methods. These methods are the most useful electrical tracing methods exposed by Feeder Manager and offer a great degree of flexibility. Traces may be further customized using the IMMElectricTraceSettings and IMMCurrentStatus interfaces. If you are using VB6, this interface should be called rather than the IMMElectricTracing interface, which cannot be called from VB6.
InterfaceIMMEnumAttributes This interface allows you to navigate a list of attributes for a given object.
InterfaceIMMEnumFeedPath

This interface returns an enumeration of objects that were encountered along a path to a circuit source feature. The feedPaths arguments on the IMMElectricTracing::FindFeedPaths and IMMElectricTracingEx::FindFeedPathsShowWork methods return an IMMEnumFeedPath object for each circuit source feature successfully reached by the trace.

InterfaceIMMEnumInt32 This interface returns an enumeration of Esri Network Element IDs for the child devices returned in a trace. This interface is returned by an argument on the IMMElectricTracingEx::FindChildDevices method.
InterfaceIMMEnumLoopElement This interface returns an enumeration of elements (as IMMLoopElement objects) that participate in a loop. This interface is returned by the IMMFeedPathEx interface.
InterfaceIMMEnumPathElement This interface returns an enumeration of IMMPathElementEx objects that represent the features encountered during a trace.
InterfaceIMMEnumTraceStopper Two methods on the IMMElectricTracingEx interface contain arguments that return an array of IMMTraceStopper objects. The methods on IMMEnumTraceStopper allow you to navigate this array.
InterfaceIMMErrorFlag  
InterfaceIMMErrorMessage  
InterfaceIMMExtendedData Defines attributes that contain information about an object. This interface is used to attach extended data to a work request or compatible unit (CU) in Designer. An example of the interface's implementation is found in the extended data view for CUs on the Manage CUs tab of the CU Admin Tool in ArcCatalog.
InterfaceIMMExtObject This interface is implemented to define a custom validation rule's display properties. It is used when creating validation rules for classes and fields.
InterfaceIMMFeederIslands  
InterfaceIMMFeedersNeedingRetracing  
InterfaceIMMFeederSource  
InterfaceIMMFeederTracer  
InterfaceIMMFeederTracer2  
InterfaceIMMFeederTracer3  
InterfaceIMMFeederTracer4  
InterfaceIMMFeederTracerCache  
InterfaceIMMFeederWeightInitSQL  
InterfaceIMMFeedPath IMMElectricTracing::FindFeedPaths and IMMElectricTracing2::FindFeedPathsShowWork both return a separate IMMFeedPath object for each circuit source feature that is reached by the trace. IMMElectricTracing and IMMElectricTracing2 are obsolete interfaces and have been replaced by IMMElectricTracingEx. IMMFeedPath is also no longer used and has been replaced by IMMFeedPathEx.
InterfaceIMMFeedPathEx The IMMEnumFeedPath interface is an enumeration of IMMFeedPath objects as the result of a trace. Each IMMFeedPath object represents an object encountered along a path to a circuit source feature.
InterfaceIMMFieldAdapter This interface is used to create the attribute fields displayed on user interfaces such as the Attribute Editor.
InterfaceIMMFieldBuilder This interface is used in conjunction with interfaces such as IMMObjectBuilder, IMMObjectClassBuilder, and IMMDefinitionBuilder to populate field adapters on the field manager.
InterfaceIMMFieldManager The IMMFieldManager interface is used to manage the proposed values of an object. It provides convenient methods for accessing, finding, and manipulating MMFieldAdapter objects. This interface is not generally implemented by applications. It is exposed by the MMFieldManager object.
InterfaceIMMFieldManagerEvents This interface provides events to update fields that rely on the field manager. For example, when a user updates attributes using the Attribute Editor, methods from this interface are called to perform the appropriate updates.
InterfaceIMMFieldManagerIntent  
InterfaceIMMFieldProperty Use this interface to create custom field property strategies. These strategies let you determine which fields are visible and under what conditions.
InterfaceIMMFireRuntimeEvents This interface is for internal Miner & Miner use only. It may be modified or removed without warning.
InterfaceIMMFrameworkUtilities  
InterfaceIMMFrameworkUtilities2  
InterfaceIMMHideEmptyChildren  
InterfaceIMMInvalidEnvelope  
InterfaceIMMItemDefinition This interface provides access to the Name, Description, and Type properties for a list item.
InterfaceIMMItemProperties  
InterfaceIMMItemProperties3  
InterfaceIMMLoginChange  
InterfaceIMMLoopElement The IMMEnumLoopElement interface returns an enumeration of IMMLoopElement objects. Each IMMLoopElement object represents an element that the trace identified as participating in a loop.
InterfaceIMMMapUtilities This interface provides basic map navigation and display utilities.
InterfaceIMMMapUtilities2  
InterfaceIMMMessageCallback

Allows an object to send messages to its client. The client must implement IMMMessageCallback and provide the object with a pointer to itself. This interface is used in the Network Adapter user interface for CYMDIST, SynerGEE, and MultiSpeak.

InterfaceIMMMobileConfig  
InterfaceIMMModeSelector  
InterfaceIMMNetworkAnalysisExtForFramework

This interface is used as an argument to methods on the IMMElectricNetworkTracing interface.

InterfaceIMMPathElement This interface is set or retrieved by a property on the IMMFeedPath interface. Both of these are used by the IMMElectricTracing and IMMElectricTracing2 interfaces, which are now obsolete. Use IMMElectricTracingEx for custom traces.
InterfaceIMMPathElementEx The IMMEnumLoopElement interface returns an enumeration of IMMPathElementEx objects. Each IMMPathElementEx object represents an element that the trace encountered on a path to the circuit source feature.
InterfaceIMMProposedDefinition  
InterfaceIMMProposedObject This is the primary interface for object creation and maintenance. Any object that displays attributes or creates GeoObjects in ArcFM must implement IMMProposedObject. This interface also provides access to the field manager, which manages the attributes of the object.
InterfaceIMMProposedObject3  
InterfaceIMMProposedObject4  
InterfaceIMMProposedObjectBehavior  
InterfaceIMMProposedObjectProgress  
InterfaceIMMProposedObjectProgressCallback  
InterfaceIMMRaiseDesignEvents  
InterfaceIMMRelationship2  
InterfaceIMMRelativeGeometry  
InterfaceIMMRowSearchResults This interface provides access to an unordered collection of rows.
InterfaceIMMRowSearchResults2 This interface extends IMMRowSearchResults by providing a threshold setting to limit the size of the results collection.
InterfaceIMMSearchConfiguration This interface provides specific parameters for each type of search.
InterfaceIMMSearchControl This interface provides information on whether the search has been stopped using the Stop button in the user interface.
InterfaceIMMSearchResults This object contains the results from a locator search. It contains no properties or methods. Rather, it serves as a marker interface for results. It may be cast to MMRowSearchResults or MMEIDSearchResults, each of which has methods used to set and extract the results.
InterfaceIMMSearchStrategy This interface contains the method that executes a search given the IMMSearchConfiguration object. It returns an IMMSearchResults object.
InterfaceIMMStoredDisplayName This interface displays (without opening) different stored displays based on the various Stored Display Type and OID.
InterfaceIMMSubsourceTracingPolicy  
InterfaceIMMSwizzleJoin  
InterfaceIMMTraceAllFeedersInBatches Creates a trace all feeders snapshot file. If this interface cannot produce a UI to ask the question whether or not the user would like to continue tracing with batches, or whether or not to overwrite the file that was found that is not a valid snapshot file, it assumes the answer is yes. If users are running this method when a UI is present, they will be prompted if they would like to overwrite the file that was found that was not a feeder snapshot file.
InterfaceIMMTracedElement This interface provides information about elements encountered during a trace.
InterfaceIMMTracedElementDelta The IMMTracedElements::Diff method allows you to analyze a trace before and after a connectivity or switching modification. This method provides the delta results in the form of an IMMTracedElementDeltas object. This object contains a collection of IMMTracedElementDelta objects that represent each modified feature in the trace.
InterfaceIMMTracedElementDeltas The IMMTracedElements::Diff method allows you to analyze a trace before an after a connectivity or switching modification. This method provides the delta results in the form of an IMMTracedElementDeltas object. This interface provides a collection of element changes encountered between the two traces.
InterfaceIMMTracedElements This interface provides a collection of elements encountered during a trace.
InterfaceIMMTraceResultsDisplay  
InterfaceIMMTraceSomeFeedersEx  
InterfaceIMMTraceStopper

IMMElectricTracing and IMMElectricTracing2 both have arguments that return an array of IMMTraceStopper objects. The methods on IMMTraceStopper allow you to navigate this array.

InterfaceIMMValidationError This interface is used to determine how errors found by QA/QC are displayed in the Attribute Editor.
InterfaceIMMValidationRule This interface allows you to define custom validation criteria. It is used to create validation rules for classes and fields.
InterfaceIMMVersionCache  
InterfaceIMMVersionDiff This interface determines how the version differences are displayed. By default, version differences are displayed on the QA/QC tab of the ArcFM Attribute Editor.
InterfaceIMMVersioningUtils This interface provides extended version management functionality required by Designer. It is supported by the MMDesignerImpl object of the DesignerAPI.
InterfaceMMElectricTraceSettings  
InterfaceMMFeederCreateAU  
InterfaceMMFeederGenericWtAU  
InterfaceMMFeederTracer  
InterfaceMMFrameworkLoginObject  
InterfacemmFrameworkUtilities  
InterfacemmMapUtils This class provides access to basic map navigation and display utilities.
InterfaceMMValidationError  
InterfaceSwizzleJoin  
Delegates
 DelegateDescription
DelegateID8FeSelTopLevelEvents_SelectionListSortedEventHandler  
DelegateIMMCoreEvents_ItemRemovedEventHandler  
Enumerations
 EnumerationDescription
EnumerationmmChangeType This enumeration indicates the type of change made to a GIS Unit. mmChangeType is used by the IMMWorkFunctionCalculator interface.
EnumerationmmCuOwner An enumeration of the possible owners of a CU.
Enumerationmmd8AttributeType This category allows the user to designate CU attributes as default or CU-defining.
Enumerationmmd8CuTypes An enumeration of the possible types of CUs.
Enumerationmmd8WorkFlowStatus This enumeration may be used by the ID8WorkFlow interface to determine the work flow status of a node (e.g., session, design, work request).
Enumerationmmd8WorkFunction This enumeration provides a list of possible work functions that may be assigned to a compatible unit (CU).
EnumerationmmDefinitionMode This enumeration lists the types of mode available. For example, it is used by the Favorites Manager to determine what a user has the ability to do.
EnumerationmmDirectionInfo This enumeration determines the direction of the trace.
EnumerationmmDisplayMode This enumeration lists the various methods for displaying field manager objects in an object editor control.
EnumerationmmESRIAnalysisOptions This enumeration indicates if trace tasks can trace on selected features, unselected features or all features. It repeats Esri's esriAnalysisType enumeration.
EnumerationmmFeederManagerAuRouting  
EnumerationmmFieldManagerIntent  
EnumerationmmFieldRepresentation  
EnumerationmmFMSubsourceLevelHandling  
EnumerationmmGisRepresentation This enumeration represents the possible alternative ways that an object can be represented within the geodatabase.
EnumerationmmGisUnitProperties  
EnumerationmmItemPropertyFormat  
EnumerationmmPackageCategory This enumeration indicates the type of package being stored. It is used by the IMMMapBook::Category property.
EnumerationmmPackageType  
EnumerationmmPhasesToTrace This enumeration contains all available phases that may be traced.
EnumerationmmProductMode This enumeration contains the available product modes for the ArcFM Solution.
EnumerationmmStoredDisplayType This enumeration is used by the IMMStoredDisplayName and IMMStoredDisplayManager interfaces.
EnumerationmmTopLevelType This enumeration defines the various types of top level objects available. You may use this enumeration to indicate a top level type which corresponds to a specific DTD. The IMMFrameworkUtilities interface uses this enumeration.
EnumerationmmUnitOfMeasure  
EnumerationmmUserMessageType  
EnumerationSetOfPhases This enumeration lists the available phases for an electric feature.
See Also

Reference

Miner.Interop.Framework Assembly

 

 


Send Comment