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