8.2 Resource section outlines
8.2.1 Introduction
This subclause gives the reader a basic understanding of the outline of each of the sections describing the resources of IEEE Std 2030.5. The intent is that each of these resources can be implemented on independent servers or grouped to coexist on a single server. Keep in mind that these resources or function sets are defined in three documents, IEEE Std 2030.5 (this document), the IEEE Std 2030.5 XML Schema, and the IEEE Std 2030.5 WADL described in IEEE Std 2030.5 supplemental material. All three need to be consulted to get a full understanding of IEEE Std 2030.5.
The resource sections follow a standard “template,” sometimes modified based on unique circumstances. Each section is outlined as follows:
1. Overview
2. List ordering
3. Application guidelines/behavior
4. LogEvents
Each of these sections is discussed in more detail below.
8.2.2 Overview
Contains a brief, three-to-four sentence, informative description of the functionality provided by the function set or resource. It does not state normative requirements.
8.2.3 List ordering
This subclause provides guidance regarding how resource elements and attributes are used to support unique ordering of resources within lists.
Table 18 —Function set list ordering
Resource name | Primary key | Secondary key | Tertiary key |
Resource | Resource.elementA (descending or ascending) | Resource.elementC (descending or ascending) | N/A |
Sub-Resource | Sub-Resource.elementD (descending or ascending) | Sub-Resource.elementB (descending or ascending) | N/A |
8.2.4 Application guidelines/behavior
This subclause describes the normative, high-level behavior of the function set and defines how the function set resources are used by clients and servers to accomplish the goals of the function set. Normative definitions of resource elements and attributes can be found in the XML Schema described in the supplemental material of IEEE Std 2030.5. This subclause contains non-trivial information about resources that is too complex to be represented in the XML Schema and non-functional requirements for clients and servers (e.g., minimum/recommended support for resource instances).
This subclause may also include application guidelines germane to sleepy HAN devices.
8.2.5 LogEvents
This subclause includes definitions of all LogEvents that may be raised by the function set. Note that function sets locally define their own LogEvent cardinal values, which typically will not be unique across function sets. The function set specific LogEvent codes are combined with a function set identifier to produce a unique code.
All LogEvent definitions are presented in the format shown by Table 19.
Table 19 —Example LogEvents
LogEvent name | LogEvent code | LogEvent description |
LE_EXAMPLE_0 | 0x00 | Normative text defining when the event should be generated |
LE_EXAMPLE_1 | 0x01 | Normative text defining when the event should be generated |