Bohemian - SysML Model Viewer¶

Bohemian is a SysML model viewer and IDL code generator for IBM Rhapsody projects. It provides a graphical interface for exploring SysML models and can automatically generate OMG IDL files suitable for DDS deployment in GVA systems.

Overview¶

Bohemian provides the following capabilities:

• Rhapsody Project Loading: Parse and display IBM Rhapsody .rpyx project files and .sbsx model files
• Model Navigation: Tree-based navigation of packages, classes, types, and relationships
• Diagram Visualization: Interactive block diagram canvas showing class structures and dependencies
• IDL Code Generation: Export SysML models to OMG IDL format for DDS communication
• LDM Pattern Detection: Automatic detection of GVA Land Data Model patterns in models

Running Bohemian¶

Basic Usage¶

# Launch the GUI
./build/bin/bohemian

# Open a specific Rhapsody project
./build/bin/bohemian /path/to/project.rpyx

Command Line Options¶

Headless IDL Export¶

For automated builds or CI/CD pipelines, Bohemian can export IDL files without launching the GUI:

# Export IDL from a project file
./build/bin/bohemian --export-idl ./output/idl /path/to/project.rpyx

# Export IDL from a directory of .sbsx files
./build/bin/bohemian --export-idl ./output/idl /path/to/model/directory

User Interface¶

Main Window Layout¶

The Bohemian interface consists of three main panels:

1. Model Tree (left): Hierarchical view of all model elements
2. Diagram Canvas (center): Visual representation of blocks and relationships
3. Properties Panel (right): Detailed information about selected elements

Class Diagram View¶

The diagram canvas displays SysML blocks with their attributes, operations, and relationships:

Interaction Diagram View¶

Bohemian supports visualization of SysML interaction models (sequence diagrams) showing message flows between objects:

State Chart View¶

State machine diagrams display the behavioral states and transitions for classes:

View Controls¶

IDL Code Generation¶

Bohemian generates OMG IDL files following the GVA Translator Guide (Issue 1.2) mapping rules:

Using the Export Dialog¶

1. Open a Rhapsody project using File > Open Project or drag-and-drop
2. Navigate the model tree to verify the structure
3. Select File > Export IDL... to open the export dialog
4. Choose the output directory
5. Click Export to generate IDL files

Export Options¶

The IDL exporter supports several configuration options:

• Generate Comments: Include element descriptions from the model
• Generate @key Annotations: Add DDS key annotations for topic identification
• Generate DDS Annotations: Add @appendable, @mutable, @autoid, @optional annotations
• Generate Topic Constants: Create KC_*_TopicName constants for DDS topics
• Generate Include Guards: Add #ifndef/#define header guards

Building Generated IDL¶

After exporting IDL files, compile them using the AstuteDDS IDL compiler:

Using astutedds-idl¶

# Generate C++ code from exported IDL files
astutedds-idl -o ./generated/cpp -I ./ldm/UK/GVA/v10.0.0/IDL Alarms.idl

# Compile multiple IDL files with include paths
astutedds-idl -o ./generated/cpp \
    -I ./ldm/UK/GVA/v10.0.0/IDL \
    -I ./ldm/UK/GVA/Common \
    Sensors.idl Actuators.idl

# Generate Python bindings
astutedds-idl -l python -o ./generated/python Alarms.idl

AstuteDDS IDL Compiler Options¶

Using the LDM SDK Build System¶

Alternatively, the LDM SDK's CMake configuration will automatically compile IDL files:

cd /path/to/ldm
mkdir -p build && cd build
cmake ..
make -j$(nproc)

Workflow Example¶

A typical workflow for using Bohemian with the LDM SDK:

1. Design your data model in IBM Rhapsody using SysML
2. Export the project to a .rpyx file
3. Open the project in Bohemian to verify the structure
4. Generate IDL files using the Export function
5. Place IDL files in the appropriate ldm/ directory
6. Build the LDM SDK to generate C++ types and Qt wrappers
7. Use the generated QtWrapper*PubSub.h classes in your application

Troubleshooting¶

Project Won't Load¶

• Ensure the .rpyx file is a valid IBM Rhapsody project
• Check that all referenced .sbsx model files are accessible
• Verify file permissions allow read access

IDL Export Fails¶

• Confirm the output directory exists and is writable
• Check for circular dependencies in the model
• Review the console output for specific error messages

Diagram Not Displaying¶

• Try View > Zoom to Fit to center the diagram
• Use View > Toggle Auto Layout to reorganize elements
• Check that the selected element has diagram content

Related Documentation¶

The following documents from the LOSA Portal provide additional context for working with SysML models and IDL generation:

Access these documents at https://landopensystems.mod.gov.uk

AI Agent for Domain Creation¶

Bohemian includes an integrated AI agent that assists with creating new LDM domains. The agent understands LDM modelling conventions, GVA patterns, and can help design data structures for integrating external systems.

Setting Up Claude API Access¶

Before using the AI agent, configure your Anthropic Claude API key:

1. Obtain an API Key: Create an account at console.anthropic.com and generate an API key
2. Open Preferences: Go to Edit > Preferences (Ctrl+,)
3. Configure AI Settings: In the AI Agent tab, enter your API key and select your preferred model

Accessing the AI Agent¶

1. Open the AI Agent panel via View > AI Agent or press Ctrl+Shift+A
2. Verify the status indicator shows "Connected" (green)
3. Start a conversation describing what you want to create

Creating New Domains¶

The AI agent excels at helping you design new domains for external system integration. For example, creating an ATAK Cursor-on-Target domain:

Example workflow:

1. Describe the external system or protocol you want to integrate
2. The agent researches the data format and identifies key structures
3. It proposes LDM-compliant types following naming conventions
4. Review and refine the design interactively
5. Export the generated IDL code

Understanding Domain Concepts¶

Ask the AI agent to explain complex military or technical concepts:

Example prompts:

AI Agent Features¶

• LDM Convention Awareness - Applies P_, C_, T_, A_, L_, KC_ prefixes automatically
• DDS Annotation Support - Adds @key, @appendable, @optional appropriately
• Military Standards Knowledge - Understands STANAG, MIL-STD, and NATO formats
• Step-by-Step Guidance - Walks through complex designs incrementally
• IDL Code Generation - Produces ready-to-compile OMG IDL output