### Bash: MagicDraw Command Line Usage Examples Source: https://context7.com/tmelsheimer/ai-ide-concept/llms.txt Example bash scripts demonstrating how to execute various MagicDraw operations from the command line using the `magicdraw.jar`. Includes actions for exporting diagrams, validating models, and transforming models, all with headless execution. ```bash #!/bin/bash # Export all diagrams from a project java -jar magicdraw.jar \ -project /path/to/project.mdzip \ -action EXPORT_ALL_DIAGRAMS \ -args /path/to/output/directory \ -headless # Validate model and generate report java -jar magicdraw.jar \ -project /path/to/project.mdzip \ -action VALIDATE_MODEL \ -report /path/to/validation-report.html \ -headless # Transform model java -jar magicdraw.jar \ -project /path/to/project.mdzip \ -action ENTITY_TO_TABLE_TRANSFORM \ -save \ -headless ``` -------------------------------- ### Define Loop Node Setup Part Action (Java) Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/constant-values.html This snippet defines the integer constant for the setup part of a loop node within the UMLPackage. It is a public static final integer used for internal representation. ```Java public static final int WRITE_STRUCTURAL_FEATURE_ACTION___LOOP_NODE_OF_SETUP_PART = 50; ``` -------------------------------- ### Define Create Object Action: Loop Node of Setup Part Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/constant-values.html This Java constant represents the action of creating a loop node that constitutes the setup part of a loop in UML. It's a public static final integer constant from the metadata. ```java public static final int CREATE_OBJECT_ACTION___LOOP_NODE_OF_SETUP_PART = 50; ``` -------------------------------- ### Java Class Definition: SwitchToPluginAction Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/serialized-form.html Defines the SwitchToPluginAction class, which extends MDStateAction and implements Serializable. It includes serialized fields for managing plugin switching activities, confirmation logic, installation files, and other installation actions. ```java class SwitchToPluginAction extends MDStateAction implements Serializable { // Serialized Fields Consumer mAdditionalActivity; BiFunction mConfirmation; File mInstallationFile; Collection mOtherInstallActions; com.nomagic.magicdraw.rebranding.SwitchablePlugin mPlugin; } ``` -------------------------------- ### BPMN 2.0 Start Event Stereotypes Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/deprecated-list.html This section covers various stereotypes for start events in BPMN 2.0, including conditional, escalation, and message start events. ```APIDOC ## BPMN 2.0 Start Event Stereotypes ### Description This section covers various stereotypes for start events in BPMN 2.0, including conditional, escalation, and message start events. ### Endpoints This section does not describe HTTP endpoints, but rather conceptual elements within the BPMN 2.0 profile. ### Stereotypes - **START_CONDITIONAL_FALSE_STEREOTYPE**: Stereotype for a non-conditional start event. Usage: `use Start_conditional_falseStereotype.STEREOTYPE_NAME` - **START_CONDITIONAL_TRUE_STEREOTYPE**: Stereotype for a conditional start event. Usage: `use Start_conditional_trueStereotype.STEREOTYPE_NAME` - **START_ESCALATION_FALSE_STEREOTYPE**: Stereotype for a non-escalation start event. Usage: `use Start_escalation_falseStereotype.STEREOTYPE_NAME` - **START_ESCALATION_TRUE_STEREOTYPE**: Stereotype for an escalation start event. Usage: `use Start_escalation_trueStereotype.STEREOTYPE_NAME` - **START_MESSAGE_FALSE_STEREOTYPE**: Stereotype for a non-message start event. ``` -------------------------------- ### Package Listing Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/index.html This section lists the available packages within the 2024x API, along with a brief description for each. ```APIDOC ## Package Listing ### Description Lists the available packages within the 2024x API and their descriptions. ### Method N/A ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response #### Success Response (200) - **packageName** (string) - The name of the package. - **packageDescription** (string) - A brief description of the package. #### Response Example ```json { "packages": [ { "packageName": "com.dassault_systemes.modeler.magic.kerml.diagram", "packageDescription": null }, { "packageName": "com.dassault_systemes.modeler.magic.ui.diagrams", "packageDescription": null }, { "packageName": "com.nomagic.actions", "packageDescription": "This package contains extensions to swing actions." } ] } ``` ``` -------------------------------- ### Java Constants for BPMN2Profile Start Event Stereotypes Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/constant-values.html This snippet shows Java String constants associated with different start event stereotypes in the BPMN2Profile. These constants represent specific configurations or properties of start events. ```java public static final String STEREOTYPE_NAME = "start_parallelMultiple_true"; ``` ```java public static final String STEREOTYPE_NAME = "start_signal_false"; ``` ```java public static final String STEREOTYPE_NAME = "start_signal_true"; ``` ```java public static final String STEREOTYPE_NAME = "start_timer_false"; ``` ```java public static final String STEREOTYPE_NAME = "start_timer_true"; ``` -------------------------------- ### Exception: com.nomagic.magicdraw.magicreport.helper.LauncherException Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/serialized-form.html Documentation for the LauncherException class in the com.nomagic.magicdraw.magicreport.helper package. ```APIDOC ## Exception com.nomagic.magicdraw.magicreport.helper.LauncherException ### Description An exception class related to launching operations within the magic report helper module. ### Method N/A (Exception definition) ### Endpoint N/A (Exception definition) ### Parameters N/A (Exception definition) ### Request Example N/A (Exception definition) ### Response #### Success Response (200) N/A (Exception definition) #### Response Example N/A (Exception definition) ### Serialized Fields N/A ``` -------------------------------- ### Timer Start Event Constants Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/deprecated-list.html Constants for Timer Start Events, including stereotype names and the interrupting property. ```APIDOC ## Timer Start Event Constants ### Description Constants related to Timer Start Events in BPMN2, defining their behavior and stereotype. ### Stereotypes & Properties - `com.nomagic.magicdraw.cbm.profiles.BPMN2Profile.TIMERSTARTEVENT_ISINTERRUPTING_PROPERTY`: Property to determine if the Timer Start Event is interrupting. - `com.nomagic.magicdraw.cbm.profiles.BPMN2Profile.TIMERSTARTEVENT_STEREOTYPE`: General stereotype name for Timer Start Events. ``` -------------------------------- ### Get SysML Stereotype for Unit Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/deprecated-list.html Gets the stereotype associated with a unit element in SysML. This is crucial for dimensional analysis and consistency in models. ```Java use getInstance(element).unit().getStereotype() ``` -------------------------------- ### BasicEStoreEList Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/allclasses-index.html An implementation of a list that delegates storage operations to a backing store. ```APIDOC ## BasicEStoreEList ### Description A list that delegates to a store. ### Method N/A (Class Documentation) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### BaseOptions Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/allclasses-index.html Interface for environment options related to Eclipse UML2 XMI export/import. ```APIDOC ## BaseOptions ### Description Environment options for Eclipse UML2 XMI export/import. ### Method N/A (Interface Documentation) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### Java Constants for BPMN2Profile Start Events Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/constant-values.html This snippet showcases Java constant declarations for different BPMN 2.0 start event types. These constants are used to identify and categorize start events within a modeling context, likely for programmatic access or configuration. They are defined as public static final String. ```java public static final String STEREOTYPE_NAME = "start_conditional_true"; public static final String STEREOTYPE_NAME = "start_escalation_false"; public static final String STEREOTYPE_NAME = "start_escalation_true"; public static final String STEREOTYPE_NAME = "start_message_false"; public static final String STEREOTYPE_NAME = "start_message_true"; public static final String STEREOTYPE_NAME = "start_multiple_false"; public static final String STEREOTYPE_NAME = "start_multiple_true"; public static final String STEREOTYPE_NAME = "start_parallelMultiple_false"; public static final String STEREOTYPE_NAME = "start_parallelMultiple_true"; ``` -------------------------------- ### BPMN 2.0 Start Event Type Checks Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/deprecated-list.html Provides methods to check if a given UML element represents a specific type of BPMN 2.0 start event. ```APIDOC ## GET /bpmn2/startEvent/{eventType} ### Description Checks if a given UML element is a specific type of BPMN 2.0 start event. ### Method GET ### Endpoint `/bpmn2/startEvent/{eventType}` ### Parameters #### Path Parameters - **eventType** (string) - Required - The type of start event to check (e.g., conditional, escalation, message, multiple, parallelMultiple, signal, timer). #### Query Parameters - **elementId** (string) - Required - The ID of the UML element to check. ### Request Example (No request body for GET) ### Response #### Success Response (200) - **isStartEvent** (boolean) - True if the element is the specified start event type, false otherwise. #### Response Example ```json { "isStartEvent": true } ``` ``` -------------------------------- ### MainToolbarConfigurationAction API Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/serialized-form.html Placeholder for documentation related to the MainToolbarConfigurationAction class. ```APIDOC ## Class MainToolbarConfigurationAction ### Description This class is related to the configuration of the main toolbar in the AI IDE concept. ### Method N/A (Class definition) ### Endpoint N/A (Class definition) ### Parameters N/A (Class definition) ### Request Example N/A (Class definition) ### Response N/A (Class definition) ``` -------------------------------- ### DTConfigurator Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/allclasses-index.html Configures diagram table actions. ```APIDOC ## DTConfigurator ### Description Configures diagram table actions. ### Method N/A ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ### Response Example N/A ``` -------------------------------- ### Access UP DM Profile Stereotypes Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/deprecated-list.html This snippet demonstrates how to retrieve the stereotype for a given UP DM Profile element. It utilizes a getInstance() method to get an element instance and then calls a specific method to get its stereotype. This pattern is repeatable for various UP DM Profile types. ```N/A use getInstance(element).ownsProcess().getStereotype() use getInstance(element).participant().getStereotype() use getInstance(element).performer().getStereotype() use getInstance(element).person().getStereotype() use getInstance(element).personType().getStereotype() use getInstance(element).physicalArchitecture().getStereotype() use getInstance(element).physicalDataModel().getStereotype() use getInstance(element).physicalResource().getStereotype() use getInstance(element).post().getStereotype() use getInstance(element).problemDomain().getStereotype() use getInstance(element).process().getStereotype() use getInstance(element).project().getStereotype() use getInstance(element).projectActivity().getStereotype() use getInstance(element).projectActivityAction().getStereotype() use getInstance(element).projectActivityEdge().getStereotype() use getInstance(element).projectMilestone().getStereotype() use getInstance(element).projectMilestoneRole().getStereotype() use getInstance(element).projectOwnership().getStereotype() use getInstance(element).projectSequence().getStereotype() use getInstance(element).projectStatus().getStereotype() use getInstance(element).projectTheme().getStereotype() use getInstance(element).projectType().getStereotype() use getInstance(element).property().getStereotype() use getInstance(element).propertySet().getStereotype() use getInstance(element).protocol().getStereotype() use getInstance(element).protocolImplementation().getStereotype() ``` -------------------------------- ### Class: com.nomagic.magicdraw.magicreport.helper.Configuration Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/serialized-form.html Documentation for the Configuration class in the com.nomagic.magicdraw.magicreport.helper package. This class is Serializable and contains various maps for configuration settings. ```APIDOC ## Class com.nomagic.magicdraw.magicreport.helper.Configuration ### Description Manages configuration settings for the magic report feature, including various mapping configurations. This class implements Serializable. ### Method N/A (Class definition) ### Endpoint N/A (Class definition) ### Parameters N/A (Class definition) ### Request Example N/A (Class definition) ### Response #### Success Response (200) N/A (Class definition) #### Response Example N/A (Class definition) ### Serialized Fields * **configMap** (Map) - A map storing general configuration properties. * **programMappingEditMap** (Map>) - A map for program editing configurations. * **programMappingViewMap** (Map>) - A map for program view configurations. * **templateMappingList** (List) - A list of template mappings. ``` -------------------------------- ### Constants for CREATE_OBJECT_ACTION Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/constant-values.html This section details the integer constants related to CREATE_OBJECT_ACTION within the UMLPackage. ```APIDOC ## CREATE_OBJECT_ACTION Constants ### Description Constants related to CREATE_OBJECT_ACTION, used for defining object creation actions. ### Method N/A (Constants) ### Endpoint N/A (Constants) ### Parameters N/A (Constants) ### Request Example N/A (Constants) ### Response #### Success Response (200) - **Constant Name** (string) - The name of the constant. - **Value** (int) - The integer value of the constant. #### Response Example { "constants": [ { "name": "CREATE_OBJECT_ACTION__REDEFINED_ELEMENT", "value": 35 }, { "name": "CREATE_OBJECT_ACTION__REDEFINED_NODE", "value": 45 }, { "name": "CREATE_OBJECT_ACTION__REDEFINITION_CONTEXT", "value": 37 }, { "name": "CREATE_OBJECT_ACTION__RESULT", "value": 65 }, { "name": "CREATE_OBJECT_ACTION__SUPPLIER_DEPENDENCY", "value": 21 }, { "name": "CREATE_OBJECT_ACTION__SYNC_ELEMENT", "value": 7 }, { "name": "CREATE_OBJECT_ACTION__TAGGED_VALUE", "value": 16 }, { "name": "CREATE_OBJECT_ACTION__VISIBILITY", "value": 30 }, { "name": "CREATE_OBJECT_ACTION_FEATURE_COUNT", "value": 66 } ] } ``` -------------------------------- ### Load and Access MagicDraw Project (Java) Source: https://context7.com/tmelsheimer/ai-ide-concept/llms.txt Demonstrates how to load an existing MagicDraw project file using the ProjectsManager and access its core components like the root model and diagrams. Requires the MagicDraw API libraries. ```java import com.nomagic.magicdraw.core.Application; import com.nomagic.magicdraw.core.Project; import com.nomagic.magicdraw.core.project.ProjectDescriptor; import com.nomagic.magicdraw.core.project.ProjectsManager; import com.nomagic.magicdraw.core.project.ProjectDescriptorsFactory; import com.nomagic.uml2.ext.jmi.reflect.Model; import com.nomagic.magicdraw.ui.diagram.DiagramPresentationElement; import java.io.File; import java.util.Collection; // Get the application instance Application application = Application.getInstance(); ProjectsManager projectsManager = application.getProjectsManager(); // Load an existing project File projectFile = new File("/path/to/project.mdzip"); ProjectDescriptor descriptor = ProjectDescriptorsFactory.createProjectDescriptor(projectFile.toURI()); try { projectsManager.loadProject(descriptor, true); Project project = application.getProject(); if (project != null) { System.out.println("Project loaded: " + project.getName()); // Access the root model Model rootModel = project.getModel(); System.out.println("Root package: " + rootModel.getName()); // Get all diagrams Collection diagrams = project.getDiagrams(); System.out.println("Number of diagrams: " + diagrams.size()); } } catch (Exception e) { System.err.println("Failed to load project: " + e.getMessage()); e.printStackTrace(); } ``` -------------------------------- ### MainToolbarConfigurationAction Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/serialized-form.html Represents a configuration action for the main toolbar, implementing Serializable. ```APIDOC ## Class MainToolbarConfigurationAction ### Description Configuration action for the main toolbar. ### Method N/A (Class definition) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ### Remarks Implements `Serializable`. ``` -------------------------------- ### UML Shapes Notation Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/allpackages-index.html Access to the implementation of all types of shapes (nodes) notation as described in the UML Notation Guide. ```APIDOC ## API Access: UML Shapes Notation ### Description Provides access to the Shapes package, which contains implementations for all types of shapes (nodes) notation as described in the UML Notation Guide. ### Method GET ### Endpoint /api/uml/symbols/shapes ### Parameters None ### Request Example ```json { "message": "Requesting access to UML shapes notation implementation." } ``` ### Response #### Success Response (200) - **package_name** (string) - The name of the UML package provided. - **description** (string) - A brief description of the package contents. #### Response Example ```json { "package_name": "shapes", "description": "Contains all types of shapes (nodes) notation described in UML Notation Guide." } ``` ``` -------------------------------- ### NMJideSplitButton Class Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/serialized-form.html Documentation for the NMJideSplitButton class, extending JideSplitButton, and its serialized fields including help listeners and shortcuts. ```APIDOC ## Class com.nomagic.awt.NMJideSplitButton ### Description Represents a split button component, extending `com.jidesoft.swing.JideSplitButton`. It implements `Serializable`. ### Method N/A (Class definition) ### Endpoint N/A (Class definition) ### Parameters N/A (Class definition) ### Request Example N/A (Class definition) ### Response #### Success Response (200) N/A (Class definition) #### Response Example N/A (Class definition) ### Serialized Fields * **mHelpListeners** (ArrayList) - A list of listeners for help events related to this button. * **mShortcuts** - (Type not specified in provided text) Associated shortcuts for the button. ``` -------------------------------- ### Transaction Management API Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/allclasses-index.html APIs for managing transactions within the MagicDraw model. This includes starting, committing, and listening to transaction events. ```APIDOC ## POST /api/transactions/start ### Description Starts a new transaction for model modifications. ### Method POST ### Endpoint /api/transactions/start ### Parameters #### Request Body - **options** (object) - Optional - Options for the transaction. - **read_only** (boolean) - Whether the transaction is read-only. ### Request Example ```json { "options": { "read_only": false } } ``` ### Response #### Success Response (200) - **transaction_id** (string) - The ID of the newly started transaction. #### Response Example ```json { "transaction_id": "tx-12345abc" } ``` ## POST /api/transactions/{transaction_id}/commit ### Description Commits the specified transaction, applying all changes made within it. ### Method POST ### Endpoint /api/transactions/{transaction_id}/commit ### Parameters #### Path Parameters - **transaction_id** (string) - Required - The ID of the transaction to commit. ### Response #### Success Response (200) - **message** (string) - A confirmation message indicating the transaction was committed successfully. #### Response Example ```json { "message": "Transaction tx-12345abc committed successfully." } ``` ## POST /api/transactions/listeners ### Description Registers a listener to receive notifications about transaction commit events. ### Method POST ### Endpoint /api/transactions/listeners ### Parameters #### Request Body - **callback_url** (string) - Required - The URL to send commit notifications to. ### Request Example ```json { "callback_url": "http://example.com/api/notify/transaction-commit" } ``` ### Response #### Success Response (200) - **message** (string) - A confirmation message indicating the listener has been registered. #### Response Example ```json { "message": "Transaction commit listener registered successfully." } ``` ``` -------------------------------- ### Get SysML Stereotype for WhiteBoxICDTable Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/deprecated-list.html Fetches the stereotype for a WhiteBoxICDTable element. This is typically used for interface control documents in system engineering. ```Java use getInstance(element).whiteBoxICDTable().getStereotype() ``` -------------------------------- ### DslBridgeInternal.Bridge Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/allclasses-index.html Interface for DSL bridge. ```APIDOC ## DslBridgeInternal.Bridge ### Description Interface for DSL bridge. ### Method N/A ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ### Response Example N/A ``` -------------------------------- ### BaseEmfUml2Helper Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/allclasses-index.html Provides helper functionalities for Eclipse UML2 XMI operations. ```APIDOC ## BaseEmfUml2Helper ### Description Eclipse UML2 XMI helper class. ### Method N/A (Class Documentation) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### Get SysML Stereotype for Value Property Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/deprecated-list.html Retrieves the stereotype for a value property, used for modeling data values and their types in SysML. ```Java use getInstance(element).valueProperty().getStereotype() ``` -------------------------------- ### Forecast Stereotype Properties Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/deprecated-list.html This section details the properties associated with the Forecast stereotype, including start date, end date, and the stereotype name. ```APIDOC ## Forecast Stereotype Properties ### Description Provides access to the start date, end date, and stereotype name for Forecast. ### Method GET ### Endpoint `/tmelsheimer/ai-ide-concept/forecastStereotype` ### Parameters #### Query Parameters - **propertyName** (string) - Required - Specifies the property to retrieve (e.g., 'ENDDATE', 'STARTDATE', 'STEREOTYPE_NAME'). ### Response #### Success Response (200) - **value** (string) - The value of the requested property. #### Response Example ```json { "value": "2024-12-31" } ``` ``` -------------------------------- ### Simulation Configuration Parameters Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/constant-values.html This section lists the available simulation configuration parameters, their corresponding string keys, and their data types. These parameters control various aspects of the simulation process. ```APIDOC ## Simulation Configuration Parameters ### Description This endpoint provides details on the available simulation configuration parameters. ### Method GET ### Endpoint `/simulation/config/parameters` ### Parameters None ### Request Example ```json {} ``` ### Response #### Success Response (200) - **parameters** (object) - An object containing simulation configuration parameters. - **animationSpeed** (String) - Controls the speed of animations during simulation. - **autoConvertUnits** (String) - Enables or disables automatic unit conversion. - **automaticParametricRecalculation** (String) - Enables or disables automatic parametric recalculation. - **autoStart** (String) - Enables or disables automatic starting of the simulation. - **autostartActiveObjects** (String) - Enables or disables automatic starting of active objects. - **autoTerminate** (String) - Enables or disables automatic termination of the simulation. - **captureTimestamp** (String) - Enables or disables timestamp capturing. - **clock_ratio** (String) - Sets the clock ratio for the simulation. - **cloneReferences** (String) - Enables or disables cloning of references. - **constraintFailureAsBreakpoint** (String) - Configures constraint failures as breakpoints. - **decimalPlaces** (String) - Sets the number of decimal places for display. - **durationSimulationMode** (String) - Configures the simulation mode to duration-based. - **endTime** (String) - Sets the end time for the simulation. - **enginesPriority** (String) - Sets the priority for simulation engines. - **excludedElements** (String) - Specifies elements to be excluded from the simulation. - **executionListeners** (String) - Configures execution listeners for the simulation. #### Response Example ```json { "animationSpeed": "String", "autoConvertUnits": "String", "automaticParametricRecalculation": "String", "autoStart": "String", "autostartActiveObjects": "String", "autoTerminate": "String", "captureTimestamp": "String", "clock_ratio": "String", "cloneReferences": "String", "constraintFailureAsBreakpoint": "String", "decimalPlaces": "String", "durationSimulationMode": "String", "endTime": "String", "enginesPriority": "String", "excludedElements": "String", "executionListeners": "String" } ``` ``` -------------------------------- ### FillsPost Stereotype Properties Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/deprecated-list.html This section details the properties associated with the FillsPost stereotype, including start date, end date, and the stereotype name itself. ```APIDOC ## FillsPost Stereotype Properties ### Description Provides access to the start date, end date, and stereotype name for FillsPost. ### Method GET ### Endpoint `/tmelsheimer/ai-ide-concept/fillsPostStereotype` ### Parameters #### Query Parameters - **propertyName** (string) - Required - Specifies the property to retrieve (e.g., 'ENDDATE', 'STARTDATE', 'STEREOTYPE_NAME'). ### Response #### Success Response (200) - **value** (string) - The value of the requested property. #### Response Example ```json { "value": "2023-12-31" } ``` ``` -------------------------------- ### DocumentationCommentProviderConfigurator.DocumentationCommentConfigurator Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/allclasses-index.html Interface for documentation comment configuration. ```APIDOC ## DocumentationCommentProviderConfigurator.DocumentationCommentConfigurator ### Description Interface for documentation comment configuration. ### Method N/A ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ### Response Example N/A ``` -------------------------------- ### Get UPDM Profile Stereotype - Node Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/deprecated-list.html Retrieves the stereotype for Node from a given element. This function requires an instance obtained through getInstance(element). ```Java com.nomagic.updm.utils.UPDMProfile.getNode() use getInstance(element).getNode().getStereotype() ``` -------------------------------- ### DomainSpecificCustomizationDifference Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/allclasses-index.html Indicates that an ancestor and contributor projects DSL customization differ. ```APIDOC ## DomainSpecificCustomizationDifference ### Description Indicates that an ancestor and contributor projects DSL customization differ. ### Method N/A ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ### Response Example N/A ``` -------------------------------- ### Protocol and Interface Actions Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/constant-values.html Actions related to managing protocols, transitions, and interfaces within the system. ```APIDOC ## ADD_PROTOCOL_TRANSITION ### Description Adds a transition to a protocol. ### Method N/A (This appears to be an action identifier, not a direct API endpoint) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` ```APIDOC ## ADD_PROTOCOL_TRANSITION_TO_SELF ### Description Adds a protocol transition to itself. ### Method N/A (This appears to be an action identifier, not a direct API endpoint) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` ```APIDOC ## ADD_PROVIDED_REQUIRED_INTERFACE ### Description Adds a provided or required interface. ### Method N/A (This appears to be an action identifier, not a direct API endpoint) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### Get UPDM Profile Stereotype - Needline Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/deprecated-list.html Retrieves the stereotype for Needline from a given element. This function requires an instance obtained through getInstance(element). ```Java com.nomagic.updm.utils.UPDMProfile.getNeedline() use getInstance(element).needline().getStereotype() ``` -------------------------------- ### Constants for DATA_STORE_NODE Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/constant-values.html This section details the integer constants related to DATA_STORE_NODE within the UMLPackage. ```APIDOC ## DATA_STORE_NODE Constants ### Description Constants related to DATA_STORE_NODE, used for representing data stores in activity diagrams. ### Method N/A (Constants) ### Endpoint N/A (Constants) ### Parameters N/A (Constants) ### Request Example N/A (Constants) ### Response #### Success Response (200) - **Constant Name** (string) - The name of the constant. - **Value** (int) - The integer value of the constant. #### Response Example { "constants": [ { "name": "DATA_STORE_NODE", "value": 221 }, { "name": "DATA_STORE_NODE___ACTIVITY_NODE_OF_REDEFINED_NODE", "value": 46 }, { "name": "DATA_STORE_NODE___ACTIVITY_PARTITION_OF_REPRESENTS", "value": 10 }, { "name": "DATA_STORE_NODE___CLASSIFIER_OF_INHERITED_MEMBER", "value": 24 }, { "name": "DATA_STORE_NODE___COMMENT_OF_ANNOTATED_ELEMENT", "value": 4 }, { "name": "DATA_STORE_NODE___CONSIDER_IGNORE_FRAGMENT_OF_MESSAGE", "value": 31 }, { "name": "DATA_STORE_NODE___CONSTRAINT_OF_CONSTRAINED_ELEMENT", "value": 11 }, { "name": "DATA_STORE_NODE___DIAGRAM_OF_CONTEXT", "value": 12 }, { "name": "DATA_STORE_NODE___DIRECTED_RELATIONSHIP_OF_SOURCE", "value": 13 }, { "name": "DATA_STORE_NODE___DIRECTED_RELATIONSHIP_OF_TARGET", "value": 14 }, { "name": "DATA_STORE_NODE___DURATION_OBSERVATION_OF_EVENT", "value": 33 }, { "name": "DATA_STORE_NODE___ELEMENT_OF_SYNC_ELEMENT", "value": 8 }, { "name": "DATA_STORE_NODE___ELEMENT_TAGGED_VALUE", "value": 18 }, { "name": "DATA_STORE_NODE___ELEMENT_VALUE_OF_ELEMENT", "value": 15 }, { "name": "DATA_STORE_NODE___EXCEPTION_HANDLER_OF_EXCEPTION_INPUT", "value": 53 } ] } ``` -------------------------------- ### Get UPDM Profile Stereotype - Mission Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/deprecated-list.html Retrieves the stereotype for Mission from a given element. This function requires an instance obtained through getInstance(element). ```Java com.nomagic.updm.utils.UPDMProfile.getMission() use getInstance(element).mission().getStereotype() ``` -------------------------------- ### Get UPDM Profile Stereotype - MilestoneSequence Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/deprecated-list.html Retrieves the stereotype for MilestoneSequence from a given element. This function requires an instance obtained through getInstance(element). ```Java com.nomagic.updm.utils.UPDMProfile.getMilestoneSequence() use getInstance(element).milestoneSequence().getStereotype() ``` -------------------------------- ### UML Paths Notation Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/allpackages-index.html Access to the implementation of all types of paths notation described in UML. ```APIDOC ## API Access: UML Paths Notation ### Description Provides access to the implementation of all types of paths notation as described in the UML specification. ### Method GET ### Endpoint /api/uml/symbols/paths ### Parameters None ### Request Example ```json { "message": "Requesting access to UML paths notation implementation." } ``` ### Response #### Success Response (200) - **package_name** (string) - The name of the UML package provided. - **description** (string) - A brief description of the package contents. #### Response Example ```json { "package_name": "paths", "description": "Contains implementation of all types of paths notation described in UML." } ``` ``` -------------------------------- ### Get UPDM Profile Stereotype - Metadata Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/deprecated-list.html Retrieves the stereotype for Metadata from a given element. This function requires an instance obtained through getInstance(element). ```Java com.nomagic.updm.utils.UPDMProfile.getMetadata() use getInstance(element).metadata().getStereotype() ``` -------------------------------- ### ManageWindowsCategory Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/serialized-form.html A category for managing windows, extending MDActionsCategory and implementing Serializable. ```APIDOC ## Class ManageWindowsCategory ### Description Category for managing windows within the IDE. ### Method N/A (Class definition) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ### Remarks Extends `com.nomagic.magicdraw.actions.MDActionsCategory` and implements `Serializable`. ``` -------------------------------- ### Get UPDM Profile Stereotype - MeasureType Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/deprecated-list.html Retrieves the stereotype for MeasureType from a given element. This function requires an instance obtained through getInstance(element). ```Java com.nomagic.updm.utils.UPDMProfile.getMeasureType() use getInstance(element).measureType().getStereotype() ``` -------------------------------- ### Get UPDM Profile Stereotype - MeasurementSet Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/deprecated-list.html Retrieves the stereotype for MeasurementSet from a given element. This function requires an instance obtained through getInstance(element). ```Java com.nomagic.updm.utils.UPDMProfile.getMeasurementSet() use getInstance(element).measurementSet().getStereotype() ``` -------------------------------- ### ElementActivationManager Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/allclasses-index.html Register ElementActivator instances. ```APIDOC ## ElementActivationManager ### Description Register ElementActivator instances. ### Method N/A ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ### Response Example N/A ``` -------------------------------- ### MaximizeEditorWindows Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/serialized-form.html Action to maximize editor windows, extending MDStateAction and implementing Serializable. ```APIDOC ## Class MaximizeEditorWindows ### Description Action to maximize the editor windows. ### Method N/A (Class definition) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ### Serialized Fields * **manager** (com.nomagic.magicdraw.ui.AbstractFramesManager) - The frames manager responsible for window operations. ``` -------------------------------- ### Get UPDM Profile Stereotype - Measurement Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/deprecated-list.html Retrieves the stereotype for Measurement from a given element. This function requires an instance obtained through getInstance(element). ```Java com.nomagic.updm.utils.UPDMProfile.getMeasurement() use getInstance(element).measurement().getStereotype() ``` -------------------------------- ### BrowserDialog Component Documentation Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/serialized-form.html Documentation for the BrowserDialog class, which extends BaseDialog and implements Serializable. It outlines the serialized fields related to browser authentication and management. ```APIDOC ## BrowserDialog Class Documentation ### Description Represents a dialog box that displays a browser component. It includes fields for authentication URL, browser instance, panel, and synchronization latches. ### Class `com.nomagic.magicdraw.ui.dialogs.BrowserDialog` ### Implements `java.io.Serializable` ### Serialized Fields * **authURL** (String) - The URL used for authentication. * **browser** (com.teamdev.jxbrowser.browser.Browser) - The browser instance used within the dialog. * **browserPanel** (com.nomagic.ui.LazyInitializationPanel) - A panel for lazily initializing the browser component. * **latch** (java.util.concurrent.CountDownLatch) - A latch for synchronization purposes. * **loginDialog** (com.nomagic.magicdraw.teamwork2.ui.TeamworkLoginDialog) - A dialog for handling teamwork logins. * **releaseLatch** (java.util.concurrent.atomic.AtomicBoolean) - An atomic boolean used as a release latch. ``` -------------------------------- ### Get UPDM Profile Stereotype - Measure Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/deprecated-list.html Retrieves the stereotype for Measure from a given element. This function requires an instance obtained through getInstance(element). ```Java com.nomagic.updm.utils.UPDMProfile.getMeasure() use getInstance(element).measure().getStereotype() ``` -------------------------------- ### Get UPDM Profile Stereotype - Materiel Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/deprecated-list.html Retrieves the stereotype for Materiel from a given element. This function requires an instance obtained through getInstance(element). ```Java com.nomagic.updm.utils.UPDMProfile.getMateriel() use getInstance(element).materiel().getStereotype() ``` -------------------------------- ### MagicDraw Module and Tree Switch Actions (Java) Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/serialized-form.html Describes ShowNotLoadedModulesAction and SwitchToTreeAction, both extending MagicDraw specific action classes (NMAction and MDAction respectively) and implementing Serializable. ```Java class ShowNotLoadedModulesAction extends com.nomagic.actions.NMAction implements Serializable ``` ```Java class SwitchToTreeAction extends com.nomagic.magicdraw.actions.MDAction implements Serializable ``` -------------------------------- ### Get UPDM Profile Stereotype - MapsToCapability Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/deprecated-list.html Retrieves the stereotype for MapsToCapability from a given element. This function requires an instance obtained through getInstance(element). ```Java com.nomagic.updm.utils.UPDMProfile.getMapsToCapability() use getInstance(element).mapsToCapability().getStereotype() ``` -------------------------------- ### EcoreRefPackage Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/allclasses-index.html Represents an Ecore reference package. ```APIDOC ## EcoreRefPackage ### Description Represents an Ecore reference package. ### Method N/A ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ### Response Example N/A ``` -------------------------------- ### Diagram Context Toolbar AM Configurator Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/allclasses-index.html Interface for all diagram context toolbar action configurators. ```APIDOC ## GET /diagrams/context/toolbar/amconfigurator ### Description Retrieves the action configurator for diagram context toolbar actions. ### Method GET ### Endpoint /diagrams/context/toolbar/amconfigurator ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **configurator** (object) - An object implementing the DiagramContextToolbarAMConfigurator interface. #### Response Example ```json { "configurator": "// Implementation details of the configurator" } ``` ``` -------------------------------- ### Get UPDM Profile Stereotype - LogicalDataModel Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/deprecated-list.html Retrieves the stereotype for LogicalDataModel from a given element. This function requires an instance obtained through getInstance(element). ```Java com.nomagic.updm.utils.UPDMProfile.getLogicalDataModel() use getInstance(element).logicalDataModel().getStereotype() ``` -------------------------------- ### Get UPDM Profile Stereotype - LogicalArchitecture Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/deprecated-list.html Retrieves the stereotype for LogicalArchitecture from a given element. This function requires an instance obtained through getInstance(element). ```Java com.nomagic.updm.utils.UPDMProfile.getLogicalArchitecture() use getInstance(element).logicalArchitecture().getStereotype() ``` -------------------------------- ### Activity Parameter Node Constants Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/constant-values.html This section lists the constants related to Activity Parameter Nodes within the UMLPackage, including their integer identifiers. ```APIDOC ## Activity Parameter Node Constants ### Description This endpoint provides a list of constants associated with Activity Parameter Nodes in the UMLPackage. Each constant represents a specific attribute or relationship and is assigned an integer value. ### Method GET ### Endpoint /tmelsheimer/ai-ide-concept/constants/activity-parameter-node ### Parameters None ### Request Example None ### Response #### Success Response (200) - **constants** (object) - An object where keys are the constant names and values are their corresponding integer identifiers. #### Response Example ```json { "constants": { "ACTIVITY_PARAMETER_NODE__IN_STATE": 48, "ACTIVITY_PARAMETER_NODE__IN_STRUCTURED_NODE": 41, "ACTIVITY_PARAMETER_NODE__INCOMING": 44, "ACTIVITY_PARAMETER_NODE__IS_CONTROL_TYPE": 49, "ACTIVITY_PARAMETER_NODE__IS_LEAF": 34, "ACTIVITY_PARAMETER_NODE__MD_EXTENSIONS": 1, "ACTIVITY_PARAMETER_NODE__NAME": 27, "ACTIVITY_PARAMETER_NODE__NAME_EXPRESSION": 28, "ACTIVITY_PARAMETER_NODE__NAMESPACE": 23, "ACTIVITY_PARAMETER_NODE__ORDERING": 50, "ACTIVITY_PARAMETER_NODE__OUTGOING": 43, "ACTIVITY_PARAMETER_NODE__OWNED_COMMENT": 3, "ACTIVITY_PARAMETER_NODE__OWNED_ELEMENT": 5, "ACTIVITY_PARAMETER_NODE__OWNER": 6, "ACTIVITY_PARAMETER_NODE__PARAMETER": 54, "ACTIVITY_PARAMETER_NODE__QUALIFIED_NAME": 29, "ACTIVITY_PARAMETER_NODE__REDEFINED_ELEMENT": 35, "ACTIVITY_PARAMETER_NODE__REDEFINED_NODE": 45, "ACTIVITY_PARAMETER_NODE__REDEFINITION_CONTEXT": 37, "ACTIVITY_PARAMETER_NODE__SELECTION": 51, "ACTIVITY_PARAMETER_NODE__SUPPLIER_DEPENDENCY": 21, "ACTIVITY_PARAMETER_NODE__SYNC_ELEMENT": 7, "ACTIVITY_PARAMETER_NODE__TAGGED_VALUE": 16, "ACTIVITY_PARAMETER_NODE__TYPE": 47, "ACTIVITY_PARAMETER_NODE__UPPER_BOUND": 52 } } ``` ``` -------------------------------- ### Get UPDM Profile Stereotype - LocationType Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/deprecated-list.html Retrieves the stereotype for LocationType from a given element. This function requires an instance obtained through getInstance(element). ```Java com.nomagic.updm.utils.UPDMProfile.getLocationType() use getInstance(element).locationType().getStereotype() ``` -------------------------------- ### NMAlert Class Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/serialized-form.html Documentation for the NMAlert class, which extends com.jidesoft.alert.Alert and implements Serializable. ```APIDOC ## Class com.nomagic.awt.NMAlert ### Description Provides alert functionality, extending the `Alert` class from the Jidesoft library. It implements `Serializable`. ### Method N/A (Class definition) ### Endpoint N/A (Class definition) ### Parameters N/A (Class definition) ### Request Example N/A (Class definition) ### Response #### Success Response (200) N/A (Class definition) #### Response Example N/A (Class definition) ``` -------------------------------- ### Get UPDM Profile Stereotype - LocationHolder Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/deprecated-list.html Retrieves the stereotype for LocationHolder from a given element. This function requires an instance obtained through getInstance(element). ```Java com.nomagic.updm.utils.UPDMProfile.getLocationHolder() use getInstance(element).locationHolder().getStereotype() ``` -------------------------------- ### AI IDE Concept Actions Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/constant-values.html This section details various actions available within the AI IDE concept, including resetting changes, resizing elements, resource management, and validation. ```APIDOC ## AI IDE Actions ### Description This API provides a list of predefined actions available within the AI IDE concept. These actions cover various functionalities such as resetting configurations, managing resources, and performing validation checks. ### Method N/A (Constants Declaration) ### Endpoint N/A (Constants Declaration) ### Parameters N/A ### Request Example N/A ### Response N/A #### Available Actions (Constants): - `RESET_CHANGES`: Resets any current changes. - `RESET_LABELS_POSITIONS`: Resets the positions of labels. - `RESET_TO_DEFAULT_STYLE`: Resets the UI to its default style. - `RESIZE_LABELS_TO_FIT_CONTENT`: Resizes labels to fit their content. - `RESIZE_TO_FIT_CONTENT`: Resizes elements to fit their content. - `RESOURCE_MANAGER`: Opens the resource manager. - `RETRIEVE_DOCUMENTATION`: Retrieves documentation. - `REVERSE_DIRECTION`: Reverses the direction of an element or action. - `REVERSE_ICON_DIRECTION`: Reverses the direction of an icon. - `REVERSE_IMPLEMENTATION`: Reverses the implementation details. - `ROLE_A_ACTIONS`: Actions related to Role A. - `ROLE_B_ACTIONS`: Actions related to Role B. - `ROTATE_LABEL_BUTTON`: Rotates a label button. - `ROUTE_PATHS_ORGANIC_STYLE`: Applies organic style to route paths. - `ROUTE_PATHS_ORTHOGONAL_STYLE`: Applies orthogonal style to route paths. - `RUN_LAST_VALIDATION`: Runs the last performed validation. - `RUN_SPELL_CHECKER`: Runs the spell checker. ``` -------------------------------- ### Get UPDM Profile Stereotype - Location Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/deprecated-list.html Retrieves the stereotype for Location from a given element. This function requires an instance obtained through getInstance(element). ```Java com.nomagic.updm.utils.UPDMProfile.getLocation() use getInstance(element).location().getStereotype() ``` -------------------------------- ### Class: com.nomagic.magicdraw.ui.diagrams.QuickFilterHintTextOverlay Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/serialized-form.html Represents a hint text overlay for quick filtering in diagrams. It includes components like iconPanel and lastAppliedText. ```APIDOC ## Class com.nomagic.magicdraw.ui.diagrams.QuickFilterHintTextOverlay ### Description Represents a hint text overlay for quick filtering in diagrams. ### Components * **iconPanel** (T extends com.nomagic.magicdraw.ui.diagrams.QuickFilterFieldIconPanel) - The icon panel associated with the overlay. * **lastAppliedText** (String) - The last applied text for the quick filter. ``` -------------------------------- ### Get UPDM Profile Stereotype - LightCondition Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/deprecated-list.html Retrieves the stereotype for LightCondition from a given element. This function requires an instance obtained through getInstance(element). ```Java com.nomagic.updm.utils.UPDMProfile.getLightCondition() use getInstance(element).lightCondition().getStereotype() ``` -------------------------------- ### Project Comparison and Merge Actions Source: https://github.com/tmelsheimer/ai-ide-concept/blob/main/serialized-form.html This section details actions related to comparing and merging projects, including options dialogs and remote merge capabilities. ```APIDOC ## Class ProjectCompareAction ### Description Represents an action for comparing projects, potentially involving a dialog for user options. ### Method N/A (Class definition) ### Endpoint N/A (Class definition) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) None #### Response Example None ## Class RemoteProjectMergeAction ### Description Represents an action for merging remote projects. ### Method N/A (Class definition) ### Endpoint N/A (Class definition) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) None #### Response Example None ```