Inherited by SynchronousQueryController.

Public Member Functions
virtual std::vector< RecipeData >	GetPreparedRecipeList ()=0
	Get the list of currently prepared recipes from the vision system. More...

virtual std::vector< RecipeData >	GetRecipeListByIndices (std::uint32_t begin_index, std::uint32_t end_index)=0
	Get the list of recipes in a specified range of indices from the vision system. More...

virtual std::vector< RecipeData >	GetRecipeList ()=0
	Get the list of available recipes from the vision system. More...

virtual std::optional< RecipeData >	GetRecipeById (RecipeId const &recipe_id)=0
	Get the recipe with the given recipe ID. More...

virtual std::optional< SystemStatus >	GetSystemStatus ()=0
	Get the actual System Status. More...

virtual std::optional< Result >	GetResultById (ResultId result_id)=0
	Get a result from the result store based on its ID. More...

virtual std::vector< Result >	GetResultList ()=0
	Get a result list from the result store which are all results presently available to the vision system. More...

virtual std::vector< Result >	GetResultListFiltered (ResultFilter const &filter)=0
	Get a result list from the result store with results matching all of the specified filter criteria. More...

virtual std::vector< Result >	GetResultListFilteredByRecipeId (RecipeId const &recipe_id)=0
	Get a result list from the result store which are results of jobs executing the recipe with a specific recipe ID. More...

virtual std::vector< Result >	GetResultListFilteredByJobId (JobId job_id)=0
	Get a result list from the result store which are results of a job with a specific job ID. More...

virtual std::vector< Result >	GetResultListFilteredByResultState (ResultState result_state)=0
	Get a result list from the result store based on their result state. More...

virtual std::vector< Result >	GetResultListFilteredByMeasId (MeasId const &meas_id)=0
	Get a result list from the result store which are results of a job with a specific measurement ID. More...

virtual std::vector< Result >	GetResultListFilteredByPartId (PartId const &part_id)=0
	Get a result list from the result store which are results of a job with a specific part ID. More...

virtual DataContainer	FetchDataContainer (DataContainerDescriptor const &request)=0
	Retrieve a data container containing the data components corresponding to the specified descriptor. More...

Member Function Documentation

◆ FetchDataContainer()

virtual DataContainer FetchDataContainer ( DataContainerDescriptor const & request )

pure virtual

Retrieve a data container containing the data components corresponding to the specified descriptor.

Parameters

request is a data container descriptor containing any number of data component descriptors for which the corresponding data components will be retrieved.

Returns: the requested data container. If individual data components could not be retrieved in the specified format, a DataComponentError will take their place.

Implemented in SynchronousQueryController.

◆ GetPreparedRecipeList()

virtual std::vector<RecipeData> GetPreparedRecipeList ( )

pure virtual

Get the list of currently prepared recipes from the vision system.

Returns: the list of available recipes from the vision system which are prepared or an empty vector if no recipe is prepared or no recipe was loaded or the vision system is not available.

Implemented in SynchronousQueryController.

◆ GetRecipeById()

virtual std::optional<RecipeData> GetRecipeById ( RecipeId const & recipe_id )

pure virtual

Get the recipe with the given recipe ID.

Parameters

recipe_id recipe ID that is looked up

Returns: The recipe that was looked up or nullopt if no recipe was found with the given ID

Implemented in SynchronousQueryController.

◆ GetRecipeList()

virtual std::vector<RecipeData> GetRecipeList ( )

pure virtual

Get the list of available recipes from the vision system.

Returns: the list of available recipes from the vision system or an empty vector if no recipe was loaded or the vision system is not available.

Implemented in SynchronousQueryController.

◆ GetRecipeListByIndices()

virtual std::vector<RecipeData> GetRecipeListByIndices	(	std::uint32_t	begin_index,
		std::uint32_t	end_index
	)

pure virtual

Get the list of recipes in a specified range of indices from the vision system.

Parameters

begin_index
end_index

Returns: the list of available recipes from the vision system with the given range or an empty vector if no recipe meet the conditions or no recipe was loaded or the vision system is not available.

Implemented in SynchronousQueryController.

◆ GetResultById()

virtual std::optional<Result> GetResultById ( ResultId result_id )

pure virtual

Get a result from the result store based on its ID.

Parameters

result_id is the result ID for which the result is retrieved.

Returns: the result that was looked up or nullopt if the requested result ID is not found in the result store. Note that the result store may only buffer a certain number of past results.

Implemented in SynchronousQueryController.

◆ GetResultList()

virtual std::vector<Result> GetResultList ( )

pure virtual

Get a result list from the result store which are all results presently available to the vision system.

Returns: the list of results that was looked up or an empty vector if no results were found in the result store. Note that the result store may only buffer a certain number of past results.

Implemented in SynchronousQueryController.

◆ GetResultListFiltered()

virtual std::vector<Result> GetResultListFiltered ( ResultFilter const & filter )

pure virtual

Get a result list from the result store with results matching all of the specified filter criteria.

Parameters

filter is a data structure which aggregates the various possible filter criteria.

Returns: the list of results that was looked up or an empty vector if no results were found in the result store matching all of the filter criteria. Note that the result store may only buffer a certain number of past results.

Implemented in SynchronousQueryController.

◆ GetResultListFilteredByJobId()

virtual std::vector<Result> GetResultListFilteredByJobId ( JobId job_id )

pure virtual

Get a result list from the result store which are results of a job with a specific job ID.

Parameters

job_id is the job ID for which results are retrieved.

Returns: the list of results that was looked up or an empty vector if no results were found in the result store for the given job ID. Note that the result store may only buffer a certain number of past results.

Implemented in SynchronousQueryController.

◆ GetResultListFilteredByMeasId()

virtual std::vector<Result> GetResultListFilteredByMeasId ( MeasId const & meas_id )

pure virtual

Get a result list from the result store which are results of a job with a specific measurement ID.

Parameters

meas_id is the measurement ID for which results are retrieved.

Returns: the list of results that was looked up or an empty vector if no results were found in the result store for the given measurement ID. Note that the result store may only buffer a certain number of past results.

Implemented in SynchronousQueryController.

◆ GetResultListFilteredByPartId()

virtual std::vector<Result> GetResultListFilteredByPartId ( PartId const & part_id )

pure virtual

Get a result list from the result store which are results of a job with a specific part ID.

Parameters

part_id is the part ID for which results are retrieved.

Returns: the list of results that was looked up or an empty vector if no results were found in the result store for the given part ID. Note that the result store may only buffer a certain number of past results.

Implemented in SynchronousQueryController.

◆ GetResultListFilteredByRecipeId()

virtual std::vector<Result> GetResultListFilteredByRecipeId ( RecipeId const & recipe_id )

pure virtual

Get a result list from the result store which are results of jobs executing the recipe with a specific recipe ID.

Parameters

recipe_id is the recipe ID for which results are retrieved.

Returns: the list of results that was looked up or an empty vector if no results were found in the result store for the given recipe ID. Note that the result store may only buffer a certain number of past results.

Implemented in SynchronousQueryController.

◆ GetResultListFilteredByResultState()

virtual std::vector<Result> GetResultListFilteredByResultState ( ResultState result_state )

pure virtual

Get a result list from the result store based on their result state.

Parameters

result_state is the result state for which results are retrieved.

Returns: the list of results that was looked up or an empty vector if no results were found in the result store for the given result state. Note that the result store may only buffer a certain number of past results.

Implemented in SynchronousQueryController.

◆ GetSystemStatus()

virtual std::optional<SystemStatus> GetSystemStatus ( )

pure virtual

Get the actual System Status.

Returns: the actual system status of the vision system if the vision system is available otherwise nullopt

Implemented in SynchronousQueryController.

The documentation for this class was generated from the following file:

plugin-support/v1/Synchronous/ISynchronousQueryController.h

Public Member Functions

Member Function Documentation

◆ FetchDataContainer()

◆ GetPreparedRecipeList()

◆ GetRecipeById()

◆ GetRecipeList()

◆ GetRecipeListByIndices()

◆ GetResultById()

◆ GetResultList()

◆ GetResultListFiltered()

◆ GetResultListFilteredByJobId()

◆ GetResultListFilteredByMeasId()

◆ GetResultListFilteredByPartId()

◆ GetResultListFilteredByRecipeId()

◆ GetResultListFilteredByResultState()

◆ GetSystemStatus()