12 DataTypes for the Vision System

12.1 Handle

This Simple Data Type defines a UInt32 representing a handle to a collection of data managed by the server.

12.2 TrimmedString

This Simple Data Type defines a String with no leading or trailing whitespace, where whitespace means the Unicode characters defined as whitespace (“WSpace=Y”, “WS”) in the Unicode database.

Where a TrimmedString is specified as input argument to a method and the incoming string contains leading or trailing whitespace, the server is entitled to react with an error (Bad_TypeMismatch) or – preferably – silently trim the string internally before processing it.

12.3 TriStateBooleanDataType

This DataType is an enumeration that identifies the filtering of particular properties in requests for lists of results, recipes etc. Its values are defined in Table 139.

12.4 ProcessingTimesDataType

This structure contains measured times that were generated during the execution of a recipe. These measured values provide information about the duration required by the various sub-functions.

12.5 MeasIdDataType

This structure is used by the client to pass an identification of the measurement to be carried out in a Start method. It is typically not changed by the server and is included in the meta data for identifying a result.

In its basic version here, the MeasIdDataType contains only a TrimmedString. It has been encapsulated in a structure for the purpose of easy sub-typing if more sophisticated identification is required.

A basic MeasIdDataType structure is considered empty when the id member has length 0. For sub-types of MeasIdDataType additional rules may apply., i.e., they shall always be considered empty, when the Id member has length 0, and may also be considered empty when other structure members fulfill particular conditions.

12.6 PartIdDataType

This structure defines the identification of a part, i.e. a Unit Under Test. It is formally defined in Table 142.

PartId structures can be passed by the client with a Start method call and should be stored by he server in results pertaining to that part. Thus they describe the connection between a unit under test and a result, which was created during the processing of a recipe applied on this unit under test.

In its basic version here, the PartIdDataType contains only a TrimmedString. It has been encapsulated in a structure for the purpose of easy sub-typing if more sophisticated identification is required, e.g. including a batch or carrier Id.

A basic PartIdDataType structure is considered empty when the id member has length 0. For sub-types of PartIdDataType this can be defined differently.

12.7 JobIdDataType

This structure is used to pass an identification of the measurement to be carried out following a Start method call. It is typically included in the meta data for identifying a result.

In its basic version here, the JobIdDataType contains only a TrimmedString. It has been encapsulated in a structure for the purpose of easy sub-typing if more sophisticated identification is required.

A basic JobIdDataType structure is considered empty when the id member has length 0. For sub-types of JobIdDataType additional rules may apply, i.e. they shall always be considered empty, when the Id member has length 0, and may also be considered empty when other structure members fulfill particular conditions.

12.8 BinaryIdBaseDataType

This abstract DataType is the base data type for identifying binary data internally and externally. Its subtypes are used in objects of RecipeType which is defined in Section 7.7., of ConfigurationDataType which is defined in Section 12.12 and also in results. It is formally defined in Table 144.

The main rationale for introducing a base type and several (identical) subtypes is to facilitate a type-safe enforcing of the distinction between external and internal Ids in method arguments.

12.9 RecipeIdExternalDataType

This structure is used for the external identification of recipes. It is identical to BinaryIdBaseDataType described in Section 12.8 except that it is not abstract.

12.10 RecipeIdInternalDataType

This structure is used for the internal identification of recipes. It is identical to BinaryIdBaseDataType described in Section 12.8 except that it is not abstract.

12.11 RecipeTransferOptions

This structure contains elements to control the transfer of the actual content of a vision system recipe by TemporaryFileTransfer using the GenerateFileForRead and GenerateFileForWrite methods of the RecipeTransferType ObjectType defined in Section 7.6. The structure is formally defined in Table 145Table 147.

If RecipeTransferOptions are used in connection with AddRecipe method, the InternalId returned by AddRecipe is to be used for generating the transfer file to have an unambiguous identification.

12.12 ConfigurationDataType

This structure is used to manage one external configuration. It has no knowledge of the internal structure of an external configuration. The actual configuration used by the machine vision system is a system-specific structure, which may be transferred using a TemporaryFileTransfer.

12.13 ConfigurationIdDataType

This structure is used for the identification of an object of ConfigurationDataType which is defined in Section 12.12. It is identical to BinaryIdBaseDataType described in Section 12.8 except that it is not abstract.

12.14 ConfigurationTransferOptions

This structure contains elements to control the transfer of the actual content of a vision system configuration by TemporaryFileTransfer using the GenerateFileForRead and GenerateFileForWrite methods of the ConfigurationTransferType ObjectType defined in Section 7.4. The structure is formally defined in Table 147.

12.15 ProductDataType

This structure is used to reference one product known to the vision system. It has no knowledge of the actual manner of managing a product in the vision system, it merely signals that the vision system has knowledge of said product.

12.16 ProductIdDataType

This structure is used for identifying an object of ProductDataType.

In its basic version here, the ProductIdDataType contains only a TrimmedString. It has been encapsulated in a structure for the purpose of easy sub-typing if more sophisticated identification is required.

A basic ProductIdDataType structure is considered empty when the id member has length 0. For sub-types of ProductIdDataType additional rules may apply. , i.e., they shall always be considered empty, when the Id member has length 0, and may also be considered empty when other structure members fulfill particular conditions.

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.

12.18 ResultIdDataType

This structure is used to pass an identification of a result generated by an operation of the vision system.

In its basic version here, the ResultIdDataType contains only a TrimmedString. It has been encapsulated in a structure for the purpose of easy sub-typing if more sophisticated identification is required.

A basic ResultIdDataType structure is considered empty when the id member has length 0. For sub-types of ResultIdDataType additional rules may apply, i.e. they shall always be considered empty, when the Id member has length 0, and may also be considered empty when other structure members fulfil particular conditions.

12.19 ResultStateDataType

This subtype of Int32 provides information about the current state of a result. This status can change during recipe processing.

It is deliberately not an Enumeration, allowing for system-specific extensions.

12.20 ResultTransferOptions

This structure contains elements to control the transfer of the actual content of a vision system result by TemporaryFileTransfer using the GenerateFileForRead method of the ResultTransferType ObjectType defined in Section 7.12. The structure is formally defined in Table 154.

12.21 SystemStateDataType

This DataType is an enumeration that identifies the pre-defined SEMI E10 states as described in Section 11.6. Its values are defined in Table 155.

12.22 SystemStateDescriptionDataType

This structure is used to describe the system state as explained in Section 11.6.