semi合集-English.pdf - 第3103页

SEMI E125-0305 © SEMI 2003, 2005 11 9.1.2.10 NotifyOn Revisions — Upon receiving this request, the equipm en t shall either enable or disable metadata revision notice s to the requesting client, bas ed on the operation a…

100%1 / 7923
SEMI E125-0305 © SEMI 2003, 2005 10
9.1.2.7.1 GetEquipmentNodeDescriptions Operation Arguments
Table 12 GetEquipmentNodeDescriptions Argument Definitions
Argument Description Kind Form
equipmentNodeIds The id’s of the requested equipment
node descriptions
in List of text, each entry equal to a valid SEMI E120
Locator value (see E120, Related Information 2). If
an empty list is provided, the equipment shall return
node descriptions for all equipment nodes.
equipmentNodeDescriptions All equipment node description
metadata.
out Structured data of type NodeDescriptionResult.
Figure 4
Interface for Accessing Equipment Metadata
9.1.2.8 NodeDescriptionResult — This class provides the list of requested EquipmentNodeDescription elements
and any unrecognized equipment node id’s that may have been provided with the request.
9.1.2.8.1 NodeDescriptionResult Attribute Definition Table
Table 13 NodeDescriptionResult Attribute Definition
Attribute Name Definition Form
unrecognizedIds Any unrecognized equipment node identifiers
provided in the original request.
List of text, each entry equal to an unrecognized
equipment node identifier provided in the
GetEquipmentNodeDescriptions request.
9.1.2.8.2 NodeDescriptionResult Association Definition Table
Table 14 NodeDescriptionResult Association Definition
Association Role Name Definition Comments
nodeDescriptions The requested equipment node description metadata. Zero or more elements of type
EquipmentNodeDescription. The
equipment shall return node description
metadata for all recognized equipment
node identifiers. If the same node
identifier appears more than once in the
request, the equipment shall return only
one corresponding node description.
9.1.2.9 GetLatestRevision — Upon receiving this request, the equipment shall return the most recent date and time
at which the metadata contents were changed. The equipment shall store the date and time of the most recent
change in non-volatile memory. The equipment shall not generate false revision dates, in which there is no change
in the available metadata, but the latest revision date/time is changed.
9.1.2.9.1 GetLatestRevision Operation Arguments
Table 15 GetLatestRevision Argument Definitions
Argument Description Kind Form
revision The most recent date and time at which the
metadata was changed.
out Structured data of type MetadataRevision, described
in Section 9.1.2.11 .
EquipmentNodeDescription
1
0..*
nodeDescriptions
NodeDescriptionResult
unrecognizedIds
SEMI E125-0305 © SEMI 2003, 2005 11
9.1.2.10 NotifyOnRevisions — Upon receiving this request, the equipment shall either enable or disable metadata
revision notices to the requesting client, based on the operation arguments provided by the client. The equipment
shall store the client’s preference in non-volatile memory.
9.1.2.10.1 NotifyOnRevisions Operation Arguments
Table 16 NotifyOnRevisions Argument Definitions
Argument Description Kind Form
notification Specifies the client’s notification
preference.
in Structured data of type NotificationRequest,
described in Section 9.1.2.12 .
9.1.2.10.2 Clients must invoke this operation with the ‘enable’ attribute of the notification argument set to ‘true’ in
order to receive notifications. The default behavior for revision notifications for a given client is disabled. The
equipment shall automatically disable notification for a client if the equipment is in an enabled communications
state and determines that the client is no longer accessible to receive such notifications. In this case, the client must
invoke this operation in order to re-enable notifications.
9.1.2.10.3 If the ‘enable’ attribute of the notification argument provided is ‘true’, the equipment shall begin
notifying the client (if it is not already doing so) whenever a change in the metadata is detected, starting with the
first detected change after the client invokes the operation. If the change is detected while the equipment is in a
disabled communications state, the equipment shall notify the interested clients at the first opportunity when its
communication status permits.
9.1.2.10.4 If the ‘enable’ attribute of the notification argument provided is ‘false’, the equipment shall cease
sending revision notifications to the client, if it is currently doing so. The equipment shall ignore duplicate
enable/disable requests from the same client (see limitations, Section 3 ).
Figure 5
Metadata Revision
9.1.2.11 MetadataRevision — This class describes the most recent metadata revision date and time.
9.1.2.11.1 MetadataRevision Attribute Definition Table
Table 17 MetadataRevision Attribute Definition
Attribute Name Definition Form
revisionDate The most recent date and time at which the
equipment metadata has changed.
Text, formatted according to ISO 8601.
Implementations may specify additional formatting
restrictions within the 8601 specification.
Figure 6
Notification Request
MetadataRevision
revisionDate
NotificationRequest
enable
SEMI E125-0305 © SEMI 2003, 2005 12
9.1.2.12 NotificationRequest — This class describes the notification preferences of the metadata client.
9.1.2.12.1 NotificationRequest Attribute Definition Table
Table 18 NotificationRequest Attribute Definition
Attribute Name Definition Form
enable The client’s preference for revision notification. Boolean. If true, the client’s preference is to be
notified of metadata revisions. If false, the
preference is to not be notified of metadata revisions.
9.2 Metadata Client
9.2.1 Figure 7 shows the interface and argument data types that clients must support in order to receive metadata
revision notifications.
Figure 7
Metadata Client Interface
9.2.2 MetadataClient Operations
Table 19 MetadataClient Operation Definition
Operation Description Type
MetadataRevised Notifies the client that the metadata has recently changed. FF
9.2.2.1 MetadataRevised — The equipment shall send this notification whenever it detects a change in the
metadata, if the client has requested to be notified through a prior invocation of the “NotifyOnRevisions” operation
of the EquipmentMetadataManager interface.
9.2.2.1.1 MetadataRevised Operation Arguments
Table 20 MetadataRevised Argument Definitions
Argument Description Kind Form
revision The date and time at which the metadata
change was detected by the equipment.
in Structured data of type RevisionNotice, described in
Section 9.2.2.2 .
MetadataRevised(in newRevision : RevisionNotice)
MetadataClient
«interface»
EquipmentElement
CEM::
equipment
RevisionNotice
11
1
newRevision
1
MetadataRevision
revisionDate