xml.Ogema.xsd Maven / Gradle / Ivy
The name of the resource, as returned by
Resource.getName(). Even write requests sent to REST must
contain this field with a matching entry.
Resource type. Same as Resource.getResourceType().
Even write requests sent to REST must contain this field with a matching entry.
Complete path of the resource, i.e. "toplevelname/subname1/.../parentname".
This is always included in responses. In messages sent to the framework, this field is ignored.
True if the resource is a decorator, false if element of the data model.
Optional for sending data to REST, always included in responses.
True if the resource is active, false if not.
In write requests to the REST interface, this can be used to activate or deactivate a resource active-state
(default if not included in message: Leave status unchanged). Always included in response by framework.
Field only exists if the resource is a reference. This references to
the "true" location of the resource.
In a POST request, using this field can be used to create a reference to
instead of a "real" subresource.
Common basis class for a resource. All resources
are either primitive (FloatResource, BooleanResource, ...) or
non-primitive (type Resource) or schedules (FloatSchedule, ...).
This defines common entries that all resources can have. The same
xml structures are used for PUT/POST and GET commands. Therefore,
few of the fields are defined as required, allowing PUT/POST commands
to be reduced to the minimum amount of information. For GET requests,
however, OGEMA should send as complete documents as possible.
A subresource of the resource. Write requests to REST can add any number or sub-resources if
they shall be written in the same write transaction. Framework responses always contain all
non-schedule subresources that are active and are not contained in the response anywhere else
(to avoid infinite-sized response messages in case of cross-references creating a subresource-loop).
A link to a sub-resource. In write requests to the REST interface, these are ignored (for having
no sensible meaning). Read requests may, under certain conditions, return a sub-resource as a
link rather than embedding it into as return message. These conditions are:
- Resource is a schedule: Being potentially large, schedules have to be addressed explicitly.
- Resource is inactive: The existance of the resource is shown, but its content is probably
not interesting, anyways.
- The resource is already contained in other parts of the same message. This scenario can occur
due to referencing, especially when references create cyclic loops. This is case is mostly a
safeguard. It guarantees that the resource information is somewhere in the message. But is does
not define where exactly it will be found.
A link to another resource. This is used in the users' entry pages, for adding
sub-resources as references and possibly for terminating loop sequences of sub-resources.
URI of the sub-resource, relative to the location
of the top-level
resources.
Type of the sub-resource. Must equal
sub-resource's type field.
Name of the sub-resource. Must equal
sub-resource's name field.
Representation of an OGEMA ResourceList.
OGEMA resource type of this list's elements.
Representation for an OGEMA primitive
BooleanResource.
Actual value of the primitive resource.
Representation for an OGEMA primitive
FloatResource.
Actual value of the resource.
Physical unit of the value.
Representation for an OGEMA primitive
IntegerResource.
Actual value of the resource.
Representaion for an OGEMA primitive
OpaqueResource.
The byte array of the resource, encoded as a
base64Binary string.
Representation for an OGEMA primitive
StringResource.
Actual value of the resource.
Representation for an OGEMA primitive TimeResource.
Actual value of the resource.
Representation for an OGEMA BooleanArrayResource.
Actual value of the resource.
Representaion for an OGEMA ByteArrayResource.
The byte array of the resource, encoded as a
base64Binary string.
Representation for an OGEMA FloatArrayResource.
Actual value of the resource.
Representation for an OGEMA IntegerArrayResource.
Actual value of the resource.
Representation for an OGEMA BooleanArrayResource.
Array values.
Representation for an OGEMA TimeArrayResource.
Actual value of the resource.
XML representation of an OGEMA SampledValue data type.
This is the base class for more specialized SampledValues.
Timestamp for the entry, defined as ms since 1.1.1970.
Optional indicator for the quality of the value. In case of a statistical value,
this is defined as the square root of the statistical variance. Otherwise,
it is anolgously defined as an expected inaccurancy. Exact values are
indicated by this being zero, "bad" values by this being positive infinity.
If quality is not indicated, the value is considered to be perfect.
The value of this sample, concrete type will be set in
SampledValue sub types derived by restriction.
Representation for boolean-typed SampledValue
Representation for float-typed SampledValue
Representation for integer-typed SampledValue
Representation for opaque-typed SampledValues
The byte array of the resource, encoded as a
base64Binary string.
Representation for string-typed SampledValue
Representation for SampledValue representing a time.
Optional for documents that are sent to an
OGEMA instance: Values in this schedule will replace schedule values
in the range [start, end)
Optional for documents that are sent to an
OGEMA instance: Values in this schedule will replace schedule values
in the range [start, end)
An entry in the schedule.
A schedule of boolean values. Note that internally OGEMA does not know typed
schedules, but the appropriate schedule type can be inferred from schedules
always decorating a primitive resource.
A schedule of floating point values. Note that internally OGEMA does not know typed
schedules, but the appropriate schedule type can be inferred from schedules
always decorating a primitive resource.
A schedule of integer values. Note that internally OGEMA does not know typed
schedules, but the appropriate schedule type can be inferred from schedules
always decorating a primitive resource.
A schedule of Opaque resources (arbitrary byte arrays). Note that internally OGEMA does not know typed
schedules, but the appropriate schedule type can be inferred from schedules
always decorating a primitive resource.
A schedule of Strings. Note that internally OGEMA does not know typed
schedules, but the appropriate schedule type can be inferred from schedules
always decorating a primitive resource.
A schedule of time values. Note that internally OGEMA does not know typed
schedules, but the appropriate schedule type can be inferred from schedules
always decorating a primitive resource.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy