1 karl 1.1 // ===================================================================
2 // Title: Device Storage Library
3 // $State: Preliminary $
4 // $Date: 2004/03/19 15:29:48 $
5 // $Source: /home/dmtf2/dotorg/var/cvs/repositories/dev/Schema/MOF/Device_StorageLib.mof,v $
6 // $Revision: 1.2 $
7 // ===================================================================
8 //#pragma inLine ("Includes/copyright.inc")
9 // Copyright 1998-2004 Distributed Management Task Force, Inc. (DMTF).
10 // All rights reserved.
11 // DMTF is a not-for-profit association of industry members dedicated
12 // to promoting enterprise and systems management and interoperability.
13 // DMTF specifications and documents may be reproduced for uses
14 // consistent with this purpose by members and non-members,
15 // provided that correct attribution is given.
16 // As DMTF specifications may be revised from time to time,
17 // the particular version and release date should always be noted.
18 //
19 // Implementation of certain elements of this standard or proposed
20 // standard may be subject to third party patent rights, including
21 // provisional patent rights (herein "patent rights"). DMTF makes
22 karl 1.1 // no representations to users of the standard as to the existence
23 // of such rights, and is not responsible to recognize, disclose, or
24 // identify any or all such third party patent right, owners or
25 // claimants, nor for any incomplete or inaccurate identification or
26 // disclosure of such rights, owners or claimants. DMTF shall have no
27 // liability to any party, in any manner or circumstance, under any
28 // legal theory whatsoever, for failure to recognize, disclose, or
29 // identify any such third party patent rights, or for such party's
30 // reliance on the standard or incorporation thereof in its product,
31 // protocols or testing procedures. DMTF shall have no liability to
32 // any party implementing such standard, whether such implementation
33 // is foreseeable or not, nor to any patent owner or claimant, and shall
34 // have no liability or responsibility for costs or losses incurred if
35 // a standard is withdrawn or modified after publication, and shall be
36 // indemnified and held harmless by any party implementing the
37 // standard from any and all claims of infringement by a patent owner
38 // for such implementations.
39 //
40 // For information about patents held by third-parties which have
41 // notified the DMTF that, in their opinion, such patent may relate to
42 // or impact implementations of DMTF standards, visit
43 karl 1.1 // http://www.dmtf.org/about/policies/disclosures.php.
44 //#pragma inLine
45 // ===================================================================
46 // Description: The Device Model extends the management concepts that
47 // are related to LogicalDevices. This file defines the
48 // classes that model a storage library.
49 //
50 // The object classes below are listed in an order that
51 // avoids forward references. Required objects, defined
52 // by other working groups, are omitted.
53 // ==================================================================
54 // Change Log for v2.8 Final
55 // CR1223 - SysDev Omnibus CR - Minor MOF corrections.
56 //
57 // Change Log for v2.7 Final
58 // CR970 - Removal of the Experimental qualifier
59 //
60 // Change Log for v2.7
61 // CR721 - Add LabelReaderStatData and PickerStatData that are part
62 // of the new statistics hierarcy
63 // CR822 - Change the subclassing of LibraryPackage from
64 karl 1.1 // Dependency to SystemPackaging
65 // ==================================================================
66
67 #pragma locale ("en_US")
68
69
70 // ===================================================================
71 // StorageLibrary
72 // ===================================================================
73 [Version ( "2.6.0" ), Description (
74 "A StorageLibrary is a collection of ManagedSystemElements that "
75 "operate together to provide cartridge library capabilities. "
76 "This object serves as an aggregation point to group the "
77 "following elements: MediaTransferDevices, a Label Reader, a "
78 "library Door, MediaAccessDevices, and other Library "
79 "components.")]
80 class CIM_StorageLibrary : CIM_System {
81
82 [Description (
83 "Capabilities of the StorageLibrary. For example, it can be "
84 "indicated that the Library can perform automatic cleaning "
85 karl 1.1 "of the MediaAccessDevices contained in it (value=1) or that "
86 "the Library provides physical door access for an operator "
87 "(value=2)."),
88 ValueMap { "0", "1", "2", "3", "4" },
89 Values { "Unknown", "Other", "Automatic Cleaning",
90 "Manual Operation", "Front Panel Lockable" }]
91 uint16 Capabilities[];
92
93 [Description (
94 "Boolean set to TRUE if there are more PhysicalMedia in a "
95 "Library than there are StorageMediaLocations to contain "
96 "them. For instance, if all MediaAccessDevices have a Media "
97 "loaded in them, and all StorageMediaLocations are loaded by "
98 "an operator, then an Overfilled condition exists.")]
99 boolean Overfilled;
100
101 [Description (
102 "Boolean set to TRUE if the Library can not currently report "
103 "the correct state of each PhysicalMedia within its proper "
104 "StorageMediaLocation.")]
105 boolean AuditNeeded;
106 karl 1.1
107 [Description (
108 "Boolean set to TRUE if an audit of the location of some or "
109 "all of the Library's PhysicalMedia is currently being "
110 "performed. That an individual Changer is currently doing an "
111 "audit is indicated by a similar AuditInProgress boolean "
112 "property on the Changer object.")]
113 boolean AuditInProgress;
114
115 [Description (
116 "Maximum time in seconds that it takes for the Storage "
117 "Library to perform a complete audit of each StorageMedia "
118 "Location, to determine the absence or presence of a "
119 "Physical Media. If automated support is not provided, then "
120 "this property's value is undefined."),
121 Units ( "Seconds" )]
122 uint64 MaxAuditTime;
123
124 [Description (
125 "Boolean set to TRUE if the Library includes a robotics "
126 "mechanism that can be controlled by a ComputerSystem, to "
127 karl 1.1 "automatically load and unload PhysicalMedia to/from "
128 "MediaAccessDevices and StorageMediaLocations. The property "
129 "is set to FALSE if the Library represents a repository of "
130 "Media that are inaccessible to a MediaAccess Device without "
131 "human intervention. An example of a non- automated Library "
132 "is a 'shelf' or 'vault' where Physical Media are kept for "
133 "extended periods of time.")]
134 boolean Automated;
135
136 [Description (
137 "Boolean indicating whether the Library's robotics are "
138 "currently active/enabled. If TRUE, then the Library may not "
139 "be safe for a human to enter.")]
140 boolean RoboticsEnabled;
141
142 [Description (
143 "Requests that the Library robotics be enabled for automated "
144 "operation (input parameter, Enabled, set to TRUE), or "
145 "disabled for manual operation (input parameter set to "
146 "FALSE). The return value should be 0 if the request was "
147 "successfully executed, 1 if the request is not supported "
148 karl 1.1 "and some other value if an error occurred. In a subclass, "
149 "the set of possible return codes could be specified, using "
150 "a ValueMap qualifier on the method. The strings to which "
151 "the ValueMap contents are 'translated' may also be "
152 "specified in the subclass as a Values array qualifier.")]
153 uint32 EnableRobotics(
154 [IN, Description (
155 "Set TRUE to enable.")]
156 boolean Enable);
157 };
158
159
160 // ==================================================================
161 // LibraryPackage
162 // ==================================================================
163 [Association, Version ( "2.7.0" ), Description (
164 "Similar to the way that LogicalDevices are 'Realized' by "
165 "PhysicalElements, a StorageLibrary can be realized in one or "
166 "more PhysicalPackages. The LibraryPackage association "
167 "explicitly defines this relationship.")]
168 class CIM_LibraryPackage : CIM_SystemPackaging {
169 karl 1.1
170 [Override ( "Antecedent" ), Description (
171 "The PhysicalPackage(s) that realize a StorageLibrary.")]
172 CIM_PhysicalPackage REF Antecedent;
173
174 [Override ( "Dependent" ), Description (
175 "The StorageLibrary.")]
176 CIM_StorageLibrary REF Dependent;
177 };
178
179
180 // ===================================================================
181 // MediaTransferDevice
182 // ===================================================================
183 [Version ( "2.6.0" ), Description (
184 "A MediaTransferDevice represents hardware that moves Physical "
185 "Media. It is a superclass for Devices like PickerElement, "
186 "ChangerDevice and InterLibraryPort.")]
187 class CIM_MediaTransferDevice : CIM_LogicalDevice {
188 };
189
190 karl 1.1
191 // ===================================================================
192 // DeviceServicesLocation
193 // ===================================================================
194 [Association, Version ( "2.6.0" ), Description (
195 "Within an automated StorageLibrary, Media should be accessible "
196 "to the various robotics and MediaTransferDevices (Pickers, "
197 "Changers, InterLibraryPorts, etc.). The Library may be "
198 "serviced by different TransferDevices, each responsible for a "
199 "subset of the Library's StorageMediaLocations. The Device "
200 "ServicesLocation association indicates that the Transfer "
201 "Device handles Media stored in the referenced Location. For "
202 "example, LibraryPort 'A' may only service Media from Slots "
203 "1-10, while LibraryPort 'B' covers Slots 11-33. This detail is "
204 "conveyed by this association.")]
205 class CIM_DeviceServicesLocation : CIM_Dependency {
206
207 [Override ( "Antecedent" ), Description (
208 "The MediaTransferDevice that handles Media from the "
209 "StorageMediaLocation.")]
210 CIM_MediaTransferDevice REF Antecedent;
211 karl 1.1
212 [Override ( "Dependent" ), Description (
213 "The MediaLocation that is serviced.")]
214 CIM_StorageMediaLocation REF Dependent;
215
216 [Description (
217 "Boolean indicating that the referenced StorageMediaLocation "
218 "is not currently accessible to the MediaTransferDevice. For "
219 "example, the Location could be the realization of an "
220 "InterLibraryPort that is currently servicing another "
221 "Library. The DeviceServicesLocation association describes "
222 "that the TransferDevice COULD service the MediaLocation. "
223 "This boolean indicates that that this is temporarily not "
224 "possible.")]
225 boolean Inaccessible;
226 };
227
228
229 // ===================================================================
230 // PickerElement
231 // ===================================================================
232 karl 1.1 [Version ( "2.6.0" ), Description (
233 "PickerElements represent hardware used to pick or place "
234 "PhysicalMedia from/into StorageMediaLocations.")]
235 class CIM_PickerElement : CIM_MediaTransferDevice {
236
237 [Description (
238 "The maximum time in seconds for a PickerElement to grab a "
239 "PhysicalMedia from a StorageMediaLocation, once the Picker "
240 "has arrived at that Location. The maximum time interval for "
241 "moving a Media from one point to another is the sum of the "
242 "PickerElement's MaxPickTime, the Changer Device's "
243 "MaxTransitTime and the PickerElement's MaxPutTime."),
244 Units ( "Seconds" )]
245 uint32 MaxPickTime;
246
247 [Description (
248 "The maximum time in seconds for a PickerElement to place a "
249 "PhysicalMedia into a StorageMediaLocation, once the Picker "
250 "has arrived at that Location. The maximum time interval for "
251 "moving a Media from one point to another is the sum of the "
252 "PickerElement's MaxPickTime, the Changer Device's "
253 karl 1.1 "MaxTransitTime and the PickerElement's MaxPutTime."),
254 Units ( "Seconds" )]
255 uint32 MaxPutTime;
256
257 [Description (
258 "String describing the location in the StorageLibrary where "
259 "the Picker is currently positioned.")]
260 string CellLocation;
261 };
262
263
264 // ===================================================================
265 // ChangerDevice
266 // ===================================================================
267 [Version ( "2.6.0" ), Description (
268 "ChangerDevices represent hardware that moves PhysicalMedia "
269 "within a System, such as a StorageLibrary.")]
270 class CIM_ChangerDevice : CIM_MediaTransferDevice {
271
272 [Description (
273 "The maximum time in seconds between a PickerElement pick "
274 karl 1.1 "and place. It should be reported as the transit time "
275 "between the two most physically distant StorageMedia "
276 "Locations in a System. The maximum time interval for moving "
277 "a Media from one point to another is the sum of the "
278 "PickerElement's MaxPickTime, the ChangerDevice's Max "
279 "TransitTime and the PickerElement's MaxPutTime."),
280 Units ( "Seconds" )]
281 uint32 MaxTransitTime;
282
283 [Description (
284 "Boolean set to TRUE if the Changer supports media flipping. "
285 "Media needs to be flipped when multi-sided PhysicalMedia "
286 "are placed into a MediaAccessDevice that does NOT support "
287 "dual sided access.")]
288 boolean MediaFlipSupported;
289
290 [Description (
291 "Boolean set to TRUE if an audit is currently being "
292 "performed by the Changer.")]
293 boolean AuditInProgress;
294
295 karl 1.1 [Description (
296 "A count of the number of audits performed by the Changer."),
297 Counter]
298 uint64 AuditsPerformed;
299 };
300
301
302 // ===================================================================
303 // PickerForChanger
304 // ===================================================================
305 [Association, Version ( "2.6.0" ), Description (
306 "PickerForChanger indicates the PickerElement(s) that access "
307 "StorageMediaLocations and deliver PhysicalMedia to the "
308 "Changer, for movement through the System. A Changer may have "
309 "several Pickers for faster exchange of Media.")]
310 class CIM_PickerForChanger : CIM_Dependency {
311
312 [Override ( "Antecedent" ), Description (
313 "The PickerElement that accesses StorageMediaLocations to "
314 "deliver Media to the Changer.")]
315 CIM_PickerElement REF Antecedent;
316 karl 1.1
317 [Override ( "Dependent" ), Max ( 1 ), Description (
318 "The ChangerDevice.")]
319 CIM_ChangerDevice REF Dependent;
320 };
321
322
323 // ===================================================================
324 // LimitedAccessPort
325 // ===================================================================
326 [Version ( "2.6.0" ), Description (
327 "LimitedAccessPorts represent hardware that transports Physical "
328 "Media into or out of a System, such as a StorageLibrary. They "
329 "are identified as 'limited' since these Ports do not provide "
330 "access to ALL the PhysicalMedia or StorageMediaLocations in a "
331 "Library, but only to a subset.")]
332 class CIM_LimitedAccessPort : CIM_MediaTransferDevice {
333
334 [Description (
335 "Boolean indicating that the Port is 'locked' (TRUE) or "
336 "'unlocked' (FALSE). When the Port is locked, access its "
337 karl 1.1 "Media Locations is prevented without the use of a physical "
338 "key, front panel activity or the issuance of a software "
339 "unlock command.")]
340 boolean Locked;
341
342 [Description (
343 "When a Port is 'Extended' or 'open' (value=TRUE), its "
344 "Storage MediaLocations are accessible to a human operator. "
345 "If not extended (value=FALSE), the Locations are accessible "
346 "to a PickerElement.")]
347 boolean Extended;
348
349 [Description (
350 "When a LimitedAccessPort is 'Extended', all related media- "
351 "transfer componentry may be stopped. The ExtendTimeout "
352 "property provides a mechanism to event on a Port left open "
353 "for a period of time (in seconds) exceeding the property's "
354 "value."),
355 Units ( "Seconds" )]
356 uint32 ExtendTimeout;
357
358 karl 1.1 [Description (
359 "Date and time that the Port was last extended.")]
360 datetime LastExtended;
361
362 [Description (
363 "The number of times that the LimitedAccessPort was used to "
364 "move a PhysicalMedia into the System/StorageLibrary."),
365 Counter]
366 uint64 ImportCount;
367
368 [Description (
369 "The number of times that the LimitedAccessPort was used to "
370 "move a PhysicalMedia out of the System/StorageLibrary."),
371 Counter]
372 uint64 ExportCount;
373
374 [Description (
375 "An enumeration expressing whether the Port is used for "
376 "import into the Library/System which scopes and names it "
377 "(value=1), export from the Library/System (value=2), or "
378 "both (value=3)."),
379 karl 1.1 ValueMap { "0", "1", "2", "3" },
380 Values { "Unknown", "Import", "Export",
381 "Both Import and Export" }]
382 uint16 Direction;
383 };
384
385
386 // ===================================================================
387 // InterLibraryPort
388 // ===================================================================
389 [Version ( "2.6.0" ), Description (
390 "InterLibraryPorts represent hardware that transports Physical "
391 "Media between connected StorageLibraries. The LibraryExchange "
392 "association identifies the connected Libraries, by identifying "
393 "the connected InterLibraryPorts.")]
394 class CIM_InterLibraryPort : CIM_MediaTransferDevice {
395
396 [Description (
397 "Date and time that the Port was last accessed by its "
398 "System/StorageLibrary. This value may be different than "
399 "that specified for the Port(s) to which this Inter "
400 karl 1.1 "LibraryPort is connected. Connected Ports are identified "
401 "using the LibraryExchange association.")]
402 datetime LastAccessed;
403
404 [Description (
405 "The number of times that the InterLibraryPort was used to "
406 "move a PhysicalMedia into the System/StorageLibrary."),
407 Counter]
408 uint64 ImportCount;
409
410 [Description (
411 "The number of times that the InterLibraryPort was used to "
412 "move a PhysicalMedia out of the System/StorageLibrary."),
413 Counter]
414 uint64 ExportCount;
415
416 [Description (
417 "An enumeration expressing whether the Port is used for "
418 "import into the Library/System which scopes and names it "
419 "(value=1), export from the Library/System (value=2), or "
420 "both (value=3)."),
421 karl 1.1 ValueMap { "0", "1", "2", "3" },
422 Values { "Unknown", "Import", "Export",
423 "Both Import and Export" }]
424 uint16 Direction;
425 };
426
427
428 // ===================================================================
429 // LibraryExchange
430 // ===================================================================
431 [Association, Version ( "2.6.0" ), Description (
432 "LibraryExchange indicates that two StorageLibraries are "
433 "connected through their InterLibraryPorts.")]
434 class CIM_LibraryExchange : CIM_Dependency {
435
436 [Override ( "Antecedent" ), Description (
437 "The InterLibraryPort of one StorageLibrary.")]
438 CIM_InterLibraryPort REF Antecedent;
439
440 [Override ( "Dependent" ), Description (
441 "The InterLibraryPort of the connected Library.")]
442 karl 1.1 CIM_InterLibraryPort REF Dependent;
443
444 [Description (
445 "Enumeration indicating whether the Antecedent (value=1), "
446 "Dependent (value=2), or neither Library (value=3) currently "
447 "has access to the Port."),
448 ValueMap { "0", "1", "2", "3" },
449 Values { "Unknown", "Antecedent", "Dependent", "Neither" }]
450 uint16 CurrentlyAccessingPort;
451 };
452
453
454 // ===================================================================
455 // LabelReader
456 // ===================================================================
457 [Version ( "2.6.0" ), Description (
458 "LabelReaders represent hardware capable of scanning or reading "
459 "a physical label or the NonVolatileMemory on a PhysicalMedia. "
460 "Examples of labels include barcode and OCR tags.")]
461 class CIM_LabelReader : CIM_LogicalDevice {
462
463 karl 1.1 [Description (
464 "An array of enumerated integers describing the formats of "
465 "the labels that can be read or scanned by the LabelReader. "
466 "The values specified for this property correspond to those "
467 "defined for CIM_PhysicalMedia.LabelFormats."),
468 ValueMap { "0", "1", "2", "3", "4", "5" },
469 Values { "Barcode", "Radio Frequency Identification",
470 "OCR (Optical Character Recognition)",
471 "MICR (Magnetic Ink Character Recognition)",
472 "7 Character Barcode", "9 Character Barcode" },
473 ModelCorrespondence { "CIM_PhysicalMedia.LabelFormats" }]
474 uint16 SupportedFormats[];
475
476 [Description (
477 "The technology used by the LabelReader. One entry of the "
478 "Values array requires some explanation - \"Memory Reader\". "
479 "The latter describes the ability to access memory in a "
480 "PhysicalMedia's packaging (for example, memory on an AIT "
481 "tape). The existence of this Memory is indicated by the "
482 "MemoryWithMedia association on the physical side, or by "
483 "AssociatedMemory on the logical side."),
484 karl 1.1 ValueMap { "0", "1", "2", "3", "4", "5", "6" },
485 Values { "Unknown", "Other", "Laser", "Infrared", "RF",
486 "Camera", "Memory Reader" }]
487 uint16 Technology;
488 };
489
490
491 // ===================================================================
492 // AssociatedLabelReader
493 // ===================================================================
494 [Association, Version ( "2.6.0" ), Description (
495 "A LogicalDevice may use or require one or more LabelReaders, "
496 "to scan barcodes or otherwise identify entities. This "
497 "relationship is described by the AssociatedLabelReader "
498 "dependency.")]
499 class CIM_AssociatedLabelReader : CIM_Dependency {
500
501 [Override ( "Antecedent" ), Description (
502 "The LabelReader.")]
503 CIM_LabelReader REF Antecedent;
504
505 karl 1.1 [Override ( "Dependent" ), Description (
506 "The Device that is dependent on the Reader Device.")]
507 CIM_LogicalDevice REF Dependent;
508 };
509
510
511 // ===================================================================
512 // PickerLabelReader
513 // ===================================================================
514 [Association, Version ( "2.6.0" ), Description (
515 "PickerLabelReader is used to indicate that one or more Label "
516 "Readers works in conjunction with PickerElements, to identify "
517 "PhysicalMedia as they are being picked/placed.")]
518 class CIM_PickerLabelReader : CIM_AssociatedLabelReader {
519
520 [Override ( "Antecedent" ), Description (
521 "The LabelReader.")]
522 CIM_LabelReader REF Antecedent;
523
524 [Override ( "Dependent" ), Description (
525 "The PickerElement that is dependent on the Reader Device.")]
526 karl 1.1 CIM_PickerElement REF Dependent;
527 };
528
529
530 // ===================================================================
531 // AccessLabelReader
532 // ===================================================================
533 [Association, Version ( "2.6.0" ), Description (
534 "AccessLabelReader is used to indicate that one or more Label "
535 "Readers works in conjunction with MediaAccessDevices, to "
536 "identify PhysicalMedia before read/write.")]
537 class CIM_AccessLabelReader : CIM_AssociatedLabelReader {
538
539 [Override ( "Antecedent" ), Description (
540 "The LabelReader.")]
541 CIM_LabelReader REF Antecedent;
542
543 [Override ( "Dependent" ), Description (
544 "The MediaAccessDevice that is dependent on the Reader "
545 "Device.")]
546 CIM_MediaAccessDevice REF Dependent;
547 karl 1.1 };
548
549
550 // ===================================================================
551 // LabelReaderStatInfo
552 // ===================================================================
553 [Version ( "2.6.0" ), Description (
554 "Statistics for a LabelReader, related to read successes, "
555 "failures and retries.")]
556 class CIM_LabelReaderStatInfo : CIM_DeviceStatisticalInformation {
557
558 [Description (
559 "The number of successful physical label scans."),
560 Counter]
561 uint64 ScanSuccesses;
562
563 [Description (
564 "The number of failed physical label scans."),
565 Counter]
566 uint64 ScanFailures;
567
568 karl 1.1 [Description (
569 "The number of retried physical label scans."),
570 Counter]
571 uint64 ScanRetries;
572
573 [Description (
574 "Method to reset the statistical counters. The method takes "
575 "one parameter as input - an integer indicating which "
576 "counter to reset. For this input parameter, 0 indicates "
577 "all, 1 resets the \"Scan Successes\" counter, 2 resets the "
578 "\"Scan Failures\" counter, and 3 resets the \"Scan "
579 "Retries\" counter. The method returns 0 if successful, 1 if "
580 "not supported, and any other value if an error occurred. A "
581 "method is specified so that the Device's instrumentation "
582 "can also reset its internal processing and counters. \n"
583 "In a subclass, the set of possible return codes should be "
584 "specified in a ValueMap qualifier on the method. The "
585 "strings to which the ValueMap contents are 'translated' can "
586 "be specified as a Values array qualifier.")]
587 uint32 ResetCounter (
588 [IN, Description (
589 karl 1.1 "The counter to reset."),
590 ValueMap { "0", "1", "2", "3" },
591 Values { "All", "Scan Successes", "Scan Failures",
592 "Scan Retries" }]
593 uint16 SelectedCounter);
594 };
595
596 // ===================================================================
597 // PickerStatInfo
598 // ===================================================================
599 [Version ( "2.6.0" ), Description (
600 "Statistics for a PickerElement, related to pick/put successes, "
601 "retries and failures.")]
602 class CIM_PickerStatInfo : CIM_DeviceStatisticalInformation {
603
604 [Description (
605 "The number of successful picks."),
606 Counter]
607 uint64 PickSuccesses;
608
609 [Description (
610 karl 1.1 "The number of failed picks."),
611 Counter]
612 uint64 PickFailures;
613
614 [Description (
615 "The number of retried picks."),
616 Counter]
617 uint64 PickRetries;
618
619 [Description (
620 "The number of successful puts."),
621 Counter]
622 uint64 PutSuccesses;
623
624 [Description (
625 "The number of failed puts."),
626 Counter]
627 uint64 PutFailures;
628
629 [Description (
630 "The number of retried puts."),
631 karl 1.1 Counter]
632 uint64 PutRetries;
633
634 [Description (
635 "Method to reset the statistical counters. The method takes "
636 "one parameter as input - an integer indicating which "
637 "counter to reset. For this input parameter, 0 indicates "
638 "all, 1-3 reset the 'pick'-related counters, and 4-6 reset "
639 "the 'put'- related counters. The method returns 0 if "
640 "successful, 1 if not supported, and any other value if an "
641 "error occurred. A method is specified so that the Device's "
642 "instrumentation can also reset its internal pocessing and "
643 "counters. \n"
644 "In a subclass, the set of possible return codes should be "
645 "specified in a ValueMap qualifier on the method. The "
646 "strings to which the ValueMap contents are 'translated' can "
647 "be specified as a Values array qualifier.")]
648 uint32 ResetCounter (
649 [IN, Description (
650 "This parameter indicates the counter to reset."),
651 ValueMap { "0", "1", "2", "3", "4", "5", "6" },
652 karl 1.1 Values { "All", "Pick Successes", "Pick Failures",
653 "Pick Retries", "Put Successes", "Put Failures",
654 "Put Retries" }]
655 uint16 SelectedCounter);
656 };
657
658 // ===================================================================
659 // LabelReaderStatData
660 // ===================================================================
661 [Version ( "2.7.0" ), Description (
662 "Statistics for a LabelReader, related to read successes, "
663 "failures and retries. The element whose statistics are "
664 "described is associated using the relationship, "
665 "ElementStatisticalData.")]
666 class CIM_LabelReaderStatData : CIM_StatisticalData {
667
668 [Description (
669 "The number of successful physical label scans."),
670 Counter]
671 uint64 ScanSuccesses;
672
673 karl 1.1 [Description (
674 "The number of failed physical label scans."),
675 Counter]
676 uint64 ScanFailures;
677
678 [Description (
679 "The number of retried physical label scans."),
680 Counter]
681 uint64 ScanRetries;
682 };
683
684
685 // ===================================================================
686 // PickerStatData
687 // ===================================================================
688 [Version ( "2.7.0" ), Description (
689 "Statistics for a PickerElement, related to pick/put successes, "
690 "retries and failures. The element whose statistics are "
691 "described is associated using the relationship, "
692 "ElementStatisticalData.")]
693 class CIM_PickerStatData : CIM_StatisticalData {
694 karl 1.1
695 [Description (
696 "The number of successful picks."),
697 Counter]
698 uint64 PickSuccesses;
699
700 [Description (
701 "The number of failed picks."),
702 Counter]
703 uint64 PickFailures;
704
705 [Description (
706 "The number of retried picks."),
707 Counter]
708 uint64 PickRetries;
709
710 [Description (
711 "The number of successful puts."),
712 Counter]
713 uint64 PutSuccesses;
714
715 karl 1.1 [Description (
716 "The number of failed puts."),
717 Counter]
718 uint64 PutFailures;
719
720 [Description (
721 "The number of retried puts."),
722 Counter]
723 uint64 PutRetries;
724 };
725
726
727 // ===================================================================
728 // end of file
729 // ===================================================================
|
Return to
Device_StorageLib.mof
CVS log
Up to [Pegasus] / pegasus / Schemas / CIMPrelim29