Inheritance diagram for CMacroFunction_AuthorFix:

Collaboration diagram for CMacroFunction_AuthorFix:

Public Types
enum	EActionType { eAuthorFixNotSet , eMoveMiddleName , eStripSuffix , eReverseNames , eTruncateMI }

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_AuthorFix ()

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 string &	GetFuncReport () const
	Function extracts statistic from the object. More...

const string &	GetErrorReport () const

void	SetNestedState (ENestedFunc type)

Static Public Member Functions
static const string &	GetDescription (EActionType fix_type)

static EActionType	GetActionType (const string &descr)

static bool	s_MoveMiddleToFirst (objects::CName_std &name)

static bool	s_TruncateMiddleInitials (objects::CName_std &name)

static bool	s_FixInitials (objects::CName_std &name)

static bool	s_ReverseAuthorNames (objects::CName_std &name)

static string	s_GetFirstNameInitials (const string &first_name)

static string	s_InsertInitialPeriods (const string &orig)

static string	s_GetFirstNameInitialsWithoutStops (const string &first_name)

static void	s_BuildName (const string &firstname, const string &mid_initials, const string &lastname, const string &suffix, objects::CName_std &name)

Protected Member Functions
	CMacroFunction_AuthorFix (EScopeEnum func_scope, EActionType type)

virtual bool	x_ValidArguments () const
	Tests the number and the type of function arguments. More...

int	x_MakeAuthorChanges (objects::CAuth_list &auth_list)

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
EActionType	m_FixType

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...

Detailed Description

Definition at line 155 of file macro_fn_pubfields.hpp.

The documentation for this class was generated from the following files:

Public Types