Commit cd4057f1 authored by claes's avatar claes

Documentation for types

parent bd7a82e0
......@@ -115,10 +115,18 @@ int ClassRead::read( char *filename)
nr > 2 &&
strcmp( low( line_part[2]), "pwr_eclass_param") == 0)
linetype = cread_eLine_Attribute;
else if ( strcmp( low( line_part[0]), "object") == 0 &&
nr > 2 &&
strcmp( low( line_part[2]), "pwr_eclass_typedef") == 0)
linetype = cread_eLine_TypeDef;
else if ( strcmp( low( line_part[0]), "object") == 0 &&
nr > 2 &&
strcmp( low( line_part[2]), "$typedef") == 0)
linetype = cread_eLine_TypeDef;
else if ( strcmp( low( line_part[0]), "object") == 0 &&
nr > 2 &&
strcmp( low( line_part[2]), "pwr_eclass_type") == 0)
linetype = cread_eLine_Type;
else if ( strcmp( low( line_part[0]), "object") == 0 &&
nr > 2 &&
strcmp( low( line_part[2]), "$objbodydef") == 0)
......@@ -226,6 +234,15 @@ int ClassRead::read( char *filename)
else
strcpy( typedef_name, line_part[1]);
break;
case cread_eLine_Type:
state |= cread_mState_Type;
object_state = cread_mState_Type;
typedef_init();
if ( line_part[1][0] == '$')
strcpy( typedef_name, &line_part[1][1]);
else
strcpy( typedef_name, line_part[1]);
break;
case cread_eLine_SysBody:
state |= cread_mState_SysBody;
break;
......@@ -361,6 +378,15 @@ int ClassRead::read( char *filename)
html_class_close();
if ( generate_struct && struct_class_open)
struct_class_close();
#endif
}
else if ( state & cread_mState_Type) {
state &= ~cread_mState_Type;
#if 0
if ( generate_html && html_class_open)
html_class_close();
if ( generate_struct && struct_class_open)
struct_class_close();
#endif
}
else if ( state & cread_mState_Object)
......@@ -407,6 +433,7 @@ int ClassRead::read( char *filename)
class_attr( attr_name, attr_value);
break;
case cread_mState_TypeDef:
case cread_mState_Type:
typedef_attr( attr_name, attr_value);
break;
case cread_mState_ObjBodyDef:
......@@ -455,6 +482,7 @@ int ClassRead::read( char *filename)
class_attr( attr_name, attr_value);
break;
case cread_mState_TypeDef:
case cread_mState_Type:
typedef_attr( attr_name, attr_value);
break;
case cread_mState_ObjBodyDef:
......@@ -1001,6 +1029,7 @@ int ClassRead::object_close()
class_close();
break;
case cread_mState_TypeDef:
case cread_mState_Type:
typedef_close();
break;
case cread_mState_Object:
......@@ -1038,14 +1067,21 @@ int ClassRead::typedef_attr( char *name, char *value)
int ClassRead::typedef_close()
{
if ( first_class) {
if ( generate_struct)
if ( generate_html)
html_init( typedef_name);
if ( generate_struct &&
object_state == cread_mState_TypeDef)
struct_init();
first_class = 0;
}
if ( generate_struct)
if ( generate_html)
html_typedef();
if ( generate_struct &&
object_state == cread_mState_TypeDef)
struct_typedef();
doc_fresh = 0;
......
......@@ -54,6 +54,7 @@ typedef enum {
cread_eLine_EndBuff,
cread_eLine_Range,
cread_eLine_TypeDef,
cread_eLine_Type,
cread_eLine_Unknown
} cread_eLine;
......@@ -77,7 +78,8 @@ typedef enum {
cread_mState_Template = 1 << 16,
cread_mState_Volume = 1 << 17,
cread_mState_DParam = 1 << 18,
cread_mState_TypeDef = 1 << 19
cread_mState_TypeDef = 1 << 19,
cread_mState_Type = 1 << 20
} cread_mState;
#define cread_cTmpFile1 "classread1.tmp"
......@@ -211,6 +213,7 @@ class ClassRead {
int html_graphplcnode();
int html_graphplccon();
int html_template();
int html_typedef();
// xtthelp
int generate_xtthelp;
......
......@@ -7,3 +7,6 @@ group NodeConfiguration pwrs_appl.html
group PlantConfiguration pwrs_libhier.html
group ClassDefinition pwrs_attribute.html
group Volumes pwrs_classvolume.html
group Types pwrs_attrref.html
group DerivedTypes pwrs_string132.html
group BasicTypes pwrs_attrref.html
\ No newline at end of file
......@@ -52,9 +52,10 @@ $(inc_dir)/pwr_systemclasses.h :
$(doc_dir)/orm/pwrs_allclasses.html :
@ echo "Generating html files for pwrs classes..."
@ co_convert -w -d $(doc_dir)/orm -g $(pwre_sroot)/wbl/pwrs/src/cnv_setup.dat "$(pwre_sroot)/wbl/pwrs/src/pwrs_c_*.wb_load"
@ co_convert -w -d $(doc_dir)/orm -g $(pwre_sroot)/wbl/pwrs/src/cnv_setup.dat "$(pwre_sroot)/wbl/pwrs/src/pwrs_*.wb_load"
@ echo "Generating html files for pwrs structs..."
@ co_convert -c -d $(doc_dir)/orm $(inc_dir)/pwr_systemclasses.h
@ co_convert -c -d $(doc_dir)/orm $(inc_dir)/pwr.h
$(exe_dir)/pwrs_xtthelp.dat :
@ echo "Generating xtt help files for pwrs classes"
......
......@@ -96,12 +96,12 @@ SObject pwrs:Class
! @Summary Bitmask for attribute properties.
! Bitmask for attribute properties.
!
! PWR_MASK_POINTER Attribute is a pointer.
! PWR_MASK_ARRAY Attribute is an array.
! PWR_MASK_STATE Value will not be loaded from develompent database.
! PWR_MASK_CONST Value is a constant.
! PWR_MASK_RTVIRTUAL Attribute doesn't exist in runtime environment
! PWR_MASK_DEVBODYREF Used for input and output attributes, where the
! PWR_MASK_POINTER Attribute is a pointer.
! PWR_MASK_ARRAY Attribute is an array.
! PWR_MASK_STATE Value will not be loaded from develompent database.
! PWR_MASK_CONST Value is a constant.
! PWR_MASK_RTVIRTUAL Attribute doesn't exist in runtime environment
! PWR_MASK_DEVBODYREF Used for input and output attributes, where the
! connection refers another object which is found
! in the first attribute of type Objid in DevBody.
! PWR_MASK_OBJIDSELF Contains the objects own objid. Used in timer attributes.
......@@ -112,6 +112,11 @@ SObject pwrs:Class
! PWR_MASK_NOREMOVE Can't be removed in plc editor.
! PWR_MASK_RTDBREF Contains an rtdb reference.
! PWR_MASK_PRIVATE Should not be interpreted by an object editor.
! PWR_MASK_ISCLASS Attribute is specified by a class.
! PWR_MASK_SUBCLASS ...
! PWR_MASK_BUFFER ...
! PWR_MASK_NOWBL Attribute will not be to printed to wb_load file.
! PWR_MASK_ALWAYSWBL Attribute is always printed to wb_load file.
!*/
Object Flags pwr_eClass_Param 5
Body SysBody
......
......@@ -67,12 +67,12 @@ SObject pwrs:Class
! @Summary Bitmask for attribute properties.
! Bitmask for attribute properties.
!
! PWR_MASK_POINTER Attribute is a pointer.
! PWR_MASK_ARRAY Attribute is an array.
! PWR_MASK_STATE Value will not be loaded from develompent database.
! PWR_MASK_CONST Value is a constant.
! PWR_MASK_RTVIRTUAL Attribute doesn't exist in runtime environment
! PWR_MASK_DEVBODYREF Used for input and output attributes, where the
! PWR_MASK_POINTER Attribute is a pointer.
! PWR_MASK_ARRAY Attribute is an array.
! PWR_MASK_STATE Value will not be loaded from develompent database.
! PWR_MASK_CONST Value is a constant.
! PWR_MASK_RTVIRTUAL Attribute doesn't exist in runtime environment
! PWR_MASK_DEVBODYREF Used for input and output attributes, where the
! connection refers another object which is found
! in the first attribute of type Objid in DevBody.
! PWR_MASK_OBJIDSELF Contains the objects own objid. Used in timer attributes.
......@@ -83,6 +83,11 @@ SObject pwrs:Class
! PWR_MASK_NOREMOVE Can't be removed in plc editor.
! PWR_MASK_RTDBREF Contains an rtdb reference.
! PWR_MASK_PRIVATE Should not be interpreted by an object editor.
! PWR_MASK_ISCLASS Attribute is specified by a class.
! PWR_MASK_SUBCLASS ...
! PWR_MASK_BUFFER ...
! PWR_MASK_NOWBL Attribute will not be to printed to wb_load file.
! PWR_MASK_ALWAYSWBL Attribute is always printed to wb_load file.
!*/
Object Flags $Attribute 5
Body SysBody
......
......@@ -9,10 +9,17 @@ SObject pwrs:Class
!/**
! @Version 1.0
! @Group ClassDefinition
! Root object of a class hierarchy.
! Root object of a class definition hierarchy.
! The ClassHier object is a toplevel object in a class volume, and act as
! the anscestor to the class definition hierarchy.
! It is generally named 'Class'.
! It should be named 'Class', and there kan only be one $ClassDef object in a
! ClassVolume.
!
! Below the $ClassHier object, all the classes in the volume are defined with
! $ClassDef objects.
!
! @b See also
! @classlink $ClassDef pwrs_classdef.html
!*/
Object $ClassHier $ClassDef pwr_eCix_ClassHier
Body SysBody
......
......@@ -35,7 +35,7 @@ SObject pwrs:Class
! @Summary Number of input, intern and output attributes.
! Number of input, intern and output attributes.
! Element 0 : the number of input attributes.
! Element 1 : the number of inter attributes.
! Element 1 : the number of intern attributes.
! Element 3 : the number of output attributes.
! Element 4 : not used.
!*/
......@@ -76,7 +76,7 @@ SObject pwrs:Class
EndBody
EndObject
!/**
! Not userd.
! Not used.
!*/
Object sw_page_y $Attribute 6
Body SysBody
......@@ -86,7 +86,32 @@ SObject pwrs:Class
EndBody
EndObject
!/**
! @Summary Method for drawing the plc symbol.
! Method for drawing the plc symbol.
!
! 0: The ordinary symbol for an object. Symbol with
! - header row containing class name,
! - footer row containing object names,
! - leadnames for all inputs and outputs.
! @image orm_filter_fo.gif
! 1: Symbol for objects where the inputs and outputs doesn't have to
! be specified.
! Symbol without leadnames for inputs and outputs.
! @image orm_inv_fo.gif
! 2: Equivalent with method 0, but equiped with an extra annotation
! field above the footer.
! 3: Method for Text objects.
! 4: Method for objects with special design.
! 5: Method for a grafcet order.
! 6: Method for document objects.
! 7: Method for singlerow objects with maximum one input and one output.
! Displays the class name and object name in the object.
! @image orm_scantime_fo.gif
! 8 and 9: This method uses method 7, 15 or 0 dependent on the number of
! used inputs and outputs.
! 14: Method for singleline arithm objects.
! 15: Method for double row objects with maximum two inputs and two outputs.
! @image orm_cstoiv_fo.gif
!*/
Object graphmethod $Attribute 7
Body SysBody
......@@ -133,7 +158,7 @@ SObject pwrs:Class
EndObject
!/**
! Attributes whose value will be displayed in an annotation
! will be serach for in RtBody.
! will be searched for in RtBody.
!*/
Object rtbody_annotation $Attribute 11
Body SysBody
......@@ -150,7 +175,13 @@ SObject pwrs:Class
EndBody
EndObject
!/**
! @Summary Compilation method. Method that generates plc code for the object.
! Compilation method. Method that generates plc code for the object.
!
! 2: Method for object without any plc code.
! 4: Method for an object with a standard function call.
! 5: Method for an object with a standard macro call.
! 58: Method for an object with template plc code in class definition.
!*/
Object compmethod $Attribute 13
Body SysBody
......@@ -186,7 +217,9 @@ SObject pwrs:Class
EndBody
EndObject
!/**
! @Summary Method to connect the object to another object.
! Method to connect the object to another object.
! 0: No connect function.
!*/
Object connectmethod $Attribute 17
Body SysBody
......@@ -195,7 +228,10 @@ SObject pwrs:Class
EndBody
EndObject
!/**
! @Summary Method to calculate the execute order in the plc program.
! Method to calculate the execute order in the plc program.
! 0: No executable code for this object.
! 2: Ordinary method for objects with executable code.
!*/
Object executeordermethod $Attribute 18
Body SysBody
......@@ -243,3 +279,5 @@ SObject pwrs:Class
EndObject
EndObject
EndSObject
......@@ -71,12 +71,12 @@ SObject pwrs:Class
! @Summary Bitmask for attribute properties.
! Bitmask for attribute properties.
!
! PWR_MASK_POINTER Attribute is a pointer.
! PWR_MASK_ARRAY Attribute is an array.
! PWR_MASK_STATE Value will not be loaded from develompent database.
! PWR_MASK_CONST Value is a constant.
! PWR_MASK_RTVIRTUAL Attribute doesn't exist in runtime environment
! PWR_MASK_DEVBODYREF Used for input and output attributes, where the
! PWR_MASK_POINTER Attribute is a pointer.
! PWR_MASK_ARRAY Attribute is an array.
! PWR_MASK_STATE Value will not be loaded from develompent database.
! PWR_MASK_CONST Value is a constant.
! PWR_MASK_RTVIRTUAL Attribute doesn't exist in runtime environment
! PWR_MASK_DEVBODYREF Used for input and output attributes, where the
! connection refers another object which is found
! in the first attribute of type Objid in DevBody.
! PWR_MASK_OBJIDSELF Contains the objects own objid. Used in timer attributes.
......@@ -87,6 +87,11 @@ SObject pwrs:Class
! PWR_MASK_NOREMOVE Can't be removed in plc editor.
! PWR_MASK_RTDBREF Contains an rtdb reference.
! PWR_MASK_PRIVATE Should not be interpreted by an object editor.
! PWR_MASK_ISCLASS Attribute is specified by a class.
! PWR_MASK_SUBCLASS ...
! PWR_MASK_BUFFER ...
! PWR_MASK_NOWBL Attribute will not be to printed to wb_load file.
! PWR_MASK_ALWAYSWBL Attribute is always printed to wb_load file.
!*/
Object Flags $Attribute 5
Body SysBody
......
......@@ -66,12 +66,12 @@ SObject pwrs:Class
! @Summary Bitmask for attribute properties.
! Bitmask for attribute properties.
!
! PWR_MASK_POINTER Attribute is a pointer.
! PWR_MASK_ARRAY Attribute is an array.
! PWR_MASK_STATE Value will not be loaded from develompent database.
! PWR_MASK_CONST Value is a constant.
! PWR_MASK_RTVIRTUAL Attribute doesn't exist in runtime environment
! PWR_MASK_DEVBODYREF Used for input and output attributes, where the
! PWR_MASK_POINTER Attribute is a pointer.
! PWR_MASK_ARRAY Attribute is an array.
! PWR_MASK_STATE Value will not be loaded from develompent database.
! PWR_MASK_CONST Value is a constant.
! PWR_MASK_RTVIRTUAL Attribute doesn't exist in runtime environment
! PWR_MASK_DEVBODYREF Used for input and output attributes, where the
! connection refers another object which is found
! in the first attribute of type Objid in DevBody.
! PWR_MASK_OBJIDSELF Contains the objects own objid. Used in timer attributes.
......@@ -82,6 +82,11 @@ SObject pwrs:Class
! PWR_MASK_NOREMOVE Can't be removed in plc editor.
! PWR_MASK_RTDBREF Contains an rtdb reference.
! PWR_MASK_PRIVATE Should not be interpreted by an object editor.
! PWR_MASK_ISCLASS Attribute is specified by a class.
! PWR_MASK_SUBCLASS ...
! PWR_MASK_BUFFER ...
! PWR_MASK_NOWBL Attribute will not be to printed to wb_load file.
! PWR_MASK_ALWAYSWBL Attribute is always printed to wb_load file.
!*/
Object Flags $Attribute 5
Body SysBody
......
......@@ -70,12 +70,12 @@ SObject pwrs:Class
! @Summary Bitmask for attribute properties.
! Bitmask for attribute properties.
!
! PWR_MASK_POINTER Attribute is a pointer.
! PWR_MASK_ARRAY Attribute is an array.
! PWR_MASK_STATE Value will not be loaded from develompent database.
! PWR_MASK_CONST Value is a constant.
! PWR_MASK_RTVIRTUAL Attribute doesn't exist in runtime environment
! PWR_MASK_DEVBODYREF Used for input and output attributes, where the
! PWR_MASK_POINTER Attribute is a pointer.
! PWR_MASK_ARRAY Attribute is an array.
! PWR_MASK_STATE Value will not be loaded from develompent database.
! PWR_MASK_CONST Value is a constant.
! PWR_MASK_RTVIRTUAL Attribute doesn't exist in runtime environment
! PWR_MASK_DEVBODYREF Used for input and output attributes, where the
! connection refers another object which is found
! in the first attribute of type Objid in DevBody.
! PWR_MASK_OBJIDSELF Contains the objects own objid. Used in timer attributes.
......@@ -86,6 +86,11 @@ SObject pwrs:Class
! PWR_MASK_NOREMOVE Can't be removed in plc editor.
! PWR_MASK_RTDBREF Contains an rtdb reference.
! PWR_MASK_PRIVATE Should not be interpreted by an object editor.
! PWR_MASK_ISCLASS Attribute is specified by a class.
! PWR_MASK_SUBCLASS ...
! PWR_MASK_BUFFER ...
! PWR_MASK_NOWBL Attribute will not be to printed to wb_load file.
! PWR_MASK_ALWAYSWBL Attribute is always printed to wb_load file.
!*/
Object Flags $Attribute 5
Body SysBody
......
......@@ -5,8 +5,17 @@
!
! <Description>.
!
!
SObject pwrs:Class
!/**
! @Version 1.0
! PlcNode specifies a buffer attribute used by the plc-editor.
!
! The buffer attribute stores plc-editor data for a plc object.
! The data is handled only by the plc editor.
!
! All plc objects should have a PlcNode buffer in DevBody.
!*/
!
Object $PlcNode $ClassDef pwr_eCix_PlcNode
Body SysBody
Attr Flags |= pwr_mClassDef_DevOnly
......
......@@ -6,7 +6,16 @@
SObject pwrs:Class
!/**
! @Group TypeDefinition
! Definition of a type.
! Definition of a base type.
! The base types are defined in the systemclass volume pwrs.
!
! Base types and derived types are used to define the type of an
! attribute in an object. The type is defined by the TypeRef attribute
! in the $Attribute object (also in $Input, $Inter, $Output).
!
! @b See also
! @classlink $TypeHier pwrs_typehier.html
! @classlink $TypeDef pwrs_typedef.html
!*/
Object $Type $ClassDef pwr_eCix_Type
Body SysBody
......
......@@ -6,7 +6,19 @@
SObject pwrs:Class
!/**
! @Group TypeDefinition
! Definition of a type.
! Definition of a derived type.
! A derived type is an array of a base type.
!
! A $TypeDef object reside in the type hierarchy in a class volume, and
! is placed as a child to the $TypeHier object.
!
! Base types and derived types are used to define the type of an
! attribute in an object. The type is defined by the TypeRef attribute
! in the $Attribute object (also in $Input, $Inter, $Output).
!
! @b See also
! @classlink $TypeHier pwrs_typehier.html
! @classlink $Type pwrs_type.html
!*/
Object $TypeDef $ClassDef pwr_eCix_TypeDef
Body SysBody
......@@ -17,6 +29,9 @@ SObject pwrs:Class
Body SysBody
Attr StructName = "TypeDef"
EndBody
!/**
! Compiled type.
!*/
Object Type $Attribute 1
Body SysBody
Attr TypeRef = "pwrs:Type-$Int32"
......@@ -24,6 +39,9 @@ SObject pwrs:Class
Attr Flags |= PWR_MASK_NOWBL
EndBody
EndObject
!/**
! Compiled size.
!*/
Object Size $Attribute 2
Body SysBody
Attr TypeRef = "pwrs:Type-$Int32"
......@@ -31,12 +49,18 @@ SObject pwrs:Class
Attr Flags |= PWR_MASK_NOWBL
EndBody
EndObject
!/**
! Base type.
!*/
Object TypeRef $Attribute 3
Body SysBody
Attr TypeRef = "pwrs:Type-$TypeId"
Attr Flags |= PWR_MASK_ALWAYSWBL
EndBody
EndObject
!/**
! Number of elements.
!*/
Object Elements $Attribute 4
Body SysBody
Attr TypeRef = "pwrs:Type-$Int32"
......
......@@ -6,7 +6,18 @@
SObject pwrs:Class
!/**
! @Group ClassDefinition
! Root of a type definition tree.
! Root object of a type definition hierarchy.
! The TypeHier object is a toplevel object in a class volume, and act as
! the anscestor to the type definition hierarchy.
! It should be named 'Type', and there kan only be one $TypeDef object in a
! ClassVolume.
!
! Below the $TypeHier object, all the types in the volume are defined with
! $Type or $TypeDef objects.
!
! @b See also
! @classlink $Type pwrs_type.html
! @classlink $TypeDef pwrs_typedef.html
!*/
Object $TypeHier $ClassDef pwr_eCix_TypeHier
Body SysBody
......
......@@ -6,6 +6,20 @@
! <Description>.
!
SObject pwrs:Type
!/**
! @Version 1.0
! @Code pwr.h
! @Group BasicTypes,Types
! Basic type attribute reference.
! Reference to an attribute in an object.
!
! The reference contains
! - objid of the referenced object
! - classid of body
! - offset of the attribute
! - size of the attribute
! - a flagword. If the bit Indirect is set, the attribute is a pointer.
!*/
Object $AttrRef pwr_eClass_Type pwr_eTix_AttrRef
Body SysBody
Attr Type = pwr_eType_AttrRef
......
......@@ -7,6 +7,14 @@
!
!
SObject pwrs:Type
!/**
! @Version 1.0
! @Code pwr.h
! @Group BasicTypes,Types
! Basic type boolean.
!
! This type is used for digital signals and attributes.
!*/
Object $Boolean pwr_eClass_Type pwr_eTix_Boolean
Body SysBody
Attr Type = pwr_eType_Boolean
......
......@@ -5,8 +5,13 @@
!
! <Description>.
!
!
SObject pwrs:Type
!/**
! @Version 1.0
! @Code pwr.h
! @Group BasicTypes,Types
! Basic type character.
!*/
Object $Char pwr_eClass_Type pwr_eTix_Char
Body SysBody
Attr Type = pwr_eType_Char
......
......@@ -5,8 +5,16 @@
!
! <Description>.
!
!
SObject pwrs:Type
!/**
! @Version 1.0
! @Code pwr.h
! @Group BasicTypes,Types
! Class identity. Basic type.
!
! Every class has a unic identity, derived from the classvolume
! identity and the class index.
!*/
Object $ClassId pwr_eClass_Type pwr_eTix_ClassId
Body SysBody
Attr Type = pwr_eType_ClassId
......
......@@ -5,8 +5,19 @@
!
! <Description>.
!
!
SObject pwrs:Type
!/**
! @Version 1.0
! @Code pwr.h
! @Group BasicTypes,Types
! Delta time. Basic type.
! The delta time is the elapsed time between two points of time. Compare
! with an absolute time (the Time type), which is a calender time.
! The differens between two absolute times will result in a delta time.
!
! @b See also
! @classlink Time pwrs_time.html
!*/
Object $DeltaTime pwr_eClass_Type pwr_eTix_DeltaTime
Body SysBody
Attr Type = pwr_eType_DeltaTime
......
......@@ -5,8 +5,14 @@
!
! <Description>.
!
!
SObject pwrs:Type
!/**
! @Version 1.0
! @Code pwr.h
! @Group BasicTypes,Types
! Enumeration value. Basic type.
!
!*/
Object $Enum pwr_eClass_Type pwr_eTix_Enum
Body SysBody
Attr Type = pwr_eType_Enum
......
......@@ -5,8 +5,15 @@
!
! <Description>.
!
!
SObject pwrs:Type
!/**
! @Version 1.0
! @Code pwr.h
! @Group BasicTypes,Types
! Basic type 32-bit float.
!
! This type is used for analog signals and attributes.
!*/
Object $Float32 pwr_eClass_Type pwr_eTix_Float32
Body SysBody
Attr Type = pwr_eType_Float32
......@@ -14,3 +21,4 @@ SObject pwrs:Type
EndBody
EndObject
EndSObject
......@@ -5,8 +5,16 @@
!
! <Description>.
!
!
SObject pwrs:Type
!/**
! @Version 1.0
! @Code pwr.h
! @Group BasicTypes,Types
! 64-bit float. Basic type.
!
! @b See also
! @classlink Time pwrs_time.html
!*/
Object $Float64 pwr_eClass_Type pwr_eTix_Float64
Body SysBody
Attr Type = pwr_eType_Float64
......
......@@ -5,8 +5,13 @@
!
! <Description>.
!
!
SObject pwrs:Type
!/**
! @Version 1.0
! @Code pwr.h
! @Group BasicTypes,Types
! 16-bit integer. Basic type.
!*/
Object $Int16 pwr_eClass_Type pwr_eTix_Int16
Body SysBody
Attr Type = pwr_eType_Int16
......
......@@ -7,6 +7,14 @@
!
!
SObject pwrs:Type
!/**
! @Version 1.0
! @Code pwr.h
! @Group BasicTypes,Types
! 32-bit integer. Basic type.
!
! This type is used for integer signals.
!*/
Object $Int32 pwr_eClass_Type pwr_eTix_Int32
Body SysBody
Attr Type = pwr_eType_Int32
......
......@@ -7,6 +7,12 @@
!
!
SObject pwrs:Type
!/**
! @Version 1.0
! @Code pwr.h
! @Group BasicTypes,Types
! 8-bit integer. Basic type.
!*/
Object $Int8 pwr_eClass_Type pwr_eTix_Int8
Body SysBody
Attr Type = pwr_eType_Int8
......
......@@ -7,6 +7,12 @@
!
!
SObject pwrs:Type
!/**
! @Version 1.0
! @Code pwr.h
! @Group BasicTypes,Types
! Bitmask value. Basic type.
!*/
Object $Mask pwr_eClass_Type pwr_eTix_Mask
Body SysBody
Attr Type = pwr_eType_Mask
......
......@@ -7,6 +7,18 @@
!
!
SObject pwrs:Type
!/**
! @Version 1.0
! @Code pwr.h
! @Group BasicTypes,Types
! Object index. Basic type.
!
! Every object has an unic index within a volume.
! Together with the volume identity it constitutes the object identity.
!
! @b See also
! @classlink Objid pwrs_objid.html
!*/
Object $ObjectIx pwr_eClass_Type pwr_eTix_ObjectIx
Body SysBody
Attr Type = pwr_eType_ObjectIx
......
......@@ -5,8 +5,21 @@
!
! <Description>.
!
!
SObject pwrs:Type
!/**
! @Version 1.0
! @Code pwr.h
! @Group BasicTypes,Types
! Object identity. Basic type.
!
! Every object has an unic identity.
! The object identity consists of the volume identity and
! the object index.
!
! @b See also
! @classlink VolumeId pwrs_volumeid.html
! @classlink ObjectIx pwrs_objectix.html
!*/
Object $Objid pwr_eClass_Type pwr_eTix_Objid
Body SysBody
Attr Type = pwr_eType_Objid
......
......@@ -3,10 +3,17 @@
! PROVIEW/R
! Copyright (C) 1996 by Comator Process AB.
!
! <Description>.
SObject pwrs:Type
!/**
! @Version 1.0
! PgmName contains the c-binding name for an attribute, i.e. the name
! used for the attribute in the c struct for an object.
!
! If the PgmName isn't specified, the attribute name is used instead.
!
SObject pwrs:Type
! If a characters is used in the attribute name,
! that is not accepted by the c language, PgmName has to be specified.
!*/
Object $PgmName pwr_eClass_TypeDef 11
Body SysBody
Attr Type = pwr_eType_String
......
......@@ -5,8 +5,14 @@
!
! <Description>.
!
!
SObject pwrs:Type
!/**
! @Version 1.0
! @Code pwr.h
! @Group BasicTypes,Types
! Reference identity. Basic type.
! A reference identity is an identity for a subscription or a direct link.
!*/
Object $RefId pwr_eClass_Type pwr_eTix_RefId
Body SysBody
Attr Type = pwr_eType_RefId
......
......@@ -3,10 +3,26 @@
! PROVIEW/R
! Copyright (C) 1996 by Comator Process AB.
!
! <Description>.
SObject pwrs:Type
!/**
! @Version 1.0
! @Code pwr.h
! @Group BasicTypes,Types
! 8-bit character. Basic type.
! The String type is a base type for the derived string types String8,
! String16, String32, String80 etc.
!
! The String type is single line, unlike the Text type which is multiline.
!
SObject pwrs:Type
! @b See also
! @classlink String8 pwrs_string8.html
! @classlink String16 pwrs_string8.html
! @classlink String32 pwrs_string8.html
! @classlink String40 pwrs_string8.html
! @classlink String80 pwrs_string8.html
! @classlink String132 pwrs_string8.html
! @classlink String256 pwrs_string8.html
!*/
Object $String pwr_eClass_Type pwr_eTix_String
Body SysBody
Attr Type = pwr_eType_String
......
......@@ -7,6 +7,18 @@
!
!
SObject pwrs:Type
!/**
! @Version 1.0
! @Code pwr.h
! @Group BasicTypes,Types
! 8-bit character. Basic type.
! The Text type is a base type for the derived text type Text1024
!
! The Text type is multiline, unlike the String type which is single line.
!
! @b See also
! @classlink Text1024 pwrs_text1024.html
!*/
Object $Text pwr_eClass_Type pwr_eTix_Text
Body SysBody
Attr Type = pwr_eType_Text
......
......@@ -5,8 +5,18 @@
!
! <Description>.
!
!
SObject pwrs:Type
!/**
! @Version 1.0
! @Code pwr.h
! @Group BasicTypes,Types
! Absolute time. Basic type.
! The absolute time is a calender time. Compare with the delta time wich is the
! the elapsed time between two points of time.
!
! @b See also
! @classlink DeltaTime pwrs_deltatime.html
!*/
Object $Time pwr_eClass_Type pwr_eTix_Time
Body SysBody
Attr Type = pwr_eType_Time
......
......@@ -7,6 +7,15 @@
!
!
SObject pwrs:Type
!/**
! @Version 1.0
! @Code pwr.h
! @Group BasicTypes,Types
! Type identity. Basic type.
!
! Every type has a unic identity, derived from the classvolume
! identity and the type index.
!*/
Object $TypeId pwr_eClass_Type pwr_eTix_TypeId
Body SysBody
Attr Type = pwr_eType_TypeId
......
......@@ -7,6 +7,12 @@
!
!
SObject pwrs:Type
!/**
! @Version 1.0
! @Code pwr.h
! @Group BasicTypes,Types
! 16-bit unsigned integer. Basic type.
!*/
Object $UInt16 pwr_eClass_Type pwr_eTix_UInt16
Body SysBody
Attr Type = pwr_eType_UInt16
......
......@@ -7,6 +7,12 @@
!
!
SObject pwrs:Type
!/**
! @Version 1.0
! @Code pwr.h
! @Group BasicTypes,Types
! 32-bit unsigned integer. Basic type.
!*/
Object $UInt32 pwr_eClass_Type pwr_eTix_UInt32
Body SysBody
Attr Type = pwr_eType_UInt32
......
......@@ -7,6 +7,12 @@
!
!
SObject pwrs:Type
!/**
! @Version 1.0
! @Code pwr.h
! @Group BasicTypes,Types
! 8-bit unsigned integer. Basic type.
!*/
Object $UInt8 pwr_eClass_Type pwr_eTix_UInt8
Body SysBody
Attr Type = pwr_eType_UInt8
......
......@@ -5,8 +5,26 @@
!
! <Description>.
!
!
SObject pwrs:Type
!/**
! @Version 1.0
! @Code pwr.h
! @Group BasicTypes,Types
! Volume identity. Basic type.
!
! Every volume has a unic identity, a 32-bit word usually specified in the for
! v1.v2.v3.v4 where v1, v2, v3 and v4 are numbers in the interval 0-255.
! Dependent of the class of the volume, the numbers is choosen in separate
! intervals:
!
! RootVolume,SubVolume: 0.1-254.1-254.1-254
! System ClassVolumes: 0. 0. 0-1.1-254
! User ClassVolumes: 0. 0.2-254.1-254
! DirectoryVolume: 254. 254. 254. 253
! WorkbenchVolume: 254. 254. 254. 254
! Local WorkbenchVolume: 254. 254. 254. 252
! VolatileVolume: 254. 254. 254.0-100
!*/
Object $VolumeId pwr_eClass_Type pwr_eTix_VolumeId
Body SysBody
Attr Type = pwr_eType_VolumeId
......
......@@ -7,7 +7,15 @@
!
!
SObject pwrs:Type
!/**
! @Version 1.0
! @Code pwr.h
! @Group DerivedTypes,Types
! 16 characters string. Derived type from String.
!
! @b See also
! @classlink String pwrs_string.html
!*/
Object $GraphName $TypeDef 1
Body SysBody
Attr Type = pwr_eType_String
......
......@@ -5,8 +5,19 @@
!
! <Description>.
!
!
SObject pwrs:Type
!/**
! @Version 1.0
! @Code pwr.h
! @Group DerivedTypes,Types
! 132 characters null-terminated string. Derived type from String.
!
! The maximum length of the string without the null termination is
! 131 characters.
!
! @b See also
! @classlink String pwrs_string.html
!*/
Object $String132 $TypeDef 2
Body SysBody
Attr Type = pwr_eType_String
......
......@@ -5,8 +5,19 @@
!
! <Description>.
!
!
SObject pwrs:Type
!/**
! @Version 1.0
! @Code pwr.h
! @Group DerivedTypes,Types
! 16 characters null-terminated string. Derived type from String.
!
! The maximum length of the string without the null termination is
! 15 characters.
!
! @b See also
! @classlink String pwrs_string.html
!*/
Object $String16 $TypeDef 3
Body SysBody
Attr Type = pwr_eType_String
......
......@@ -5,8 +5,19 @@
!
! <Description>.
!
!
SObject pwrs:Type
!/**
! @Version 1.0
! @Code pwr.h
! @Group DerivedTypes,Types
! 256 characters null-terminated string. Derived type from String.
!
! The maximum length of the string without the null termination is
! 255 characters.
!
! @b See also
! @classlink String pwrs_string.html
!*/
Object $String256 $TypeDef 4
Body SysBody
Attr Type = pwr_eType_String
......
......@@ -7,6 +7,18 @@
!
!
SObject pwrs:Type
!/**
! @Version 1.0
! @Code pwr.h
! @Group DerivedTypes,Types
! 32 characters null-terminated string. Derived type from String.
!
! The maximum length of the string without the null termination is
! 31 characters.
!
! @b See also
! @classlink String pwrs_string.html
!*/
Object $String32 $TypeDef 5
Body SysBody
Attr Type = pwr_eType_String
......
......@@ -7,6 +7,18 @@
!
!
SObject pwrs:Type
!/**
! @Version 1.0
! @Code pwr.h
! @Group DerivedTypes,Types
! 40 characters null-terminated string. Derived type from String.
!
! The maximum length of the string without the null termination is
! 39 characters.
!
! @b See also
! @classlink String pwrs_string.html
!*/
Object $String40 $TypeDef 6
Body SysBody
Attr Type = pwr_eType_String
......
......@@ -7,6 +7,18 @@
!
!
SObject pwrs:Type
!/**
! @Version 1.0
! @Code pwr.h
! @Group DerivedTypes,Types
! 8 characters null-terminated string. Derived type from String.
!
! The maximum length of the string without the null termination is
! 7 characters.
!
! @b See also
! @classlink String pwrs_string.html
!*/
Object $String8 $TypeDef 7
Body SysBody
Attr Type = pwr_eType_String
......
......@@ -5,8 +5,19 @@
!
! <Description>.
!
!
SObject pwrs:Type
!/**
! @Version 1.0
! @Code pwr.h
! @Group DerivedTypes,Types
! 80 characters null-terminated string. Derived type from String.
!
! The maximum length of the string without the null termination is
! 79 characters.
!
! @b See also
! @classlink String pwrs_string.html
!*/
Object $String80 $TypeDef 8
Body SysBody
Attr Type = pwr_eType_String
......
......@@ -7,6 +7,18 @@
!
!
SObject pwrs:Type
!/**
! @Version 1.0
! @Code pwr.h
! @Group DerivedTypes,Types
! 1024 characters null-terminated text. Derived type from Text.
!
! The maximum length of the text without the null termination is
! 1023 characters.
!
! @b See also
! @classlink Text pwrs_text.html
!*/
Object $Text1024 $TypeDef 9
Body SysBody
Attr Type = pwr_eType_Text
......
......@@ -5,8 +5,22 @@
!
! <Description>.
!
!
SObject pwrs:Type
!/**
! @Version 1.0
! @Code pwr.h
! @Group DerivedTypes,Types
! URL. 160 characters null-terminated string. Derived type from String.
!
! An URL indentifies the location of a resource on the Internet, e.g.
! /http://proview.se
!
! The maximum length of the URL without the null termination is
! 159 characters.
!
! @b See also
! @classlink String pwrs_string.html
!*/
Object $URL $TypeDef 13
Body SysBody
Attr Type = pwr_eType_String
......
......@@ -7,6 +7,15 @@
!
!
SObject pwrs:Type
!/**
! @Version 1.0
! @Code pwr.h
! @Group DerivedTypes,Types
! 32 characters string. Derived type from String.
!
! @b See also
! @classlink String pwrs_string.html
!*/
Object $XRef $TypeDef 10
Body SysBody
Attr Type = pwr_eType_String
......
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