# ##############################################################
#
# File: utilization.rnc - Specialized schema for the
# measure of interface utilization
# Version: $Id: utilization.rnc,v 1.12 2006/02/09 05:32:51 zurawski Exp $
# Purpose: Describes specific elements to be used in the
# representation and handling of interface
# utilization
# Reference: http://books.xmlschemata.org/relaxng/page2.html
#
# ##############################################################
# ##############################################################
# Namespace definitions
# ##############################################################
namespace nmwg = "http://ggf.org/ns/nmwg/base/2.0/"
namespace utilization = "http://ggf.org/ns/nmwg/characteristic/utilization/2.0/"
# ##############################################################
# Include additional functionality from other files
# ##############################################################
include
"nmtopo.rnc"
include
"nmbase.rnc" {
Metadata |= UtilizationMetadata
Data |= UtilizationData
}
# ##############################################################
# Metadata is the 'data' that describes physical measurements.
# Metadata can be something such as a physical address, or
# a geographical location; any form of static, re-usable
# designation. It is important to note that the subject
# namespace and parameters namespace MUST match (or the parameters
# can be a generic NMWG) or bad things will occur.
#
# Example:
#
#
# metadataIdRef="OPTIONAL_REFERENCE_ID"
# xmlns:nmwg="http://ggf.org/ns/nmwg/base/2.0/">
#
# <!-- TBD OPTIONAL SUBJECT -->
#
# <!-- TBD OPTIONAL PARAMETERS -->
#
# <!-- TBD OPTIONAL EVENTTYPE -->
#
# <!-- TBD OPTIONAL KEY -->
#
# <!-- ANY OPTIONAL (MULTIPLE) ELEMENT IN ANY NAMESPACE -->
#
#
#
# ##############################################################
UtilizationMetadata =
element
nmwg:metadata
{
Identifier &
MetadataIdentifierRef? &
UtilizationMetadataContent
}
UtilizationMetadataBlock =
UtilizationSubject? &
(
UtilizationParameters |
Parameters
)?
UtilizationMetadataContent =
(
UtilizationMetadataBlock |
FilterMetadataBlock
) &
EventType? &
Key?
# ##############################################################
# Redefined utilization subject allows only an interface, and
# the two id attributes.
#
# Example:
#
#
# metadataIdRef="OPTIONAL_REFERENCE_ID"
# xmlns:nmwg="http://ggf.org/ns/nmwg/tools/utilization/2.0/">
#
#
#
# TEXT
#
# TEXT
#
# TEXT
#
# TEXT
#
# TEXT
#
# TEXT
#
# TEXT
#
# TEXT
#
# TEXT
#
# TEXT
#
# TEXT
#
# TEXT
#
#
#
#
#
# ##############################################################
UtilizationSubject =
element
utilization:subject
{
Identifier &
MetadataIdentifierRef? &
Interface
}
# ##############################################################
# This is simply the regular method of doing parameters with an
# enumeration to limit what 'names' are accepted and an outer
# utilization: namespace for the parameters.
#
# Example:
#
#
# xmlns:nmwg="http://ggf.org/ns/nmwg/tools/utilization/2.0/">
#
#
# xmlns:nmwg="http://ggf.org/ns/nmwg/base/2.0/">
#
# <!-- ANY TEXT, (IF YOU DID NOT USE THE VALUE ATTRIBUTE) -->
#
#
#
# <!-- MORE PARAMETERS -->
#
#
#
# ##############################################################
UtilizationParameters =
element
utilization:parameters
{
Identifier &
UtilizationParameter+
}
UtilizationParameter =
element
nmwg:parameter
{
attribute name { "interval" | "valueUnits" } &
(
attribute value { text } |
text
)
}
# ##############################################################
# The data block is complex, and has the potential to contain
# many things. The data block can be used to return a metadata
# block from a request, commonTime or datum elements, keys,
# or something that we have perhaps not defined as of yet.
#
# Example:
#
#
# metadataIdRef="OPTIONAL_REFERENCE_ID"
# xmlns:nmwg="http://ggf.org/ns/nmwg/base/2.0/">
#
# <!-- OPTIONAL (MULTIPLE) METADATA -->
#
# <!-- OR -->
#
# <!-- TBD OPTIONAL (MULTIPLE) COMMON TIME ELEMENTS AND
# OPTIONAL (MULTIPLE) DATUM ELEMENTS-->
#
# <!-- OR -->
#
# <!-- TBD OPTIONAL (MULTIPLE) DATUM ELEMENTS -->
#
# <!-- OR -->
#
# <!-- OPTIONAL (MULTIPLE) KEY ELEMENTS -->
#
# <!-- OR -->
#
# <!-- ANY OPTIONAL (MULTIPLE) ELEMENT IN ANY NAMESPACE -->
#
#
#
# ##############################################################
UtilizationData =
element
nmwg:data
{
Identifier &
MetadataIdentifierRef? &
(
(
Metadata* |
UtilizationMetadata*
) |
(
UtilizationCommonTime+ &
UtilizationDatum*
) |
UtilizationDatum* |
Key*
)
}
# ##############################################################
# CommonTime is used a a shortcut able to 'factor out' a frequently
# occurring time range that a bunch of datum (or other) elements
# might share, thus reducing complexity of XML representation.
# CommonTime is similar to the other NMWG time stamps (from
# nmtime.rnc) in its potential time representations.
#
# Example:
#
#
# duration="OPTIONAL_DURATION"
# inclusive="OPTIONAL_INCLUSIVE_FLAG"
# xmlns:nmwg="http://ggf.org/ns/nmwg/base/2.0/">
#
# <!-- TBD OPTIONAL START TIME ELEMENT (USE END TIME OR DURATION) -->
#
# <!-- TBD OPTIONAL END TIME ELEMENT (ONLY WITH START TIME) -->
#
# <!-- TBD OPTIONAL TIME VALUE ELEMENT (USE IF NO VALUE ATTRIBUTE) -->
#
# <!-- TBD OPTIONAL (MULTIPLE) DATUM ELEMENTS -->
#
# <!-- ANY OPTIONAL (MULTIPLE) ELEMENT IN ANY NAMESPACE -->
#
#
# ##############################################################
UtilizationCommonTime =
element
nmwg:commonTime
{
Type &
(
TimeStamp |
(
StartTime &
(
EndTime |
Duration
)
)
) &
UtilizationDatum*
}
# ##############################################################
# These are the basic elements we would expect to see in the
# specific iperf datum.
#
# Example:
#
#
# valueUnits="OPTIONAL_VALUE_UNITS"
# timeType="OPTIONAL_TIME_TYPE"
# timeValue="OPTIONAL_TIME_VALUE"
# xmlns:nmwg="http://ggf.org/ns/nmwg/tools/utilization/2.0/">
#
# <!-- TIME ELEMENT (IF ATTRIBUTES NOT USED) -->
#
#
#
# ##############################################################
UtilizationDatum =
element
utilization:datum
{
attribute value { xsd:float } &
attribute valueUnits { xsd:string }? &
(
(
attribute timeType { xsd:string } &
attribute timeValue { xsd:string }
) |
Time
)?
}