semi合集-English.pdf - 第3102页

SEMI E125-0305 © SEMI 2003, 2005 10 9.1.2.7. 1 GetEquipmentNode Descriptions Operati on Argument s Table 12 GetEquipmen tNodeDescriptions Argument Definitions Argument Description Kind Form equipmentNodeIds The id’s of t…

100%1 / 7923
SEMI E125-0305 © SEMI 2003, 2005 9
9.1.2.3.1 GetStateMachines Operation Arguments
Table 8 GetStateMachines Argument Definitions
Argument Description Kind Form
stateMachines All state machine metadata provided by
the equipment.
out Unordered list of elements of type StateMachine,
described in Section 10.8 .
9.1.2.4 GetSEMIObjTypes — Upon receiving this request, the equipment shall return all OSS ObjType metadata
provided by the equipment.
9.1.2.4.1 GetSEMIObjTypes Operation Arguments
Table 9 GetSEMIObjTypes Argument Definitions
Argument Description Kind Form
objTypes All SEMI ObjType metadata provided by
the equipment.
out Unordered list of elements of type SEMIObjType,
described in Section 10.8 . If no SEMI ObjTypes are
provided, this list shall be empty.
9.1.2.5 GetExceptions — Upon receiving this request, the equipment shall return all exception metadata provided
the equipment.
9.1.2.5.1 GetExceptions Operation Arguments
Table 10 GetExceptions Argument Definitions
Argument Description Kind Form
exceptions All exception metadata provided by
the equipment.
out Unordered list of elements of type Exception,
described in Section 10.7 .
9.1.2.6 GetEquipmentStructure — Upon receiving this request, the equipment shall return all equipment structural
metadata provided by the equipment.
9.1.2.6.1 GetEquipmentStructure Operation Arguments
Table 11 GetEquipmentStructure Argument Definitions
Argument Description Kind Form
equipmentStructure All equipment structural metadata
provided by the equipment.
out Structured data, of a type derived from the SEMI
E120 type Link or EquipmentElement, that represents
the equipment as a whole.
9.1.2.7 GetEquipmentNodeDescriptions — Upon receiving this request, the equipment shall return all requested
equipment node description metadata defined for the equipment. If the request includes unrecognized equipment
node identifiers, the equipment shall return only node descriptions for recognized identifiers. All unrecognized
identifiers shall be returned with the response.
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