class CustomDataGroup
Package: swiss.avm.up.core.generic.specification.interface_declaration.javamodel.CustomDataGroup
Direct Known Subclasses:
class CustomDataGroup extends NamedResource, AOmitFromFieldbusOwner
Properties
name
The name of this Resource.
StringLiteral[1..1]
omitFromFieldbus
Variable is omitted from fieldbus. (It has no inpact on the Siemens and Beckhoff platforms.)
Consider, the variable will not be visible on ServiceUi and can not be used in UpAct.
defaultValue = false
BooleanLiteral[0..1]
A literal where only the two values 'false' and 'true' are accepted.
remanent
Enables data values to be stored in the control unit's non-volatile memory.
How exactly the values are stored (retain or persistent) must be defined on the respective platform.
BooleanLiteral[0..1]
A literal where only the two values 'false' and 'true' are accepted.
structureToken
StringLiteral[1..1]
Method Summary
className
@TemplateNameFunctions
Structure name at PLC
Parameters:
ControllerInterface
getBrFileHandlerMode
@FTemplateFunctions
Returns none if custom data group is not remanent.
Return:
FilehandlerOptions
getFileHandlerParamJobIndex
@FTemplateFunctions
Returns param job index (c_PARAJOB_CNF, cPARAJOB_PAR, ...) for B&R file handler
Return:
IntegerLiteral
getName
@InterfaceDeclarationExtension
Return:
StringLiteral
getName
@FName
getStructId
@ServiceUiFunctions
Return:
StringLiteral
getStructureToken
@InterfaceDeclarationExtension
Return:
StringLiteral
isBrDefaultInitRequired
@FTemplateFunctions
Returns true or null if for custom data group a VariableInitCustom is defined.
Return:
BooleanLiteral
isFileHandlerRequired
@FTemplateFunctions
True or null. File handler required for data group (Default or Storage function)
Return:
BooleanLiteral
isFileHandlerStorageRequired
@FTemplateFunctions
Returns true or null if storage with file handler required.
Return:
BooleanLiteral
isIfsRemanent
@FVariableName
Returns true if _Rem should be part of name (S7 Persistent) otherwise null
Parameters:
PlatformType
Return:
BooleanLiteral
isOmittedFromFieldbus
@FModelConfig
Returns true, if the data group is omitted from fieldbus.
Return:
BooleanLiteral
isRemanent
@ControllerFunctionSpace
Returns true if data group is remanent. Consider platform specific additional configuration for specific remanent behavior.
Return:
BooleanLiteral