NCBI C++ ToolKit
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
CMacroFunction_CopyStringQual Class Reference

Search Toolkit Book for CMacroFunction_CopyStringQual

#include <gui/objutils/macro_fn_aecr.hpp>

+ Inheritance diagram for CMacroFunction_CopyStringQual:
+ Collaboration diagram for CMacroFunction_CopyStringQual:

Public Member Functions

 CMacroFunction_CopyStringQual (EScopeEnum func_scope)
 
virtual ~CMacroFunction_CopyStringQual ()
 
virtual void TheFunction ()
 class CMacroFunction_CopyStringQual Expected syntax: CopyStringQual( src_field, dest_field, existingtext_opt, delimiter) the last parameter is optional src_field_name and dest_field_name are subfields of the same object Can not use this function to copy from taxname to protein description More...
 
- Public Member Functions inherited from IOperateOnTwoQuals
virtual ~IOperateOnTwoQuals ()
 
void ChangeFields (CMQueryNodeValue::TObs &src_objs, CMQueryNodeValue::TObs &dest_objs)
 
- Public Member Functions inherited from IEditMacroFunction
virtual ~IEditMacroFunction ()
 Virtual destructor. More...
 
virtual void operator() (CMacroCmdComposite &cmd_composite, CIRef< IMacroBioDataIter > &data, CQueryParseTree::TNode &qnode) override
 Function operator. More...
 
bool SetQualStringValue (CObjectInfo &oi, const string &value)
 Functions make the action and collect statistics. More...
 
bool HasDataChanged () const
 
const CRef< IFunctionLog > & GetFunctionLog () const
 
- Public Member Functions inherited from IMacroFunction< CIRef< IMacroBioDataIter > >
 IMacroFunction (EScopeEnum func_scope)
 Constructor. More...
 
virtual ~IMacroFunction ()
 Virtual destructor. More...
 
EScopeEnum GetFuncScope ()
 
ENestedFunc GetNestedState ()
 
const stringGetFuncReport () const
 Function extracts statistic from the object. More...
 
const stringGetErrorReport () const
 
void SetNestedState (ENestedFunc type)
 

Static Public Member Functions

static CTempString GetFuncName ()
 

Protected Member Functions

virtual bool x_ValidArguments (void) const
 Tests the number and the type of function arguments. More...
 
- Protected Member Functions inherited from IOperateOnTwoQuals
 IOperateOnTwoQuals (EScopeEnum func_scope)
 
bool x_GetSourceFields (CObjectInfo oi, size_t index, CMQueryNodeValue::TObs &result)
 
bool x_GetDestFields (CObjectInfo oi, size_t index, CMQueryNodeValue::TObs &result)
 
string x_GetSourceString (CObjectInfo &src)
 
- Protected Member Functions inherited from IEditMacroFunction
 IEditMacroFunction (EScopeEnum func_scope)
 
virtual void x_InitCall (CIRef< IMacroBioDataIter > &data) override
 
virtual void x_SetUserObjects (CQueryParseTree::TNode &qnode) override
 Extracts the function arguments and initializes m_Result member. More...
 
virtual void x_ResetState ()
 Reset the state of member variables that are set directly/indirectly from function arguments. More...
 
virtual bool x_IsNestedFunctionReturnValid () const
 
void x_AssignReturnValue (const CObjectInfo &oi, const string &field_name)
 Assigns value to m_Result. It is mostly useful for functions used in the WHERE clause. More...
 
void x_AssignReturnValueFromContainer (const CObjectInfo &oi, const string &container, const string &field_name)
 
void x_GetObjectsFromRef (CMQueryNodeValue::TObs &objects, const size_t &index)
 
void x_GetOptionalArgs (string &delimiter, bool &remove_field, size_t &index)
 
void x_LogChangedQuals (const CRef< IFunctionLog > &log)
 
- Protected Member Functions inherited from IMacroFunction< CIRef< IMacroBioDataIter > >
void x_LogFunction (CNcbiOstrstream &logstr)
 
void x_LogError (CNcbiOstrstream &logstr)
 

Private Member Functions

virtual bool x_ChangeFields (CObjectInfo &src, CObjectInfo &dest)
 

Additional Inherited Members

- Public Types inherited from IEditMacroFunction
using TParent = IMacroFunction< CIRef< IMacroBioDataIter > >
 
using TNodeValuesVec = vector< CRef< CMQueryNodeValue > >
 
- Public Types inherited from IMacroFunction< CIRef< IMacroBioDataIter > >
enum  EScopeEnum
 
enum  ENestedFunc
 
- Protected Attributes inherited from IOperateOnTwoQuals
objects::edit::EExistingText m_ExistingText { objects::edit::eExistingText_cancel }
 
objects::ECapChange m_CapChange { objects::eCapChange_none }
 
- Protected Attributes inherited from IEditMacroFunction
CIRef< IMacroBioDataIterm_DataIter
 
TNodeValuesVec m_Args
 
CRef< CMQueryNodeValuem_Result
 
Int4 m_QualsChangedCount
 Number of changed qualifiers during the function call. More...
 
string m_FuncName
 Name of the function as it's been used in the script. More...
 
CRef< IFunctionLogm_FuncLog
 
- Protected Attributes inherited from IMacroFunction< CIRef< IMacroBioDataIter > >
CRef< CMacroCmdCompositem_CmdComposite
 
string m_Report
 function activity report More...
 
string m_Error
 error report More...
 
ENestedFunc m_Nested
 flag indicating whether the function is nested within another function More...
 

Detailed Description

Definition at line 414 of file macro_fn_aecr.hpp.


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