semi合集-English.pdf - 第3469页

SEMI E134-0305 © SEMI 2004, 2005 22 Argument Description Kind Form error The consumer subm itting the DCP does not have sufficient privileg e to delete the requested DCP. error Structured data, of type UnauthorizedOperat…

SEMI E134-0305 © SEMI 2004, 2005 21

9.1.2.7.6 DCPDeactivated — This class describes a DCP that has been successfully deactivated on the equipment.

9.1.2.7.6.1 DCPDeactivated Attribute Definition Table

Table 26 DCPDeactivated Attribute Definition

Attribute Name Definition Form

planId Identifies a plan that has been deactivated. Text, equal to the ‘id’ attribute of the

DataCollectionPlan that was deactivated.

timeDeactivated The date and time at which the DCP was

deactivated.

Text, formatted according to Section 14.5.

deactivatedBy The identity of the consumer that deactivated the

DCP.

Text, equal to a valid identifier for the consumer that

took the action (see Limitations, Section 3.1.2 ). If

the equipment is deactivating the DCP, this field shall

be a URN of the form “urn:semi-org:equipment”.

The valid values to use for this attribute to identify

consumers shall be specified by any adjunct

document defining a technical binding for this

specification.

reason A human-readable description of the reason that the

DCP was deactivated.

Text.

planId

DCPNotActive

Figure 12

DCPNotActive Class

9.1.2.7.7 DCPNotActive — This class describes a DCP that has not been activated, either by a specific consumer, or

by any consumer (see Section 9.1.2.7.1).

9.1.2.7.7.1 DCPNotActive Attribute Definition Table

Table 27 DCPNotActive Attribute Definition

Attribute Name Definition Form

planId Identifies the plan that is not active. Text, equal to the ‘id’ attribute of the

DataCollectionPlan that is not active.

9.1.2.8 DeletePlan — Upon receiving this request, the equipment shall delete the requested plan definition from

non-volatile storage. The equipment shall reject this request if the requested plan is currently active for one or more

consumers. For a plan to be deleted, it must be deactivated (no consumer is currently receiving data produced by the

plan). Note that no consumer can delete built-in DCPs provided with the equipment (see Section 11.1.2.1).

9.1.2.8.1 If the consumer does not have sufficient privilege (see Section 10) to delete the requested DCP, the

equipment shall return an UnauthorizedOperation error.

9.1.2.8.2 DeletePlan Operation Arguments

Table 28 DeletePlan Argument Definitions

Argument Description Kind Form

planId Identifier for the requested plan. in Text, equal to a valid DCP id.

deletedPlan Confirmation that the requested plan has

been deleted.

out Structured data, of type DCPDeleted, described in

Section 9.1.2.8.5.

SEMI E134-0305 © SEMI 2004, 2005 22

Argument Description Kind Form

error The consumer submitting the DCP does

not have sufficient privilege to delete the

requested DCP.

error Structured data, of type UnauthorizedOperation,

described in Section 9.1.2.2.5 . If the consumer

was attempting to delete a built-in DCP (see

Section 11.1.2.1 ), the requiredPrivilege attribute

of the UnauthorizedOperation class shall be set to

the value “no such privilege”.

error The equipment does not recognize the

requested planId.

error Structured data, of type NoSuchPlan, described in

Section 9.1.2.4.3.

error The requested planId is currently active error Structured data, of type DCPIsActive (see Section

9.1.2.8.3).

DCPIsActive

DCPActivated

activat edPlan

Figure 13

DCPIsActive Error

9.1.2.8.3 DCPIsActive — This class describes an error in activating or deleting a DCP that is currently active. It

provides information describing the original activation of the DCP.

9.1.2.8.3.1 DCPIsActive Association Definition Table

Table 29 DCPIsActive Association Definition

Association Role Name Definition Comments

activatedPlan Provides a description of the original activation

of the DCP.

Structured data, of type DCPActivated, described in

Section 9.1.2.8.4.

planId

timeActivated

activatedBy

DCPActivated

Figure 14

DCPActivated Class

9.1.2.8.4 DCPActivated — This class describes a DCP that has been successfully activated on the equipment.

9.1.2.8.4.1 DCPActivated Attribute Definition Table

Table 30 DCPActivated Attribute Definition

Attribute Name Definition Form

planId Identifies an active DCP. Text, equal to the ‘id’ attribute of the

DataCollectionPlan that has been activated.

timeActivated The date and time at which the DCP was activated. Text, formatted according to Section 14.5.

activatedBy The identity of the consumer that activated the

DCP.

Text, equal to a valid identifier for the consumer that

took the action (see Limitations, Section 3.1.2). The

valid values to use for this attribute to identify

SEMI E134-0305 © SEMI 2004, 2005 23

consumers shall be specified by any adjunct document

defining a technical binding for this specification.

planI d

timeDeleted

delet edBy

DCPDeleted

Figure 15

DCPDeleted Class

9.1.2.8.5 DCPDeleted — This class describes a DCP that has been deleted from the equipment. It is used only in

the response to the DeletePlan operation. The equipment is not required to retain a history of deleted DCPs.

9.1.2.8.5.1 DCPDeleted Attribute Definition Table

Table 31 DCPDeleted Attribute Definition

Attribute Name Definition Form

planId Identifies the DCP that was deleted. Text, equal to the ‘id’ attribute of the

DataCollectionPlan that was deleted.

timeDeleted The date and time at which the DCP was deleted. Text, formatted according to Section 14.5.

deletedBy The identity of the consumer that deleted the DCP. Text, equal to a valid identifier for the consumer that

deleted the DCP (see Limitations, Section 3.1.2 ).

The valid values to use for this attribute to identify

consumers shall be specified by any adjunct document

defining a technical binding for this specification.

9.1.2.9 GetParameterValues — This operation can be used by consumers to determine the current state of the

equipment. It is not intended to be used as a substitute for data collection through DCPs. Upon receiving this

request, the equipment shall return the most current values for the requested Parameters known to the equipment at

the time of the request. The equipment is not required to actively retrieve new or update internally stored values at

the time of the request. Consumers should be aware that the time at which the equipment last obtained or updated

the requested Parameter values may be earlier than the time at which the request is made. If some values cannot be

obtained at the time of the request (perhaps due to an internal equipment failure), or if the request refers to

Parameters that are not defined, the equipment shall indicate so by returning NoValue (see Section 14.2.1.4) for each

such Parameter.

9.1.2.9.1 If the consumer does not have sufficient privilege (see Section 10) to request Parameter values, the

equipment shall return an UnauthorizedOperation error.

9.1.2.9.2 GetParameterValues Operation Arguments

Table 32 GetParameterValues Argument Definitions

Argument Description Kind Form

parameterRequest The Parameters whose values are being

requested.

in List of elements of type ParameterRequest,

described in Section 11.1.9.

parameterValues The values of the requested parameters. out List of elements of type ParameterValue,

described in Section 14.2.

error The consumer does not have sufficient

privilege to request Parameter values.

error Structured data, of type UnauthorizedOperation,

described in Section 9.1.2.2.5.

9.1.2.10 GetObjTypeInstanceIds — This operation provides consumers with information required to request the

values of attributes of specific E39-compliant objects that have been instantiated on the equipment. A consumer