1 marek 1.1 // Copyright (c) 2008 DMTF.  All rights reserved.
  2              [Version ( "2.19.0" ), 
  3               UMLPackagePath ( "CIM::Metrics::BaseMetric" ), 
  4               Description ( 
  5                  "Each CIM_BaseMetricValue object represents the instance value "
  6                  "of a metric. Since the gathering of metric information can "
  7                  "involve large quantities of information there may be many "
  8                  "instances of this class. The use of this class as an "
  9                  "instrumentation source may be inefficient unless the rate of "
 10                  "metrics are known. The length of time a CIM_BaseMetricValue "
 11                  "instance exists after the metric information is captured is "
 12                  "not defined and is implementation dependent. \n"
 13                  "Most metric data values change over time. There are two ways "
 14                  "of mapping this into CIM_BaseMetricValue objects: The value "
 15                  "for the next point in time may use the same object and just "
 16                  "change its properties (such as the value or timestamp), or the "
 17                  "existing objects remain unchanged and a new object is created "
 18                  "for the new point in time. The first method is typically used "
 19                  "for snapshot data and the second method for historical data. "
 20                  "Which method is used, is indicated by the Volatile property." )]
 21           class CIM_BaseMetricValue : CIM_ManagedElement {
 22 marek 1.1 
 23                 [Key, Override ( "InstanceID" ), 
 24                  Description ( 
 25                     "Within the scope of the instantiating Namespace, "
 26                     "InstanceID opaquely and uniquely identifies an instance "
 27                     "of this class. In order to ensure uniqueness within the "
 28                     "NameSpace, the value of InstanceID SHOULD be constructed "
 29                     "using the following \'preferred\' algorithm: \n"
 30                     ": \n"
 31                     "Where and are separated by a colon \':\', and where MUST "
 32                     "include a copyrighted, trademarked or otherwise unique "
 33                     "name that is owned by the business entity "
 34                     "creating/defining the InstanceID, or is a registered ID "
 35                     "that is assigned to the business entity by a recognized "
 36                     "global authority (This is similar to the <Schema "
 37                     "Name>_<Class Name> structure of Schema class names.) In "
 38                     "addition, to ensure uniqueness MUST NOT contain a colon "
 39                     "(\':\'). When using this algorithm, the first colon to "
 40                     "appear in InstanceID MUST appear between and . \n"
 41                     "is chosen by the business entity and SHOULD not be "
 42                     "re-used to identify different underlying (real-world) "
 43 marek 1.1           "elements. If the above \'preferred\' algorithm is not "
 44                     "used, the defining entity MUST assure that the resultant "
 45                     "InstanceID is not re-used across any InstanceIDs "
 46                     "produced by this or other providers for this instance\'s "
 47                     "NameSpace. \n"
 48                     "For DMTF defined instances, the \'preferred\' algorithm "
 49                     "MUST be used with the set to \'CIM\'." )]
 50              string InstanceID;
 51           
 52                 [Required, Description ( 
 53                     "The key of the BaseMetricDefinition instance for this "
 54                     "CIM_BaseMetricValue instance value." ), 
 55                  ModelCorrespondence { "CIM_BaseMetricDefinition.Id" }]
 56              string MetricDefinitionId;
 57           
 58                 [Description ( 
 59                     "A descriptive name for the element to which the metric "
 60                     "value belongs (i.e., the measured element). This "
 61                     "property is required by behavior if there is no "
 62                     "association defined to a ManagedElement, but may be used "
 63                     "in other cases to provide supplemental information. This "
 64 marek 1.1           "allows metrics to be captured independently of any "
 65                     "ManagedElement. An example is where a metric value "
 66                     "belongs to a combination of elements, such as the input "
 67                     "and output ports of the traffic in a switch. If there "
 68                     "are multiple ManagedElements associated with the metric "
 69                     "value, then usually there is one that naturally belongs "
 70                     "to the metric value and that one should be used to "
 71                     "create the supplemental information. The property is not "
 72                     "meant to be used as a foreign key to search on the "
 73                     "measured element. Instead, the association to the "
 74                     "ManagedElement should be used." )]
 75              string MeasuredElementName;
 76           
 77                 [Description ( 
 78                     "Identifies the time when the value of a metric instance "
 79                     "is computed. Note that this is different from the time "
 80                     "when the instance is created. For a given "
 81                     "CIM_BaseMetricValue instance, the TimeStamp changes "
 82                     "whenever a new measurement snapshot is taken if Volatile "
 83                     "is true. A managmenet application may establish a time "
 84                     "series of metric data by retrieving the instances of "
 85 marek 1.1           "CIM_BaseMetricValue and sorting them according to their "
 86                     "TimeStamp." ), 
 87                  ModelCorrespondence { "CIM_BaseMetricDefinition.TimeScope", 
 88                     "CIM_BaseMetricValue.Duration" }]
 89              datetime TimeStamp;
 90           
 91                 [Description ( 
 92                     "Property that represents the time duration over which "
 93                     "this metric value is valid. This property should not "
 94                     "exist for timestamps that apply only to a point in time "
 95                     "but should be defined for values that are considered "
 96                     "valid for a certain time period (ex. sampling). If the "
 97                     "\"Duration\" property exists and is nonNull, the "
 98                     "TimeStamp is to be considered the end of the interval." ), 
 99                  ModelCorrespondence { "CIM_BaseMetricDefinition.TimeScope", 
100                     "CIM_BaseMetricValue.TimeStamp" }]
101              datetime Duration;
102           
103                 [Required, Description ( 
104                     "The value of the metric represented as a string. Its "
105                     "original data type is specified in "
106 marek 1.1           "CIM_BaseMetricDefinition." )]
107              string MetricValue;
108           
109                 [Description ( 
110                     "If present, specifies one BreakdownDimension from the "
111                     "BreakdownDimensions array defined in the associated CIM_ "
112                     "BaseMetricDefinition. This is the dimension along which "
113                     "this set of metric values is broken down. For a "
114                     "description of the concept, see the class "
115                     "CIM_BaseMetricDefinition." )]
116              string BreakdownDimension;
117           
118                 [Description ( 
119                     "Defines a value of the BreakdownDimension property "
120                     "defined for this metric value instance. For instance, if "
121                     "the BreakdownDimension is \"TransactionName\", this "
122                     "property could name the actual transaction to which this "
123                     "particular metric value applies." )]
124              string BreakdownValue;
125           
126                 [Description ( 
127 marek 1.1           "If true, Volatile indicates that the value for the next "
128                     "point in time may use the same object and just change "
129                     "its properties (such as the value or timestamp). If "
130                     "false, the existing objects remain unchanged and a new "
131                     "object is created for the new point in time." )]
132              boolean Volatile;
133           
134           
135           };