# cee::ug::ResultsQueryResult

class `ResultsQueryResult`

  A ResultsQuery result that contains the values found by a ResultsQuery on one ResultsQueryItem.

  The count of stored values depends on the mapping of the result.

  For a node-mapped or an element-mapped result, there will be only one result value (i.e. one scalar, vector or symmetric tensor).

  For element-node-mapped or element-surface-mapped results, there will be one result value per subitem (element-node or element-surface).

  Public Functions

  `ResultsQueryResult`()

    Constructs a query result.

  `ResultsQueryResult`(const ResultsQueryResult &other)

    Constructs a query result as a copy of other.

  ResultsQueryResult &`operator=`(const ResultsQueryResult &other)

    Assigns other to this query result and returns a reference to this result.

  bool `operator==`(const ResultsQueryResult &other) const

    Returns true if this result is equal to the passed result.

  void `setSpatialDimension`(int spatialDimension)

    set the spatial dimension of the result data being storage per item

  bool `addSubItem`(double *data, size_t dataCount)

    Insert the item into the container verifying that its match the spatial dimension.

  size_t `subItemCount`() const

    Returns the number of subitem values in the result.

  double `scalar`() const

    Returns the unique scalar stored in this result.

    Use this only if the result is not element-node-mapped or element-surface-mapped.

  Vec3d `vector`() const

    Returns the unique vector stored in this result.

    Use this only if the result is not element-node-mapped or element-surface-mapped.

  SymmetricTensor `tensor`() const

    Returns the unique symmetric tensor stored in this result.

    Use this only if the result is not element-node-mapped or element-surface-mapped.

  double `subItemScalar`(size_t subItemIndex) const

    Returns the scalar stored in this result for a given sub-item (element node or element surface).

    By extension, when the result is node-mapped or element-mapped the unique scalar is stored in place of this first subitem.

  Vec3d `subItemVector`(size_t subItemIndex) const

    Returns the vector stored in this result for a given sub-item (element node or element surface).

    By extension, when the result is node-mapped or element-mapped the unique vector is stored in place of this first subitem.

  SymmetricTensor `subItemTensor`(size_t subItemIndex) const

    Returns the symmetric tensor stored in this result for a given sub-item (element node or element surface).

    By extension, when the result is node-mapped or element-mapped the unique symmetric tensor is stored in place of this first subitem.

  double `averageSubItemScalar`() const

    Returns the arithmetic average of the scalars stored for all sub items.

  Vec3d `averageSubItemVector`() const

    Returns the arithmetic average of the vectors stored for all sub items.

  SymmetricTensor `averageSubItemTensor`() const

    Returns the arithmetic average of the symmetric tensors stored for all sub items.

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...