12.17 ResultDataType
This structure contains properties that were created during the execution of a recipe. The Id is required to retrieve a result using the method GetResultById, which is defined in Section 7.10.2.1. A result may be a total or a partial result, which is defined by the value of the property IsPartial. The structure of the ResultContent which is generated by the vision system is application-specific and not defined at this time.
Note that this DataType contains nested structures, namely the Id types. If these are subtyped, the entire structure needs to be sub-typed also so that the client can recognize that fact.
| Name | Type | Description | O / M |
| ResultDataType | Structure | ||
| resultId | ResultIdDataType | System-wide unique identifier, 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 and it is identical to the ResultId of the ResultReadyEventType defined in Section8.3.8.4. | Mandatory |
| hasTransferableDataOnFile | Boolean | Indicates that additional data for this result can be retrieved by temporary file transfer | Optional |
| isPartial | Boolean | Indicates whether the result is the partial result of a total result. | Mandatory |
| isSimulated | Boolean | Indicates whether the system was in simulation mode when the result was created. | Optional |
| resultState | ResultStateDataType | ResultState provides information about the current state of a result and the ResultStateDataType is defined in Section 12.18. | Mandatory |
| measId | MeasIdDataType | This identifier is given by the client when starting asingle 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 jobwhich the result belongs to, this makes for easier filtering on the part of the client without keeping track of JobIds. | Optional |
| partId | PartIdDataType | 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. | Optional |
| externalRecipeId | RecipeIdExternalDataType | External Id of the recipe in use which produced the result. The ExternalID is only managed by the environment. | Optional |
| internalRecipeId | RecipeIdInternalDataType | 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. | Mandatory |
| productId | ProductIdDataType | productId which was used to trigger the job which created the result. | Optional |
| externalConfigurationId | ConfigurationIdDataType | External Id of the configuration in use while the result was produced. | Optional |
| internalConfigurationId | ConfigurationIdDataType | Internal Id of the configuration in use while the result was produced. This ID is system-wide unique and it is assigned by the vision system. | Mandatory |
| jobId | JobIdDataType | The ID of the job, created by the transition from state Ready to state SingleExecution or to state ContinuousExecution which produced the result. | Mandatory |
| creationTime | UtcTime | CreationTime indicates the time when the result was created. | Mandatory |
| processingTimes | ProcessingTimesDataType | Collection of different processing times that were needed to create the result. | Optional |
| resultContent | BaseDataType[] | Abstract data type to be subtyped from to hold result data created by the selected recipe. | Optional |