ArcFM Engine Developer Guide
Miner.Interop.Process Namespace (Miner.Interop.Process)
| Miner.Interop.Process Assembly : Miner.Interop.Process Namespace |
| Class | Description | |
|---|---|---|
 | IMMPxNodeEvents_SinkHelper | |
| MMPxNodeListClass | |
| PxApplicationClass | |
| PxLoginClass |
| Interface | Description | |
|---|---|---|
 | __PxApplication | |
| __PxApplication_Event | |
| __PxTaskTool | |
| __PxTaskTool_Event | |
| IDictionary | IDictionary is originally defined in Microsoft's Visual Basic libraries. Schneider Electric includes it in the MMPxBase library to that it can be native to Process Framework. An IDictionary object may be used on the MMPxNodeList class to cache data on the node. Doing this allows an implementer to share data with other objects that may be interacting with the PxNode. |
| IMMDynamicList | This interface, along with the IMMListBuilder interface, is responsible for building an ID8List of nodes within the Process Framework application. |
| IMMEnumExtension | This interface returns an enumeration of extensions available in Process Framework. |
| IMMEnumExtensionNames | This interface returns an enumeration of extension names available in the Process Framework. |
| IMMEnumPxControl | This interface returns an enumeration of controls available in Process Framework. |
| IMMEnumPxFilter | This interface returns an enumeration of filters available in Process Framework. |
| IMMEnumPxNodeType | This interface returns an enumeration of node types available in Process Framework. |
| IMMEnumPxRole | This interface returns an enumeration of roles available in Process Framework. |
| IMMEnumPxState | This interface returns an enumeration of states available in Process Framework. |
| IMMEnumPxTasks | This interface is utilized by the EnabledTasks property on the IMMPxNode3 interface. |
| IMMEnumPxTransition | This interface returns an enumeration of transitions available in Process Framework. |
| IMMEnumPxUser | This interface returns an enumeration of users available in Process Framework. |
| IMMEnumTreeViewTool | This interface returns an enumeration of tree view tools available in Process Framework. |
| IMMExtension | Use this interface to create a custom Process Framework extension. |
| IMMExtensionEx | The Process Framework application does not require you to implement this interface when creating a custom extension. If you implement it, the PxApp will check each table name in the collection to ensure the table exists in the database. If it does not, an error message will be generated. |
| IMMListBuilder | Use this interface to create custom build objects in your Process Framework extension. |
| IMMPxApplication | The application object is the core object in the Process Framework application. When created it loads all MM extensions from a registry category. Only when IMMPxApplication::Show( ) is called, will the application load any tools, controls or filters. A pointer to the application object is passed to all tools, controls, filters and extensions when created, giving all objects access to all other objects. |
| IMMPxApplicationEx | This interface provides information about Process Framework extensions and the current node. |
| IMMPxApplicationEx2 | This interface extends the IMMPxApplication interface. |
| IMMPxApplicationEx3 | This interface extends the IMMPxApplication interface. |
| IMMPxApplicationEx5 | This interface extends the IMMPxApplication interface.
It provides access to the MM_PX_CURRENT_STATE table and "caching" of the contents of that table. |
| IMMPxApplicationEx6 | This interface provides access to a sequence generator object. |
| IMMPxApplicationEx7 | This interface extends the IMMPxApplication interface and provides support for XML packets. |
| IMMPxCimMessaging | This interface provides support for CIM-compliant messaging in Process Framework. In 9.2, the IMMPxMessaging interface provides more general support for Process Framework messaging and should be used instead of IMMPxCimMessaging. |
| IMMPxCleanup | This interface is used to eliminate the data associated with sessions or designs created using Process Framework that have been flagged for clean up. |
| IMMPxCleanuplist | This interface describes the list of nodes created by Process Framework that need to be cleaned up. |
| IMMPxCleanupReorder | This interface allows the cleanup list to be reordered. |
| IMMPxControl | This interface is required to create a custom control. The IMMPxControl2 interface offers an additional Terminate method. |
| IMMPxControl2 | This interface is optional. It offers a Terminate method that the IMMPxControl interface does not. If you choose to implement the IMMPxControl2 interface, the properties may delegate back to the IMMPxControl interface to avoid duplicate code. |
| IMMPxDeleter | This interface allows you to delete nodes that have a specific node type. This requires a deleter object for each node type. PxDeleter carries out any functions necessary to delete the node from the Process Framework tables and the ArcMap tables. This may include marking the appropriate status fields in the Process Framework tables if the ArcMap data cannot be deleted at the time of invocation. |
| IMMPxDisplayName | This interface is used by custom controls, deleters and namers to retrieve the display name. |
| IMMPxExtIntegration | This interface is responsible for communication between the Process Framework and ArcMap applications. |
| IMMPxExtIntegration2 | This interface extends IMMPxExtIntegration. |
| IMMPxFilter | Use this interface to create custom filter objects in your Process Framework extension. |
| IMMPxFilterEx | This interface provides the property which allows you to specify an extension. Use this interface in conjunction with IMMPxFilter to create custom filter objects. |
| IMMPxHelper | IMMPxHelper provides an interface to the general use tools in the Process Framework application. |
| IMMPxHelper2 | Use this interface to retrieve values from the MM_PX_CONFIG table. |
| IMMPxHelper3 | Extends the IMMPxHelper interface. |
| IMMPxIntegrationCache | This interface is responsible for passing information between the Process Framework and ArcMap applications. |
| IMMPxIntegrationCache2 | This interface extends the IMMPxIntegrationCache interface. |
| IMMPxIntegrationCache3 | This interface extends the IMMPxIntegrationCache interface. |
| IMMPxIntegrationCache4 | This interface contains a property that is set to the current map when an edit session or redline session is started. |
| IMMPxLogin | This interface provides access to the Process Framework login. |
| IMMPxLogin2 | This interface extends the IMMPxLogin interface. |
| IMMPxLogin3 | This interface extends the IMMPxLogin interface. |
| IMMPxLogin4 | This interface extends the IMMPxLogin interface. |
| IMMPxLogin5 | This interface extends the IMMPxLogin interface. |
| IMMPxLogin6 | This interface extends the IMMPxLogin interface. |
| IMMPxLogin7 | This interface allows Process Framework version validation before checking table access. The version may be set on the PxVersion property. The login user interface then validates the PxVersion against the version of the database that the user has logged into. Version failures are reported and the user is allowed to retry. |
| IMMPxLoginEx | This interface extends the IMMPxLogin interface. |
| IMMPxMessageProcessor | Use this interface to create a custom message processor that processes messages in Workflow Manager as they are received from your Work Management System (WMS). |
| IMMPxMessaging | Implement this interface to provide access to the message processing framework in Process Framework. |
| IMMPxMobileHelper | This interface provides several methods for common Mobile functions. |
| IMMPxMobileHelper2 | |
| IMMPxNode | This interface provides information about a node in the Process Framework application. |
| IMMPxNode2 | This interface returns a value indicating whether the node is a top level node. You may wish to use this interface when creating custom filters. |
| IMMPxNode3 | This interface returns a node's enabled tasks and allows a programmer to get an IMMPxTask by its name from the node's list of enabled tasks. |
| IMMPxNode4 | This interface enhances the IMMPxNode interface. |
| IMMPxNodeDelete | This interface provides functionality for deleting a node. |
| IMMPxNodeEdit | This interface provides functionality for editing a node. |
| IMMPxNodeEdit2 | This interface provides a property that allows you to indicate whether a node is a top level node. |
| IMMPxNodeEvents | This interface provides the ability to track things that can happen to the node list. |
| IMMPxNodeEvents_Event | |
| IMMPxNodeHistory | This interface is used to track information about a Process Framework node. |
| IMMPxSDEVersion | Provides information about the SDE version associated with a Process Framework node. |
| IMMPxSDEVersion2 | This interface extends the IMMPxSDEVersion interface. |
| IMMPxSDEVersionNamer | This interface provides node type specific control over how the base version name and the version name properties of a node are generated. Classes the implement this interface will be specified in the MM_PX_NODE_TYPE table for each node type by their ProgIDs. The PxApplication will look up the version namer in the table whenever requested and return it to the caller. Any time node specific code needs to update a base version name or version name it will request the name from the version namer and use that name. |
| IMMPxSequenceGenerator | This interface allows an external implementation to access the same sequence generator that is used internally. This provides custom extensions (and other customizations) access to the code that generates sequence numbers in the Process Framework database. |
| IMMPxState | This interface allows a developer to programmatically access a state that has been created using the Process Framework Administration tool. |
| IMMPxSubtask | This interface is used to create subtasks that may be executed by a task. |
| IMMPxSubtask2 | This interface allows subtasks to behave differently under certain user-defined conditions. |
| IMMPxTask | The primary function of this interface is to allow for the execution of the task. This interface is not meant to be implemented as a custom object. It is documented for informational purposes only. Tasks may be called programmatically from other tools. |
| IMMPxTask2 | Extends the IMMPxTask interface. |
| IMMPxTaskTool | This interface provides access to the Process Framework Task Tool available in ArcMap. |
| IMMPxTransition | This interface allows a developer to programmatically access transitions created using the Process Framework Administration Tool. |
| IMMPxUser | This interface reads the values set for users in the Process Framework Administration Tool. The IMMPxUser2 interface provides additional properties and may be used instead of IMMPxUser. |
| IMMPxUser2 | This interface inherits the Id, Name, and Roles properties from IMMPxUser. It provides the additional functionality of Description and DisplayName properties. It may be used instead of the IMMPxUser interface. |
| IMMPxXml | This interface provides a way to import and export the XML representation of a Process Framework node. |
| IMMPxXml2 | This interface provides a way to import and export the XML of a Process Framework node as an IXMLDOMDocument object. |
| IMMTreeViewToolEx | Use this interface to create custom tools for a Process Framework extension. |
| IMMTreeViewToolEx2 | Use this interface to create custom tools for a Process Framework extension. |
| MMPxNodeList | This object is useful for accessing a Process Framework node as a node, as a node being edited, as an ID8List or ID8ListItem or an ordered list or list item. The numerous interfaces implemented on this object make it straightforward to access information. |
| PxApplication | This object represents the Process Framework application. It is a core object in the Process Framework. |
| PxLogin | Manages logging into the Process Framework applications. |
| PxTaskTool | This class implements IMMPxTaskTool. Use IMMPxApplicationEx2::TaskTool to get an instance of PxTaskTool. |
| Enumeration | Description | |
|---|---|---|
 | mmDatabaseType | An enumeration of the types of databases that may be used with ArcFM. DB2 is currently not supported. |
