Skip to content

class BR_Config

Package: swiss.avm.up.core.config.br.javamodel.BR_Config

Direct Known Subclasses: PlatformConfig_BR


class BR_Config extends RootVariableLibrary

Configurations which have to be made especially for the B&R application.

Properties

customFolders

If necessary, custom folders can be specified (e.g., mappView)

CustomFolders[0..1]

defaultHardwareConfig

Configuration from PCD Library - Default for Simulation

DefaultHardwareConfig[0..1]

initTaskNameOverride

default, if empty:
i_ctrl_1

StringLiteral[0..1]

librariesConfig

Configuration of base and user libraries.

LibraryConfig[0..1]

loggerConfig

Configuration of log system

LoggerConfig[0..1]

moduleSystemOnTarget

Safe or normal B&R module system

Default setting is 'SAFE', then the drive F on flash card is used for the data.
If set to 'NORMAL', the data is stored on drive D.

ModuleSystemOnTarget[0..1]

optimizedGeneration

Only the variable initialization files used in hardware configuration are generated.

BooleanLiteral[0..1]

A literal where only the two values 'false' and 'true' are accepted.

preCompileHookCommon

This function is executed before the B&R compilation process.

TextLiteral[0..1]

A Literal that accepts multiple lines of text.

remanentConfig

RemanentStoreOptions[1..1]

service

ABrServiceConfig[0..N]

taskGroupConfig

Connects the instance groups to the task class.

TaskGroupConfig_BR[0..N]

textListsConfig

TextListsConfig[1..1]

textManager

TextManager[0..1]

The text manager connects the native text resources with the respective translations. The languages to be translated are defined here. For each NativeTextList a TextTable is created in which the individual texts are translated.

unitConfig

UnitConfig[1..1]

userObjectConfig

UserObjectConfig_BR[0..1]

webrootIntegrationFolder

Integrate files to the webroot
Folder is relative to the project. Subfolder is possible (separate with "/")

After the code generation, this folder (with all subfolders) will be coppied to the folder Webroot. If there is already a file with the same name, it will be overwritten.

StringLiteral[0..1]

Method Summary

_getFilteredExcludedVariableGroups

Parameters:

Model

Return:

List<VariableGroup>

activateOpcAuditEvents

@ConfigFunctionSpace

True if audit events should be activated at OPC-UA definition. Otherwise null.

Return:

BooleanLiteral

createUpActItemsConfig

Return:

StringLiteral

generateOpcLimits

@ConfigFunctionSpace

True if limit definition should be part of OPC-UA definition. Otherwise false.

Return:

BooleanLiteral

getAllFileClient

@ConfigFunctionSpace

Return:

List<FileClient>

getAllFileClients

@ConfigBRFunctions

Return:

List<FileClient>

getAllTestSuiteInstances

@ServiceUiFunctions

Return:

List<SuiteInstance>

getBaseLibraryDefinitions

@ConfigFunctionSpace

Returns all ignore and overwrite base libraries from brConfig

Return:

List<BaseLibraryDefinition>

getDataGroupFileHandlerConfigActive

@ConfigFunctionSpace

Returns all active file handler configs (mode2_FileDefault or mode3_FileDefaultAutoInit).

Return:

List<FileHandlerDataGroupConfig>

getDataGroupFileHandlerConfigExceptNoneAndOnlyFileDevice

@ConfigFunctionSpace

Returns all file handler configs except mode (none, only file device, remanent).

Return:

List<FileHandlerDataGroupConfig>

getDataGroupWithRemanentHandler

@FTemplateFunctions

Returns list of data group with remanent handler

Return:

List<CustomDataGroup>

getExcludedVariableGroups

@BrControllerTreeFunctionSpace

Parameters:

Model

Return:

List<VariableGroup>

getHardwareConfigs

@ConfigBRFunctions

Return:

List<HardwareConfig>

getMaxTestReportFileClients

@FTemplateFunctions

Return:

IntegerLiteral

getNoOfAllLogClient

@ConfigFunctionSpace

Return:

IntegerLiteral

getOpcLimitViolationType

@ConfigFunctionSpace

Get defined violation type or null for default.

Return:

LimitViolationType

getOpcUaConfig

@ConfigFunctionSpace

Return:

OpcUaConfig

getOpcUaConfigs

@ConfigFunctionSpace

Return:

List<OpcUaConfig>

getTestingJson

Return:

StringLiteral

getUnitIdMapping

@ConfigBRFunctions

Parameters:

Unit

Return:

UnitIdMapping

getUsedBrBaseLibraries

@ConfigFunctionSpace

Returns list with getBrBaseLibraries@GenericFunctionSpace list without ignore and overwrite libraries and evaluation used filter.

Return:

List<BaseLibraryDefinition>

getUserObjects

@FUserObj

Parameters:

ControllerTree

Return:

List<APlatformUserObject>

getUserTask_VcDataObjects

@FUserObj

Parameters:

ControllerTree
AHardwareConfigBR

Return:

List<UserObjectDefinition>

getVariableInit

@FTemplateFunctions

Dependends to optimized generation flag at config. Returns all variableInit or only linked at a hardware config. With removing of deprecated interface data groups (remove unoptimized option and remove number of functions for calculation).

Return:

List<VariableInitInterface>

getVariableInitExceptRemanent

@FTemplateFunctions

Like getVariableInit, except data groups with remanent handler. Since default must directly linked to remanent structure from remanent handler.

Return:

List<VariableInitCustom>

getVariableInitRemanent

@FTemplateFunctions

Returns only variable init for remanent handler.

Return:

List<VariableInitCustom>

includeInterlockOpcTag

@ConfigFunctionSpace

True if ilk tags should be part of OPC-UA definition. Otherwise false.

Return:

BooleanLiteral

includeOpcUnit

@ConfigFunctionSpace

True if limit definiton should be part of OPC-UA definition. Otherwise false.

Return:

BooleanLiteral

internal_getBrBaseLibraries

@ConfigFunctionSpace

Return:

List<BaseLibraryDefinition>

isAsVersionBelowSix

@FProjectStructureBr

Return:

BooleanLiteral

isDatLogUsed

@ControlTemplateFunctions

returns true if at least one data logger is configured

Return:

BooleanLiteral

isFileHandlerNeeded

@FTemplateFunctions

Returns true if a B&R file handler configured.

Return:

BooleanLiteral

isRemanentHandlerNeeded

@FTemplateFunctions

Returns true if a B&R remanent handler configured.

Return:

BooleanLiteral

logfileClientUsed

@ConfigBRFunctions

Return:

BooleanLiteral