## On this page

  

 

 # ansys::Project::Query Class Reference

 Last update: 19.05.2025 

Set of conditions used in search within the [Project](classansys_1_1_project_1_1_project.xhtml "Base class for Project API, also see SimProject."). See [Iterator::find()](classansys_1_1_project_1_1_iterator.xhtml#a117905095e2e70e0a2f9dbe051882bec "Execute a Query onto the current Iterator.") [More...](classansys_1_1_project_1_1_query.xhtml#details)

`#include "Query.hpp"`

## <a id="pub-types" name="pub-types"></a>Public Types

enum [Operator](classansys_1_1_project_1_1_query.xhtml#a573f60ab433e79d792adc3a2c43d2c36) {   
 [OpEqual](classansys_1_1_project_1_1_query.xhtml#a573f60ab433e79d792adc3a2c43d2c36ae62e264ca6b0f30b8d49044190639449), [OpNotEqual](classansys_1_1_project_1_1_query.xhtml#a573f60ab433e79d792adc3a2c43d2c36a6e8f7d5bad3a36fa6212252c5da5cd33), [OpContains](classansys_1_1_project_1_1_query.xhtml#a573f60ab433e79d792adc3a2c43d2c36ac49a884da01c7007be9fc1b1e93b1a52), [OpListContains](classansys_1_1_project_1_1_query.xhtml#a573f60ab433e79d792adc3a2c43d2c36a28e5ef4722c4d187064f65e84ff099f9),   
 [OpHasKey](classansys_1_1_project_1_1_query.xhtml#a573f60ab433e79d792adc3a2c43d2c36ac87d95f911ec121fa546be5acf89b5cd), [OpUndefined](classansys_1_1_project_1_1_query.xhtml#a573f60ab433e79d792adc3a2c43d2c36ad392018e2a341cc8d174f4001eff1600)  
 } ## <a id="pub-methods" name="pub-methods"></a>Public Member Functions

 [Query](classansys_1_1_project_1_1_query.xhtml#a693abfd1bbc617dbd463a529182c696a) ()  [Query](classansys_1_1_project_1_1_query.xhtml#accc4b3a49109a0d992c9bea5f67de8b2) (std::string pKey, [Operator](classansys_1_1_project_1_1_query.xhtml#a573f60ab433e79d792adc3a2c43d2c36) pOp) Constructor, simple query with unary operator. [More...](classansys_1_1_project_1_1_query.xhtml#accc4b3a49109a0d992c9bea5f67de8b2)  
  [Query](classansys_1_1_project_1_1_query.xhtml#aa11759b898e8ce9ad56ea93b5e7f3fe9) (std::string pKey, [Operator](classansys_1_1_project_1_1_query.xhtml#a573f60ab433e79d792adc3a2c43d2c36) pOp, std::string pVal) Constructor, simple query with binary operator. [More...](classansys_1_1_project_1_1_query.xhtml#aa11759b898e8ce9ad56ea93b5e7f3fe9)  
 [Query](classansys_1_1_project_1_1_query.xhtml) &amp; [operator+=](classansys_1_1_project_1_1_query.xhtml#a94479fcb90a6a98679740625ceeef0a9) (const [Query](classansys_1_1_project_1_1_query.xhtml) &amp;pObj) Append a [Query](classansys_1_1_project_1_1_query.xhtml "Set of conditions used in search within the Project. See Iterator::find()") object to the current. [More...](classansys_1_1_project_1_1_query.xhtml#a94479fcb90a6a98679740625ceeef0a9)  
 bool [evaluate](classansys_1_1_project_1_1_query.xhtml#a2954de4bce6cb1e254c5fc05071d05aa) (const [Iterator](classansys_1_1_project_1_1_iterator.xhtml) &amp;pIter) Evaluates the query for the specified iterator. [More...](classansys_1_1_project_1_1_query.xhtml#a2954de4bce6cb1e254c5fc05071d05aa)  
 bool [evaluate](classansys_1_1_project_1_1_query.xhtml#adb860209358e8dffe5703593f991637f) (const [Metadata](classansys_1_1_project_1_1_metadata.xhtml) &amp;pMeta) Evaluates the query for the specified metadata object Only variable names prefixed by [Metadata](classansys_1_1_project_1_1_metadata.xhtml "Dictionary of values associated with an Iterator."):: will be evaluated. [More...](classansys_1_1_project_1_1_query.xhtml#adb860209358e8dffe5703593f991637f)  
 <a id="details" name="details"></a>## Detailed Description

Set of conditions used in search within the [Project](classansys_1_1_project_1_1_project.xhtml "Base class for Project API, also see SimProject."). See [Iterator::find()](classansys_1_1_project_1_1_iterator.xhtml#a117905095e2e70e0a2f9dbe051882bec "Execute a Query onto the current Iterator.")

[Query](classansys_1_1_project_1_1_query.xhtml "Set of conditions used in search within the Project. See Iterator::find()") variables:

- name : The project item name
- type : The project item type (File, Folder, Link, ...)
- subclass : The item subclass
- [Metadata](classansys_1_1_project_1_1_metadata.xhtml "Dictionary of values associated with an Iterator.")::\* : The metadata key named \*

[Query](classansys_1_1_project_1_1_query.xhtml "Set of conditions used in search within the Project. See Iterator::find()") operators:

- OpEqual , OpNotEqual : Equality operator
- OpContains : Check if the string contains the specified value
- OpListContains : Check if the data is a CSV vector and contains the value
- OpHasKey : Check if the key is known ([Metadata](classansys_1_1_project_1_1_metadata.xhtml "Dictionary of values associated with an Iterator.")::\*)

A query will succeed if all key-operator-\[value\] tuples are true.



## Member Enumeration Documentation

<a id="a573f60ab433e79d792adc3a2c43d2c36" name="a573f60ab433e79d792adc3a2c43d2c36"></a>## [◆ ](#a573f60ab433e79d792adc3a2c43d2c36)Operator

 enum [ansys::Project::Query::Operator](classansys_1_1_project_1_1_query.xhtml#a573f60ab433e79d792adc3a2c43d2c36)

Enumerator<a id="a573f60ab433e79d792adc3a2c43d2c36ae62e264ca6b0f30b8d49044190639449" name="a573f60ab433e79d792adc3a2c43d2c36ae62e264ca6b0f30b8d49044190639449"></a>OpEqual <a id="a573f60ab433e79d792adc3a2c43d2c36a6e8f7d5bad3a36fa6212252c5da5cd33" name="a573f60ab433e79d792adc3a2c43d2c36a6e8f7d5bad3a36fa6212252c5da5cd33"></a>OpNotEqual <a id="a573f60ab433e79d792adc3a2c43d2c36ac49a884da01c7007be9fc1b1e93b1a52" name="a573f60ab433e79d792adc3a2c43d2c36ac49a884da01c7007be9fc1b1e93b1a52"></a>OpContains <a id="a573f60ab433e79d792adc3a2c43d2c36a28e5ef4722c4d187064f65e84ff099f9" name="a573f60ab433e79d792adc3a2c43d2c36a28e5ef4722c4d187064f65e84ff099f9"></a>OpListContains <a id="a573f60ab433e79d792adc3a2c43d2c36ac87d95f911ec121fa546be5acf89b5cd" name="a573f60ab433e79d792adc3a2c43d2c36ac87d95f911ec121fa546be5acf89b5cd"></a>OpHasKey <a id="a573f60ab433e79d792adc3a2c43d2c36ad392018e2a341cc8d174f4001eff1600" name="a573f60ab433e79d792adc3a2c43d2c36ad392018e2a341cc8d174f4001eff1600"></a>OpUndefined 



## Constructor &amp; Destructor Documentation

<a id="a693abfd1bbc617dbd463a529182c696a" name="a693abfd1bbc617dbd463a529182c696a"></a>## [◆ ](#a693abfd1bbc617dbd463a529182c696a)Query() \[1/3\]

 ansys::Project::Query::Query  ( ) 





<a id="accc4b3a49109a0d992c9bea5f67de8b2" name="accc4b3a49109a0d992c9bea5f67de8b2"></a>## [◆ ](#accc4b3a49109a0d992c9bea5f67de8b2)Query() \[2/3\]

 ansys::Project::Query::Query  ( std::string  *pKey*,    [Operator](classansys_1_1_project_1_1_query.xhtml#a573f60ab433e79d792adc3a2c43d2c36)  *pOp*   ) 

Constructor, simple query with unary operator.





<a id="aa11759b898e8ce9ad56ea93b5e7f3fe9" name="aa11759b898e8ce9ad56ea93b5e7f3fe9"></a>## [◆ ](#aa11759b898e8ce9ad56ea93b5e7f3fe9)Query() \[3/3\]

 ansys::Project::Query::Query  ( std::string  *pKey*,    [Operator](classansys_1_1_project_1_1_query.xhtml#a573f60ab433e79d792adc3a2c43d2c36)  *pOp*,    std::string  *pVal*   ) 

Constructor, simple query with binary operator.





## Member Function Documentation

<a id="a2954de4bce6cb1e254c5fc05071d05aa" name="a2954de4bce6cb1e254c5fc05071d05aa"></a>## [◆ ](#a2954de4bce6cb1e254c5fc05071d05aa)evaluate() \[1/2\]

 bool ansys::Project::Query::evaluate  ( const [Iterator](classansys_1_1_project_1_1_iterator.xhtml) &amp;  *pIter*) 

Evaluates the query for the specified iterator.

Returnstrue if the [Query](classansys_1_1_project_1_1_query.xhtml "Set of conditions used in search within the Project. See Iterator::find()") matches the iterator content. 



<a id="adb860209358e8dffe5703593f991637f" name="adb860209358e8dffe5703593f991637f"></a>## [◆ ](#adb860209358e8dffe5703593f991637f)evaluate() \[2/2\]

 bool ansys::Project::Query::evaluate  ( const [Metadata](classansys_1_1_project_1_1_metadata.xhtml) &amp;  *pMeta*) 

Evaluates the query for the specified metadata object Only variable names prefixed by [Metadata](classansys_1_1_project_1_1_metadata.xhtml "Dictionary of values associated with an Iterator."):: will be evaluated.

Returnstrue if the [Metadata](classansys_1_1_project_1_1_metadata.xhtml "Dictionary of values associated with an Iterator.") matches the iterator content. 



<a id="a94479fcb90a6a98679740625ceeef0a9" name="a94479fcb90a6a98679740625ceeef0a9"></a>## [◆ ](#a94479fcb90a6a98679740625ceeef0a9)operator+=()

 [Query](classansys_1_1_project_1_1_query.xhtml) &amp; ansys::Project::Query::operator+=  ( const [Query](classansys_1_1_project_1_1_query.xhtml) &amp;  *pObj*) 

Append a [Query](classansys_1_1_project_1_1_query.xhtml "Set of conditions used in search within the Project. See Iterator::find()") object to the current.