Skip to content

P
proview
Commit 157c3a80 authored by claes's avatar claes
Browse files
Options

Documentation modifications

parent 09977a80
Hide whitespace changes
Inline Side-by-side
Showing with 181 additions and 31 deletions
src/wbl/pwrb/src/pwrb_c_busconfig.wb_load
View file @ 157c3a80
!
! Proview $Id: pwrb_c_busconfig.wb_load,v 1.3 2005-09-01 14:58:01 claes Exp $
! Proview $Id: pwrb_c_busconfig.wb_load,v 1.4 2006-02-23 14:37:12 claes Exp $
! Copyright (C) 2005 SSAB Oxelösund AB.
!
! This program is free software; you can redistribute it and/or
......@@ -23,11 +23,21 @@ SObject pwrb:Class
! @Version 1.0
! @Group ProjectConfiguration
! @Summary Configures a Qcom bus.
! The Bus object configures a qcom bus that nodes in the project will
! The Bus object configures a Qcom bus that nodes in the project will
! communicate on.
!
! The object should be configured in the project volume as a top object,
! and have the NodeConfig object of the nodes in the bus as children.
! Qcom is the communication protocoll for proview nodes and proview
! processes. Nodes that will communicate over Qcom has to use the same
! Qcom bus. Communication between nodes in different busses is not possible.
!
! A Qcom bus is specified with a busnumber in the interval 0-999.
!
! The BusConfig object should be configured in the directory volume as a top
! object. Below this, each node of the system, that belong to this Qcom bus,
! should be configured with a NodeConfig object.
!
! It is common to configure at least two different Qcom busses in a system, one
! for the production nodes and one for simulation nodes.
!
! @b See also
! @classlink NodeConfig pwrb_nodeconfig.html
......@@ -40,7 +50,7 @@ SObject pwrb:Class
EndBody
Object RtBody $ObjBodyDef 1
!/**
! Description of the bus
! Description of the bus.
!*/
Object Description $Attribute 1
Body SysBody
......@@ -48,7 +58,8 @@ SObject pwrb:Class
EndBody
EndObject
!/**
! QCOM bus number.
! Specification of a Qcom bus.
! A number in the intervall 1-999.
!*/
Object BusNumber $Attribute 2
Body SysBody
......
src/wbl/pwrs/src/pwrs_c_classvolume.wb_load
View file @ 157c3a80
!
! Proview $Id: pwrs_c_classvolume.wb_load,v 1.4 2005-09-01 14:58:03 claes Exp $
! Proview $Id: pwrs_c_classvolume.wb_load,v 1.5 2006-02-23 14:37:20 claes Exp $
! Copyright (C) 2005 SSAB Oxelsund AB.
!
! This program is free software; you can redistribute it and/or
......@@ -22,10 +22,46 @@ SObject pwrs:Class
!/**
! @Version 1.0
! @Group Volumes,ClassDefinition
! A class volume contains class and type definition hierarchies.
! When a class volume is created, also a classvolume object is created.
! This object is not displayed in the object hierarchy in the navigator,
! though it can be opened from menu.
! A class volume contains class and type definition objects.
!
! Classes and types in proview, are specified with objects, such
! as ClassDef, ObjBodyDef, Attribute, Type and TypeDef etc.
! These classdefinition object reside in classvolumes.
!
! To create an instance object of a specific class, the classvolume of
! of this class has to be loaded.
!
! ClassVolumes are divided into the groups system classvolumes,
! manufacturer classvolumes and user classvolumes. System and
! manufacturer classvolumes comes with the proview release, and
! the loadfiles reside on $pwr_load.
!
! User classvolumes contains local classes for a project.
! The volume has to be registred in the global volume list, and is
! identified by a volume identity.
!
! In the directory volume of a project, a user class volume is
! configured by a ClassVolumeConfig object.
!
! If a node contains instances of classes in a specific classvolume,
! this volume is loaded at runtime startup, and doesn't have to be
! configured with any volume load object.
!
! If a node doesn't contain any instances, but has to display or
! subscribe to remote objects of the class, you should specify
! that the class volume should be loaded with a ClassVolumeLoad object
! in the directory volume. If this is not done, classes can be loaded
! at runtime from remote nodes, using the class cashe. The class cashe
! is also used if the class is loaded, but the version of the class
! differs on the remote node.
!
! The user class volume is edited in the class editor, which is opened
! from the directory volume, by selecting a ClassVolumeConfig object.
!
! @b See also
! @classlink ClassVolumeConfig pwrb_classvolumeconfig.html
! @classlink ClassVolumeLoad pwrb_classvolumeload.html
! @classlink VolumeId pwrs_volumeid.html
!*/
Object $ClassVolume $ClassDef pwr_eCix_ClassVolume
Body SysBody
......
src/wbl/pwrs/src/pwrs_c_dynamicvolume.wb_load
View file @ 157c3a80
!
! Proview $Id: pwrs_c_dynamicvolume.wb_load,v 1.4 2005-09-01 14:58:03 claes Exp $
! Proview $Id: pwrs_c_dynamicvolume.wb_load,v 1.5 2006-02-23 14:37:20 claes Exp $
! Copyright (C) 2005 SSAB Oxelsund AB.
!
! This program is free software; you can redistribute it and/or
......@@ -22,11 +22,23 @@ SObject pwrs:Class
!/**
! @Version 1.0
! @Group Volumes
! A dynamic volume only exist in runtime, and contains object that is
! A dynamic volume only exist in runtime, and contains objects that is
! created and deleted in runtime.
! When the dynamic volume is created, also a dynamic volume object is created.
! This object should not be configured in the configurator.
! A dynamic volume is configured by a CreateVolume object.
!
! A dynamic volume is configured by a CreateVolume object, normally
! positioned in the node hierarchy. It is not configured in the
! directory volume.
!
! The volume can be mounted in the root volume with a MountObject
! object.
!
! The volume has to be registred in the global volume list, and is
! identified by a volume identity.
!
! @b See also
! @classlink CreateVolume pwrs_createvolume.html
! @classlink RootVolume pwrs_rootvolume.html
! @classlink VolumeId pwrs_volumeid.html
!*/
Object $DynamicVolume $ClassDef pwr_eCix_DynamicVolume
Body SysBody
......
src/wbl/pwrs/src/pwrs_c_rootvolume.wb_load
View file @ 157c3a80
!
! Proview $Id: pwrs_c_rootvolume.wb_load,v 1.5 2005-09-01 14:58:03 claes Exp $
! Proview $Id: pwrs_c_rootvolume.wb_load,v 1.6 2006-02-23 14:37:20 claes Exp $
! Copyright (C) 2005 SSAB Oxelsund AB.
!
! This program is free software; you can redistribute it and/or
......@@ -21,7 +21,33 @@
SObject pwrs:Class
!/**
! @Group Volumes
! The root volume is loaded at runtime startup.
! A root volume contains the root of the object tree of the
! realtime database of a node. The volume is loadede into
! the database at system startup.
!
! Only one rootvolume can be loaded into a node, and in one
! qcom bus, the root volume can only be loaded into one node.
!
! It is possible to mount objects of other volumes in the object
! tree of a root volume. SubVolumes, SharedVolumes, DynamicVolumes
! and RootVolumes of remote nodes, can be mounted by placing
! mount objects in the object tree.
!
! The volume has to be registred in the global volume list, and is
! identified by a volume identity.
!
! In the directory volume of a project, a root volume is configured
! by a RootVolumeConfig object, and the node the volume is to be
! loaded into is specified with a RootVolumeLoad object.
!
! @b See also
! @classlink RootVolumeConfig pwrb_rootvolumeconfig.html
! @classlink RootVolumeLoad pwrb_rootvolumeload.html
! @classlink SubVolume pwrs_subvolume.html
! @classlink SharedVolume pwrs_sharedvolume.html
! @classlink DynamicVolume pwrs_dynamicvolume.html
! @classlink ClassVolume pwrs_classvolume.html
! @classlink VolumeId pwrs_volumeid.html
!*/
Object $RootVolume $ClassDef pwr_eCix_RootVolume
Body SysBody
......
src/wbl/pwrs/src/pwrs_c_sharedvolume.wb_load
View file @ 157c3a80
!
! Proview $Id: pwrs_c_sharedvolume.wb_load,v 1.4 2005-09-01 14:58:03 claes Exp $
! Proview $Id: pwrs_c_sharedvolume.wb_load,v 1.5 2006-02-23 14:37:20 claes Exp $
! Copyright (C) 2005 SSAB Oxelsund AB.
!
! This program is free software; you can redistribute it and/or
......@@ -22,7 +22,26 @@ SObject pwrs:Class
!/**
! @Group Volumes
! Volume shared by several nodes.
! Not implemented.
!
! A SharedVolume can be loaded into several nodes. Objects that is
! common for several nodes, e.g. XttGraph objects or Sound objects,
! can be placed in a shared volume.
!
! The volume has to be registred in the global volume list, and is
! identified by a volume identity.
!
! In the directory volume of a project, a shard volume is configured
! by a SharedVolumeConfig object, and the node (or nodes) the volume
! is to be loaded into is specified with a SharedVolumeLoad object.
!
! @b See also
! @classlink SharedVolumeConfig pwrb_sharedvolumeconfig.html
! @classlink SharedVolumeLoad pwrb_sharedvolumeload.html
! @classlink RootVolume pwrs_rootvolume.html
! @classlink SubVolume pwrs_subvolume.html
! @classlink DynamicVolume pwrs_dynamicvolume.html
! @classlink ClassVolume pwrs_classvolume.html
! @classlink VolumeId pwrs_volumeid.html
!*/
Object $SharedVolume $ClassDef pwr_eCix_SharedVolume
Body SysBody
......
src/wbl/pwrs/src/pwrs_c_subvolume.wb_load
View file @ 157c3a80
!
! Proview $Id: pwrs_c_subvolume.wb_load,v 1.5 2005-09-01 14:58:03 claes Exp $
! Proview $Id: pwrs_c_subvolume.wb_load,v 1.6 2006-02-23 14:37:20 claes Exp $
! Copyright (C) 2005 SSAB Oxelsund AB.
!
! This program is free software; you can redistribute it and/or
......@@ -21,7 +21,39 @@
SObject pwrs:Class
!/**
! @Group Volumes
! Sub volume.
! Sub volume as an additional volume that, together with the root
! volume is loaded into a node at system startup.
!
! Sometimes it is convenient to separate the objects of a node into
! two (or more) volumes, for example if a part of the plant is to be
! moved to another node later, or if there are several developers that
! has to work in different databases. It is then possible to devide the
! objects of a node into a rootvolume, and a subvolume (or several
! subvolumes).
!
! The subvolumes is mounted in the rootvolume with a MountObject. Make
! sure to find a suitable mouning point in the root volume. If the
! subvolumes should be mounted on remote nodes, e.g. on an operator
! station, the mounting point should not be hidden in the object tree
! of the root volume.
!
! In one qcom bus, a subvolume can only be loaded into one single node.
!
! The volume has to be registred in the global volume list, and is
! identified by a volume identity.
!
! In the directory volume of a project, a sub volume is configured
! by a SubVolumeConfig object, and the node the volume is to be
! loaded into is specified with a SubVolumeLoad object.
!
! @b See also
! @classlink SubVolumeConfig pwrb_subvolumeconfig.html
! @classlink SubVolumeLoad pwrb_subvolumeload.html
! @classlink RootVolume pwrs_rootvolume.html
! @classlink SharedVolume pwrs_sharedvolume.html
! @classlink DynamicVolume pwrs_dynamicvolume.html
! @classlink ClassVolume pwrs_classvolume.html
! @classlink VolumeId pwrs_volumeid.html
!*/
Object $SubVolume $ClassDef pwr_eCix_SubVolume
Body SysBody
......
src/wbl/pwrs/src/pwrs_c_system.wb_load
View file @ 157c3a80
!
! Proview $Id: pwrs_c_system.wb_load,v 1.3 2005-09-01 14:58:03 claes Exp $
! Proview $Id: pwrs_c_system.wb_load,v 1.4 2006-02-23 14:37:20 claes Exp $
! Copyright (C) 2005 SSAB Oxelösund AB.
!
! This program is free software; you can redistribute it and/or
......@@ -21,12 +21,17 @@
SObject pwrs:Class
!/**
! @Version 1.0
! An object common for all the nodes in a PROVIEW/R
! An object common for all the nodes in a Proview
! system.
!
! SystemName is used to identify one PROVIEW/R system
! The object is configured on the top level in the directory volume.
!
! In runtime the system object is placed in the SystemVolume below
! the pwrNode hierarchy.
!
! SystemName is used to identify one Proview system
! among others.
! The object is placed on the top level in the directory volume.
!
!*/
Object $System $ClassDef pwr_eCix_System
Body SysBody
......@@ -38,7 +43,7 @@ SObject pwrs:Class
Attr StructName = "System"
EndBody
!/**
! Optional text to describe the use of the object.
! Optional description.
!*/
Object Description $Attribute 1
Body SysBody
......@@ -46,10 +51,15 @@ SObject pwrs:Class
EndBody
EndObject
!/**
! Specifies the name or notation of a PROVIEW/R system.
! Specifies the name or notation of a Proview system.
! The systemname is used to identify volumes registred for a system
! in the global volumelist.
!
! The SystemName is used by load data files and for
! authorisations.
! In the initial configuration, the system name normally equals
! the project name. Sometimes, at an upgrade or major revision, it is
! a good idea to make a copy, to keep the current state of the project.
! The copy will have a new projectname, but the system name remains the
! same, and identifies the volumes and node that belongs to the system.
!*/
Object SystemName $Attribute 2
Body SysBody
......@@ -59,7 +69,11 @@ SObject pwrs:Class
!/**
! Specifies the name of the system group that the system
! is a member of.
! The SystemGroup is used for authorisation.
!
! The SystemGroup is used for authorisation in the development
! and operator environment.
!
! SystemGroups are configured in the User Database.
!*/
Object SystemGroup $Attribute 9
Body SysBody
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7