NCBI C++ ToolKit
|
Search Toolkit Book for CMacroFunction_PubFields
#include <gui/objutils/macro_fn_pubfields.hpp>
Static Public Attributes | |
static const char * | sm_PubTitle = "PUB_TITLE" |
class CMacroFunction_PubFields PUB_TITLE(), PUB_ISSUE(), PUB_AFFIL(subfield) - returns a list of CObjectInfo (or string) that contain publication title subfield is optional, used for affiliation, author or date More... | |
static const char * | sm_PubAffil = "PUB_AFFIL" |
static const char * | sm_PubAuthors = "PUB_AUTHORS" |
static const char * | sm_PubCit = "PUB_CIT" |
static const char * | sm_PubDate = "PUB_DATE" |
static const char * | sm_PubIssue = "PUB_ISSUE" |
static const char * | sm_PubJournal = "PUB_JOURNAL" |
static const char * | sm_PubPages = "PUB_PAGES" |
static const char * | sm_PubPMID = "PUB_PMID" |
static const char * | sm_PubDOI = "PUB_DOI" |
static const char * | sm_PubClass = "PUB_CLASS" |
static const char * | sm_PubStatus = "PUB_STATUS" |
static const char * | sm_PubSerialNumber = "PUB_SERIAL_NUMBER" |
static const char * | sm_PubVolume = "PUB_VOLUME" |
Protected Member Functions | |
virtual bool | x_ValidArguments () const |
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... | |
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 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) |
Static Private Member Functions | |
static string | x_GetStatus (const objects::CPub &pub) |
Private Attributes | |
objects::EPublication_field | m_FieldType |
string | m_ResField |
used for resolving fields for authors, date, affiliation 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 |
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... | |
Definition at line 76 of file macro_fn_pubfields.hpp.