NCBI C++ ToolKit
|
Search Toolkit Book for IEditMacroFunction
Base class for any user function that performs editing operations on ASN.1 data. More...
#include <gui/objutils/macro_edit_fn_base.hpp>
Public Types | |
using | TParent = IMacroFunction< CIRef< IMacroBioDataIter > > |
using | TNodeValuesVec = vector< CRef< CMQueryNodeValue > > |
![]() | |
enum | EScopeEnum |
enum | ENestedFunc |
Public Member Functions | |
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 |
![]() | |
IMacroFunction (EScopeEnum func_scope) | |
Constructor. More... | |
virtual | ~IMacroFunction () |
Virtual destructor. More... | |
virtual void | TheFunction ()=0 |
Function implementation. More... | |
EScopeEnum | GetFuncScope () |
ENestedFunc | GetNestedState () |
const string & | GetFuncReport () const |
Function extracts statistic from the object. More... | |
const string & | GetErrorReport () const |
void | SetNestedState (ENestedFunc type) |
Protected Member Functions | |
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 bool | x_ValidArguments () const =0 |
Tests the number and the type of function arguments. 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) |
![]() | |
void | x_LogFunction (CNcbiOstrstream &logstr) |
void | x_LogError (CNcbiOstrstream &logstr) |
Protected Attributes | |
CIRef< IMacroBioDataIter > | m_DataIter |
TNodeValuesVec | m_Args |
CRef< CMQueryNodeValue > | m_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< IFunctionLog > | m_FuncLog |
![]() | |
CRef< CMacroCmdComposite > | m_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... | |
Base class for any user function that performs editing operations on ASN.1 data.
Definition at line 58 of file macro_edit_fn_base.hpp.