ARB: GBL_command_arguments Class Reference

ARB

#include <gb_aci.h>

Inheritance diagram for GBL_command_arguments:

Inheritance graph

Collaboration diagram for GBL_command_arguments:

Collaboration graph

Public Member Functions
	GBL_command_arguments (const GBL_call_env &cenv_, const char *command_, GBL_streams &input_, GBL_streams &param_, GBL_streams &output_)

	~GBL_command_arguments ()

GBDATA *	get_item_ref () const

const GBL_call_env &	get_callEnv () const

const GBL_env &	get_env () const

const char *	track_field_access (const char *fieldname) const

GBDATA *	get_gb_main () const

const char *	get_treename () const

const char *	get_cmdName () const

const GBL_streams &	get_param_streams () const

int	param_count () const

const char *	get_param (int idx) const

const char *	get_optional_param (int idx, const char *defaultValue) const

GBL	get_param_smart (int idx) const

bool	set_params_checked ()

Public Attributes
GBL_streams &	input

GBL_streams &	output

Detailed Description

Definition at line 198 of file gb_aci.h.

Constructor & Destructor Documentation

GBL_command_arguments::GBL_command_arguments	(	const GBL_call_env &	cenv_,
		const char *	command_,
		GBL_streams &	input_,
		GBL_streams &	param_,
		GBL_streams &	output_
	)

inline

Definition at line 214 of file gb_aci.h.

GBL_command_arguments::~GBL_command_arguments ( )

inline

Definition at line 229 of file gb_aci.h.

References gb_assert.

Member Function Documentation

GBDATA* GBL_command_arguments::get_item_ref ( ) const

inline

Definition at line 233 of file gb_aci.h.

References GBL_call_env::get_item_ref().

Referenced by apply_to_origin(), GBL_IMPL::check_item_referenced(), gbl_export_sequence(), gbl_findgene(), gbl_readdb(), gbl_sequence(), and gbl_taxonomy().

const GBL_call_env& GBL_command_arguments::get_callEnv ( ) const

inline

Definition at line 234 of file gb_aci.h.

Referenced by custom_gr_env(), custom_gx_env(), gbl_apply_binary_operator(), gbl_command(), gbl_do(), gbl_eval(), gbl_select(), gbl_srt(), and track_field_access().

const GBL_env& GBL_command_arguments::get_env ( ) const

inline

Definition at line 235 of file gb_aci.h.

References GBL_call_env::get_env().

Referenced by apply_to_origin(), and applyToItemFoundByKey().

const char* GBL_command_arguments::track_field_access ( const char * fieldname ) const

inline

Definition at line 237 of file gb_aci.h.

References get_callEnv(), and GBL_call_env::track_field_access().

Referenced by gbl_readdb().

GBDATA* GBL_command_arguments::get_gb_main ( ) const

inline

Definition at line 239 of file gb_aci.h.

References GBL_call_env::get_gb_main().

Referenced by apply_filters(), expect_used_in_genome_db(), gbl_ali_name(), gbl_findacc(), gbl_findspec(), gbl_sequence(), and gbl_sequence_type().

const char* GBL_command_arguments::get_treename ( ) const

inline

Definition at line 240 of file gb_aci.h.

References GBL_call_env::get_treename().

Referenced by gbl_taxonomy().

const char* GBL_command_arguments::get_cmdName ( ) const

inline

Definition at line 241 of file gb_aci.h.

Referenced by apply_ACI(), apply_to_origin(), GBL_IMPL::check_has_parameters(), GBL_IMPL::check_item_referenced(), GBL_IMPL::check_no_parameter(), GBL_IMPL::check_optional_parameters(), GBL_IMPL::check_parameters(), and expect_used_in_genome_db().

const GBL_streams& GBL_command_arguments::get_param_streams ( ) const

inline

Definition at line 243 of file gb_aci.h.

Referenced by apply_ACI().

int GBL_command_arguments::param_count ( ) const

inline

Definition at line 244 of file gb_aci.h.

References GBL_streams::size().

Referenced by apply_ACI(), GBL_IMPL::check_has_parameters(), GBL_IMPL::check_no_parameter(), GBL_IMPL::check_optional_parameters(), GBL_IMPL::check_parameters(), GBL_IMPL::check_valid_param_index(), gbl_apply_binary_operator(), gbl_cut(), gbl_drop(), gbl_echo(), gbl_exec(), gbl_readdb(), gbl_srt(), gbl_swap(), and gbl_taxonomy().

const char* GBL_command_arguments::get_param ( int idx ) const

inline

Definition at line 245 of file gb_aci.h.

References GBL_streams::get().

Referenced by apply_ACI(), apply_to_origin(), applyToItemFoundByKey(), backfront_stream(), gbl_apply_binary_operator(), gbl_command(), gbl_count(), gbl_crop(), gbl_cut(), gbl_define(), gbl_do(), gbl_drop(), gbl_eval(), gbl_exec(), gbl_extract_sequence(), gbl_extract_words(), gbl_head(), gbl_inRange(), gbl_keep(), gbl_readdb(), gbl_remove(), gbl_round(), gbl_select(), gbl_srt(), gbl_swap(), gbl_tail(), gbl_taxonomy(), gbl_trace(), gbl_translate(), mid(), and tab().

const char* GBL_command_arguments::get_optional_param	(	int	idx,
		const char *	defaultValue
	)		const

inline

Definition at line 246 of file gb_aci.h.

References GBL_streams::get(), and GBL_streams::size().

Referenced by gbl_colsplit(), gbl_len(), gbl_merge(), gbl_split(), and gbl_translate().

GBL GBL_command_arguments::get_param_smart ( int idx ) const

inline

Definition at line 247 of file gb_aci.h.

References GBL_streams::get_smart().

bool GBL_command_arguments::set_params_checked ( )

inline

Definition at line 250 of file gb_aci.h.

Referenced by GBL_IMPL::check_has_parameters(), GBL_IMPL::check_no_parameter(), GBL_IMPL::check_optional_parameters(), GBL_IMPL::check_parameters(), and gbl_apply_binary_operator().

Member Data Documentation

GBL_streams& GBL_command_arguments::input

GBL_streams& GBL_command_arguments::output

Definition at line 212 of file gb_aci.h.

Referenced by apply_ACI(), gbl_dd(), gbl_head(), gbl_tail(), gbl_trace(), and mid().

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

ARBDB/gb_aci.h