This method is used to retrieve a result from the vision system. It is basically identical to the GetResultById method described in Section 7.10.2.1, but it returns the result not in a single output argument of ResultDataType but in individual output arguments corresponding to the elements of the ResultDataType structure.
The reason for providing this method is to facilitate the use of subtypes to the structures nested inside of ResultDataType. Since the NodeIds of structured DataTypes nested within a structured DataType are not transferred together with the DataType, subtyping these nested structures would then also necessitate subtyping ResultDataType. This is of course possible, but in the absence of such a subtype, the individual components can still be requested by this method.
Signature
GetResultComponentsById ([in]ResultIdDataTyperesultId[in]Int32timeout[out]BooleanhasTransferableDataOnFile[out]HandleresultHandle[out]BooleanisPartial[out]BooleanisSimulated[out]ResultStateDataTyperesultState[out]MeasIdDataTypemeasId[out]PartIdDataTypepartId[out]RecipeIdExternalDataTypeexternalRecipeId[out]RecipeIdInternalDataTypeinternalRecipeId[out]ProductIdDataTypeproductId[out]ConfigurationIdDataTypeexternalConfigurationId[out]ConfigurationIdDataTypeinternalConfigurationId[out]JobIdDataTypejobId[out]UtcTimecreationTime[out]ProcessingTimesDataTypeprocessingTimes[out]BaseDataType[]resultContent[out]Int32error);
Table 68 – GetResultComponentsById Method Arguments
Argument |
Description |
resultId |
System-wide unique identifier for the result |
timeout |
With this argument the client can give a hint to the server how long it will need access to the result data. A value > 0 indicates an estimated maximum time for processing the data in milliseconds. A value = 0 indicates that the client will not need anything besides the data returned by the method call. A value < 0 indicates that the client cannot give an estimate. The client cannot rely on the data being available during the indicated time period. The argument is merely a hint allowing the server to optimize its resource management. |
hasTransferableDataOnFile |
Indicates that TemporaryFileTransfer needs to be used to retrieve all data of the result content. |
resultHandle |
The server shall return to each client requesting result data a system-wide unique handle identifying the result set / client combination. This handle should be used by the client to indicate to the server that the result data is no longer needed, allowing the server to optimize its resource handling. |
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 |
ResultState provides information about the current state of a result and the ResultStateDataType is defined in Section 12.19. |
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 identifier of the recipe in use which produced the result. This is only managed by the environment. |
internalRecipeId |
Internal identifier of the recipe in use which produced the result. This identifier is system-wide unique and it is assigned by the vision system. |
productId |
Identifier of the product in use which produced the result. This is only managed by the environment. |
externalConfigurationId |
External identifier of the configuration in use while the result was produced. |
InternalConfigurationId |
Internal identifier of the configuration in use while the result was produced. This identifier is system-wide unique and it is assigned by the vision system. |
jobId |
The identifier of the job, created by the transition from state Ready to state SingleExecution or to state ContinuousExecution which produced the result. |
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 the actual result content created by the job. |
error |
0 – OK Values > 0 are reserved for errors defined by this and future standards. Values < 0 shall be used for application-specific errors. |
Table 69 – GetResultComponentsById Method AddressSpace Definition
Attribute |
Value |
||||
BrowseName |
GetResultById |
||||
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
ModellingRule |
HasProperty |
Variable |
InputArguments |
Argument[] |
PropertyType |
Mandatory |
HasProperty |
Variable |
OutputArguments |
Argument[] |
PropertyType |
Mandatory |