Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from http://www.ncbi.nlm.nih.gov/IEB/ToolBox/CPP_DOC/doxyhtml/ncbiapp__api_8hpp_source.html below:

NCBI C++ ToolKit: include/corelib/ncbiapp_api.hpp Source File

(

)

{

m_App !=

; }

operator !(

)

{

m_App ==

; }

SSystemMutex& GetInstanceMutex(

);

*

* argv,

*

* envp = 0,

*

* argv,

*

* envp = 0,

(

);

(

) = 0;

DryRun(

);

Exit(

);

SetEnvironment(

& name,

&

);

HasLoadedConfig(

)

;

FinishedLoadingConfig(

)

;

& GetConfigPath(

)

;

& GetProgramDisplayName(

)

;

GetAppName(EAppNameType name_type = eBaseName,

argc = 0,

*

* argv =

);

IsDryRun(

)

;

m_OnExitActions.AddAction(func);

& GetInstanceLock(

);

EPreparseArgs PreparseArgs(

argc,

*

* argv);

fDisableStdArgs = 0x01

DisableArgDescriptions(

disable = fDisableStdArgs);

fNoSyncWithStdio = 0x01,

fDefault_CinBufferSize = 0x02,

fDefault_SyncWithStdio = 0x00,

LoadConfig(

& reg,

* conf,

LoadConfig(

& reg,

* conf);

SetProgramDisplayName(

& app_name);

FindProgramExecutablePath(

argc,

*

* argv,

* real_path = 0);

AppStart(

);

AppStop(

exit_code);

SetExitCode(

exit_code, EExitMode when = eExceptionalExits);

fSkipSafeStaticDestroy = 1 << 0

ExecuteOnExitActions();

x_HonorStandardSettings(

* reg = 0);

x_ReadLogOptions();

x_LogOptions(

event);

x_SetupStdio(

);

x_AddDefaultArgs(

);

* got_exception);

(

) = 0;

Idle(

);

&

CNcbiActionGuard class Executes registered callbacks on request or on destruction.

Interface for application idler.

Interface class for Phone Home Policy.

void AddOnExitAction(TFunc func)

Add callback to be executed from CNcbiApplicationAPI destructor.

EHideStdArgs

Which standard flag's descriptions should not be displayed in the usage message.

bool HasLoadedConfig(void) const

Check if the config file has been loaded.

unique_ptr< CNcbiArguments > m_Arguments

Command-line arguments.

bool ReloadConfig(CMetaRegistry::TFlags flags=CMetaRegistry::fReloadIfChanged, IRegistry::TFlags reg_flags=IRegistry::fWithNcbirc)

Reload the configuration file.

CNcbiApplicationAPI * m_App

unique_ptr< CNcbiOstream > m_DiagStream

Opt., aux., see eDS_ToMemory.

int TStdioSetupFlags

Binary OR of "EStdioSetup".

NCBI_EXCEPTION_DEFAULT(CAppException, CCoreException)

string m_ConfigPath

Path to .ini file used.

CNcbiActionGuard m_OnExitActions

Actions executed on app destruction.

TDisableArgDesc m_DisableArgDesc

Arg desc. disabled.

TStdioSetupFlags m_StdioFlags

Std C++ I/O adjustments.

string m_LogFileName

Log file name.

friend class CNcbiApplicationGuard

string m_ProgramDisplayName

Display name of app.

CNcbiApplicationAPI * operator->(void)

virtual int Run(void)=0

Run the application.

int m_LogOptions

logging of env, reg, args, path

void SetAppFlags(TAppFlags flags)

IPhoneHomePolicy * m_PhoneHomePolicy

Pointer to active Phone Home Policy, if any.

string m_ExePath

Program executable path.

const CNcbiEnvironment & GetEnvironment(void) const

Get the application's cached environment.

CNcbiEnvironment & SetEnvironment(void)

Get a non-const copy of the application's cached environment.

const string & GetProgramExecutablePath(EFollowLinks follow_links=eIgnoreLinks) const

Get the application's executable path.

EExitMode

When to return a user-set exit code.

const CNcbiRegistry & GetConfig(void) const

Get the application's cached configuration parameters (read-only).

EStdioSetup

Flags to adjust standard I/O streams' behaviour.

int m_ExitCode

Exit code to force.

char * m_CinBuffer

Cin buffer if changed.

EPreparseArgs

Result of PreparseArgs()

INcbiIdler * GetIdler(EOwnership ownership=eNoOwnership)

Return currently installed idler or NULL.

const char * m_LogFile

Logfile if set in the command line.

EErrCode

Error types that an application can generate.

const CArgDescriptions * GetArgDescriptions(void) const

Get argument descriptions (set by SetupArgDescriptions)

shared_ptr< CReadLockGuard > m_AppLock

unique_ptr< CNcbiEnvironment > m_Environ

Cached application env.

const string & GetConfigPath(void) const

Get the full path to the configuration file (if any) we ended up using.

unique_ptr< CArgs > m_Args

Parsed cmd.-line args.

IPhoneHomePolicy * GetPhoneHomePolicy() const

Return pointer to current Phone Home Policy or NULL.

int THideStdArgs

Binary OR of "EHideStdArgs".

bool FinishedLoadingConfig(void) const

Check if the application has finished loading config file (successfully or not).

EFollowLinks

Whether to follow symbolic links (also known as shortcuts or aliases)

const string & GetProgramDisplayName(void) const

Get the application's "display" name.

bool IsDryRun(void) const

Check if it is a test run.

EExitMode m_ExitCodeCond

When to force it (if ever)

CNcbiRegistry & GetRWConfig(void)

Get the application's cached configuration parameters, accessible for read-write for an application's...

const CNcbiApplicationAPI * Get(void) const

unique_ptr< CArgDescriptions > m_ArgDesc

Cmd.-line arg descriptions.

virtual void Idle(void)=0

EDisableArgDesc

Disable argument descriptions.

int TDisableArgDesc

Binary OR of "EDisableArgDesc".

CNcbiApplicationAPI * Get(void)

CRef< CNcbiRegistry > m_Config

Guaranteed to be non-NULL.

static CNcbiApplicationAPI * m_Instance

Current app. instance.

CNcbiApplicationAPI & operator*(void)

ENcbiOwnership m_PhoneHomePolicy_Ownership

Phone Home Policy ownersheep.

void SetIdler(INcbiIdler *idler, EOwnership ownership=eTakeOwnership)

Set new idler and ownership.

virtual ~CDefaultIdler(void)

virtual ~INcbiIdler(void)

string m_RealExePath

Symlink-free executable path.

const CNcbiArguments & GetArguments(void) const

Get the application's cached unprocessed command-line arguments.

void RunIdler(void)

Execute currently installed idler if any.

bool m_ConfigLoaded

Finished loading config.

THideStdArgs m_HideArgs

Std cmd.-line flags to hide.

string m_DefaultConfig

conf parameter to AppMain

CRef< CVersionAPI > m_Version

Program version.

@ eNoExits

never (stick to existing logic)

@ eExceptionalExits

when an (uncaught) exception occurs

@ ePreparse_Continue

Continue application execution.

@ eUnsetArgs

Command-line argument description not found.

@ eSecond

Second instance of CNcbiApplicationAPI is prohibited.

@ eLoadConfig

Registry data failed to load from config file.

@ eSetupDiag

Application diagnostic stream setup failed.

@ eIgnoreLinks

Do not follow symbolic links.

@ eFollowLinks

Follow symbolic links.

@ eFullName

per GetProgramExecutablePath(eIgnoreLinks)

@ eBaseName

per GetProgramDisplayName

@ eTakeOwnership

An object can take ownership of another.

@ eNoOwnership

No ownership is assumed.

@ fHideAll

Hide all standard argument descriptions.

@ fHideFullVersion

Hide full version description.

@ fHideConffile

Hide configuration file description.

@ fHideHelp

Hide help description.

@ fHideXmlHelp

Hide XML help description.

@ fHideLogfile

Hide log file description.

@ fHideVersion

Hide version description.

@ fHideFullHelp

Hide full help description.

@ fHideDryRun

Hide dryrun description.

EAppDiagStream

Where to write the application's diagnostics to.

@ eDS_Default

Try standard log file (app.name + ".log") in /log/, use stderr on failure.

virtual const char * GetErrCodeString(void) const override

Translate from the error code value to its string representation.

int TFlags

Binary OR of "EFlags".

@ fWithNcbirc

Include .ncbirc (used only by CNcbiReg.)

#define END_NCBI_SCOPE

End previously defined NCBI scope.

#define BEGIN_NCBI_SCOPE

Define ncbi namespace.

IO_PREFIX::ostream CNcbiOstream

Portable alias for ostream.

NCBI_NS_STD::string::size_type SIZE_TYPE

enum ENcbiOwnership EOwnership

Ownership relations between objects.

ENcbiOwnership

Ownership relations between objects.

#define NCBI_XNCBI_EXPORT

const TYPE & Get(const CNamedParameterList *param)

const string version

version string

const GenericPointer< typename T::ValueType > T2 value

#define GetArgs

Avoid preprocessor name clash with the NCBI C Toolkit.

Defines command line argument related classes.

Defines unified interface to application:

Define IPhoneHomePolicy, interface class for Phone Home Policy.

This class allows to add build info (date and tag) to application version.

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4