SUMMARY: NESTED | FIELD | | METHOD
DETAIL: FIELD | METHOD

Class CIM_StatisticalData

CIM_ManagedElement
   extended by CIM_StatisticalData


Abstract class CIM_StatisticalData
 extends CIM_ManagedElement


General Information:
CIM_StatisticalData is a root class for any 
arbitrary collection of statistical data and/or metrics applicable to one or 
more ManagedElements. These statistics MUST represent the most recent 
observations and MUST NOT be provided if irrelevant or stale. Note that this 
class uses a simplified naming/identity algorithm as compared to 
CIM_StatisticalInformation.

Qualifiers:
-------------
Abstract
Version=2.19.0
UMLPackagePath=CIM::Core::Statistics









  
  

    Supported Fields 
      Summary

  

     string 
      
    Description 
The 
      Description property provides a textual description of the object.

  

     string 
      
    Caption 
The Caption 
      property is a short textual description (one- line string) of the 
      object.

  

     string 
      
    InstanceID Key  
Within the scope of the instantiating Namespace, 
      InstanceID opaquely and uniquely identifies an instance of this class . . 
      .

  

     string 
      
    ElementName 
The 
      user friendly name for this instance of StatisticalData . . .

  

     datetime 
      
    StartStatisticTime 
      
The time, relative to managed element where the statistic was 
      collected, when the first measurement was taken . . .

  

     datetime 
      
    StatisticTime 
The 
      time the most recent measurement was taken, relative to the managed 
      element where the statistic was collected.

  

     datetime 
      
    SampleInterval 
      
Some statistics are sampled at consistent time intervals . . 
      .




  
  

    Methods Summary

  

     uint32
    ResetSelectedStats(SelectedStatistics) 
      
Method to reset one or more of the instance's statistics . . .

  

     
    Create(Instance, 
      ResourceCreated) 
Creates a new instance of this class

  

     
    Put(Instance) 
Changes 
      properties of the selected instance

  

     
    Get(Instance) 
Gets the 
      representation of the instance

  

     
    Delete() 
Deletes an 
      instance

  

     
    Pull(EnumerationContext, 
      MaxElements) 
Pulls instances of this class, following an 
      Enumerate operation

  

     
    Enumerate() 
      
Enumerates the instances of this class

  

     
    Release(EnumerationContext) 
      
Releases an enumeration context

  

     
    Subscribe() 
      
Subscribes to this resource (WS-Eventing)

  

     
    Unsubscribe() 
      
Remove subscription to this resource 
  (WS-Eventing)




  
  

    Field 
Detail


Description 
public string Description



  
General Information:
The Description property provides a textual 
  description of the 
  object.

Qualifiers:
-------------
MaxLen=256


  

  





Caption 
public string Caption



  
General Information:
The Caption property is a short textual 
  description (one- line string) of the 
  object.

Qualifiers:
-------------
MaxLen=64


  

  





InstanceID Key 
public string InstanceID



  
General Information:
Within the scope of the instantiating 
  Namespace, InstanceID opaquely and uniquely identifies an instance of this 
  class. In order to ensure uniqueness within the NameSpace, the value of 
  InstanceID SHOULD be constructed using the following 'preferred' algorithm: 
  
<OrgID>:<LocalID> 
Where <OrgID> and <LocalID> 
  are separated by a colon ':', and where <OrgID> MUST include a 
  copyrighted, trademarked or otherwise unique name that is owned by the 
  business entity creating/defining the InstanceID, or is a registered ID that 
  is assigned to the business entity by a recognized global authority (This is 
  similar to the <Schema Name>_<Class Name> structure of Schema 
  class names.) In addition, to ensure uniqueness <OrgID> MUST NOT contain 
  a colon (':'). When using this algorithm, the first colon to appear in 
  InstanceID MUST appear between <OrgID> and <LocalID>. 
  
<LocalID> is chosen by the business entity and SHOULD not be re-used 
  to identify different underlying (real-world) elements. If the above 
  'preferred' algorithm is not used, the defining entity MUST assure that the 
  resultant InstanceID is not re-used across any InstanceIDs produced by this or 
  other providers for this instance's NameSpace. 
For DMTF defined instances, 
  the 'preferred' algorithm MUST be used with the <OrgID> set to 
  'CIM'.

Qualifiers:
-------------
Key
Override=InstanceID
MaxLen=256


  

  





ElementName 
public string ElementName



  
General Information:
The user friendly name for this instance of 
  StatisticalData. In addition, the user friendly name can be used as a index 
  property for a search of query. (Note: Name does not have to be unique within 
  a 
  namespace.)

Qualifiers:
-------------
Required
Override=ElementName
MaxLen=256


  

  





StartStatisticTime 
public datetime StartStatisticTime



  
General Information:
The time, relative to managed element where 
  the statistic was collected, when the first measurement was taken. If the 
  statistic is reset, the StartStatisticTime is the time when the reset was 
  performed.

  

  





StatisticTime 
public datetime StatisticTime



  
General Information:
The time the most recent measurement was 
  taken, relative to the managed element where the statistic was collected.

  

  





SampleInterval 
public datetime SampleInterval



  
General Information:
Some statistics are sampled at consistent 
  time intervals. This property provides the sample interval so that client 
  applications can determine the minimum time that new statistics should be 
  pulled. If the statistics are not sampled at consistent time intervals, this 
  property must be set to a zero time interval.

  

  






  
  

    Method 
Detail


ResetSelectedStats
public uint32 ResetSelectedStats([IN]string SelectedStatistics[])



  
Permission Information:
No permissions defined

General 
  Information:
Method to reset one or more of the instance's statistics. 
  The method takes one parameter as input - an array of strings indicating which 
  statistics to reset. If all the statistics in the instance should be reset, 
  the first element of the array MUST be set to "All" or "ALL". If one or more 
  individual statistics should be reset, the corresponding property names are 
  entered into the elements of the array. 
The method returns 0 if 
  successful, 1 if not supported, and any other value if an error occurred. A 
  method is specified so that the StatisticalInformation's provider/ 
  instrumentation, which calculates the statistics, can reset its internal 
  processing, counters, etc. 
In a subclass, the set of possible return codes 
  could be specified, using a ValueMap qualifier on the method. The strings to 
  which the ValueMap contents are 'translated' may also be specified in the 
  subclass as a Values array 
  qualifier.

Parameters:
--------------

  

    
SelectedStatistics 
    
General Information:
Array of strings indicating which 
    statistics to 
    reset.

Qualifiers:
-------------
IN







Create
public  Create([IN]CIM_StatisticalData Instance, [OUT] REF CIM_StatisticalData ResourceCreated)



  
Permission Information:
No permissions defined

General 
  Information:
Creates a new instance of this class

Product 
  Specific Usage:
The following properties must be included in any 
  representation of CIM_StatisticalData: 

InstanceID 
ElementName 
  






Put
public  Put([IN]CIM_StatisticalData Instance)



  
Permission Information:
No permissions defined

General 
  Information:
Changes properties of the selected 
  instance

Product Specific Usage:
The following properties 
  must be included in any representation of CIM_StatisticalData: 
  

InstanceID 
ElementName 






Get
public  Get([OUT]CIM_StatisticalData Instance)



  
Permission Information:
No permissions defined

General 
  Information:
Gets the representation of the instance





Delete
public  Delete()



  
Permission Information:
No permissions defined

General 
  Information:
Deletes an instance





Pull
public  Pull([IN]String EnumerationContext, [IN]String MaxElements)



  
Permission Information:
All users permitted to use method, only 
  instances to whom the user has permissions will be returned

General 
  Information:
Pulls instances of this class, following an Enumerate 
  operation





Enumerate
public  Enumerate()



  
Permission Information:
All users permitted to use 
  method

General Information:
Enumerates the instances of this 
  class





Release
public  Release([IN]String EnumerationContext)



  
Permission Information:
All users permitted to use 
  method

General Information:
Releases an enumeration 
  context





Subscribe
public  Subscribe()



  
Permission Information:
No permissions defined

General 
  Information:
Subscribes to this resource (WS-Eventing)





Unsubscribe
public  Unsubscribe()



  
Permission Information:
No permissions defined

General 
  Information:
Remove subscription to this resource 
(WS-Eventing)






  
  

    SUMMARY: NESTED | FIELD | METHOD
  

  

    DETAIL: FIELD | METHOD



  
  

    
      
Copyright © 2006-2022, Intel 
      Corporation. All rights 
reserved.