# Class CIM_SWRAllocationStatistics
extends CIM_SWRStatistics

The metrics of SWRAllocationStatistics describe the allocation of the software resource. The allocation is basically the size of the software resource in terms of technical units (e.g., kB) or domain-specific units (e.g., the number of items (e.g., the number of messages if the software resource is of the type 'queue'). The operational parameters regarding the allocation limits are surfaced also. Further details can be found in the description of the base class SWRStatistics. The metrics found in this statistics are raw values that describe the allocation behavior of the software resource as simple as possible. Thus, the metric values can be used most flexibly (e.g., cumulative, averaged, etc.). The drawback of the flexibility is that the likelyhood of required calculations - subsequent to retrieval of the values - increases in order to result in rates or statistical data needed for monitoring and reporting.

### Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods

## Class Hierarchy

CIM_ManagedElement
|
+--CIM_StatisticalData
|
+--CIM_SWRStatistics
|
+--CIM_SWRAllocationStatistics

## Direct Known Subclasses

## Class Qualifiers

Name | Data Type | Value
--- | --- | ---
Description | string | The metrics of SWRAllocationStatistics describe the allocation of the software resource. The allocation is basically the size of the software resource in terms of technical units (e.g., kB) or domain-specific units (e.g., the number of items (e.g., the number of messages if the software resource is of the type 'queue'). The operational parameters regarding the allocation limits are surfaced also. Further details can be found in the description of the base class SWRStatistics. The metrics found in this statistics are raw values that describe the allocation behavior of the software resource as simple as possible. Thus, the metric values can be used most flexibly (e.g., cumulative, averaged, etc.). The drawback of the flexibility is that the likelyhood of required calculations - subsequent to retrieval of the values - increases in order to result in rates or statistical data needed for monitoring and reporting.
Experimental | boolean | true
UMLPackagePath | string | CIM::Application::SWResources
Version | string | 2.8.1000

## Class Properties

### Local Class Properties

Name | Data Type | Default Value | Qualifiers
--- | --- | --- | ---
Name | Data Type | Value
AllocationHighWaterMark | uint32 |
Description | string | AllocationHighWaterMark describes allocation peak (highest allocation level) reached throughout the sample interval. The unit depends on the type of the statistics. The timestamp that corresponds to the high water mark is not presented since the sample interval is small enough that the exact point in time is not significant. The metric is targeted to quantify errors like the violation of the upper limit or any capacity problems. A value of null indicates that no allocation level is available. The initial value is 0.
ModelCorrespondence | string | CIM_SWRStatistics.Unit, CIM_SWRAllocationStatistics.AllocationHighWaterMark
AllocationLevel | uint32 |
Description | string | AllocationLevel describes the current size of the software resource in units corresponding to the type of the statistics (e.g., technical based on Kilobytes). The unit can be found at the CIM_SWRStatistics.Unit. The metric is a point metric and applies to the point in time of the end of the sample interval. A value of null indicates that no allocation level is available. The initial value is 0.
ModelCorrespondence | string | CIM_SWRStatistics.Unit
AverageItemResidenceTime | datetime |
Description | string | AverageItemResidenceTime describes the average period of time that items reside in the software resource. This is particular interesting for blocked or (volatile) storage software resources. The average takes all items into account that are output from the software resource (i.e., the items' residence time ends). A value of null indicates that no average is available. The initial value is 0.
DroppedAllocationQuantity | uint32 |
Description | string | DroppedAllocationQuantity allows to further quantify the error of the software resource is over-used and upper limits are reached. In such a case, aging algorithms or other priorization algorithms implemented by the software resource may enforce the deletion of items. DroppedAllocationQuantity counts the items dropped due the resolution of such an overload. The metric's unit depends on the type of the statistics. If no items have been dropped, the value is 0. The property value is null if no numeric value can be provided. The initial value is 0.
HighWaterMarkTimeStamp | datetime |
Description | string | HighWaterMarkTimeStamp is the point in time at which the high water mark was detected. The initial value is 0.
ModelCorrespondence | string | CIM_SWRAllocationStatistics.AllocationHighWaterMark
OtherAllocationLevel | uint32 |
Description | string | OtherAllocationLevel describes the current size of the software resource in complementary units compared to AllocationLevel (e.g., domain-specific units like the number of items: buffered objects or pooled connections). The unit can be found at CIM_SWRStatistics.OtherUnit. The metric is a point metric and applies to the point in time of the end of the sample interval. A value of null indicates that no allocation level is available. The initial value is 0.
ModelCorrespondence | string | CIM_SWRStatistics.OtherUnit, CIM_SWRAllocationStatistics.AllocationLevel

### Inherited Properties

Name | Data Type | Class Origin
--- | --- | ---
Caption | string | CIM_ManagedElement
Characteristic | uint16 | CIM_SWRStatistics
Description | string | CIM_ManagedElement
ElementName | string | CIM_StatisticalData
ErrorCount | uint32 | CIM_SWRStatistics
FirstError | uint16 | CIM_SWRStatistics
FirstErrorTimeStamp | datetime | CIM_SWRStatistics
Generation | uint64 | CIM_ManagedElement
InstanceID | string | CIM_StatisticalData
LastError | uint16 | CIM_SWRStatistics
LastErrorTimeStamp | datetime | CIM_SWRStatistics
LowerLimit | uint32 | CIM_SWRStatistics
OtherLowerLimit | uint32 | CIM_SWRStatistics
OtherUnit | string | CIM_SWRStatistics
OtherUpperLimit | uint32 | CIM_SWRStatistics
RateIntervalEndTime | datetime | CIM_StatisticalData
RateIntervalStartTime | datetime | CIM_StatisticalData
SampleInterval | datetime | CIM_StatisticalData
StartStatisticTime | datetime | CIM_StatisticalData
StatisticsType | uint16 | CIM_SWRStatistics
StatisticTime | datetime | CIM_StatisticalData
Unit | string | CIM_SWRStatistics
UpperLimit | uint32 | CIM_SWRStatistics

## Class Methods

### Inherited Class Methods

Name | Return Type | Class Origin
--- | --- | ---
ResetSelectedStats | uint32 | CIM_StatisticalData