PeriCfgScanner (universAAL Super POM 3.4.2-SNAPSHOT API)

java.lang.Object
- org.universAAL.lddi.lib.ieeex73std.x73.p20601.dim.DIM
- - org.universAAL.lddi.lib.ieeex73std.x73.p20601.dim.MDS
  - - org.universAAL.lddi.lib.ieeex73std.x73.p20601.dim.Scanner
    - - org.universAAL.lddi.lib.ieeex73std.x73.p20601.dim.CfgScanner
      - org.universAAL.lddi.lib.ieeex73std.x73.p20601.dim.PeriCfgScanner

All Implemented Interfaces:

GET_Service, MDS_Events, PeriCfgScanner_Events
```
public class PeriCfgScanner
extends CfgScanner
implements PeriCfgScanner_Events
```
The PeriCfgScanner class represents a class that can be instantiated. PeriCfgScanner objects are used to send reports containing Periodic data, that is, data sampled during fixed periods. It buffers any data value changes to be sent as part of a periodic report. Event reports shall be sent with a time interval equal to the Reporting-Interval attribute value. The number of observations for each metric object is dependent on the metric object�s update interval and the scanner�s Reporting-Interval. Example: A periodic configurable scanner is set up to �scan� two metric objects with a Reporting-Interval of 1 s. The two objects update their corresponding observed value periodically with an interval of 1 s and � s, respectively. The periodic configurable scanner then issues event reports every second containing one observation scan of metric object #1 and two observation scans of metric object #2.

Field Summary
- Fields inherited from class org.universAAL.lddi.lib.ieeex73std.x73.p20601.dim.DIM
  objects

Constructor Summary

Constructors
Constructor and Description

PeriCfgScanner(LinkedList<Attribute> list)

Constructors
Constructor and Description
`PeriCfgScanner(LinkedList<Attribute> list)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`Buf_Scan_Report_Fixed(ScanReportInfoFixed srif)`
`void`	`Buf_Scan_Report_Grouped(ScanReportInfoGrouped srig)`
`void`	`Buf_Scan_Report_MP_Fixed(ScanReportInfoMPFixed srimpf)`
`void`	`Buf_Scan_Report_MP_Grouped(ScanReportInfoMPGrouped srimpg)`
`void`	`Buf_Scan_Report_MP_Var(ScanReportInfoMPVar srimpvar)`
`void`	`Buf_Scan_Report_Var(ScanReportInfoVar sriv)`
`void`	`GET()` The manager may request the MDS object attributes of the agent in which case the manager shall send the Remote Operation Invoke \| Get command (see roiv-cmip-get in A.10.2) with the reserved handle value of 0.
`int`	`getNomenclatureCode()`
`ConfigReportRsp`	`MDS_Configuration_Event(ConfigReport cfgreport)` This event is sent by the agent during the configuring state of startup if the manager does not already know the agent's configuration from past associations.
`void`	`MDS_Data_Request()`
`void`	`MDS_Dynamic_Data_Update_Fixed(ScanReportInfoFixed scanreportinfofixed)` This event provides dynamic data (typically measurements) from the agent for some or all of the metric objects or the MDS object that the agent supports.
`void`	`MDS_Dynamic_Data_Update_MP_Fixed(ScanReportInfoMPFixed scanreportinfompfixed)` This is the same as MDS-Dynamic-Data-Update-Fixed, but allows inclusion of data from multiple persons.
`void`	`MDS_Dynamic_Data_Update_MP_Var(ScanReportInfoMPVar scanreportinfompvar)` This is the same as MDS-Dynamic-Data-Update-Var, but allows inclusion of data from multiple persons.
`void`	`MDS_Dynamic_Data_Update_Var(ScanReportInfoVar scanreportinfovar)` This event provides dynamic data (typically measurements) from the agent for some or all of the objects that the agent supports.
`void`	`Set_Time()`

Methods inherited from class org.universAAL.lddi.lib.ieeex73std.x73.p20601.dim.DIM
addObjecttoDim, getObjectfromDim

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PeriCfgScanner
```
public PeriCfgScanner(LinkedList<Attribute> list)
               throws Exception
```
    Throws:
    
    Exception
- Method Detail
  - getNomenclatureCode
```
public int getNomenclatureCode()
```
    Overrides:
    
    getNomenclatureCode in class CfgScanner
  - MDS_Configuration_Event
```
public ConfigReportRsp MDS_Configuration_Event(ConfigReport cfgreport)
```
    Description copied from interface: MDS_Events
    
    This event is sent by the agent during the configuring state of startup if the manager does not already know the agent's configuration from past associations. The event provides static information about the supported measurement capabilities of the agent.
    
    Specified by:
    
    MDS_Configuration_Event in interface MDS_Events
  - MDS_Dynamic_Data_Update_Var
```
public void MDS_Dynamic_Data_Update_Var(ScanReportInfoVar scanreportinfovar)
```
    Description copied from interface: MDS_Events
    
    This event provides dynamic data (typically measurements) from the agent for some or all of the objects that the agent supports. Data for reported objects are reported using a generic attribute list variable format (see 7.4.5 for details on event report formats). The event is triggered by an MDS-Data- Request from the manager system, or it is sent as an unsolicited message by the agent. For agents that support manager-initiated measurement data transmission, refer to 8.9.3.3.3 for information on controlling the activation and/or period of the data transmission. For agents that do not support manager-initiated measurement data transmission, refer to 8.9.3.3.2 for information on the limited control a manager can assert.
    
    Specified by:
    
    MDS_Dynamic_Data_Update_Var in interface MDS_Events
  - MDS_Dynamic_Data_Update_Fixed
```
public void MDS_Dynamic_Data_Update_Fixed(ScanReportInfoFixed scanreportinfofixed)
```
    Description copied from interface: MDS_Events
    
    This event provides dynamic data (typically measurements) from the agent for some or all of the metric objects or the MDS object that the agent supports. Data are reported in the fixed format defined by the Attribute-Value-Map attribute for reported metric objects or the MDS object (see 7.4.5 for details on event report formats). The event is triggered by an MDS-Data-Request from the manager system (i.e., a manager-initiated measurement data transmission), or it is sent as an unsolicited message by the agent (i.e., an agent-initiated measurement data transmission). For agents that support manager-initiated measurement data transmission, refer to 8.9.3.3.3 for information on controlling the activation and/or period of the data transmission. For agents that do not support manager-initiated measurement data transmission, refer to 8.9.3.3.2 for information on the limited control a manager can assert.
    
    Specified by:
    
    MDS_Dynamic_Data_Update_Fixed in interface MDS_Events
  - MDS_Dynamic_Data_Update_MP_Var
```
public void MDS_Dynamic_Data_Update_MP_Var(ScanReportInfoMPVar scanreportinfompvar)
```
    Description copied from interface: MDS_Events
    
    This is the same as MDS-Dynamic-Data-Update-Var, but allows inclusion of data from multiple persons.
    
    Specified by:
    
    MDS_Dynamic_Data_Update_MP_Var in interface MDS_Events
  - MDS_Dynamic_Data_Update_MP_Fixed
```
public void MDS_Dynamic_Data_Update_MP_Fixed(ScanReportInfoMPFixed scanreportinfompfixed)
```
    Description copied from interface: MDS_Events
    
    This is the same as MDS-Dynamic-Data-Update-Fixed, but allows inclusion of data from multiple persons.
    
    Specified by:
    
    MDS_Dynamic_Data_Update_MP_Fixed in interface MDS_Events
  - GET
```
public void GET()
```
    Description copied from interface: GET_Service
    
    The manager may request the MDS object attributes of the agent in which case the manager shall send the Remote Operation Invoke | Get command (see roiv-cmip-get in A.10.2) with the reserved handle value of 0. The agent shall respond by reporting its MDS object attributes to the manager using the Remote Operation Response | Get response (see rors-cmip-get in A.10.2). In the response to a Get MDS Object command, only attributes implemented by the agent are returned.
    
    Specified by:
    
    GET in interface GET_Service
  - MDS_Data_Request
```
public void MDS_Data_Request()
```
    Specified by:
    
    MDS_Data_Request in class MDS
  - Set_Time
```
public void Set_Time()
```
    Specified by:
    
    Set_Time in class MDS
  - Buf_Scan_Report_Var
```
public void Buf_Scan_Report_Var(ScanReportInfoVar sriv)
```
    Specified by:
    
    Buf_Scan_Report_Var in interface PeriCfgScanner_Events
  - Buf_Scan_Report_Fixed
```
public void Buf_Scan_Report_Fixed(ScanReportInfoFixed srif)
```
    Specified by:
    
    Buf_Scan_Report_Fixed in interface PeriCfgScanner_Events
  - Buf_Scan_Report_Grouped
```
public void Buf_Scan_Report_Grouped(ScanReportInfoGrouped srig)
```
    Specified by:
    
    Buf_Scan_Report_Grouped in interface PeriCfgScanner_Events
  - Buf_Scan_Report_MP_Var
```
public void Buf_Scan_Report_MP_Var(ScanReportInfoMPVar srimpvar)
```
    Specified by:
    
    Buf_Scan_Report_MP_Var in interface PeriCfgScanner_Events
  - Buf_Scan_Report_MP_Fixed
```
public void Buf_Scan_Report_MP_Fixed(ScanReportInfoMPFixed srimpf)
```
    Specified by:
    
    Buf_Scan_Report_MP_Fixed in interface PeriCfgScanner_Events
  - Buf_Scan_Report_MP_Grouped
```
public void Buf_Scan_Report_MP_Grouped(ScanReportInfoMPGrouped srimpg)
```
    Specified by:
    
    Buf_Scan_Report_MP_Grouped in interface PeriCfgScanner_Events

Class PeriCfgScanner

Field Summary

Fields inherited from class org.universAAL.lddi.lib.ieeex73std.x73.p20601.dim.DIM

Constructor Summary

Method Summary

Methods inherited from class org.universAAL.lddi.lib.ieeex73std.x73.p20601.dim.DIM

Methods inherited from class java.lang.Object

Constructor Detail

PeriCfgScanner

Method Detail

getNomenclatureCode

MDS_Configuration_Event

MDS_Dynamic_Data_Update_Var

MDS_Dynamic_Data_Update_Fixed

MDS_Dynamic_Data_Update_MP_Var

MDS_Dynamic_Data_Update_MP_Fixed

GET

MDS_Data_Request

Set_Time

Buf_Scan_Report_Var

Buf_Scan_Report_Fixed

Buf_Scan_Report_Grouped

Buf_Scan_Report_MP_Var

Buf_Scan_Report_MP_Fixed

Buf_Scan_Report_MP_Grouped