NCBI C++ ToolKit
|
Search Toolkit Book for CMacroFunction_LocationSeqType
#include <gui/objutils/macro_fn_loc_constr.hpp>
Static Public Member Functions | |
static objects::CSeq_loc * | s_GetLocation (const string &field_name, CIRef< IMacroBioDataIter > iter) |
Static Public Attributes | |
static const char * | sm_SeqNa = "IS_SEQ_NA" |
class CMacroFunction_LocationSeqType IS_SEQ_AA(["location"]) - returns true if the sequence identified by this location is a protein IS_SEQ_NA(["location"]) - returns true if the sequence identified by this location is a nucleotide sequence Initially, a parameter was necessary to specify the location, but later on this requirement was removed More... | |
static const char * | sm_SeqAa = "IS_SEQ_AA" |
Protected Member Functions | |
virtual bool | x_ValidArguments () const |
Tests the number and the type of function arguments. More... | |
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) |
Protected Attributes | |
objects::ESeqtype_constraint | m_Seqtype |
Protected Attributes inherited from IEditMacroFunction | |
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 |
Protected Attributes inherited from IMacroFunction< CIRef< IMacroBioDataIter > > | |
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... | |
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 |
Definition at line 98 of file macro_fn_loc_constr.hpp.