commsconfig/commsdatabaseshim/Documentation/COMMDB.MDL
branchRCL_3
changeset 81 c34f57d8afa7
parent 80 405674398db4
parent 76 576874e13a2c
child 85 7c25be0307fe
equal deleted inserted replaced
80:405674398db4 81:c34f57d8afa7
     1 
       
     2 (object Petal
       
     3     version    	37)
       
     4 
       
     5 (object Design "<Top Level>"
       
     6     is_unit    	TRUE
       
     7     is_loaded  	TRUE
       
     8     defaults   	(object defaults
       
     9 	rightMargin 	0.250000
       
    10 	leftMargin 	0.250000
       
    11 	topMargin  	0.250000
       
    12 	bottomMargin 	0.500000
       
    13 	pageOverlap 	0.250000
       
    14 	clipIconLabels 	TRUE
       
    15 	autoResize 	TRUE
       
    16 	snapToGrid 	TRUE
       
    17 	gridX      	31
       
    18 	gridY      	31
       
    19 	defaultFont 	(object Font
       
    20 	    size       	10
       
    21 	    face       	"Arial"
       
    22 	    bold       	FALSE
       
    23 	    italics    	FALSE
       
    24 	    underline  	FALSE
       
    25 	    strike     	FALSE
       
    26 	    color      	0
       
    27 	    default_color 	TRUE)
       
    28 	showMessageNum 	3
       
    29 	showClassOfObject 	TRUE
       
    30 	notation   	"Booch")
       
    31     root_category 	(object Class_Category "<Top Level>"
       
    32 	exportControl 	"Public"
       
    33 	global     	TRUE
       
    34 	subsystem  	"<Top Level>"
       
    35 	logical_models 	(list unit_reference_list
       
    36 	    (object Class "CCommsDatabase"
       
    37 		documentation 	"Controls access to the DBMS server and the comms database. Also allows access to the DBMS database change notifier.  Each client of the database should have one of these objects."
       
    38 		fields     	(list has_relationship_list
       
    39 		    (object Has_Relationship
       
    40 			documentation 	"DBMS server access"
       
    41 			label      	"iDbs"
       
    42 			supplier   	"RDbs"
       
    43 			exportControl 	"Private"
       
    44 			Containment 	"By Value"
       
    45 			supplier_cardinality 	(value cardinality "1")
       
    46 			client_cardinality 	(value cardinality "1"))
       
    47 		    (object Has_Relationship
       
    48 			documentation 	"The database"
       
    49 			label      	"iDatabase"
       
    50 			supplier   	"RDbNamedDatabase"
       
    51 			exportControl 	"Private"
       
    52 			Containment 	"By Value"
       
    53 			supplier_cardinality 	(value cardinality "1")
       
    54 			client_cardinality 	(value cardinality "1"))
       
    55 		    (object Has_Relationship
       
    56 			documentation 	"Notifys of database changes"
       
    57 			label      	"iNotifier"
       
    58 			supplier   	"RDbNotifier"
       
    59 			exportControl 	"Private"
       
    60 			Containment 	"By Value"
       
    61 			supplier_cardinality 	(value cardinality "1")
       
    62 			client_cardinality 	(value cardinality "1")))
       
    63 		class_attributes 	(list class_attribute_list
       
    64 		    (object ClassAttribute "iOpenRefCout"
       
    65 			documentation 	"Reference count the database opens"
       
    66 			type       	"TInt"
       
    67 			initv      	"0"
       
    68 			Containment 	"By Value")
       
    69 		    (object ClassAttribute "iLockRefCount"
       
    70 			documentation 	"Reference counts the transactions on the database"
       
    71 			type       	"TInt"
       
    72 			initv      	"0"
       
    73 			Containment 	"By Value")
       
    74 		    (object ClassAttribute "iNotifierOpenError"
       
    75 			documentation 	"Error on opening the notifier.  Only reported to the client if the notifier is used."
       
    76 			type       	"TInt"
       
    77 			initv      	"KErrNotReady"
       
    78 			Containment 	"By Value")
       
    79 		    (object ClassAttribute "iShowHiddenRecords"
       
    80 			documentation 	"Determines whether the client should be shown hidden records."
       
    81 			type       	"TBool"
       
    82 			initv      	"EFalse"
       
    83 			Containment 	"By Value")))
       
    84 	    (object Class "CCommsDbView"
       
    85 		fields     	(list has_relationship_list
       
    86 		    (object Has_Relationship
       
    87 			supplier   	"RDbView")
       
    88 		    (object Has_Relationship
       
    89 			supplier   	"TTableStates"))
       
    90 		used_nodes 	(list uses_relationship_list
       
    91 		    (object Uses_Relationship
       
    92 			supplier   	"CCommsDatabase")))
       
    93 	    (object Class "RCommsDatabaseServer"
       
    94 		superclasses 	(list inheritance_relationship_list
       
    95 		    (object Inheritance_Relationship
       
    96 			supplier   	"RSessionBase")))
       
    97 	    (object Class "RSessionBase")
       
    98 	    (object Class "CCommsDbServer"
       
    99 		fields     	(list has_relationship_list
       
   100 		    (object Has_Relationship
       
   101 			supplier   	"CCommsDatabase")
       
   102 		    (object Has_Relationship
       
   103 			supplier   	"CCommsDbSessCounter"))
       
   104 		superclasses 	(list inheritance_relationship_list
       
   105 		    (object Inheritance_Relationship
       
   106 			supplier   	"CServer")))
       
   107 	    (object Class "CServer")
       
   108 	    (object Class "CCommsDbSessCounter"
       
   109 		used_nodes 	(list uses_relationship_list
       
   110 		    (object Uses_Relationship
       
   111 			supplier   	"CCommsDatabase")))
       
   112 	    (object Class "CCommsDbSession"
       
   113 		fields     	(list has_relationship_list
       
   114 		    (object Has_Relationship
       
   115 			supplier   	"CCommsDbView"))
       
   116 		superclasses 	(list inheritance_relationship_list
       
   117 		    (object Inheritance_Relationship
       
   118 			supplier   	"CSession"))
       
   119 		used_nodes 	(list uses_relationship_list
       
   120 		    (object Uses_Relationship
       
   121 			supplier   	"CCommsDbServer"
       
   122 			supplier_cardinality 	(value cardinality "1")
       
   123 			client_cardinality 	(value cardinality "n"))
       
   124 		    (object Uses_Relationship
       
   125 			supplier   	"RMessage")))
       
   126 	    (object Class "RDbView")
       
   127 	    (object Class "CPermanentFileStore")
       
   128 	    (object Class "CSession")
       
   129 	    (object Class "RDbStoreDatabase")
       
   130 	    (object Class "RMessage")
       
   131 	    (object Class "TTableStates")
       
   132 	    (object Class "RDbs")
       
   133 	    (object Class "RDbNamedDatabase")
       
   134 	    (object Class "RDbNotifier")
       
   135 	    (object Class "CCommsDbTableView"
       
   136 		fields     	(list has_relationship_list
       
   137 		    (object Has_Relationship
       
   138 			documentation 	"View on the table"
       
   139 			label      	"iTableView"
       
   140 			supplier   	"RDbView"
       
   141 			exportControl 	"Private"
       
   142 			Containment 	"By Value"
       
   143 			supplier_cardinality 	(value cardinality "1")
       
   144 			client_cardinality 	(value cardinality "1"))
       
   145 		    (object Has_Relationship
       
   146 			documentation 	"The set of columns for this table"
       
   147 			label      	"iColSet"
       
   148 			supplier   	"CDbColSet"
       
   149 			exportControl 	"Private"
       
   150 			Containment 	"By Reference"
       
   151 			supplier_cardinality 	(value cardinality "0..1")
       
   152 			client_cardinality 	(value cardinality "1"))
       
   153 		    (object Has_Relationship
       
   154 			label      	"iTemplate"
       
   155 			supplier   	"CCommsDbTemplateRecord"
       
   156 			exportControl 	"Private"
       
   157 			supplier_cardinality 	(value cardinality "0..1")
       
   158 			client_cardinality 	(value cardinality "1")))
       
   159 		used_nodes 	(list uses_relationship_list
       
   160 		    (object Uses_Relationship
       
   161 			supplier   	"CCommsDatabase"
       
   162 			supplier_cardinality 	(value cardinality "1")
       
   163 			client_cardinality 	(value cardinality "0..n")
       
   164 			friend     	TRUE))
       
   165 		class_attributes 	(list class_attribute_list
       
   166 		    (object ClassAttribute "iState"
       
   167 			documentation 	"State of the table"
       
   168 			type       	"TTableState"
       
   169 			initv      	"EOpenIdle"
       
   170 			Containment 	"By Value")
       
   171 		    (object ClassAttribute "iTableName"
       
   172 			documentation 	"The name of the table"
       
   173 			type       	"TBuf"
       
   174 			Containment 	"By Value")))
       
   175 	    (object Class "CDbColSet")
       
   176 	    (object Class "CCommsDbTemplateRecord"
       
   177 		fields     	(list has_relationship_list
       
   178 		    (object Has_Relationship
       
   179 			label      	"iView"
       
   180 			supplier   	"CCommsDbTableView"
       
   181 			exportControl 	"Private"
       
   182 			supplier_cardinality 	(value cardinality "1")
       
   183 			client_cardinality 	(value cardinality "1")))
       
   184 		class_attributes 	(list class_attribute_list
       
   185 		    (object ClassAttribute "iRecordExists"
       
   186 			type       	"TBool"
       
   187 			Containment 	"By Value")))
       
   188 	    (object Class "CDbOverrideSettings"
       
   189 		fields     	(list has_relationship_list
       
   190 		    (object Has_Relationship
       
   191 			label      	"iDb"
       
   192 			supplier   	"CCommsDatabase"
       
   193 			exportControl 	"Private"
       
   194 			supplier_cardinality 	(value cardinality "1")
       
   195 			client_cardinality 	(value cardinality "1")))
       
   196 		class_attributes 	(list class_attribute_list
       
   197 		    (object ClassAttribute "iPartialFull"
       
   198 			type       	"TParamList"
       
   199 			Containment 	"By Value")
       
   200 		    (object ClassAttribute "iIntOverrides"
       
   201 			type       	"CArrayFixFlat<TCommDbIntOverride>")
       
   202 		    (object ClassAttribute "iBoolOverrides"
       
   203 			type       	"CArrayFixFlat<TCommDbBoolOverride>")
       
   204 		    (object ClassAttribute "iDes8Overrides"
       
   205 			type       	"CArrayFixFlat<TCommDbDes8Override>")
       
   206 		    (object ClassAttribute "iDes16Overrides"
       
   207 			type       	"CArrayFixFlat<TCommDbDes16Override>")
       
   208 		    (object ClassAttribute "iLongDesOverrides"
       
   209 			type       	"CArrayFixFlat<CCommDbLongDesOverride*>")))
       
   210 	    (object Class "CStoreableOverrideSettings"
       
   211 		superclasses 	(list inheritance_relationship_list
       
   212 		    (object Inheritance_Relationship
       
   213 			supplier   	"CDbOverrideSettings"))
       
   214 		class_attributes 	(list class_attribute_list
       
   215 		    (object ClassAttribute "iStore"
       
   216 			type       	"CBufStore")))
       
   217 	    (object Association "$UNNAMED$0"
       
   218 		quid       	"34734706029E"
       
   219 		roles      	(list role_list
       
   220 		    (object Role "$UNNAMED$1"
       
   221 			supplier   	"CCommsDbSession")
       
   222 		    (object Role "$UNNAMED$2"
       
   223 			supplier   	"CCommsDbServer")))
       
   224 	    (object Association "$UNNAMED$3"
       
   225 		quid       	"3479EE67021C"
       
   226 		roles      	(list role_list
       
   227 		    (object Role "$UNNAMED$4"
       
   228 			supplier   	"CCommsDbSession")
       
   229 		    (object Role "$UNNAMED$5"
       
   230 			supplier   	"RCommsDatabaseServer")))
       
   231 	    (object Class_Category "Server creates and removes server sessions"
       
   232 		exportControl 	"Public"
       
   233 		logical_models 	(list unit_reference_list)
       
   234 		logical_presentations 	(list unit_reference_list))
       
   235 	    (object Class_Category "OpenTableLC() opens a table in the database"
       
   236 		exportControl 	"Public"
       
   237 		logical_models 	(list unit_reference_list)
       
   238 		logical_presentations 	(list unit_reference_list)))
       
   239 	logical_presentations 	(list unit_reference_list
       
   240 	    (object ClassDiagram "CommDb"
       
   241 		title      	"CommDb"
       
   242 		zoom       	100
       
   243 		max_height 	28350
       
   244 		max_width  	21600
       
   245 		origin_x   	0
       
   246 		origin_y   	664
       
   247 		items      	(list diagram_item_list
       
   248 		    (object ClassView "Class" "CCommsDatabase" @1
       
   249 			IncludeAttribute 	TRUE
       
   250 			location   	(713, 682)
       
   251 			label      	(object ItemLabel
       
   252 			    Parent_View 	@1
       
   253 			    location   	(408, 495)
       
   254 			    nlines     	2
       
   255 			    max_width  	732
       
   256 			    justify    	0
       
   257 			    label      	"CCommsDatabase")
       
   258 			compartment 	(object Compartment
       
   259 			    Parent_View 	@1
       
   260 			    location   	(406, 561)
       
   261 			    anchor     	2
       
   262 			    nlines     	7
       
   263 			    max_width  	734
       
   264 			    justify    	0)
       
   265 			width      	1062
       
   266 			height     	546
       
   267 			autoResize 	TRUE)
       
   268 		    (object ClassView "Class" "RDbs" @2
       
   269 			location   	(310, 1333)
       
   270 			label      	(object ItemLabel
       
   271 			    Parent_View 	@2
       
   272 			    location   	(206, 1249)
       
   273 			    nlines     	2
       
   274 			    max_width  	240
       
   275 			    justify    	0
       
   276 			    label      	"RDbs")
       
   277 			autoResize 	TRUE)
       
   278 		    (object ClassView "Class" "RDbNamedDatabase" @3
       
   279 			location   	(744, 1395)
       
   280 			label      	(object ItemLabel
       
   281 			    Parent_View 	@3
       
   282 			    location   	(640, 1311)
       
   283 			    nlines     	2
       
   284 			    max_width  	240
       
   285 			    justify    	0
       
   286 			    label      	"RDbNamedDatabase")
       
   287 			autoResize 	TRUE)
       
   288 		    (object ClassView "Class" "RDbNotifier" @4
       
   289 			location   	(1519, 1178)
       
   290 			label      	(object ItemLabel
       
   291 			    Parent_View 	@4
       
   292 			    location   	(1415, 1094)
       
   293 			    nlines     	2
       
   294 			    max_width  	240
       
   295 			    justify    	0
       
   296 			    label      	"RDbNotifier")
       
   297 			autoResize 	TRUE)
       
   298 		    (object ClassView "Class" "CCommsDbTableView" @5
       
   299 			IncludeAttribute 	TRUE
       
   300 			location   	(2325, 682)
       
   301 			label      	(object ItemLabel
       
   302 			    Parent_View 	@5
       
   303 			    location   	(2022, 537)
       
   304 			    nlines     	2
       
   305 			    max_width  	727
       
   306 			    justify    	0
       
   307 			    label      	"CCommsDbTableView")
       
   308 			compartment 	(object Compartment
       
   309 			    Parent_View 	@5
       
   310 			    location   	(2022, 603)
       
   311 			    anchor     	2
       
   312 			    nlines     	5
       
   313 			    max_width  	728
       
   314 			    justify    	0)
       
   315 			width      	1054
       
   316 			height     	428
       
   317 			autoResize 	TRUE)
       
   318 		    (object ClassView "Class" "RDbView" @6
       
   319 			location   	(2387, 1209)
       
   320 			label      	(object ItemLabel
       
   321 			    Parent_View 	@6
       
   322 			    location   	(2283, 1125)
       
   323 			    nlines     	2
       
   324 			    max_width  	240
       
   325 			    justify    	0
       
   326 			    label      	"RDbView")
       
   327 			autoResize 	TRUE)
       
   328 		    (object HasView "iTableView" @7
       
   329 			label      	(object ItemLabel
       
   330 			    Parent_View 	@7
       
   331 			    location   	(2367, 985)
       
   332 			    anchor_loc 	1
       
   333 			    nlines     	1
       
   334 			    max_width  	450
       
   335 			    justify    	0
       
   336 			    label      	"iTableView")
       
   337 			client     	@5
       
   338 			supplier   	@6
       
   339 			line_style 	0)
       
   340 		    (object HasView "iDbs" @8
       
   341 			label      	(object ItemLabel
       
   342 			    Parent_View 	@8
       
   343 			    location   	(439, 1075)
       
   344 			    anchor_loc 	1
       
   345 			    nlines     	1
       
   346 			    max_width  	450
       
   347 			    justify    	0
       
   348 			    label      	"iDbs")
       
   349 			client     	@1
       
   350 			supplier   	@2
       
   351 			line_style 	0)
       
   352 		    (object HasView "iDatabase" @9
       
   353 			label      	(object ItemLabel
       
   354 			    Parent_View 	@9
       
   355 			    location   	(732, 1106)
       
   356 			    anchor_loc 	1
       
   357 			    nlines     	1
       
   358 			    max_width  	450
       
   359 			    justify    	0
       
   360 			    label      	"iDatabase")
       
   361 			client     	@1
       
   362 			supplier   	@3
       
   363 			line_style 	0)
       
   364 		    (object HasView "iNotifier" @10
       
   365 			label      	(object ItemLabel
       
   366 			    Parent_View 	@10
       
   367 			    location   	(1250, 978)
       
   368 			    anchor_loc 	1
       
   369 			    nlines     	1
       
   370 			    max_width  	450
       
   371 			    justify    	0
       
   372 			    label      	"iNotifier")
       
   373 			client     	@1
       
   374 			supplier   	@4
       
   375 			line_style 	0)
       
   376 		    (object ClassView "Class" "CDbColSet" @11
       
   377 			location   	(2914, 1116)
       
   378 			label      	(object ItemLabel
       
   379 			    Parent_View 	@11
       
   380 			    location   	(2810, 1032)
       
   381 			    nlines     	2
       
   382 			    max_width  	240
       
   383 			    justify    	0
       
   384 			    label      	"CDbColSet")
       
   385 			autoResize 	TRUE)
       
   386 		    (object HasView "iColSet" @12
       
   387 			label      	(object ItemLabel
       
   388 			    Parent_View 	@12
       
   389 			    location   	(2731, 925)
       
   390 			    anchor_loc 	1
       
   391 			    nlines     	1
       
   392 			    max_width  	450
       
   393 			    justify    	0
       
   394 			    label      	"iColSet")
       
   395 			client     	@5
       
   396 			supplier   	@11
       
   397 			line_style 	0)
       
   398 		    (object UsesView "" @13
       
   399 			client     	@5
       
   400 			supplier   	@1
       
   401 			line_style 	0)
       
   402 		    (object NoteView @14
       
   403 			location   	(1705, 186)
       
   404 			label      	(object ItemLabel
       
   405 			    Parent_View 	@14
       
   406 			    location   	(1138, 127)
       
   407 			    nlines     	2
       
   408 			    max_width  	1159
       
   409 			    label      	"CCommsDbTableView object created from a CCommsDatabase by calling OpenTableLC() or OpenViewLC(), etc")
       
   410 			width      	1219
       
   411 			height     	131)
       
   412 		    (object AttachView "" @15
       
   413 			client     	@13
       
   414 			supplier   	@14
       
   415 			line_style 	0)
       
   416 		    (object ClassView "Class" "CCommsDbTemplateRecord" @16
       
   417 			IncludeAttribute 	TRUE
       
   418 			location   	(1922, 1426)
       
   419 			label      	(object ItemLabel
       
   420 			    Parent_View 	@16
       
   421 			    location   	(1696, 1342)
       
   422 			    nlines     	2
       
   423 			    max_width  	539
       
   424 			    justify    	0
       
   425 			    label      	"CCommsDbTemplateRecord")
       
   426 			compartment 	(object Compartment
       
   427 			    Parent_View 	@16
       
   428 			    location   	(1696, 1408)
       
   429 			    anchor     	2
       
   430 			    nlines     	2
       
   431 			    max_width  	537
       
   432 			    justify    	0)
       
   433 			width      	782
       
   434 			autoResize 	TRUE)
       
   435 		    (object HasView "iTemplate" @17
       
   436 			label      	(object ItemLabel
       
   437 			    Parent_View 	@17
       
   438 			    location   	(2098, 1096)
       
   439 			    anchor_loc 	1
       
   440 			    nlines     	1
       
   441 			    max_width  	450
       
   442 			    justify    	0
       
   443 			    label      	"iTemplate")
       
   444 			client     	@5
       
   445 			supplier   	@16
       
   446 			line_style 	0)
       
   447 		    (object HasView "iView" @18
       
   448 			label      	(object ItemLabel
       
   449 			    Parent_View 	@18
       
   450 			    location   	(2098, 1096)
       
   451 			    anchor_loc 	1
       
   452 			    nlines     	1
       
   453 			    max_width  	450
       
   454 			    justify    	0
       
   455 			    label      	"iView")
       
   456 			client     	@16
       
   457 			supplier   	@5
       
   458 			line_style 	0)
       
   459 		    (object ClassView "Class" "CDbOverrideSettings" @19
       
   460 			IncludeAttribute 	TRUE
       
   461 			location   	(1426, 1860)
       
   462 			label      	(object ItemLabel
       
   463 			    Parent_View 	@19
       
   464 			    location   	(931, 1673)
       
   465 			    nlines     	2
       
   466 			    max_width  	1196
       
   467 			    justify    	0
       
   468 			    label      	"CDbOverrideSettings")
       
   469 			compartment 	(object Compartment
       
   470 			    Parent_View 	@19
       
   471 			    location   	(931, 1739)
       
   472 			    anchor     	2
       
   473 			    nlines     	7
       
   474 			    max_width  	1194
       
   475 			    justify    	0)
       
   476 			width      	1734
       
   477 			height     	546
       
   478 			autoResize 	TRUE)
       
   479 		    (object HasView "iDb" @20
       
   480 			label      	(object ItemLabel
       
   481 			    Parent_View 	@20
       
   482 			    location   	(977, 1238)
       
   483 			    anchor_loc 	1
       
   484 			    nlines     	1
       
   485 			    max_width  	450
       
   486 			    justify    	0
       
   487 			    label      	"iDb")
       
   488 			client     	@19
       
   489 			supplier   	@1
       
   490 			line_style 	0)
       
   491 		    (object ClassView "Class" "CStoreableOverrideSettings" @21
       
   492 			IncludeAttribute 	TRUE
       
   493 			location   	(1426, 2418)
       
   494 			label      	(object ItemLabel
       
   495 			    Parent_View 	@21
       
   496 			    location   	(1286, 2334)
       
   497 			    nlines     	2
       
   498 			    max_width  	329
       
   499 			    justify    	0
       
   500 			    label      	"CStoreableOverrideSettings")
       
   501 			compartment 	(object Compartment
       
   502 			    Parent_View 	@21
       
   503 			    location   	(1285, 2450)
       
   504 			    anchor     	2
       
   505 			    nlines     	1
       
   506 			    max_width  	328
       
   507 			    justify    	0)
       
   508 			width      	478
       
   509 			autoResize 	TRUE)
       
   510 		    (object InheritView "" @22
       
   511 			client     	@21
       
   512 			supplier   	@19
       
   513 			line_style 	0)))))
       
   514     root_subsystem 	(object SubSystem "<Top Level>"
       
   515 	physical_models 	(list unit_reference_list)
       
   516 	physical_presentations 	(list unit_reference_list
       
   517 	    (object Module_Diagram "Main"
       
   518 		title      	"Main"
       
   519 		zoom       	100
       
   520 		max_height 	28350
       
   521 		max_width  	21600
       
   522 		origin_x   	0
       
   523 		origin_y   	0
       
   524 		items      	(list diagram_item_list))))
       
   525     process_structure 	(object Processes
       
   526 	ProcsNDevs 	(list
       
   527 	    (object Process_Diagram ""
       
   528 		title      	""
       
   529 		zoom       	100
       
   530 		max_height 	28350
       
   531 		max_width  	21600
       
   532 		origin_x   	0
       
   533 		origin_y   	0
       
   534 		items      	(list diagram_item_list))))
       
   535     properties 	(object Properties))