# cee::ug::ResultsQuery

class `ResultsQuery`

  A query object to retrieve results from a given DataSource.

  Create the ResultsQuery by assigning its data source in the constructor, and then use its methods to retrieve results from it.

  Classes related to ResultsQuery are ResultsQueryItem, which is used to define specific nodes or elements to perform the query on, and ResultsQueryResult, which is a container associated to one of the items and holds the values found by the query.

  Public Functions

  `ResultsQuery`(DataSource *dataSource)

    Creates a query object from a data source.

  bool `scalars`(int scalarId, int stateId, size_t geometryIndex, const std::vector<ResultsQueryItem> *items, std::vector<ResultsQueryResult> *results)

    Returns scalar results values for given items (nodes, elements).

    The items must be defined according to the mapping of the queried result: nodes for node-mapped results, or elements for element, element-node- or element-surface-mapped results

  bool `vectors`(int vectorId, int stateId, size_t geometryIndex, const std::vector<ResultsQueryItem> *items, std::vector<ResultsQueryResult> *results)

    Returns vector results values for given items (nodes, elements).

    The items must be defined according to the mapping of the queried result: nodes for node-mapped results, or elements for element, element-node- or element-surface-mapped results

  bool `tensors`(int tensorId, int stateId, size_t geometryIndex, const std::vector<ResultsQueryItem> *items, std::vector<ResultsQueryResult> *results)

    Returns vector results values for given items (nodes, elements).

    The items must be defined according to the mapping of the queried result: nodes for node-mapped results, or elements for element, element-node- or element-surface-mapped results

  bool `minimumAndMaximumScalar`(int scalarId, int stateId, size_t geometryIndex, ResultsQueryResultPosition *minScalarPositionAndResult, ResultsQueryResultPosition *maxScalarPositionAndResult)

    Searches for the minimum and maximum scalar value.

    Reports their positions, node/element ids, part ids and values

    The position reported depended on the result mapping. If being a node or element-node result, the position is the node position. For elements, the element centroid position is reported, and for PER_ELEMENT_SURFACE result mapping, the element surface centroid is reported.

    The itemId within is expressed accordingly to the result mapping. If node/element does not have ids, the index is used.

  bool `minimumScalars`(size_t scalarsCount, int scalarId, int stateId, size_t geometryIndex, std::vector<ResultsQueryResultPosition> *minScalarPositionAndResults)

    Searches for the minimum scalar values.

    Reports their positions, node/element ids, part ids and values

    searchCounts parameter determines how many values are going to be reported.

    The position reported depended on the result mapping. If being a node or element-node result, the position is the node position. For elements, the element centroid position is reported, and for PER_ELEMENT_SURFACE result mapping, the element surface centroid is reported.

    The itemId within is expressed accordingly to the result mapping. If node/element does not have ids, the index is used.

  bool `maximumScalars`(size_t scalarsCount, int scalarId, int stateId, size_t geometryIndex, std::vector<ResultsQueryResultPosition> *maxScalarPositionAndResults)

    Searches for the maximum scalar values.

    Reports their positions, node/element ids, part ids and values

    searchCounts parameter determines how many values are going to be reported.

    The position reported depended on the result mapping. If being a node or element-node result, the position is the node position. For elements, the element centroid position is reported, and for PER_ELEMENT_SURFACE result mapping, the element surface centroid is reported.

    The itemId within is expressed accordingly to the result mapping. If node/element does not have ids, the index is used.

  bool `minimumAndMaximumVector`(int vectorId, int stateId, size_t geometryIndex, ResultsQueryResultPosition *minVectorPositionAndResult, ResultsQueryResultPosition *maxVectorPositionAndResult)

    Searches for the minimum and maximum vector value.

    Reports their positions, node/element ids, part ids and values

    The position reported depended on the result mapping. If being a node or element-node result, the position is the node position. For elements, the element centroid position is reported, and for PER_ELEMENT_SURFACE result mapping, the element surface centroid is reported.

    The itemId within is expressed accordingly to the result mapping. If node/element does not have ids, the index is used.

  bool `minimumVectors`(size_t vectorsCount, int vectorId, int stateId, size_t geometryIndex, std::vector<ResultsQueryResultPosition> *minVectorPositionAndResults)

    Search the minimums vector values.

    Reports their positions, node/element ids, part ids and values

    searchCounts parameter determines how many values are going to be reported.

    The position reported depended on the result mapping. If being a node or element-node result, the position is the node position. For elements, the element centroid position is reported, and for PER_ELEMENT_SURFACE result mapping, the element surface centroid is reported.

    The itemId within is expressed accordingly to the result mapping. If node/element does not have ids, the index is used.

  bool `maximumVectors`(size_t vectorsCount, int vectorId, int stateId, size_t geometryIndex, std::vector<ResultsQueryResultPosition> *maxVectorPositionAndResults)

    Search the maximums scalar values.

    Reports their positions, node/element ids, part ids and values

    searchCounts parameter determines how many values are going to be reported.

    The position reported depended on the result mapping. If being a node or element-node result, the position is the node position. For elements, the element centroid position is reported, and for PER_ELEMENT_SURFACE result mapping, the element surface centroid is reported.

    The itemId within is expressed accordingly to the result mapping. If node/element does not have ids, the index is used.

Conversation saved
HOOPSY BETA

### Hello! I'm HOOPSY

Your multilingual generative AI assistant for documentation. Ask me anything about HOOPS Envision for Desktop in your own language, or choose a sample question below to start a conversation:

What is HOOPS Envision for Desktop?
What are the latest release notes for HOOPS Envision for Desktop?
How do I start evaluating HOOPS Envision for Desktop?
How do I write my first sample application?
How can I get assistance?

HOOPSY may store conversations according to OpenAI's policy. Responses may not always be accurate.

HOOPSY is thinking...