Code Monkey home page Code Monkey logo

fbd-complexity-tool's Introduction

Tiqva logo

Tiqva - FBD complexity measurement tool

FBD Complexity Tool is a Java program used for measuring code complexity metrics of IEC 61131-3 Function Block Diagram programs. The tool supports FBD programs saved in the PLC Open TC6 XML schema.

Requirements

  • Java 1.8 Run Time Environment
  • Maven (for building the project)

Setup

To build the project, run the following Maven command: $ mvn clean package

This will pull all the dependencies from the Maven repository, build the project and create an executable .jar in the \target directory

Usage

The tool requires three parameters to successfully perform the complexity metrics measurements:

  • Path to the folder with FBD XML files
  • Path to the configuration file
  • Output file path

Using the provided example PLC project:

java -jar ./target/fbd-complexity-tool.jar -c ./examples/config.properties -f ./examples -o results.csv

The measurement results will be stored in a CSV file (results.csv in the example above).

Notes

The FBD Complexity Measurement Tool can measure different type of code complexities:

  • Number of Elements
  • Cyclomatic Complexity Number
  • Halstead Metrics
  • Information Flow Metric

The listed complexity metrics are defined for general-purpose programming languages (such as C or Java). Mapping of these complexity metrics (Number of Elements metric relates to the Lines of Code metric for general purpose programming languages) to the FBD syntax has been done and documented in a research paper (link).

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.