What is ModFrame

ModFrame is a software tool made to support fast development and configuration of model based systems for process operation applications. ModFrame may be viewed as a development environment for model based process control applications. However, it may be used as a basis for many different computations which are to be performed cyclic. ModFrame consists of a set of components performing different tasks.

ModFrame is thus a set of software tools with the following purposes:

• Defining computational algorithms for control of a process or for simulation purposes based on predefined algorithms and hierarchically organized control blocks.

• Configuration of numerical process descriptions and process topologies by drawing process diagrams on a computer screen.

• Configuring and parameterizing these models/algorithms.

• Execution of on-line model based process supervision and control functionality.

• Interaction and communication with existing control system and process I/O functionality via Apis Hive. Apis Hive is both an OPC server and has the possibility to communicate with other OPC server through its OPC client.

• The component based structure ensures re-usability and flexibility.

Application structure

ModFrame consists of a server and a client which runs independently of each other. The client connects to a server and configures it, but it can be closed without affecting the server's computations.

Servers perform the actual computations, and several servers can run on different machines and share the computational load by passing data to each other through ApisHive's OPC mechanisms. Data from an external I/O system will also typically be retrieved from ApisHive.

The client, as opposed to the server, has an advanced user interface (UI), enabling the configuration of the server as well as displaying current computational results. Several clients can connect to a single server, and configure or view results simultaneously.

The basic UI is a graphical process representation, where each process unit or computational unit (real or conceptual/functional) is represented by a graphical icon in a process graphics picture. For a chemical process part, this graphic representation may look like a simplified process flow sheet with computational units attached (controllers, optimisers, soft sensors).

Dependencies

• ModFrame is a Java-application and the Java Runtime Environment (JRE) 1.6 must be installed on the computer running ModFrame.
• If ModFrame is to run in the ApisHive environment, the ApisJavaBee must be installed.
• The ModFrame installation kit runs currently only in Windows. If ModFrame is to be used on other platforms, please contact Prediktor for installation instructions. www.prediktor.no.

Installation

By double-clicking the ModFrame.msi file, the ModFrame application will be installed. Both the server and client software will be installed. It is currently not possible to only install the server or the client. After installation go to the All Programs->APIS->ModFrame where there will two items: ModFrame Client and ModFrame Server.

Choose the ModFrame Server and observe that the server window is displayed.

Choose the ModFrame Client and observe the client window is displayed. Connect to the server started in the previous steps.

See also: Classpath and JavaOptions.

Using ModFrame

Concepts

Server

Introduction

The server can either run stand-alone or as part of the ApisHive application through the ApisJavaBee-module. The ModFrame server will perform the actual computations and communicate with I/O systems for instance through the ApisHive framework. It runs independently of whether one or more clients are connected. It can be configured to load an application file and start performing computations when the it starts both as a stand-alone server and when it runs as a part of the ApisHive framework.

Stand-alone server

When the server runs as stand-alone, it can be started by selecting the following entry All Programs->Apis->ModFrame->ModFrame server.

Server settings

The server settings will be read from the serverstart.ini file in the ModFrame installation directory. This is a text file where one line can contain one setting. The default value column indicates the value of the setting if it is not present in the file.

Batch file

It is possible to create a batch file which starts the server with custom settings. Below is an example of the contents of a batch file. This must be altered to fit the installation. Using batch files it is possible to set all java options as well as the ini-file containing the elements described above.

C:\\\Program Files\Java\jdk1.6.0_03\bin\javaw.exe -Xmx768m -XX:+UseConcMarkSweepGC -verbose:gc -Dswing.defaultlaf=javax.swing.plaf.metal.MetalLookAndFeel -Djava.security.policy=java.policy -classpath C:\\\Apis\ModFrame\ModFrame.jar;C:\\\Apis\ModFrame\xml.jar;C:\\\Apis\ModFrame\jtds-1.2.2.jar;C:\\\Apis\ModFrame\ClickAndTrace.jar; com.modframe.server.MFServer "C:\\\Apis\ModFrame\serverstart.ini"

Part of the ApisHive Framework

The ModFrame application can run inside the ApisHive process through the ApisJavaBee-module. In this case the settings described for the stand-alone server will be exposed as properties in the ApisJavaBee-module, and the class-path and java options are set in registry.

ApisJavaBee

This module will load a java-application. Items can be created and connected to ports in ModFrame.

Properties

Property	Description	Default value
ExchangeRate	The exchange rate in milliseconds when retrieving values from external items	0 (Turned off)
Run	States whether the ModFrame is performing computations.	False
JavaAppVisible	Specifies if the ModFrame server window is visible or not. (If ApisHive is run as a windows server, the window is always invisible.)	True.
JavaAppStartfile	The application file which will be opened when ApisHive is started.
ApplicationFilePath	The path to where the application files are stored.	The ApisHive config folder
LibraryFilePath	The path to where the library files are stored.	The ApisHive config folder
TimeStep	The computational time interval [ms] between the computations.	1000
Timer	The time interval [ms] of the timer trigging the computations. This interval is the real-time interval between computations, whereas TimeStep is the simulated time interval. If the system is to be run  real-time these two properties should be equal.	1000
MaxItemBufferStrategy	Specifies the size of the item buffer. The item buffer will be used when a computation cycle has not finished within its time slot. A snapshot of the current item values will be put in the item buffer. When the computation cycle has finished it will read the item values from the buffer and performing computations with those values. This is useful when a sudden CPU load of the computer running ApisHive makes the computations take longer than anticipated. If the CPU load persists the item buffer will be filled to its maximum size, and warnings will be issued. If this situation is recurring either the timer interval should be increased or the CPU usage must be decreased. Having a large maximum size will increase memory usage of ApisHive!	20
EventReportLevel	The level of the reported events from the java application. (E.g. if Warning is chosen, Warning and Alarm events will be reported, but the Information events will not.)

Expert properties

Items 

There are different types of items in the ApisJavaBee. Scalar, Vector and Matrix items can be connected to ports in ModFrame.

Scalar

The Scalar item type represents a scalar value of boolean, string or double precision floating point value. The value type is controlled with the ItemType attribute. It can only be chosen when creating an item and not be altered later on. The InputValue attribute specifies if the value is an input value to ModFrame or not.

Vector

The Vector item type represents a vector/array value of boolean, string or double precision floating point value. The value type is controlled with the ItemType attribute. It can only be chosen when creating an item and not be altered later on. The InputValue attribute specifies if the value is an input value to ModFrame or not.

Matrix

The Matrix item type represents a matrix value of boolean, string or double precision floating point value. The value type is controlled with the ItemType attribute. It can only be chosen when creating an item and not be altered later on. The InputValue attribute specifies if the value is an input value to ModFrame or not.

StateFileItem

An item for setting the state file name. The folder which it will be stored in or read from is specified in the StateFileFolder property. The PersistedStateDestination property must also be set to File(s).

Attributes

StateTriggerItem

An it for trigging state reading or writing.

CommandItem

The command button can start and stop computations in ModFrame.

StatusItem

The status items show the current status of the server.

Advanced

Class path

The class path is stored in the default value of the registry key:

HKEY_CLASSES_ROOT\Prediktor.ApisJava\CLASSPATH

ModFrame may stop working if this value is altered. Do not change the value unless you know what you are doing!

Java options

The java options are stored in the default value of the registry key:

 HKEY_CLASSES_ROOT\Prediktor.ApisJava\JAVAOPTIONS 

Altering this value may cause ModFrame to stop working properly.

The -Xrs property should always be present as the absence of this value will force ModFrame to terminate when a user logs off.

Application

A ModFrame application is the set of components residing in a ModFrame server at any given time. The application is hierarchical in that some components can contain other components. There will always be a single root parent component called the top application which is responsible for the computational algorithm. The application can be saved to and opened from files. The application files are stored on a particular folder on the server, and the clients can browse that folder and choose files from it. The application file location is set in the server settings. There are two file formats available (xml and mfz). The xml file format is a pure xml file and tend to become large. The mfz file format is a compressed version of the xml file, and is better suited for large applications.

It is possible to make the server open a particular application file automatically when the server starts up through the server settings.

Application states

It is possible to take snapshots of the current state of the application and store it to files (or Apis items). Even though the application files also contain snapshot information it also contains configuration information making the files large and relatively slow to open. As opposed to this the state files generally become small and very fast to open.

The state files contain what is needed for an application to reach the same state as it was in when the states were persisted. It depends largely on the component what is considered to be the states. In addition to the inner states of the components, the port values are persisted.

A state file will only work and load the correct if the application has not changed since when the states were persisted.

The location of the states files are controlled in the server settings.

Computational algorithm

The server will perform computations on a cyclic basis. In an application there must be a root parent called a top application. The top application is a ModFrame component that is a container. A container can contain child components. The child components can both be ModFrame components and views. By adding a ModFrame components that are containers to the top application, it is possible to create a component hierarchy.

The computational algorithm of the child ModFrame components is decided by each container. For the detailed computational algorithm see the documentation of the particular container. Even though it is up to the container to decide the computational algorithm, there are two distinct algorithms that will be common to most containers.

Parallel computations

When the computations are performed in parallel, that means that the container will iterate through its child component list twice. The first iteration will read all input ports and perform the actual computations. The next iteration will write the results to the output ports. This algorithm ensures that the computational results will be independent on the computational position of the child components. However it will also have that consequence that value will take longer to propagate through components connected serially. Let's say that we have three ModFrame components connected to each other in this way: component1's output is connected to component 2's input and component 3's input is connected to component 2's output. A change on component 1's input will take three computational iteration's to reach component 3's output.

Sequential computations

When the computations are performed sequentially, the container will only iterate through its child component list once. In that iteration each component  will copy values to its input ports from the output ports of other components, read the input ports, perform computations and write to its output ports sequentially. The computational results of this algorithm are very dependent on the order of the child components. It's easier to make mistakes with this algorithm in the configuration phase, but it has the advantage of being able to propagate signals faster through connected components. The propagation can in this scenario only take one time step if the components are ordered correctly.

ModFrame component

A ModFrame component (MFC) is a software component performing one or more dedicated tasks. Examples of such tasks are: mathematical simulation of process equipment (pipes, tanks, heat exchangers), reading online data and performing computations on them, communicating with databases through JDBC.

A ModFrame component will have one or more property pages depending on the complexity of the component. The behavior of the component is influenced by changing these properties. ModFrame components interact with other ModFrame components through ports. The number of ports and the meaning of these ports vary from component to component, but generally ports are created and deleted by changing the properties of a component.

In the user interface the ModFrame component will be represented by an image, preferably indicating the task the component is performing.

Container

A container is a special ModFrame component which can contain other ModFrame components and views. The container will perform computations on its child components based on its computational algorithm. The container can expose ports of its child components making it possible to communicate with components in other containers. It is possible to group a set of components as a container and also ungroup a container.

In the user interface the container looks like an ordinary ModFrame component, but it can be expanded to edit the contents of the container.

Ports

The preferred way of exchanging data between ModFrame components is through ports. Ports can be connected to other ports and receive and or send information from/to those ports. There are different types of ports containing different types of data. There are two major types or ports: Unidirectional and bidirectional. In the unidirectional ports information will always flow in one direction. Whereas in bidirectional ports information will flow in both directions. The computational algorithms of the containers specifies and enforces the data exchange between the ports.

In the user interface the ports will reside inside of the image of a ModFrame component as a small movable square.

Unidirectional ports

The following table lists the available unidirectional ports in ModFrame proper. Extensions to ModFrame such as the Tracker modules may define additional ports. Unidirectional ports are either input or output ports and they can only be connected to the same port types of the opposite direction. (Inputs can only be connected to outputs, and vice versa.)

Bidirectional ports

ProcessPorts.

Overview

The ModFrame client is the tool for configuring a ModFrame application. The client can be connected to one server at the time, but several clients can simultaneously be connected to the same server. The client displays the contents of the connected server graphically in the Configuration panel, as well as the component hierarchy in the Browser.

The Menu and the Tool bar is used for operations, as well as popup menus on the components in the configuration panel and  browser. Messages (information, warning and alarms) are presented in the Log view.

Starting the client

After ModFrame has been installed the ModFrame client can be started by selecting All Programs->Apis->ModFrame->ModFrame client.

 Batch file

It is possible to create a batch file which starts the client with custom settings. Below is an example of the contents of a batch file. This must be altered to fit the installation. Using batch files it is possible to set all java options. It is also possible to give a file name as a parameter containing settings for the client.

C:\\\Program Files\Java\jdk1.6.0_03\bin\javaw.exe -Xmx500m -Dswing.defaultlaf=javax.swing.plaf.metal.MetalLookAndFeel -Djava.security.policy=java.policy -classpath C:\\\Apis\ModFrame\ModFrame.jar;C:\\\Apis\ModFrame\xml.jar;C:\\\Apis\ModFrame\ClickAndTrace.jar; com.modframe.client.MFClient "C:\\\Apis\ModFrame\clientsettings.ini"

Client settings

The following settings can be applied to the client by adding them to the client settings file.

User interface elements

Menu

The menu bar consists of menus performing different tasks on the client and server. Consider the tool bar for additional operations.

File

 Application

Edit

View

Server

Tool bar

The tool bar consists of buttons and other UI elements performing tasks on the client and server. Consider the menu for additional operations.

Name	Icon	Task
Port connection		Toggles whether it is possible to connect ports in the client.
Port move		Toggles whether it is possible to move the ports in the client.
Select view	N/A	Selects the active view.
Select layers		Selects the visible layers.
Zoom		Performs zooming in the configuration panel.
Log view		Hides/shows the log view.
Container bar		Hides/shows the container bar.
Help		Opens the user manual.

Browser

The browser contains two (or three if a data source component is present in the application) tabs.

Application tab

The first tab displays the current application in hierarchical tree view. The root node of that tree represents the root ModFrame component (top application). The child components of that component is displayed on the next level and so on. In addition all the ports of a component is displayed as nodes in the tree. By right-clicking the component node a menu will be displayed. The application tab has the possibility to filter the components by name, and also ordering the components both by computational order as well as alphabetically.

Component tab

The component tab displays the available components which can be added to the application. The components are displayed in a tree view grouping common components by their functionality. There is a filter in the tab making it possible to filter the components by name.

History tab

The component tab presents available historic data sources in a tree view. The data sources will contain items which can be plotted or shown in a table.

Configuration panel

The configuration panel is where the ModFrame components and data views are displayed. The configuration of the components take place in this panel after components have been added to them. Each container can be made to display its child components in the configuration panels. A new tab will be created for each container when the container is made to display its child components.

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Log view

The log view displays messages from the server. The messages are displayed in a table. The first column displays a severity icon indicating information, warning or alarm. The second column displays the time of the message. The third column contains the source(s) (typically component name) of the message. The last column contains the actual message.

The log messages can be logged to files as well.

Container bar

The container bar will show the hierarchy position of a container making it easy to find parent and child controls of a container.

Server connection dialog

The server connection dialog makes it possible to connect to a server. The tables below describes the fields and buttons in the dialog.

Add component dialog

The add component dialog makes it possible to create a ModFrame component to the connected server. The tables below describes the fields and buttons in the dialog.

Basics

Connecting to a server

Connection to the server can be obtained by clicking the Connect to server button in the tool bar. By filling in appropriate entries in the server connection dialog and clicking connect, the client will be connected.

Error messages....

The client can be made to automatically connect to a specific server when it starts. This is obtained by creating a batch file for the client.

Configuration mode

When the client is in configuration mode it is possible to alter the configuration. When it is not in configuration mode, the user is only able to view the configuration and results.

The configuration mode is toggled by clicking the configuration mode button. Menus, buttons and other components may be disabled and enabled when client toggles between the configuration modes.

Add a ModFrame component

The user can either add a ModFrame component with the tool bar, menu or by dragging the component in to the configuration panel from the components tab. The last option enables the user to place the component in the panel initially, but the top application must be added by the two first options since the configuration panel does not exist.

Either one of the options will display the add component dialog. The user can select from the list and choose an appropriate name of the new component. If a component with the name supplied already exists in the container.

Add a container

A container can be added by either clicking the Add container button in the tool bar (the Add component dialog will be pre-selected with the AdaptableContainer), or by clicking the Add component button in the tool bar in which case the user must locate the container manually.

Edit properties

Properties of components are edited by right-clicking on the component and selecting Edit properties in the pop-up menu. A dialog box will generally contain a set of property pages, as well as a button row. The buttons are OK, Cancel and Apply.

The properties are updated in the server when OK or Apply are pushed. The OK button also closes the dialog box. Properties may depend on each other and depending on the complexity of the component, the user may have to click the Apply button several times when changing a set of properties. The property pages will be updated each time the user clicks Apply.(A component may for instance create or delete properties depending on the value of other properties.)

Depending on the property, the value may be not validated when OK or Apply is clicked. If the user has chosen an illegal property value, a warning box will be displayed notifying the user of the error. The properties will not be actually written to the server component until the properties have been validated.

Changing property values of a component will generally change the behavior of the component. Ports may for instance be created or removed when editing properties.

Non-container components will display the property dialog box when double-clicked, where as the container components will expand itself when double-click.

Consult the documentation for each component for more information on the properties available and their meanings.

Connect ModFrame components

ModFrame components communicate with each other through ports. Ports can connected in two ways:

Port connection dialog

The port connection dialog is opened by right-clicking the component for which you want to connect ports and by choosing the Connect Ports menu entry. The port connection dialog contains two views. The first view contain filters and the ports of the component from which the dialog was opened, and the second view contains filters and all the other components in the container.

Filters

The left filters are a data type filter and a port name filter. By selecting entries in the DataType filter only ports that correspond to that data type will be shown. The port name filter works with wild cards so by setting the filter value to *tag* only ports with the word tag in them will be visible.

The right filters function in the same manner, but it is also possible to add extra limitations. If the Compatible ports check box is checked the right view will change when ports are clicked in the left view. Only ports that can be connected will be displayed in the right view. If the Follow left filter is checked the port name filter for the left filter is used.

Connection

Several connections can made in the dialog simultaneously, but the actual connections will only take place when the Ok button is clicked. The connection is made by either dragging and dropping the port from the left view to the right or by selecting the port in the left and right view and by clicking connect. Disconnect is performed by selecting the connected ports and clicking Disconnect.

Graphical port connection

The port connections can be made directly in the Configuration panel as well. To do this the Tool bar button must be clicked. Then the user must click either one of the ports to connect, a line will appear and be attached to the port. By clicking the other port the connection is finalized and the connection line will be drawn between the ports.

Add a data display

A data display for a port is created by right-clicking the port and selecting Create Data View menu item. A dialog is displayed with the following fields:

Choose the data view and click ok.

Group components

It is possible to group several components in a container. The connections to components outside the selection will be maintained after the grouping. To group components select the components and right-click one of them and select Edit->Group components. Enter the desired name of the component and click Ok.

To ungroup the components right-click the container and choose Edit->Un-group, and the components will be ungrouped.

Exporting and importing port connections

Exporting connections

Port connections can be exported to a text file. This is useful when similar components are repeatedly added to a configuration. If the port names are similar it is fast to search and replace component and port names and import port connections instead of having to manually connect the ports.

Port connections can be exported either by selecting File->Export connections... or by selecting the components to export port connections for and right-clicking one of the selected components and selecting Edit->Export connections. The first case will export connections for all components in the root container, where as the latter case only exports connections for the selected components.

The export connections dialog will be displayed:

The Ports check box indicate that port to port connections will be exported. The I/O check box indicates that port to Apis item or Apis item to port connections will be exported. The sub-components check box indicates that connections of components inside components that are containers will be exported.

The connections file will be saved on the client.

Importing connections

Port connections can be imported. This means that connections between ports can be made by importing a text file containing the connections.

To import connections select File->Import connections. A standard file selection dialog is displayed, and by selecting a file containing the connections, port connections are made.

File structure

The port connections file contains six tab separated columns. (There is no heading). The columns are shown below:

<asf><asf><Format> Time false <asf><asf><Time> CurrentTime false
<asf><asf><Dec> Time false <asf><asf><Time> CurrentTime false

Exporting and importing components

Export

Components can be exported to file. This means that it is possible to reuse components created for one application in another. Both views and ModFrame components is exportable.

To export a set of components do the following:

• Select the components you wish to export.
• Right-click on one of them and select Export...
• A file dialog appears where you must give the file a name, click ok and the file is created.

The file will be saved in the folder specified in the LibraryPath property (stand alone server) or LibraryFilePath (server runs in the ApisHive context)

Import

To import an exported file, first make sure that the file is in the correct folder. Then right-click the container's background an choose Edit->Import Raw... or Edit->Import Default.

For non-Tracker components these two options are equal. For Tracker components Import Raw means that the tracker components keep the exported IDs. (MaterialDefintionID and so forth.) The safest bet is to use the Import Default option which sets all the IDs of the Tracker components to default values.

Controlling computations

Users can control the server's computations from the client. This is done from the tool bar.

Server parameters

The server parameters consist of the current server settings. Some of these settings are set from the serverstart.ini file (stand-alone server) or ApisJavaBee properties (server is run in the ApisHive context).

The server parameters can be viewed (and some of them changed) by selecting the top menu item Server->Server properties.

The following parameters are listed.

Views

A view is specified by coordinates in the configuration panel. After having defined a set of views, the user can select a view and navigate to it. This makes it faster and easier for users to navigate in the configuration panel.

A view is defined by selecting View->View definition in the top menu. The following dialog is displayed:

By clicking the Add button a new view is defined. Give the view a sensible name, and fill in the other items as desired.

Layers

It is possible to define layers for the application. Components can be assigned to one specific layer, and from the client it is possible to choose which layers are visible. If a component belongs to a layer which isn't visible, the component will be hidden.

To create a layer select View->Layer definition.  Each layer must have a unique level. After layers have been defined, views can include one or more layers. The user can select which layer is visible directly in the tool bar as well.

Modframe Components

Array operations

VectorAccumulator

Creates double vectors from a single double input value. There is a port which contains the current index where the double input value will be put. The vector will be accumulated until the AccumulateNewVector port becomes true. At this point a new vector will be created where the input values will be put. If the Vector Delay property is larger than 1 the older vectors will be shifted.

The AccumulateNewVector signal must be true before the accumulating starts.

When the WriteVector signal goes high the oldest accumulated vector will written to the output port. The vector will be removed from internal list of accumulated vectors. If a new WriteVector signal is sent before the AccumulateNewVector is true, the oldest vector value will be written, but now this vector will not be deleted and subsequent WriteVector signals will write that vector until an AccumulateNewVector signal has been issued.

The proper and most intuitive way of accumulating vectors will thus be to signal AccumlateNewVector as many times as there are supposed to be buffered vectors (as given by the Vector delay property) and then signal AccumlateNewVector and WriteVector every other time.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Vector length

The length of the generated vectors

Vector delay

The number of vectors buffered. Each time the AccumulateNewVector signal is called the current vectors are shifted in the buffer. If the buffer is of equal length as this property, the oldest vector will be discarded.

Accumulation rules

Specifies when the input value is written to the accumulated vector.

The options are

• First value - The value will be accumulated when the index port value is changed.
• Last value - The value will be accumulated continuously (this means that the last value will be accumulated).

Initial element value

Specifies the value of the elements prior to being set. All elements not set by the index/value pair will maintain this value.

The options are:

• NaN - The initial value will be NaN (Not a number).
• 0.0 - The initial value will be 0.0.

Ports

Converters

Analog2ProcessPorts

Converts several analog inputs to one process port.

Properties

Parameters

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Vectors

DimConc

Decides the number of concentrations. Changing this will alter the number of concentration ports.

FlowPortVisible

If value is greater than zero, the analog flow port is visible.

DensityPortVisible

If value is greater than zero, the analog density port is visible.

EnthalpyPortVisible

If value is greater than zero, the analog enthalpy port is visible.

PressurePortVisible

If value is greater than zero, the analog pressure port is visible.

TempPortVisible

If value is greater than zero, the analog temp port is visible.

ConcPortsVisible

If value is greater than zero, the analog concentration ports are visible.

Ports

Decoder

The Decoder component is designed for value translation in the ModFrame application. On the basis of a set of defined translations (Code sets), the component will translate an input value provided on an input port and provide the result on an output port. The input and output may be analog, digital or string values.

Properties

The properties of this component are organized in multiple tabs. The separate tabs are described dedicated sub topics.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Dimension

This property defines the dimension of the ports providing the input values and the ports providing the translated values. These ports may be vector or scalar.

Input type

This property defines the data type of the input port and the value to translate from.

Output type

This property defines the data type of the translated value and the port on which to provide the translated value.

Default output code

This property defines the default translation for values that appear on the input port but does not match the code sets.

Code set location

This property decides if the code sets is defined internally in the component or are provided on input ports to the component. The alternatives are:

• Internal. The code sets are defined through the code sets tab of the component.
• External. The code sets are provided on code set ports.

Code sets

This tab defines the valid translations when the Code set location property is Internal. The number of possible translations is unlimited.

This parameter tab is based on the parameter matrix concept. Use the Add button to add a new row and the remove button to remove a selected row. The columns of the matrix are described below.

InputCode

This column defines the values that can be translated

OutputCode

This column defines the translations of the values defined in the corresponding element of the InputCode column.

Ports

Input

This is the input port providing the value(s) for translation. The dimension of the port may be scalar or vector depending on the Dimension property.

Output

This is the output port providing the translated value(s). The dimension of the port may be scalar or vector depending on the Dimension property.

Activate

This is a digital port that can be used to activate/deactivate the component. If the component is deactivated, no translations will occur.

Code set ports

The code set ports appear when the Code set location is External.

• InputCodeSet. This is a vector port defining the values that can be translated.
• OutputCodeSet. This is a vector port defining the translations of the values defined on the InputCodeSet port.

NumToString

This component is designed to convert a numerical value to a string of a specific format.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

ReportEventLevel

All events with equal or higher severity will be reported.

Decimal format

This property defines the format of the converted string.

Ports

NumberValue

This is the port providing the numerical value to convert to a string.

StringValue

This port provides the string representation of the numerical value provided on th NumberValue port.

ProcessPort2Analog

Converts a process port to several analog ports representing the different parts of the porcess port (flow, pressure, density etc.)

Properties

Parameters

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Vectors

DimConc

Decides the number of concentrations. Changing this will alter the number of concentration ports.

FlowPortVisible

If value is greater than zero, the analog flow port is visible.

DensityPortVisible

If value is greater than zero, the analog density port is visible.

EnthalpyPortVisible

If value is greater than zero, the analog enthalpy port is visible.

PressurePortVisible

If value is greater than zero, the analog pressure port is visible.

TempPortVisible

If value is greater than zero, the analog temp port is visible.

ConcPortsVisible

If value is greater than zero, the analog concentration ports are visible.

Ports

StringAppend

This component concatenates a number of input strings to form a concatenated output string.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

ReportEventLevel

All events with equal or higher severity will be reported.

Delimiter

This property can be used to define a delimiter to separate the concatenated strings.

Number of strings to append

This property defines the number of strings to concatenate, and hence the number of input string ports.

Ports

Input string ports

The component contains a configurable number of string input ports providing the strings to concatenate.The name of these ports are String 1 - String N. 

Appended string

This port provides the concatenated string.

Activate

This is a digital port that can be used to activate/deactivate the component. If the component is deactivated, no concatenation will occur.

StringParser

This component is designed to parse an input string for numerical values.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

ReportEventLevel

All events with equal or higher severity will be reported.

Maximum number of parsed values

This property defines the maximum number of numerical values to parse from the input string. If the input string contains more numerical values, these will be neglected.

Delimiter

This property defines the delimiter used to separate the numerical values in the input string

Decimal separator

This property defines the decimal separator used in the input string.

Result type

This property defines how to expose the result. The alternatives are:

• Scalar. The parsed values are exposed on scalar ports. The number of scalar ports is defined by the Maximum number of parsed values property.
• Vector. The parsed values are exposed on a vector port. The number of elements in the vector is defined by the Maximum number of parsed values property.

Ports

StringValue

This port provides the string to parse for numerical values.

Parsed value ports

The parsed values are either exposed on a string vector port named ParsedValues or N scalar string ports named ParsedValue1 to ParsedValueN.

Deprecated

SoftPlc

The SoftPlc component is deprecated. The blocks of the SoftPlc is ported to ModFrame components. The tables below contains the corresponding ModFrame component to a SoftPlc block.

Analog

Digital

Linear Algebra

Math

Scalar

Arithmetics

Division

Divides the dividend input by the divisor input. (c = a/b)

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Divide by zero action

Specifies the output value if the divisor is zero. The alternatives are:

1. Zero - The output becomes zero
2. NaN - The output becomes NaN (not a number).
3. Infinity - The value is either positive or negative infinity, depending on the dividend.
4. PortValue - The value is retrieved from a port.

Ports

Multiplication

 Multiplies the inputs and writes the result to the output.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Inputs

The number of inputs which will be multiplied.

Ports

The number of input ports will vary depending on the Inputs property.

Subtraction

Computes the difference between the minuend with the subtrahend. Example: c − b = a. c is the minuend, b is the subtrahend and a is the difference.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Ports

Sum

This component sums two or more analog inputs and writes the sum to an analog output.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Inputs

The number of inputs which will be summed.

Ports

The number of input ports will vary depending on the Inputs property.

Calculus

SampleTime

Exposes the current sample time in a port.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Ports

TimeDerivation

The time derivation of the input value. The time derivation is found by subtracting the current input value with the input value of the previous time step and dividing the result by the sample time.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Ports

TimeIntegral

The time integral of the input value. When the reset port is true, the integral value will be reset to zero. If the hold port is true the integration is paused.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Gain

The value gain property is multiplied with the current integral value. It is possible to expose this property as a value.

Ports

Statistics

Mean

Finds the mean of the input signal. A window size can be applied in which case older input values have less significance on the mean value (i.e. a forgetting factor).

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Window size

The window size specifies the weight of the previous values compared to the new value. If the current time step has exceeded the window size, previous mean value is given the weight of the (Window size - 1)/Window size whereas the new value is given the weight of 1/(Window size). This implies that the new values are given more weight than the older values. If no weighing is to take place set the window size to a very large number.

Ports

Standard Deviation

Finds the mean and standard devation of the input signal. A window size can be applied in which case older input values have less significance on the mean and standard deviation (i.e. a forgetting factor).

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Window size

The window size specifies the weight of the previous values compared to the new value. If the current time step has exceeded the window size, previous mean and standard deviation values are given the weight of the (Window size - 1)/Window size whereas the new value is given the weight of 1/(Window size). This implies that the new values are given more weight than the older values. If no weighing is to take place set the window size to a very large number.

Ports

Trigonometrics

Acosine

Finds the arc-cosine value of the input. The output is given in radians.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Ports

Asine

Finds the arc-sine value of the input. The output is given in radians.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Ports

Atangent

Finds the arc-tangent value of the input. The output is given in radians.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Ports

Cosine

Finds the cosine value of the input. The input is given in radians.

Browser path: Math\Scalar\Trigonometric\Cosine

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Ports

Sine

Finds the sine value of the input. The input is given in radians.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Ports

Tangent

Finds the tangent value of the input. The input is given in radians.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Ports

AbsoluteValue

This component takes the absolute value of the analog input and writes it to the output.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Ports

Ceiling

Finds the smallest integer not less than x, or, formally

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Ports

Exponential

The input value is run through the exponential function (y = e x).

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Ports

Floor

Finds the largest integer less than or equal to x. Formally, for all real numbers x,

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Ports

Increment

Increments the output value according to the Increment Value property each time step. The initial value is set by the Initial value property.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Initial value

The initial value of the output. The output is reset to the initial value when the Reset port is high. It is possible to expose this property as a port.

Increment value

The output is incremented each time step with this value. It is possible to expose this property as a port.

Ports

LinearModel

Computes the linear equation: Sum(ai * xi), where ai is the i'th parameter and xi is the i'th input signal.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Model parameters count

The number of model parameters. This property creates properties a1-aN and M input ports where N is the value Model parameters count property.

a1 - aN

The N'th model parameter.

Ports

The number of input ports will vary depending on the Properties.

Logarithm

 Finds the natural logarithm of the input. (y = ln(x))

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Ports

Maximum

 Finds the maximum of the inputs.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Inputs

The number of inputs for which maximum will be found.

Ports

The number of input ports will vary depending on the Properties.

Minimum

Finds the minimum of the inputs.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Inputs

The number of inputs for which minimum will be found.

Ports

The number of input ports will vary depending on the Properties.

Power

Finds the power where one input is the base and the exponent is either a port input or a property.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Exponent

The exponent of the power function. The property can be exposed as a port.

Ports

Round

Rounds the input value to the nearest integer.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Ports

SquareRoot

Finds the square root of the input signal.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Ports

Linear algebra

Augment

Creates a matrix from several matrices. The Rows and Columns properties decide how many input matrices there are and where in the resulting augmented matrix these matrices will appear.

For instance if the Rows and Columns properties are set to 2, 4 input matrices are created. The first input matrix will be placed in the upper left corner of the resulting matrix, the second in the upper right corner, the third in the lower left corner, and the fourth in the lower right corner.

If the input matrices do not match in terms of rows and columns with the matrices on the same row or column, zeros are inserted.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Rows

The number of rows matrices are inserted in the resulting matrix.

Columns

The number of columns matrices are inserted in the resulting matrix.

Ports

The number of input ports will vary depending on the Rows and Columns properties.

ColumnsRemove

Removes one or more columns from a matrix. The number of columns to remove are specified with the Column count property, and changing this value will create or delete properties called: Column 1 - N where N is the value of the Column count property.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Column count

The number of columns to remove from the input matrix.

Column 1 - N

The zero based column index of the column to remove from the matrix. This property is exposable.

Ports

ColumnsSelection

Selects one or more columns from a matrix. The number of columns to select are specified with the Column count property, and changing this value will create or delete properties called: Column 1 - N where N is the value of the Column count property. The selected columns can either be exposed as one matrix or one matrix (with one column) for each selected column by changing the Output type property.

If one of the column indices are illegal the corresponding column in the resulting matrix is filled with zeros and an error message is written once.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Column count

The number of columns to select from the input matrix.

Output type

Decides how the selected columns are exposed. Two options:

1. Single Matrix: The selected columns are exposed in one common matrix
2. Individual Matrices: The selected columns are exposed in individual matrices (with one column) for each column.

Column 1 - N

The zero based column index of the column to select from the matrix. This property is exposable.

Ports

Determinant

Finds the determinant of the matrix.

If the matrix is not square (number of rows not equal to the number of columns) the determinant cannot be found and the previous out value is kept and an error message is written once.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Ports

Dimension

Finds the number of rows, columns and the total elements of a matrix and exposes these values on ports.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Ports

Eigenvalues

Finds the eigenvalues of a matrix.

If the matrix is not square (number of rows not equal to the number of columns) the eigenvalues cannot be found and the previous out value is kept and an error message is written once.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Ports

ElementsSelection

Selects one or more elements from a matrix and exposes these values on analog ports. The Element count property specifies how many elements will be exposed on ports. When the value of this property changes other properties will be created/deleted. The properties this apply to are called: Element 1 - N Row and Element 1 - N Column.

Example: If the Element count property is 2, there will be created four extra properties called Element 1 Row, Element 1 Column, Element 2 Row and Element 2 Column. The values of the first two properties correspond to the first element's zero based position in the matrix. (The values of the two last properties correspond to the second element's zero based position in the matrix.)

If the positions of the elements are illegal the previous value will be kept and a warning is issued.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Element count

The number of elements to select from the input matrix.

Element 1 - N Row

The zero based row index of the element to select from the matrix. This property is exposable.

Element 1 - N Column

The zero based column index of the element to select from the matrix. This property is exposable.

Ports

Equal

Tests if the two matrices are equal.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Ports

Identity

Creates an Identity matrix where the size of the matrix is determined with the Identity size source property.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Identity size source

Specifies how the size of the identity matrix is determined.

The options are:

1. Scalar: The size of the matrix is determined by the properties Row count and Column count.
2. Matrix: The size of the matrix is determined by the size of the input matrix.

Row count

If the Identity size source property is set to Scalar, this property becomes visible and the value determines the number of rows in the identity matrix. This property can be exposed as a port.

Column count

If the Identity size source property is set to Scalar, this property becomes visible and the value determines the number of columns in the identity matrix. This property can be exposed as a port.

Ports

InsertRows

Inserts rows in the matrix supplied as an input. The number of rows to insert are configurable. The rows will be inserted from a specified index and the subsequent rows will be inserted consecutively. The value of the elements can be specified.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Row index

The index of the first row to be inserted. The other rows will be inserted consecutively. The property can be exposed as a port.

Row count

The number of rows to insert. The property can be exposed as a port.

Element value

The value of the elements in the rows to be inserted. The property can be exposed as a port.

Ports

InsertColumns

Inserts columns in the matrix supplied as an input. The number of columns to insert are configurable. The columns will be inserted from a specified index and subsequent columns will be inserted consecutively. The value of the elements can be specified.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Column index

The index of the first column to be inserted. The other columns will be inserted consecutively. The property can be exposed as a port.

Column count

The number of columns to insert. The property can be exposed as a port.

Element value

The value of the elements in the columns to be inserted. The property can be exposed as a port.

Ports

Inverse

Finds the inverse of a matrix.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Ports

MatrixCreation

Creates a matrix with a specified amount of rows and columns. The values of the matrix are inputted with Analog ports. There will be Rows * Columns inputs, and one input corresponds to a specific element in the matrix.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Rows

The number of rows in the matrix

Columns

The number of columns in the matrix

Ports

The number of inputs depend on the Rows and Columns property. There will be Rows * Columns inputs. These inputs represent an element in the matrix.

Multiplication

Multiplies two or more matrices.

If the matrices are not of correct sizes, an alarm will be issued.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Inputs

The number of inputs which will be multiplied.

Ports

The number of input ports will vary depending on the Inputs property.

Norm

Finds the norm of the matrix. Which norm to use is specified in the Norm property.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Norm

Specifies which Norm will be used.

The options are:

1. 1-Norm
2. 2-Norm
3. Infinity Norm
4. Frobenius Norm

Ports

Null

Creates a matrix filled with zeroes.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Null size source

Specifies from where the size of the result matrix is obtained.

The options are:

1. Scalar: The size is retrieved from properties or ports as row size and column size.
2. Matrix: The size is determined by a matrix inputted to the component

Row count

The number of rows in the resulting matrix. Only visible when the Null size source property is scalar. The property is exposable.

Column count

The number of columns in the resulting matrix. Only visible when the Null size source property is scalar. The property is exposable.

Ports

Random

Creates a matrix with random numbers.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Row count

The number of rows in the matrix. This property is exposable.

Column count

The number of columns in the matrix. This property is exposable.

Mean value

The mean value of the random numbers. This property is exposable.

Standard deviation

The standard deviation of the random numbers. This property is exposable.

Ports

Rank

Finds the rank of the matrix.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Ports

RowsRemove

Removes one or more rows from a matrix. The number of rows to remove are specified with the Row count property, and changing this value will create or delete properties called: Row 1 - N where N is the value of the Row count property.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Row count

The number of rows to remove from the input matrix.

Row 1 - N

The zero based row index of the row to remove from the matrix. This property is exposable.

Ports

RowsSelection

Selects one or more rows from a matrix. The number of rows to select are specified with the Row count property, and changing this value will create or delete properties called: Row 1 - N where N is the value of the Row count property. The selected rows can either be exposed as one matrix or one matrix (with one row) for each selected row by changing the Output type property.

If one of the row indices are illegal the corresponding row in the resulting matrix is filled with zeros and an error message is written once.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Row count

The number of rows to select from the input matrix.

Output type

Decides how the selected rows are exposed. Two options:

1. Single Matrix: The selected rows are exposed in one common matrix
2. Individual Matrices: The selected rows are exposed in individual matrices (with one row) for each row.

Row 1 - N

The zero based row index of the row to select from the matrix. This property is exposable.

Ports

ScalarMultiplication

Multiplies a scalar with a matrix.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Ports

SetElements

Sets element values in a matrix. Several elements can be set, and the row and column number of the element can be specified from properties and ports.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Element count

The element count specifies how many elements to set in the matrix. Changing this property will create or remove properties below.

Element 1 to N Row

The row index of the N'th element to set. The property can be exposed.

Element 1 to N Column

The column index of the N'th element to set. The property can be exposed.

Ports

SingularValueDecomposition

 Performs a singular value decomposition on a matrix. The three resulting matrices are written to ports.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Ports

Subtraction

Computes the difference between the minuend with the subtrahend. Example: C − B = A. C is the minuend, B is the subtrahend and A is the difference.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Ports

Sum

This component sums two or more matrix inputs and writes the sum to a matrix output.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Inputs

The number of inputs which will be summed.

Ports

The number of input ports will vary depending on the Inputs property.

Transpose

Transposes a matrix.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Ports

Scheduling

Scheduler

The purpose of the Scheduler component is to schedule periodic tasks in the tracker application. The Scheduler uses a dedicated MFScheduler database to store information about scheduled events.

Properties

The properties of this component are organized in multiple tabs. The separate tabs are described dedicated sub topics.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Trigger

This property decides the type of triggering interval to use. The alternatives are:

• Millisecond interval. The scheduled tasks will be triggered at millisecond intervals. The interval in milliseconds are specified by the Interval property.
• Second interval. The scheduled tasks will be triggered at second intervals. The interval in seconds are specified by the Interval property.
• Minute interval. The scheduled tasks will be triggered at minute intervals. The interval in minutes are specified by the Interval property.
• Hour interval. The scheduled tasks will be triggered at hour intervals. The interval in hours are specified by the Interval property.
• Daily. The scheduled tasks ts will be triggered daily at time given by the Hour and Minute properties
• Weekly. The scheduled tasks will be triggered weekly at day given by the Day (Weekly) property and time given by the Hour and Minute properties
• Monthly. The scheduled tasks will be triggered monthly at day given by the Day (Monthly) property and time given by the Hour and Minute properties
• Cron. The scheduled tasks will be triggered in respect to a cron-expression given by the CronExpression property.

Trigger state

This property defines the state of the trigger. The alternatives are:

• Running. The trigger is active, and tasks will be executed at the specified intervals.
• Paused. The trigger not active. No tasks will be executed.

Interval

This property defines the trigger interval when the Trigger property is either Millisecond interval, Second interval, Minute interval or Hour interval.

Day (Monthly)

This property defines the day in month to execute tasks when the Trigger property is Monthly.

Day (Weekly)

This property defines the day in week to execute tasks when the Trigger property is Weekly.

Hour

This property defines the hour of the day to execute tasks when the  Trigger property is Daily, Weekly or Monthly.

Minute

This property defines the minute of the hour to execute tasks when the Trigger property is Daily, Weekly or Monthly.

CronExpression

This cron-expression defines the trigger interval when the Trigger property is Cron.

Tasks

This tab is used to define the tasks to execute at the intervals specified in the Properties tab. It is possible to schedule all Schedulable components (components that implements the SchedulerTask interface) in the application.

This parameter tab is based on the parameter matrix concept. Use the Add button to add a new row and the remove button to remove a selected row. The columns of the matrix are described below.

Tasks

This column specifies the name of the ModFrame components to schedule.

Ports

This component has no ports.

Signal Processing

SignalType

Specifies the type of signal to be delayed. The signal can be analog, digital, string, vector, string vector or matrix.

Digital_pulse

LastingPulse

When the input signal goes high the output will go high and stay high for a specified amount of time.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

High time

The time which the output stays after the input has gone high. The property can be exposed as a port.

Ports

PulseCounter

Counts the number of times the input signal has gone from low to high since the last reset.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Ports

PulseDelay

Writes pulse on the output which lasts one time step when the incoming signal goes from low to high. The pulse will be delayed a specified amount of time steps.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Time step delay

The amount of time steps the pulse will be delayed before written to the output.

Ports

The ports displayed depends on the SignalType property.

PulseHighDelay

When the input signal goes from low to high, the output will go to high a specified amount of time later. If the input signal goes from high to low the output signal will go to low immediately.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Delay

The amount of time after the input singal goes high, the output go high. It is possible to expose this property as a port.

Ports

PulseLowDelay

When the input signal goes from high to low, the output will go to low a specified amount of time later. If the input signal goes from low to high the output signal will go to high immediately.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Delay

The amount of time after the input singal goes low, the output go low. It is possible to expose this property as a port.

Ports

SquarePulse

Creates a square pulse with specified high and low times.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

High time

The amount of time the output signal is high. This property can be exposed as a port.

Low time

The amount of time the output signal is low. This property can be exposed as a port.

Ports

===================

#AND

Performs an AND operation on the inputs. If and only if all the inputs are true, the output becomes true.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Inputs

The number of inputs which will be AND'ed.

Ports

The number of input ports will vary depending on the Inputs property.

BitSelection

Selects one or more bits from the input signal and outputs it as a digital port value.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Selection pattern

The bit pattern which decides which bits are selected from the input (all the bits that are 1 will be selected from the input). The selection pattern is 1 indexed.

Ports

The selection pattern decides how many output ports there are. The amount of bits that are one is equal to the amount of output ports.

BitwiseAnd

 Takes two or more inputs and performs an AND operation on each bit. The result is written to the output port.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Inputs

The number of inputs which will be AND'ed.

Ports

The number of input ports will vary depending on the Inputs property.

Invert

Inverts a digital input and writes the result to an output port.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Ports

OR

 Performs an OR operation on the inputs. If one or more of the inputs are true, the output will be true.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Inputs

The number of inputs which will be OR'ed.

Ports

The number of input ports will vary depending on the Inputs property.

RSFlipFlop

The RSFlipFlop has one Set input and one Reset input. If the Reset is false and Set goes from false to true out is set to true. The output will remain true until the Reset signal becomes true.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Ports

XOR

The component performs an XOR operation on the two inputs. If the both inputs are true or both inputs are false, the output is false. The output is true otherwise.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Ports

Compare

Compares the analog input to a high and low limit. There are two outputs indicating whether the values is over the high limit or below the low limit. The limits can either be specified as ports or properties.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

High value

When the incoming value is over the high limit, the High indicator port becomes true. The property can be exposed as a port.

Low value

When the incoming value is below the low limit, the Low indicator port becomes true. The property can be exposed as a port.

Ports

DigitalMultiplexer

This component will have several input signals and control signals. Depending on the value of the control signals, one input signal will be propagated to the output. The control signals are digital ports which combined creates a binary number. The binary number is then used to choose the input signal.

The control signals are named Digital multiplexer signal 1 - N. The Digital multiplexer signal 1 is the least significant bit. The number of control signals is specified with the Digital inputs property. The number of input signals is equal to 2N where N is equal to the Digital inputs property.

The input and output signal types are specified with the Signal type property.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

SignalType

Specifies the type of signal to be delayed. The signal can be analog, digital, string, vector, string vector or matrix.

Digital inputs

The number of digital inputs. The signal inputs will be created automatically, and the number of the signal inputs is 2N where N is the number of Digital inputs.

Ports

The number of input ports will vary depending on the Digital inputs property.

Equal

This component tests if two or more inputs are equal. If they are equal the output port becomes true. The signal can be analog, digital, vector, string vector and matrix.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

SignalType

Specifies the type of signal to be delayed. The signal can be analog, digital, string, vector, string vector or matrix.

Inputs

The number of inputs to test if are equal.

Ports

The ports displayed depends on the SignalType property.

Limit

The input signal is limited. This means that if an input signal exceeds a certain value the output becomes the limit value. A low limit can also be applied in the same manner.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

High limit

If the input signal exceeds this value the output will become equal to this limit. The property can be exposed as a port.

Low limit

If the input signal is below this value the output will become equal to this limit. The property can be exposed as a port.

Ports

LowpassFilter

This component will low pass filter the input signal.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Time constant

The time constant specifies the inverse of the cut-off frequency.

Ports

Multiplexer

This component will have several input signals and one control signal. Depending on the value of the control signal, one input signal will be propagated to the output. The control signal is an analog port whose number will specify which input will be sent to the output. The number is zero-based (i.e. the first input signal is chosen when the value of the control signal is zero.)

The input and output signal types are specified with the Signal type property.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

SignalType

Specifies the type of signal to be delayed. The signal can be analog, digital, string, vector, string vector or matrix.

Inputs

The number of inputs.

Ports

The number of input ports will vary depending on the Inputs property.

Ramp

Ramp one signal to another at a specified rate.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Ports

Random

Creates a random signal and exposed it on a analog port.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Mean value

The mean value of the random values being generated.

Standard deviation

The standard deviation of the random values being generated.

Ports

Sampling

Samples the input and exposed the value on an output port. The value can be either analog, digital, string, vector, string vector or matrix. The sampling is triggered by a digital port.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

SignalType

Specifies the type of signal to be delayed. The signal can be analog, digital, string, vector, string vector or matrix.

Sample trigging

Specifies when the samping occurs.

Ports

SnapEvent

Gives positive flank in one of the following snapshot situations:

• Persist state
• Load state
• Both persist and load

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Events

Choose between:

1. Write - triggers on persisting a snapshot, writeState.
2. Read - triggers on loading a snapshot, readState.
3. Both - triggers on both persisting and loading a snapshot.

Ports

TimeDelay

This component delays an incoming signal a given amount of time before writing the signal to an output. The signal can be analog, digital, vector, string vector and matrix.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

SignalType

Specifies the type of signal to be delayed. The signal can be analog, digital, string, vector, string vector or matrix.

Time Delay

The amount of time [s], the signal will be delayed.

Ports

The ports displayed depends on the SignalType property.

TimeStepDelay

This component delays an incoming signal a given amount of time steps before writing the signal to an output. The signal can be analog, digital, vector, string vector and matrix.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

SignalType

Specifies the type of signal to be delayed. The signal can be analog, digital, string, vector, string vector or matrix.

Time step delay

The amount of time steps the signal will be delayed.

Ports

The ports displayed depends on the SignalType property.

Trigger

 Creates a pulse when the input is changed. The input can be String, Analog, Digital or Analog vector.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Input type

Specifies what kind of input port will generate the pulse.

The options are:

• String input - The input is a string
• Digital input - The input is a boolean
• Analog input - The input is a double value
• Vector input - The input is a double vector

Ports

String

Vector

StringVectorAdd

This component is used to create a string vector from incoming scalar strings.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Add options

Specifies how elements are added to the resulting string vector.

The options are:

• Increasing
  The new string will be appended to the existing vector. The MaxElements property does not apply.
• Shifting
  The new string will be appended to the existing vector until the length of the vector reaches the number of the MaxElements property, after which the older elements will be shifted out and the new element will be written to the last element of the vector.
• Constant position
  The new string will be appended to the existing vector until the length of the vector reaches the number of the MaxElements property, after which the new element will be shifted out and the new element will be written to the first element, the next element after that will be written to the second element and so forth.

Unique elements

If true a string will not be added to the vector if there already is an equal string in that vector.

Allow empty strings

If true empty strings are allowed in the vector.

Max Elements

The maximum number of elements in the vector. Only applies when the Add options property is not set to Increasing

Persist vector

The vector will be persisted if true.

Ports

StringVectorAppend

This component takes a configurable amount of string vectors and concatinates them to one long string vector.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Number of strings to append

Specifies the number of string vectors which will be sent as input to the component. The resulting vector is concatinated from these inputs.

Unique elements

If true, the string elements of the resulting vector must be unique.

Ports

StringVectorComp

Two String vectors are compared.

The output value is generated after the following rules:

If a string element in the comparatorVectorPort is equal to a string element in the mainVectorPort, the bit that corresponds to element index of the string element in the mainVectorPort will be set to 1 in the result.

Example;

mainVectorPort = {"Element1", "Element2", "Element3"}

comparatorVectorPort = {"Something", "Element1", "Something else", "Element2"}

The result will be: 3

bit 0 and 1 is 1 and the rest is 0.

If the MainVectorPort contains a vector with more elements than 32 the elements with index higher than 32 will not be compared.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Ports

StringVectorExtractor

The purpose of the StringVectorExtractor is to extract the elements of a string vector into scalars. The different elements of the string vector can be extracted into digital, analog or string scalar ports.

Properties

The properties of this component are organized in multiple tabs. The separate tabs are described dedicated sub topics.

Parameters

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

ReportEventLevel

All events with equal or higher severity will be reported.

Extracted elements

This tab is used to define what elements from the input string vector to extract to scalar ports.

This parameter tab is based on the parameter matrix concept. Use the Add button to add a new row and the remove button to remove a selected row. The columns of the matrix are described below.

Element number

This is the element number (0 based) from the input string vector to extract.

Datatype

This is the desired data type for of the extracted element. The alternatives are:

• String. The extracted element will be exposed on a String port value.
• Double. The extracted element will be exposed on a Analog port value.
• Boolean. The extracted element will be exposed on a Digital port value.

If it is impossible to cast the actual element to the desired data type, the component will issue a warning.

Port name 

This property is used to specify the desired port name for the extracted vector element.

Ports

StringVector

This port is used to receive the string vector for which to extract elements.

Extracted element ports

The component has a configurable number of extracted element ports. The name and type of these ports are defined in the Extracted elements tab.

StringVectorJoin

The StringVectorJoin components is used to join strings elements from multiple input string vectors into a new output string vector. The corresponding elements of the input string vectors are concatenated to shape a new string element in the output string vector. The input strings may have different dimensions, and the behavior in this situation can be specified.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

ReportEventLevel

All events with equal or higher severity will be reported.  

Delimiter

This property can be used to insert a delimiter pattern between the concatenated string elements.

Number of strings to append

This property is used to specify the number of string vectors to join, and hence the number of input string vector ports.

Padding

This property defines the behavior when the input string vectors have different dimensions. The alternatives are:

• None. The longest input vector decides the dimension of the joined string vector. Vectors with fewer elements than the longest vector will not contribute to the excess elements of the joined string vector.
• LastValue. The longest input vector decides the dimension of the joined string vector. Vectors with fewer elements than the longest vector will contribute with their last element to the excess elements of the joined string vector.

Ports

Input string vectors

The component contains a configurable number of input string vector ports providing the string vectors to join. The name of these ports are StringVector 1 - StringVector N.

JoinedStringVector

This port displays joined string vector.

Activate

This is a digital port that can be used to activate/deactivate the component. If the component is deactivated, no joining will occur.

StringVectorPicker

Picks a string from the input string vector by specifying the element index.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Element

The index of the element to get from the input string vector.

Ports

StringVectorReverser

Takes an input string vector and reverses the positions of the elements. (The first element becomes the last, the second element becomes the last but one and so on.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Ports

ChangeCase

Changes the case of an input string either to lower or upper case. The case is controlled by a property.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

To lower case

If true the input string will be converted to lower case.

Invariant locale

If true the locale used is English, otherwise the current locale is used.

Ports

Contains

Tests if one string contains another string. The requirement can either be that the string must start with, end with or contain the other string. It is possible to ignore the case in the test.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Requirement

Specifies where the ContainString must be contained in the MainString. The choices are: Starts with, Ends with or Contains. Contains means that string can be located anywhere in the MainString.

Ignore case

If true the case of the strings are ignored.

Ports

Equals

Tests if two or more input strings are equal.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Inputs

The number of string inputs which will be tested if are equal.

Ignore case

If true the case of the strings are ignored.

Ports

IndexOf

Finds the index of a substring in a string. The index is zero based. It is possible to search both from the beginning of the string and from the end of the string. It is also possible to specify the index from where the search is started.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

First

Starts the search at the front of the string if true. If the it is false the string is searched backwards.

Ignore case

If true the case of the strings are ignored.

FromIndex

The index from where the search is started. If the First property is false, the index is reveresed. (I.e. 0 means the length of the string, 1 means the length - 1 and so forth. The property is exposable.

Ports

Length

Finds the length of a string.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Ports

Match

Tests if a string matches a regular expression.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Regular Expression

The regular expression against which the input string is matched. The property is exposable.

Ports

Replace

Replaces substring(s) of the input string that matches the given regular expression with the given replacement input string.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Regular Expression

The regular expression against which the input string is matched. The property is exposable.

Replace All

If true all substrings matching the regular expression will be replaced, if false only the first substring matching the regular expression will be replaced.

Ports

Time

CurrentUtcTime

Finds the current time. The time can either be the actual CPU time or the simulation time.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Time source

Specifies if the time is the simulated time or the actual CPU time.

Ports

Decipher

Process a UTC Time given in milliseconds since 1/1 1970 and outputs the year, month, day etc. It is possible to specify the time zone.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Timezone

The time zone which will be used.

Ports

Format

Formats a time given in milliseconds since 1/1 1970 to a configurable string.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Format

The format of the string.

Timezone

Specifies the time zone.

Ports

Top applications

BMSimulation

This component is a top application. It can only be a root container. The computationl algorithm can be selected from the Calculation order property. This top application can be used for real time purposes as well as simulation purposes. If it is used for simulation purposes the SimulationStartTime property specifies the start time of the simulation, and the time will move forward from that time when starting the simulation.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

SimulationStartTime

The start time for the simulation. The format is: DD.MM.YYYY hh:mm:ss

Calculation order

Specifies the computational algorithm.

BMSQLEngine

This component is identical to BMSimulation except that it also is able to connect to SQL Server. This makes it possible to use certain query components.

Database

Database type

Specifies what kind of database to connect to.

Computer

The computer hosting the database

Port

The communication port of the database

Database name

The name of the database to connect to.

Login name

The login id.

Password

The password.

Connection status

Displays the status of the connection. (Read only)

AdaptableContainer

This is a container which can be a top application as well as a general container. It can adapt its computational algorithm to the either the container which is in or the root container. It can also either choose the parallel or sequential algorithm directly. This is done through the ComputationalAlgorithm property.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Computational algorithm

Chooses the computational algorithm of this container.

The options are:

• Root container adaption - uses the computational algorithm of the root container
• Parent container adaption - uses the computational algorithm of the parent container
• Sequential computations - uses the sequential algorithm
• Parallel computations - uses the parallel algorithm

Ports

The component does not have ports, but ports from components within this container can be exposed to this container.

Converter

Converts an input to an output of another type. The following types are supported: Analog port, Digital port, String port, String vector port, Double vector port and Double matrix port.

The following rules apply when converting, (the columns indicate inputs and the rows indicate outputs):

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Input type

The type of the input to convert.

Output type

The type of the output.

Ports

Reporter

Writes a message to the reporting server. The message will for instance appear in the event viewer.

Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Message

The message which will be written. If no message is specified, a port will appear where the message can be written.

Severity

The severity of the message

Repeated

If true repeated messages will be ignored.