1 karl  1.1.2.2 // Copyright (c) 2008 DMTF.  All rights reserved.
  2                  [Abstract, Version ( "2.19.0" ), 
  3                   UMLPackagePath ( "CIM::Core::Statistics" ), 
  4                   Description ( 
  5                      "CIM_StatisticalData is a root class for any arbitrary "
  6                      "collection of statistical data and/or metrics applicable to "
  7                      "one or more ManagedElements. These statistics MUST represent "
  8                      "the most recent observations and MUST NOT be provided if "
  9                      "irrelevant or stale. Note that this class uses a simplified "
 10                      "naming/identity algorithm as compared to "
 11                      "CIM_StatisticalInformation." )]
 12               class CIM_StatisticalData : CIM_ManagedElement {
 13               
 14                     [Key, Override ( "InstanceID" ), 
 15                      Description ( 
 16                         "Within the scope of the instantiating Namespace, "
 17                         "InstanceID opaquely and uniquely identifies an instance "
 18                         "of this class. In order to ensure uniqueness within the "
 19                         "NameSpace, the value of InstanceID SHOULD be constructed "
 20                         "using the following \'preferred\' algorithm: \n"
 21                         "<OrgID>:<LocalID> \n"
 22 karl  1.1.2.2           "Where <OrgID> and <LocalID> are separated by a colon "
 23                         "\':\', and where <OrgID> MUST include a copyrighted, "
 24                         "trademarked or otherwise unique name that is owned by "
 25                         "the business entity creating/defining the InstanceID, or "
 26                         "is a registered ID that is assigned to the business "
 27                         "entity by a recognized global authority (This is similar "
 28                         "to the <Schema Name>_<Class Name> structure of Schema "
 29                         "class names.) In addition, to ensure uniqueness <OrgID> "
 30                         "MUST NOT contain a colon (\':\'). When using this "
 31                         "algorithm, the first colon to appear in InstanceID MUST "
 32                         "appear between <OrgID> and <LocalID>. \n"
 33                         "<LocalID> is chosen by the business entity and SHOULD "
 34                         "not be re-used to identify different underlying "
 35                         "(real-world) elements. If the above \'preferred\' "
 36                         "algorithm is not used, the defining entity MUST assure "
 37                         "that the resultant InstanceID is not re-used across any "
 38                         "InstanceIDs produced by this or other providers for this "
 39                         "instance\'s NameSpace. \n"
 40                         "For DMTF defined instances, the \'preferred\' algorithm "
 41                         "MUST be used with the <OrgID> set to \'CIM\'." )]
 42                  string InstanceID;
 43 karl  1.1.2.2 
 44                     [Required, Override ( "ElementName" ), 
 45                      Description ( 
 46                         "The user friendly name for this instance of "
 47                         "StatisticalData. In addition, the user friendly name can "
 48                         "be used as a index property for a search of query. "
 49                         "(Note: Name does not have to be unique within a "
 50                         "namespace.)" )]
 51                  string ElementName;
 52               
 53                     [Description ( 
 54                         "The time, relative to managed element where the "
 55                         "statistic was collected, when the first measurement was "
 56                         "taken. If the statistic is reset, the StartStatisticTime "
 57                         "is the time when the reset was performed." )]
 58                  datetime StartStatisticTime;
 59               
 60                     [Description ( 
 61                         "The time the most recent measurement was taken, relative "
 62                         "to the managed element where the statistic was "
 63                         "collected." )]
 64 karl  1.1.2.2    datetime StatisticTime;
 65               
 66                     [Description ( 
 67                         "Some statistics are sampled at consistent time "
 68                         "intervals. This property provides the sample interval so "
 69                         "that client applications can determine the minimum time "
 70                         "that new statistics should be pulled. If the statistics "
 71                         "are not sampled at consistent time intervals, this "
 72                         "property must be set to a zero time interval." )]
 73                  datetime SampleInterval = "00000000000000.000000:000";
 74               
 75               
 76                     [Description ( 
 77                         "Method to reset one or more of the instance\'s "
 78                         "statistics. The method takes one parameter as input - an "
 79                         "array of strings indicating which statistics to reset. "
 80                         "If all the statistics in the instance should be reset, "
 81                         "the first element of the array MUST be set to \"All\" or "
 82                         "\"ALL\". If one or more individual statistics should be "
 83                         "reset, the corresponding property names are entered into "
 84                         "the elements of the array. \n"
 85 karl  1.1.2.2           "The method returns 0 if successful, 1 if not supported, "
 86                         "and any other value if an error occurred. A method is "
 87                         "specified so that the StatisticalInformation\'s "
 88                         "provider/ instrumentation, which calculates the "
 89                         "statistics, can reset its internal processing, counters, "
 90                         "etc. \n"
 91                         "In a subclass, the set of possible return codes could be "
 92                         "specified, using a ValueMap qualifier on the method. The "
 93                         "strings to which the ValueMap contents are \'translated\' "
 94                         "may also be specified in the subclass as a Values array "
 95                         "qualifier." )]
 96                  uint32 ResetSelectedStats(
 97                        [IN, Description ( 
 98                            "Array of strings indicating which statistics to reset."
 99                             )]
100                     string SelectedStatistics[]);
101               
102               };