<head><META http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="mof.css" xmlns:lxslt="http://xml.apache.org/xslt"> <title>DMTF Schema Documentation Schema Documentation</title> </head><html> <body bgcolor="White"> <hr> </hr> <a name="CIM_SWRStatistics"></a> <H1>Class CIM_SWRStatistics<BR>extends <a href="CIM_StatisticalData.html">CIM_StatisticalData</a> </H1>This is base class for the software resource statistics. Depending on the implementation it can be of six types that identify the unit type (technical or domain-specific) and the behavioral characteristic of the software resource (allocation, input or output). The statistics is also the place at which the corresponding operational settings of the software resource appear. These parameters are changeable on-the-fly (i.e., they are writable). They bear the same constraints regarding their interdependencies between technical and domain-specific units as SWRLimitSettings. Point metrics apply to the point in time of end of the sample, interval metrics apply to the sample interval. It is up to the implementation of the statistcs whether the sample interval ends at the point in time of the request of the instance of this class (working with internal ring buffers) or whether the underlying instrumentation autonomously determines the beginning and the end of the sample interval. SWRStatistics is associated to SoftwareResource via ElementStatisticalData. In general, one software resource is expected to have three statistics. The statistics type covers each behavior characteristics at most once. I.e., the software resource has at most one allocation statistcs, one input statistics and one output statistics. Nevertheless, the implementation of the software resource may exhibit more statistics SWRStatistics instances that cover more context-specific behavior characteristics.<h3> Table of Contents<br> <a href="#c_hierarchy">Hierarchy</a> <br> <a href="#c_subclasses">Direct Known Subclasses</a> <br> <a href="#c_qualifiers">Class Qualifiers</a> <br> <a href="#c_properties">Class Properties</a> <br> <a href="#c_methods">Class Methods</a> <br> </h3> <hr> </hr> <H2> <a name="c_hierarchy">Class Hierarchy</a> </H2> <a href="CIM_ManagedElement.html">CIM_ManagedElement</a> <br data="@NAME"> |<br> +--<a href="CIM_StatisticalData.html">CIM_StatisticalData</a> <br data="@NAME"> |<br> +--<b>CIM_SWRStatistics</b> <br data="CIM_SWRStatistics -- CIM_StatisticalData"> <H2> <a name="c_subclasses">Direct Known Subclasses</a> </H2> <a href="CIM_SWRAllocationStatistics.html">CIM_SWRAllocationStatistics</a> <BR> <a href="CIM_SWRIOStatistics.html">CIM_SWRIOStatistics</a> <BR> <H2> <a name="c_qualifiers">Class Qualifiers</a> </H2> <TABLE BORDER="1" CELLPADDING="1" WIDTH="100%"> <TR> <TH>Name</TH><TH>Data Type</TH><TH>Value</TH> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">This is base class for the software resource statistics. Depending on the implementation it can be of six types that identify the unit type (technical or domain-specific) and the behavioral characteristic of the software resource (allocation, input or output). The statistics is also the place at which the corresponding operational settings of the software resource appear. These parameters are changeable on-the-fly (i.e., they are writable). They bear the same constraints regarding their interdependencies between technical and domain-specific units as SWRLimitSettings. Point metrics apply to the point in time of end of the sample, interval metrics apply to the sample interval. It is up to the implementation of the statistcs whether the sample interval ends at the point in time of the request of the instance of this class (working with internal ring buffers) or whether the underlying instrumentation autonomously determines the beginning and the end of the sample interval. SWRStatistics is associated to SoftwareResource via ElementStatisticalData. In general, one software resource is expected to have three statistics. The statistics type covers each behavior characteristics at most once. I.e., the software resource has at most one allocation statistcs, one input statistics and one output statistics. Nevertheless, the implementation of the software resource may exhibit more statistics SWRStatistics instances that cover more context-specific behavior characteristics.</TD> </TR> <TR> <TD VALIGN="TOP">Experimental</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">true</TD> </TR> <TR> <TD VALIGN="TOP">UMLPackagePath</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM::Application::SWResources</TD> </TR> <TR> <TD VALIGN="TOP">Version</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">2.8.1000</TD> </TR> </TABLE> <H2> <a name="c_properties">Class Properties</a> </H2> <H3>Local Class Properties</H3> <TABLE WIDTH="100%" CELLPADDING="1" BORDER="1"> <TR> <TH ROWSPAN="2"><B>Name</B></TH><TH ROWSPAN="2"><B>Data Type</B></TH><TH ROWSPAN="2"><B>Default Value</B></TH><TH COLSPAN="5"><B>Qualifiers</B></TH> </TR> <TR> <TH>Name</TH><TH>Data Type</TH><TH>Value</TH> </TR> <TR> <TH ROWSPAN="4" VALIGN="TOP">Characteristic</TH><TD ROWSPAN="4" VALIGN="TOP">uint16</TD><TD ROWSPAN="4" VALIGN="TOP"></TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">Characteristic allows for the distinction of the software resource behavior characteristics. This is either the allocation, input and output. Values: Allocation: Statistics about the size of the software resource. Input: Statistics about the data transfer into the software resource. Output: Statistics about the data transfer from the software resource.</TD> </TR> <TR> <TD VALIGN="TOP">ValueMap</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">0, 2, 3, 4, 5..32767, 32768..65535</TD> </TR> <TR> <TD VALIGN="TOP">Values</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">Unknown, Allocation, Input, Output, DMTF Reserved, Vendor Reserved</TD> </TR> <TR> <TH ROWSPAN="2" VALIGN="TOP">ErrorCount</TH><TD ROWSPAN="2" VALIGN="TOP">uint32</TD><TD ROWSPAN="2" VALIGN="TOP"></TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">ErrorCount is the count of errors that have been detected throughout the sample interval.</TD> </TR> <TR> <TH ROWSPAN="4" VALIGN="TOP">FirstError</TH><TD ROWSPAN="4" VALIGN="TOP">uint16</TD><TD ROWSPAN="4" VALIGN="TOP"></TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">This is the error code of the first error that occurs during the sample interval. It is assumed that the first error, detected throughout the sample interval, is the first symptom of the root cause and therefore closer than the last error. Unrelated, subsequent errors during the sample interval of the statistics do not show up. Such a behavior is tolerable compared to the relatively short length of the sample interval. Values: Unspecified Error: No error code can be determined. Violate Upper Limit: The upper limit of the behavior characteristic (allocation, input, output) was exceeded. Violate Lower Limit: The lower limit was underrun. Erroneous Transfer: The transfer had to be aborted. This message does not overlap with 'Erroneous Item'. Erroneous Item: The handling of at least one item was problematic and the item had to be dropped, suspended or rejected. Access to Software Resource Denied: The access control of software resource refused the use of the it.</TD> </TR> <TR> <TD VALIGN="TOP">ValueMap</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">0, 2, 3, 4, 5, 6, 7..32767, 32768..65535</TD> </TR> <TR> <TD VALIGN="TOP">Values</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">Unspecified Error, Violate Upper Limit, Violate Lower Limit, Erroneous Transfer, Erroneous Item, Access to Software Resource Denied, DMTF Reserved, Vendor Reserved</TD> </TR> <TR> <TH ROWSPAN="2" VALIGN="TOP">FirstErrorTimeStamp</TH><TD ROWSPAN="2" VALIGN="TOP">datetime</TD><TD ROWSPAN="2" VALIGN="TOP"></TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">FirstErrorTimeStamp is the point in time at which FirstError was detected.</TD> </TR> <TR> <TH ROWSPAN="4" VALIGN="TOP">LastError</TH><TD ROWSPAN="4" VALIGN="TOP">uint16</TD><TD ROWSPAN="4" VALIGN="TOP"></TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">This is the error code of the last error that occured. The value of LastError remains from one sample interval to the next even if a sample interval is error-free. Values: Unspecified Error: No error code can be determined. Violate Upper Limit: The upper limit of the behavior characteristic (allocation, input, output) was exceeded. Violate Lower Limit: The lower limit was underrun. Erroneous Transfer: The transfer had to be aborted. This message does not overlap with 'Erroneous Item'. Erroneous Item: The handling of at least one item was problematic and the item had to be dropped, suspended or rejected. Access to Software Resource Denied: The access control of software resource refused the use of the it.</TD> </TR> <TR> <TD VALIGN="TOP">ValueMap</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">0, 2, 3, 4, 5, 6, 7..32767, 32768..65535</TD> </TR> <TR> <TD VALIGN="TOP">Values</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">Unspecified Error, Violate Upper Limit, Violate Lower Limit, Erroneous Transfer, Erroneous Item, Access to Software Resource Denied, DMTF Reserved, Vendor Reserved</TD> </TR> <TR> <TH ROWSPAN="2" VALIGN="TOP">LastErrorTimeStamp</TH><TD ROWSPAN="2" VALIGN="TOP">datetime</TD><TD ROWSPAN="2" VALIGN="TOP"></TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">LastErrorTimeStamp is the point in time at which FirstError was detected.</TD> </TR> <TR> <TH ROWSPAN="4" VALIGN="TOP">LowerLimit</TH><TD ROWSPAN="4" VALIGN="TOP">uint32</TD><TD ROWSPAN="4" VALIGN="TOP"></TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">This is an operational lower limit parameter of the software resource. The limit applies to input, output or allocation according to the statistics type. The corresponding unit is found at the property Unit. A null value indicates that no lower limit exists. The property value can be modified. Whether changes are persisted on saving the modification depends on the implementation of the software resource. The default behavior is no persistence.</TD> </TR> <TR> <TD VALIGN="TOP">ModelCorrespondence</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_SWRLimitSetting.LowerInputLimit, CIM_SWRLimitSetting.LowerOutputLimit, CIM_SWRLimitSetting.LowerAllocationLimit</TD> </TR> <TR> <TD VALIGN="TOP">Write</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">true</TD> </TR> <TR> <TH ROWSPAN="2" VALIGN="TOP">OtherLowerLimit</TH><TD ROWSPAN="2" VALIGN="TOP">uint32</TD><TD ROWSPAN="2" VALIGN="TOP"></TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">This property is not null, if the operational lower limit parameter of the software resource can be calculated from the property LowerLimit. If LowerLimit is described by technical units (i.e., InputUnit applies to the technical domain), OtherLowerLimit is described by domain-specific units.</TD> </TR> <TR> <TH ROWSPAN="2" VALIGN="TOP">OtherUnit</TH><TD ROWSPAN="2" VALIGN="TOP">string</TD><TD ROWSPAN="2" VALIGN="TOP"></TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">This is the complementary unit of the operational limit parameters. If Unit is a unit of the technical domain, OtherUnit is a domain-specific unit.</TD> </TR> <TR> <TH ROWSPAN="2" VALIGN="TOP">OtherUpperLimit</TH><TD ROWSPAN="2" VALIGN="TOP">uint32</TD><TD ROWSPAN="2" VALIGN="TOP"></TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">This property is not null, if the operational upper limit parameter of the software resource can be calculated from the property UpperLimit. If UpperLimit is described by technical units (i.e., InputUnit applies to the technical domain), OtherUpperLimit is described by domain-specific units.</TD> </TR> <TR> <TH ROWSPAN="4" VALIGN="TOP">StatisticsType</TH><TD ROWSPAN="4" VALIGN="TOP">uint16</TD><TD ROWSPAN="4" VALIGN="TOP">2</TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">StatisticsType describes whether the statistics is specified in terms of technical units or domain-specific units. Domain-specific is meant to be the items unit or 'business' unit of the usage the software resource. It may range from objects or tables (in a buffer) to orders in a queue. It depends on the implementation and usage context of the software resource. The default is the technical domain. Values: Technical: The writable operational parameters and the affected metrics are assigned a technical unit e.g Kilobytes. Domain-Specific: The writable operational parameters and the affected metrics are assigned a business-like, item-oriented unit e.g messages, objects, orders, etc..</TD> </TR> <TR> <TD VALIGN="TOP">ValueMap</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">0, 2, 3, 4..32767, 32768..65535</TD> </TR> <TR> <TD VALIGN="TOP">Values</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">Unknown, Technical, Domain-Specific, DMTF Reserved, Vendor Reserved</TD> </TR> <TR> <TH ROWSPAN="3" VALIGN="TOP">Unit</TH><TD ROWSPAN="3" VALIGN="TOP">string</TD><TD ROWSPAN="3" VALIGN="TOP">kB</TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">This is the unit of the numeric metrics and the set of upper and lower limits of the software resource. The property should always have a value, null should not appear.The property value is read-only and assumed to correspond to the implementation of the software resource to which the operational parameters and metrics apply. The default value is of the technical domain (Kilobytes).</TD> </TR> <TR> <TD VALIGN="TOP">ModelCorrespondence</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_SWRLimitSetting.InputUnit, CIM_SWRLimitSetting.OutputUnit, CIM_SWRLimitSetting.AllocationUnit</TD> </TR> <TR> <TH ROWSPAN="4" VALIGN="TOP">UpperLimit</TH><TD ROWSPAN="4" VALIGN="TOP">uint32</TD><TD ROWSPAN="4" VALIGN="TOP"></TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">This is an operational upper limit parameter of the software resource. The limit applies to input, output or allocation according to the statistics type. The corresponding unit is found at the property Unit. A null value indicates that no upper limit exists. The property value can be modified. Whether changes are persisted on saving the modification depends on the implementation of the software resource. The default behavior is no persistence.</TD> </TR> <TR> <TD VALIGN="TOP">ModelCorrespondence</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_SWRLimitSetting.UpperInputLimit, CIM_SWRLimitSetting.UpperOutputLimit, CIM_SWRLimitSetting.UpperAllocationLimit</TD> </TR> <TR> <TD VALIGN="TOP">Write</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">true</TD> </TR> </TABLE> <H3>Inherited Properties</H3> <TABLE BORDER="1" CELLPADDING="1" WIDTH="60%"> <TR> <TH>Name</TH><TH>Data Type</TH><TH>Class Origin</TH> </TR> <TR> <TH VALIGN="TOP">Caption</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_ManagedElement.html">CIM_ManagedElement</a></TD> </TR> <TR> <TH VALIGN="TOP">Description</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_ManagedElement.html">CIM_ManagedElement</a></TD> </TR> <TR> <TH VALIGN="TOP">ElementName</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_StatisticalData.html">CIM_StatisticalData</a></TD> </TR> <TR> <TH VALIGN="TOP">Generation</TH><TD VALIGN="TOP">uint64</TD><TD VALIGN="TOP"><a href="CIM_ManagedElement.html">CIM_ManagedElement</a></TD> </TR> <TR> <TH VALIGN="TOP">InstanceID</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_StatisticalData.html">CIM_StatisticalData</a></TD> </TR> <TR> <TH VALIGN="TOP">SampleInterval</TH><TD VALIGN="TOP">datetime</TD><TD VALIGN="TOP"><a href="CIM_StatisticalData.html">CIM_StatisticalData</a></TD> </TR> <TR> <TH VALIGN="TOP">StartStatisticTime</TH><TD VALIGN="TOP">datetime</TD><TD VALIGN="TOP"><a href="CIM_StatisticalData.html">CIM_StatisticalData</a></TD> </TR> <TR> <TH VALIGN="TOP">StatisticTime</TH><TD VALIGN="TOP">datetime</TD><TD VALIGN="TOP"><a href="CIM_StatisticalData.html">CIM_StatisticalData</a></TD> </TR> </TABLE> <h2> <a name="c_methods">Class Methods</a> </h2> <H3>Inherited Class Methods</H3> <TABLE BORDER="1" CELLPADDING="1" WIDTH="60%"> <TR> <TH>Name</TH><TH>Return Type</TH><TH>Class Origin</TH> </TR> <TR> <TH VALIGN="TOP">ResetSelectedStats</TH><TD VALIGN="TOP">uint32</TD><TD VALIGN="TOP"><a href="CIM_StatisticalData.html">CIM_StatisticalData</a></TD> </TR> </TABLE> </body> </html>
