ResultReadyEvent is an EventType subtype of BaseEventType, defined in OPC 10000-5. This event is to be triggered by the server when the vision system has a complete or partial result available for the client. Figure 30 defines the structure. It is formally defined in Table 112.
To enable access to a result, several properties of the result, which are generated by the system, are supplied. These properties can be used to query the results in the ResultManagement object. A sufficiently small result can also be provided in the ResultContent component of the event.
The ResultReadyEvent is not shown explicitly in the state machine as it is not connected to a state transition.
Figure 30 – Overview ResultReadyEventType
Table 112 – Definition of ResultReadyEventType
|
Attribute |
Value |
||||
|
BrowseName |
ResultReadyEventType |
||||
|
IsAbstract |
False |
||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
ModellingRule |
|
Subtype of the BaseEventType defined in OPC 10000-5 |
|||||
|
HasProperty |
Variable |
IsPartial |
Boolean |
PropertyType |
Mandatory |
|
HasProperty |
Variable |
IsSimulated |
Boolean |
PropertyType |
Optional |
|
HasProperty |
Variable |
ResultState |
ResultStateDataType |
PropertyType |
Mandatory |
|
HasProperty |
Variable |
MeasId |
MeasIdDataType |
PropertyType |
Optional |
|
HasProperty |
Variable |
PartId |
PartIdDataType |
PropertyType |
Optional |
|
HasProperty |
Variable |
ExternalRecipeId |
RecipeIdExternalDataType |
PropertyType |
Optional |
|
HasProperty |
Variable |
InternalRecipeId |
RecipeIdInternalDataType |
PropertyType |
Mandatory |
|
HasProperty |
Variable |
ProductId |
ProductIdDataType |
PropertyType |
Optional |
|
HasProperty |
Variable |
ExternalConfigurationId |
ConfigurationIdDataType |
PropertyType |
Optional |
|
HasProperty |
Variable |
InternalConfigurationId |
ConfigurationIdDataType |
PropertyType |
Mandatory |
|
HasProperty |
Variable |
JobId |
JobIdDataType |
PropertyType |
Mandatory |
|
HasProperty |
Variable |
ResultId |
ResultIdDataType |
PropertyType |
Mandatory |
|
HasProperty |
Variable |
CreationTime |
UtcTime |
PropertyType |
Mandatory |
|
HasProperty |
Variable |
ProcessingTimes |
ProcessingTimesDataType |
PropertyType |
Optional |
|
HasProperty |
Variable |
ResultContent |
BaseDataType[] |
PropertyType |
Optional |
IsPartial
Indicates whether the result is the partial result of a total result.
IsSimulated
Indicates whether the system was in simulation mode when the job generating this result was created.
ResultState
Indicates at what processing state this result was generated.
MeasId, PartId, ExternalRecipeId, InternalRecipeId, ProductId, ExternalConfigurationId, InternalConfigurationId, JobId, ResultId
If the information is somehow linked to one of the (vision system) objects referenced by these Ids, these properties can transport this reference. In particular:
MeasId: This identifier is given by the client when starting a single or continuous execution and transmitted to the vision system. It is used to identify the respective result data generated for this job. Although the system-wide unique JobId would be sufficient to identify the job which the result belongs to, this makes for easier filtering on the part of the client without keeping track of JobIds.
PartId: A PartId is given by the client when starting the job; although the system-wide unique JobId would be sufficient to identify the job which the result belongs to, this makes for easier filtering on the part of the client without keeping track of JobIds.
ExternalRecipeId:
External Id of the recipe in use which produced the result. The ExternalId is only managed by the environment. This will typically be derived from the arguments of the Start method call which caused the result to be created.
InternalRecipeId:
Internal Id of the recipe in use which produced the result. This Id is system-wide unique and it is assigned by the vision system. This will typically be derived from the arguments of the Start method call which caused the result to be created.
ProductId: Id of the product selected to produce the result. This will typically be derived from the arguments of the Start method call which caused the result to be created.
ExternalConfigurationId: External Id of the configuration in effect in the system when the result was produced.
InternalConfigurationId: Internal Id of the configuration in effect in the system when the result was produced.
JobId:
The Id of the job, created by the transition from state Ready to state SingleExecution or to state ContinuousExecution which produced the result.
ResultId: vision-system-wide unique Id, which is assigned by the system. This Id can be used for fetching exactly this result using the methods detailed in Section 7.10.2.
CreationTime
CreationTime indicates the time when the result was created.
ProcessingTimes
Collection of different processing times that were needed to create the result.
ResultContent
Abstract data type to be subtyped from to hold result data created by the selected recipe.