@simatic-ax/string-builder

Description

The package @simatic-ax/string-builder provides a StringBuilder class that implements a fluent interface. This allows users to chain string operations.

The construction of composite strings follows a pattern which is closer to natural speech compared with the conventional string operations (e.g. CONCAT). The readability of string operations is improved by using the package.

Getting started

Install with Apax:

If not yet done login to the GitHub registry first. More information you'll find here

apax add @simatic-ax/string-builder

Add the namespace in your ST code:

USING Simatic.Ax.Strings;

Objects

UML Diagram

classDiagram
    class StringBuilder
        StringBuilder : -_string STRING
    interface IConstrainedStringBuilder
        IConstrainedStringBuilder : +Reset IConstrainedStringBuilder
        IConstrainedStringBuilder : +Append IStringBuilder
        IConstrainedStringBuilder : +ToString() STRING 
    interface IStringBuilder
        IStringBuilder : +Insert() IStringBuilder
        IStringBuilder : +Remove() IStringBuilder
        IStringBuilder : +Substring() IStringBuilder
        IStringBuilder : +StartOf() IStringBuilder
        IStringBuilder : +EndOf() IStringBuilder
        IStringBuilder : +Replace() IStringBuilder
    IConstrainedStringBuilder <|-- IStringBuilder
    StringBuilder ..|> IStringBuilder

Loading

Interfaces

IStringBuilder
IConstrainedStringBuilder

Classes

StringBuilder

Methods

Name	Description
Reset	Reset the current string to an empty string
Append	Append the text to the current string and return it
Insert	Insert the text at a specific location in the string and return it
Remove	Remove characters from the string and return it
Substring	Retrieve a specific part of the string and return it
StartOf	Retrieve the start of a string and return it
EndOf	Retrieve the end of a string and return it
Replace	Replace characters in a string and return it
ToString	Return the current string

Example

Configuration

CONFIGURATION MyConfiguration

    TASK Main(Interval := T#100ms, Priority := 1);
    PROGRAM P1 WITH Main: MyProgram;

    VAR_GLOBAL
        diagnosticMessage  : STRING;
    END_VAR

END_CONFIGURATION

Program

USING Simatic.Ax.Strings
PROGRAM MyProgram

    VAR_EXTERNAL
        diagnosticMessage : STRING;
    END_VAR

    VAR
        _sb : StringBuilder;
    END_VAR

    diagnosticMessage := _sb.Append('build a string').Append(' by chaining methods.').Insert('How to ',0).ToString();
    // result : "How to build a string by chaining methods."
    
END_PROGRAM

Contribution

Thanks for your interest in contributing. Anybody is free to report bugs, unclear documentation, and other problems regarding this repository in the Issues section or, even better, is free to propose any changes to this repository using Merge Requests.

Markdownlint-cli

This workspace will be checked by the markdownlint-cli (there is also documented ho to install the tool) tool in the CI workflow automatically. To avoid, that the CI workflow fails because of the markdown linter, you can check all markdown files locally by running the markdownlint with:

markdownlint **/*.md --fix

License and Legal information

Please read the Legal information