Detailed Description

The UI Loader Widget class loads form (.ui) files dynamically and includes functionality to replace routings in real time.

The routing replacement functionality allows one form file to show data from different systems by the click of a button. Routings can be changed either by providing replacement strings to the slot named setRoutingReplacement(QString) or by configuring replacement strings as dynamic properties on the following format:

stringReplacement1="$(REPLACE1)=Replacement1;$(REPLACE2)=OtherReplacement1"
stringReplacement2="$(REPLACE1)=Replacement2;$(REPLACE2)=OtherReplacement2"

You can provide any number of replacements separated by ";". The replacements are added by first specifying the string that are to be replaced in the routings, followed by an equal sign and then the string that we want to replace it with (e.g. $(COMPONENT)=Pump1).

The dynamic properties must be named stringReplacement followed by a number. After configuring the properties, providing the numbers to the slot named setRoutingReplacement(int) or setRoutingReplacement(double) will select the routing replacements. It is also possible to control this using a cdp object by adding routing to the property named cdpSelectReplacementRouting.

The replacements strings are executed on the routings from left to right. The order of the first replacements will be used in all consecutive replacements. Meaning, that if stringReplacement2 in the above example had $(REPLACE2) as its first replacement, it would still be executed after $(REPLACE1) as this is the order used in stringReplacement1. The same goes if the replacements are added using setRoutingReplacement(QString).

To avoid broken routings in the application, the template variables need to be wrapped in $(). The alternative is to ensure that the initial routings are valid (e.g. use MyComp1 instead of $(REPLACE1) in the above example and then use MyComp1=MyComp2 in stringReplacement2 etc.).

Example

The following example discuss the different use cases of the CDPBaseUiLoaderWidget. Each section add more functionality.

How to load a form within a form

A simple example of using the CDPBaseUiLoaderWidget is to create two form files, main.ui and load.ui. The main form is typically based on CDPBaseMainWindow and the second one is usually based on a standard QWidget. Add a CDPBaseUiLoaderWidget to the main form and make it load the load.ui form by editing the property named, uiFileName. The load.ui file must be added as a resource, be in the studio working directory or include full path to show in studio. The first option is usually the best one.

How to replace routings in a loaded form

Start by adding a CDPBaseMeter to the load.ui form and add the following routing to the cdpRouting property; AppName.$(SIGNAL).Value. In this string, the word $(SIGNAL) is what we want to replace. Replace AppName with the name of your application if it is named differently.

Next, we need to setup the replacement strings on the CDPBaseUiLoaderWidget in the main.ui form. Create a dynamic property by clicking on the plus icon next to the filter in the property panel and select String.... Name the property stringReplacement1 and repeat the steps to create a second property named stringReplacement2. Add the following value in the first property $(SIGNAL)=CPULoad and add $(SIGNAL)=MemUsedRelative to the second one.

Now, when the CDPBaseUiLoaderWidget receives the value 1 or 2, either by setRoutingReplacement slot or by adding routing in the property named cdpSelectReplacementRouting, the CDPBaseMeter will show CPULoad or MemUsedRelative respectively.