semi合集-English.pdf - 第1675页

SEMI E39-0703 © SEMI 1995, 2003 17 11.6.2 Co mments for the ObjSpec and ObjStatus parameters of GetAttr and SetAttr also apply to the parameters for the GetType service. 11.6.3 Table 6 define s the parameters for t he Ge…

100%1 / 7923
SEMI E39-0703 © SEMI 1995, 2003 16
information in Status, indicating the error and the
attribute.
11.5.10 ObjStatus — This is a required parameter in
the response message. It is a structure that consists of
an acknowledge code and a list of status parameters.
The acknowledge code is used to indicate errors that
apply to the response as a whole. A status parameter is
a structure consisting of a code indicating a specific
error and accompanying text providing additional
information. Text is often used to inform a person of
the results of an operation.
11.5.11 Tables 4 and 5 define the parameters for the
GetAttr and SetAttr services, respectively.
Table 4 GetAttr Service
Parameter Req/Ind Rsp/Conf Description
ObjSpec C - The object specifier, used to specify the owner of the target object.
ObjType M - The type of the target object.
(List of)
ObjID
C - The identifier of the target object. If present, identifiers are treated as a pre-filter
of the form “ObjID = <identifier>”, where the individual identifiers are joined
with logical OR’s.
(List of)
AttrFilter
C - An attribute filter to be applied to the target object. If both AttrFilter and ObjID
are omitted, attributes are requested for all instances of the target object type.
(List of)
AttrName
C - The name of a desired attribute. If the name is “ObjType,” and if ObjType
(above) is omitted, then the object type of all subordinate objects is requested.
If omitted, then all public attributes of the target object are requested.
(List of)
ObjSetting
- M Attributes that match the specified characteristics, per qualifying object
instance. Setting value may not be valid if corresponding ObjStatus shows a
failure.
ObjStatus - M Information concerning the success or failure of the request.
Table 5 SetAttr Service
Parameter Req/Ind Rsp/Conf Description
ObjSpec C - The object specifier, used to specify the owner of the target object.
ObjType M - The type of the target object.
(List of)
ObjID
C - The identifier of the target object. If present, is treated as a primary filter of the
form “ObjID = <identifier>”.
(List of)
AttrSetting
M - An attribute’s name and desired value.
(List of)
ObjSetting
- M The attributes’ resulting values. Requested setting value(s) may have not
changed if corresponding ObjStatus shows a failure.
ObjStatus - M Information concerning the success or failure of the request.
11.6 GetType — GetType is a service that is directed at object types rather than object instances. It is used to ask an
owner object for the object types that it owns.
11.6.1 Figure 9 shows the message flow for the GetType service.
Figure 9
GetType Message Flow
SEMI E39-0703 © SEMI 1995, 2003 17
11.6.2 Comments for the ObjSpec and ObjStatus parameters of GetAttr and SetAttr also apply to the parameters for
the GetType service.
11.6.3 Table 6 defines the parameters for the GetType service.
Table 6 GetType Service
Parameter Req/Ind Rsp/Conf Description
ObjSpec C - The object specifier, used to specify the owner of the target object.
(List of)ObjType - M The types of objects owned by the service provider.
ObjStatus - M Information concerning the success or failure of the request.
11.7 GetAttrName — GetAttrName is a service that is directed at object types rather than object instances. It is used
to ask for the names of the attributes of one or more objects owned by the service provider.
11.7.1 Figure 10 shows the message flow for the GetAttrName service.
Figure 10
GetAttName Message Flow
11.7.2 Wild characters may be used in the object types requested.
11.7.3 Comments for the ObjSpec and ObjStatus parameters of GetAttr and SetAttr also apply to the parameters for
the GetAttrName service.
11.7.4 Table 7 defines the parameters for the GetAttrName service.
Table 7 GetAttrName Service
Parameter Req/Ind Rsp/Conf Description
ObjSpec C - The object specifier, used to specify the owner of the target object.
(List of)ObjType M - The type of the target object owned by the service provider. ObjType may use wild
characters.
(List of)AttrName - M The names of the attributes of each of the target object(s).
ObjStatus - M Information concerning the success or failure of the request.
12 Additional Services
12.1 Additional services described in this section may have some restrictions when invoked. In some cases,
services that are invoked may report a failure. For example: the owner of an object shall not delete the object during
its lifecycle or while it is valid and required by another agent. Existence of an object may depend on preconditions,
provided parameters, state of another object, corresponding operation, context of application, etc. Supplier shall
document any restrictions or information regarding the validity of the additional services listed below.
12.1.1 This section defines the services required for additional operations defined in Section 10. These services are
listed in Table 8.
SEMI E39-0703 © SEMI 1995, 2003 18
Table 8 Additional Object Services
Message Service Name Type Description
Create R A request is made to create an object.
Delete R A request is made to delete an object.
Attach R A supervisor requests an object to attach itself to the supervisor.
AttachSetAttr R A supervisor requests to set one or more attributes of an attached object.
AttachSupervisedObject R A request is made to a supervisor to attach another object to the supervisor.
Detach R A supervisor requests an object to detach itself from the supervisor.
DetachSupervisedObject R A request is made to a supervisor to detach a specified attached object.
Reattach R A supervisor requests an object to reattach to itself to the new supervisor.
ObjectAction R A request for an object to perform an action.
ObjectActionCompletion N Notification that a delayed action has been completed, sucessfully or unsuccessfully.
GetServiceNames R A request to an object owner for a list of services supported by its owned objects.
GetServiceParameters R A request to an object for the service parameters supported for specified services.
12.2 Object Services Parameter Dictionary — Parameter definitions are provided in Section 11.1.
12.2.1 Table 9 defines the parameters used in services defined in Section 12, in addition to those parameters defined
in Table 3.
Table 9 Additional Object Services Parameter Dictionary
Parameter Definition Form
AttachToken Attach token provided by an object at the time it is
attached or reattached.
Unsigned integer
TargetSpec Object specifier of target object to attach or detach. Formatted text for object specifier.
12.3 Create — The service user may request the service provider to create a new object and assign the value of one
or more of its attributes. The request may be denied if an attempt is made to set attributes that are not allowed for
that object type.
12.3.1 Parameters for Create are listed in Table 10.
Table 10 Create Service
Parameter Req/Ind Rsp/Conf Description
ObjSpec M M In the request, the object specifier of agent providing the object create
service. In the response, the object specifier of the new instance.
NOTE: The values may be different in the request and the response. The
p
arameter in the request may be “ ” (an empty string) if there is no object
or the owner object is outside of the domain of the receiving entity. If
the entity is the equipment itself rather than a component of equipment,
the owner may be defined by “Equipment” even if no such object is
defined.
ObjType M - The object type to be created.
(list of) AttrSetting C C Initial attribute settings. Conditions for inclusion of an attribute are
object-specific in both request and response.
ObjStatus - M Information concerning the result of the requested operation.