NCBI C++ ToolKit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
CMacroFunction_FixPubCaps Class Reference

Search Toolkit Book for CMacroFunction_FixPubCaps

#include <gui/objutils/macro_fn_do.hpp>

+ Inheritance diagram for CMacroFunction_FixPubCaps:
+ Collaboration diagram for CMacroFunction_FixPubCaps:

Public Types

enum  EPubType {
  eTitle , eAuthor , eAffiliation , eAffilExceptAffilDiv ,
  eAffilCountry
}
 
- 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
 

Public Member Functions

virtual ~CMacroFunction_FixPubCaps ()
 
virtual void TheFunction ()
 Function implementation. More...
 
- 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 string s_FixCapitalizationInTitle (const string &title, bool first_is_upper, const objects::CSeq_entry_Handle &seh)
 
static Int4 s_FixCapitalizationInAuthor (objects::CName_std &auth_names)
 
static bool s_FixCapitalizationInElement (string &value, bool fix_abbrev, bool fix_short_words, bool cap_after_apostrophe)
 
static void s_FixCapitalizationInCountryString (string &country, bool punct_only)
 
static Int4 s_FixCapsInPubAffil (objects::CAffil &affil, bool punct_only)
 
static Int4 s_FixCapsInPubAffil_NoAffilDiv (objects::CAffil &affil, bool punct_only)
 
static Int4 s_FixCapsInPubAffil_Affil (objects::CAffil &affil, bool punct_only)
 
static Int4 s_FixCapsInPubAffil_Div (objects::CAffil &affil, bool punct_only)
 
static Int4 s_FixCapsInPubAffil_City (objects::CAffil &affil, bool punct_only)
 
static Int4 s_FixCapsInPubAffil_Street (objects::CAffil &affil, bool punct_only)
 
static Int4 s_FixCapsInPubAffil_Sub (objects::CAffil &affil, bool punct_only)
 
static Int4 s_FixCapsInPubAffil_Country (objects::CAffil &affil, bool punct_only)
 

Protected Member Functions

 CMacroFunction_FixPubCaps (EScopeEnum func_scope, EPubType type)
 
virtual bool x_ValidArguments () const
 Tests the number and the type of function arguments. More...
 
void x_FixCapsInPubAffilCountry (objects::CAffil &affil, bool punct_only)
 
- 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

EPubType m_Type
 
- 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 159 of file macro_fn_do.hpp.


The documentation for this class was generated from the following files:
Modified on Mon Jun 17 05:04:14 2024 by modify_doxy.py rev. 669887