Search Toolkit Book for CMacroFunction_SatelliteType

#include <gui/objutils/macro_fn_aecr.hpp>

Inheritance diagram for CMacroFunction_SatelliteType:

Collaboration diagram for CMacroFunction_SatelliteType:

Public Member Functions
	CMacroFunction_SatelliteType (EScopeEnum func_scope)

Public Member Functions inherited from CMacroFunction_SatelliteFields
virtual	~CMacroFunction_SatelliteFields ()

virtual void	TheFunction ()
	class CMacroFunction_SatelliteFields SATELLITE_NAME() SATELLITE_TYPE() 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 CTempString	GetFuncName ()

Static Public Member Functions inherited from CMacroFunction_SatelliteFields
static string	s_GetSatelliteType (const string &value)

static string	s_GetSatelliteName (const string &value)

static string	s_MakeSatellite (const string &type, const string &name)

Additional Inherited Members
Public Types inherited from CMacroFunction_SatelliteFields
enum	ESatelliteFieldType { eSatelliteType , eSatelliteName }

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 Member Functions inherited from CMacroFunction_SatelliteFields
	CMacroFunction_SatelliteFields (EScopeEnum func_scope, ESatelliteFieldType type)

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 inherited from CMacroFunction_SatelliteFields
ESatelliteFieldType	m_FieldType

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 558 of file macro_fn_aecr.hpp.

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

include/gui/objutils/macro_fn_aecr.hpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description