Class Backup
Version 2.0
Modified 08-MAR-2026 11:05:32.00
Code rt_plc_macro_logic.h
 Points out a data segment in rtdb where the items will
 be backed up on a file.

 If the segment pointed out by the Backup object was
 created in the development environment the backup may
 concern either the whole object or single attributes in
 the object pointed out. In the development environment
 the Backup object can be configured either by the
 Configuration Editor or the PLC Editor.

 Backup objects created by the Configuration Editor is
 located below $PlantHier objects. The Backup object and
 the object referred to have to reside on the same
 target node, else no backup will be done. DataName
 specifies what to backup.

 The input of a backup object configured by the PLC
 Editor, is connected to the output of the object that
 will be backed up. It is assumed that this output is
 supplied with the output-flag. ObjectBackup specifies
 if the whole object or only the connected output
 attribute is to be backed up. DataName is filled in at
 the initialisation of the PLC job.

 Backup of objects configured and created in run time
 always concerns only the whole object, not a single
 attribute. The corresponding backup object is also
 configured and created in run time.

Hints
 Note! Whole signal objects should not be backed up, as
 this might cause problems after booting.

 Every type of signal object has a pointer *ActualValue
 and it is not likely that this will be the  same after
 booting as before. If backup of a single attribute in a
 signal object is required, e.g. ActualValue in an Av
 object, backup that attribute and not the whole object.
 When the run-time environment of a node is created the
 attributes of the instances get default values.
 Instances in the backup file which,

 - are to be found in node's rtdb will be updated
   according to the back-up
 - are missed in rtdb, because they are deleted, or
   have got a new name e.g., will be skipped

 One cannot presuppose at change of ProviewR distribution
 that the back-up file will works.

See Also



RtBody attributes pwr_sClass_Backup
Boolean In in
Boolean ObjectBackup   Used by Backup objects configured in the PLC Editor.
Specifies if the whole object, connected to the Backup
object, or just the connected output should be backed
up. FALSE means that only the connected output
(=parameter) should be backed up. TRUE means that the
whole object should be backed up.
AttrRef DataName   Specifies the name of what to backup.
Example:
VKV-ProdEnergi ( the whole object is concerned)
VKV-TEMP1.ActualValue (only ActualValue is concerned)
Boolean Fast   Specifies whether the backup cycle should be fast or
slow. FALSE means slow and TRUE means fast
backup-cycle. The meaning of fast and slow will be
determined by the Backup_Conf object.
UInt32 Status   Status code on OpenVMS-format. Specifies if an error
occurred in connection with the backup of the object.
As long as Status = 0 no backup has been done.

DevBody attributes 
PlcNode PlcNode  


GraphPlcNode
object_type 119
parameters[0] 1
parameters[1] 0
parameters[2] 0
parameters[3] 0
subwindows 0
graphmethod 7 (Get,Set)
graphindex 1
default_mask[0] 1
default_mask[1] 0
segname_annotation 1
compmethod 37
compindex 0
tracemethod 0
traceindex 0
connectmethod 0
objname Backup
graphname Backup
debugpar


Attributes detail


In Input
Class Input
Type Boolean
Flags STATE | RTVIRTUAL
GraphName in
Body RtBody

ObjectBackup Intern
Class Intern
Type Boolean
Flags RTVIRTUAL
Body RtBody
 Used by Backup objects configured in the PLC Editor.
 Specifies if the whole object, connected to the Backup
 object, or just the connected output should be backed
 up. FALSE means that only the connected output
 (=parameter) should be backed up. TRUE means that the
 whole object should be backed up.

DataName Attribute
Class Attribute
Type AttrRef
Flags
Body RtBody
 Specifies the name of what to backup.
 Example:
   VKV-ProdEnergi  ( the whole object is concerned)
   VKV-TEMP1.ActualValue  (only ActualValue is concerned)

Fast Attribute
Class Attribute
Type Boolean
Flags
Body RtBody
 Specifies whether the backup cycle should be fast or
 slow. FALSE means slow and TRUE means fast
 backup-cycle. The meaning of fast and slow will be
 determined by the Backup_Conf object.

Status Attribute
Class Attribute
Type UInt32
Flags STATE
Body RtBody
 Status code on OpenVMS-format. Specifies if an error
 occurred in connection with the backup of the object.
 As long as Status = 0 no backup has been done.

PlcNode Buffer
Class Buffer
Type PlcNode
Flags
Body DevBody