semi合集-English.pdf - 第3101页

SEMI E125-0305 © SEMI 2003, 2005 9 9.1.2.3. 1 GetStateMa chines Operation Argumen ts Table 8 GetStateMachines Argument Definitions Argument Description Kind Form stateMachines All state mach ine metad ata provided by the…

100%1 / 7923
SEMI E125-0305 © SEMI 2003, 2005 8
GetUnits() : Unit[]
GetTypeDefinitions() : ParameterTypeDefinition[]
GetStateMachines() : StateMachine[]
GetSEMIObjTy pes() : SEMIObjT ype[]
GetExc ept ions() : Ex cept ion[]
GetEquipment Structure() : EquipmentElement[ ]
GetEquipment NodeDesc riptions(in equipmentNodeIds : String[]) : NodeDesc riptionRes
u
GetLatestRevision() : Met adataRevis ion
NotifyOnRevisions(in notification : NotificationR equest)
«interface»
EquipmentMetadataManager
Figure 3
Interface for Accessing Equipment Metadata
9.1.2 EquipmentMetadataManager Operations
Table 5 EquipmentMetadataManager Operation Definition
Operation Description Type
GetUnits Retrieves all unit metadata provided by the equipment. RR
GetTypeDefinitions Retrieves all type definitions provided by the equipment. RR
GetStateMachines Retrieves all state machine metadata provided by the equipment. RR
GetSEMIObjTypes Retrieves all SEMI ObjTypes metadata provided by the equipment. RR
GetExceptions Retrieves all exception metadata provided by the equipment. RR
GetEquipmentStructure Retrieves all equipment structural metadata provided by the equipment. RR
GetEquipmentNodeDescriptions Retrieves all requested equipment node description metadata. RR
GetLatestRevision Retrieve the last date and time at which the equipment metadata was revised RR
NotifyOnRevisions Request that the equipment notify the requestor when changes to the metadata are
made
RR
9.1.2.1 GetUnits — Upon receiving this request, the equipment shall return all units metadata provided by the
equipment.
9.1.2.1.1 GetUnits Operation Arguments
Table 6 GetUnits Argument Definitions
Argument Description Kind Form
units All units defined for the equipment. out Unordered list of elements of type Unit, described in
Section 10.6 .
9.1.2.2 GetTypesDefinitions — Upon receiving this request, the equipment shall return all type definition metadata
provided by the equipment.
9.1.2.2.1 GetTypesDefinitions Operation Arguments
Table 7 GetTypesDefinitions Argument Definitions
Argument Description Kind Form
typeDefinitions All type definitions provided by the
equipment.
out Unordered list of elements of type
ParameterTypeDefinition, described in Section 10.5 .
9.1.2.3 GetStateMachines — Upon receiving this request, the equipment shall return all state machine metadata
provided by the equipment.
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