NCBI C++ ToolKit
Public Member Functions | List of all members
CMacroFunction_IsLeaf Class Reference

Search Toolkit Book for CMacroFunction_IsLeaf

CMacroFunction_IsLeaf Returns true if child is a leaf, so you can do queries that exclude non-leaf nodes, e.g. More...

#include <gui/widgets/phylo_tree/phylo_tree_query_macro_fns.hpp>

+ Inheritance diagram for CMacroFunction_IsLeaf:
+ Collaboration diagram for CMacroFunction_IsLeaf:

Public Member Functions

 CMacroFunction_IsLeaf (EScopeEnum func_scope, CPhyloTree *tree)
 
virtual void TheFunction ()
 
- Public Member Functions inherited from ITreeMacroFunction
 ITreeMacroFunction (EScopeEnum func_scope, CPhyloTree *tree)
 Ctor. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ITreeMacroFunction
virtual void x_InitCall (CPhyloTreeNode &data)
 Functions make the action and collect statistics. More...
 
virtual void x_SetUserObjects (CQueryParseTree::TNode &qnode)
 
void x_AssignReturnValue (const CObjectInfo &oi, const string &field_name)
 function useful mostly for functions in the WHERE clause More...
 
- Static Protected Member Functions inherited from ITreeMacroFunction
static string JSFilter (const string &str)
 Filter out java/javascript keywords that could possibly be used in xss attacks, particularly event handler names and < and > symbols. More...
 
- Protected Attributes inherited from ITreeMacroFunction
CPhyloTreeNodem_Node
 
CPhyloTreem_Tree
 
vector< CRef< CQueryNodeValue > > m_Args
 
CRef< CQueryNodeValuem_Result
 
- Static Protected Attributes inherited from ITreeMacroFunction
static string s_JSFilterdKeywords []
 
static pair< string, strings_JSSwapKeywords []
 

Detailed Description

CMacroFunction_IsLeaf Returns true if child is a leaf, so you can do queries that exclude non-leaf nodes, e.g.

IsLeaf("") AND IsNull("host_disease") checks for any leaf nodes that do not have a value (even blank) set for "host_disease"

Definition at line 274 of file phylo_tree_query_macro_fns.hpp.

Constructor & Destructor Documentation

◆ CMacroFunction_IsLeaf()

CMacroFunction_IsLeaf::CMacroFunction_IsLeaf ( EScopeEnum  func_scope,
CPhyloTree tree 
)
inline

Definition at line 277 of file phylo_tree_query_macro_fns.hpp.

Member Function Documentation

◆ TheFunction()

void CMacroFunction_IsLeaf::TheFunction ( )
virtual

Definition at line 624 of file phylo_tree_query_macro_fns.cpp.

References QueryValueType::eBool.


The documentation for this class was generated from the following files:
Modified on Fri Sep 20 14:57:59 2024 by modify_doxy.py rev. 669887