CIMgen

CIMgen is a command-line tool that generates language-specific data models (classes, structs) from Common Information Model (CIM) RDF schemas. It is designed to parse complex CIM RDF files and produce idiomatic code in various programming languages like Go, C++, Java, and Python.

Several projects use CIMgen, see Projects using CIMgen.

CIMgen Go

This is a rewrite of CIMgen in the Go programming language.

How to Build and Run

Make sure that you have cloned the repo recursively to include the CGMES schema files from ENTSO-E

git clone --recurse-submodules [...]

or clone the submodule in a second step

git submodule update --init --recursive

Ensure that GOPATH is set and included in your PATH.

Change into the cimgen-go folder:

cd cimgen-go

Use the go run command, specifying the target language with the -lang flag.

# Example for generating C++ code
go run cmd/cimgen/main.go -lang cpp

Alternatively, you can install cimgen.

go install ./...

How to Test

Run the test suite using the go test command. The -v flag provides verbose output.

go test -v ./...

Debugging

To analyze differences between generated file you can use

git diff --no-index --word-diff --diff-filter=MR --ignore-space-change --ignore-blank-lines output/[dir 1] output/[dir 2]
diff -wB output/[dir 1] output/[dir 2]

Architecture

The code generation process follows these main steps:

Schema Loading: The tool begins by finding and parsing the relevant CIM RDF schema files based on the specified version and profiles.
Schema Processing: It processes the parsed RDF data into an internal, language-agnostic representation of CIM classes, properties, datatypes, and their relationships.
Code Generation: Using Go's text/template engine, it feeds the internal representation into language-specific templates (lang-templates/*.tmpl) to generate the final source code files.

Key Go Files

cmd/cimgen/main.go: The main entry point for the CLI tool. It parses command-line arguments and orchestrates the code generation process.
cim_generate.go: Contains the core logic for driving the generation process for a specific language.
cim_schema_import.go: Handles the discovery and parsing of the CIM RDF schema files.
cim_schema_processing.go: Responsible for transforming the raw parsed schema into the internal representation used by the generators.
generator_*.go: A set of files (e.g., generator_go.go, generator_cpp.go) that implement the generation logic for each target language.

CIMgen Python

Python tool for code generation from CIM data model for several programming languages

Usage

Generating C++ files

Generating C++ files on Linux

pip install -e .
cimgen --outdir=output/cpp/CGMES_2.4.15_27JAN2020 --schemadir=cgmes_schema/CGMES_2.4.15_27JAN2020 --langdir=cpp --cgmes_version=cgmes_v2_4_15

This will build version CGMES_2.4.15_27JAN2020 in the subfolder output/cpp/CGMES_2.4.15_27JAN2020.

Note

If you wish to build an alternative version, you can see available options in the subfolder called cgmes_schema. For the schema CGMES_3.0.0 you have to use the option --cgmes_version=cgmes_v3_0_0. outdir can be set to whichever absolute path you wish to create the files in.

Alternatively, you can leverage Makefile:

pip install -e .
#unset BUILD_IN_DOCKER # if you previously set to use docker
#export SCHEMA=CGMES_3.0.0 # to use CGMES 3.0.0
make cpp