NCBI C++ ToolKit
Classes | Macros | Enumerations
cidtool.hpp File Reference

Declarations of command line interface arguments and handlers. More...

#include <corelib/ncbiapp.hpp>
#include <connect/services/compound_id.hpp>
+ Include dependency graph for cidtool.hpp:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Go to the SVN repository for this file.

Classes

class  CComponentIDToolApp
 
struct  CComponentIDToolApp::SOptions
 

Macros

#define GRID_APP_NAME   "cidtool"
 
#define INPUT_FILE_OPTION   "input-file"
 
#define OUTPUT_FILE_OPTION   "output-file"
 
#define OPTION_ACCEPTED   1
 
#define OPTION_SET   2
 
#define OPTION_EXPLICITLY_SET   4
 
#define OPTION_N(number)   (1 << number)
 

Enumerations

enum  EOption {
  eUntypedArg , eOptionalID , eID , eAppUID ,
  eAttrName , eAttrValue , eNoConnRetries , eLoginToken ,
  eAuth , eInput , eInputFile , eRemoteAppArgs ,
  eRemoteAppStdIn , eRemoteAppStdOut , eRemoteAppStdErr , eOutputFile ,
  eOutputFormat , eNetCache , eCache , eCacheArg ,
  ePassword , eOffset , eSize , eTTL ,
  eEnableMirroring , eTryAllServers , eUseCompoundID , eNetStorage ,
  eObjectKey , eUserKey , eNamespace , ePersistent ,
  eFastStorage , eMovable , eCacheable , eNoMetaData ,
  eNetSchedule , eQueue , eWorkerNode , eBatch ,
  eAffinity , eAffinityList , eUsePreferredAffinities , eClaimNewAffinities ,
  eAnyAffinity , eExclusiveJob , eJobOutput , eJobOutputBlob ,
  eReturnCode , eLimit , eAuthToken , eReliableRead ,
  eConfirmRead , eRollbackRead , eFailRead , eErrorMessage ,
  eJobId , eJobGroupInfo , eClientInfo , eNotificationInfo ,
  eAffinityInfo , eActiveJobCount , eJobsByStatus , eStartAfterJob ,
  eJobCount , eJobStatus , eVerbose , eBrief ,
  eStatusOnly , eProgressMessageOnly , eDeferExpiration , eWaitForJobStatus ,
  eWaitForJobEventAfter , eExtendLifetime , eProgressMessage , eJobGroup ,
  eAllJobs , eWaitTimeout , eFailJob , eQueueArg ,
  eAllQueues , eQueueClasses , eTargetQueueArg , eQueueClassArg ,
  eQueueClass , eQueueDescription , eSwitchArg , ePullback ,
  eWaitForJobCompletion , eNow , eDie , eDrain ,
  eCompatMode , eJobInputDir , eJobOutputDir , eDumpCGIEnv ,
  eDumpCGIStdIn , eAggregationInterval , ePreviousInterval , eFileTrackSite ,
  eFileTrackToken , eMirror , eServiceName , eNoDNSLookup ,
  eNCID , eOptionalNCID , eDirectMode , eNoServerCheck ,
  eReportProgress , eExtendedOptionDelimiter , eClientNode , eClientSession ,
  eCommand , eMultiline , eProtocolDump , eDebugConsole ,
  eDumpNSNotifications , eNumberOfOptions , eCID , eInputFile ,
  eOutputFile , eNumberOfOptions
}
 

Detailed Description

Declarations of command line interface arguments and handlers.

Definition in file cidtool.hpp.

Macro Definition Documentation

◆ GRID_APP_NAME

#define GRID_APP_NAME   "cidtool"

Definition at line 41 of file cidtool.hpp.

◆ INPUT_FILE_OPTION

#define INPUT_FILE_OPTION   "input-file"

Definition at line 43 of file cidtool.hpp.

◆ OPTION_ACCEPTED

#define OPTION_ACCEPTED   1

Definition at line 55 of file cidtool.hpp.

◆ OPTION_EXPLICITLY_SET

#define OPTION_EXPLICITLY_SET   4

Definition at line 57 of file cidtool.hpp.

◆ OPTION_N

#define OPTION_N (   number)    (1 << number)

Definition at line 58 of file cidtool.hpp.

◆ OPTION_SET

#define OPTION_SET   2

Definition at line 56 of file cidtool.hpp.

◆ OUTPUT_FILE_OPTION

#define OUTPUT_FILE_OPTION   "output-file"

Definition at line 44 of file cidtool.hpp.

Enumeration Type Documentation

◆ EOption

enum EOption
Enumerator
eUntypedArg 
eOptionalID 
eID 
eAppUID 
eAttrName 
eAttrValue 
eNoConnRetries 
eLoginToken 
eAuth 
eInput 
eInputFile 
eRemoteAppArgs 
eRemoteAppStdIn 
eRemoteAppStdOut 
eRemoteAppStdErr 
eOutputFile 
eOutputFormat 
eNetCache 
eCache 
eCacheArg 
ePassword 
eOffset 
eSize 
eTTL 
eEnableMirroring 
eTryAllServers 
eUseCompoundID 
eNetStorage 
eObjectKey 
eUserKey 
eNamespace 
ePersistent 
eFastStorage 
eMovable 
eCacheable 
eNoMetaData 
eNetSchedule 
eQueue 
eWorkerNode 
eBatch 
eAffinity 
eAffinityList 
eUsePreferredAffinities 
eClaimNewAffinities 
eAnyAffinity 
eExclusiveJob 
eJobOutput 
eJobOutputBlob 
eReturnCode 
eLimit 
eAuthToken 
eReliableRead 
eConfirmRead 
eRollbackRead 
eFailRead 
eErrorMessage 
eJobId 
eJobGroupInfo 
eClientInfo 
eNotificationInfo 
eAffinityInfo 
eActiveJobCount 
eJobsByStatus 
eStartAfterJob 
eJobCount 
eJobStatus 
eVerbose 
eBrief 
eStatusOnly 
eProgressMessageOnly 
eDeferExpiration 
eWaitForJobStatus 
eWaitForJobEventAfter 
eExtendLifetime 
eProgressMessage 
eJobGroup 
eAllJobs 
eWaitTimeout 
eFailJob 
eQueueArg 
eAllQueues 
eQueueClasses 
eTargetQueueArg 
eQueueClassArg 
eQueueClass 
eQueueDescription 
eSwitchArg 
ePullback 
eWaitForJobCompletion 
eNow 
eDie 
eDrain 
eCompatMode 
eJobInputDir 
eJobOutputDir 
eDumpCGIEnv 
eDumpCGIStdIn 
eAggregationInterval 
ePreviousInterval 
eFileTrackSite 
eFileTrackToken 
eMirror 
eServiceName 
eNoDNSLookup 
eNCID 
eOptionalNCID 
eDirectMode 
eNoServerCheck 
eReportProgress 
eExtendedOptionDelimiter 
eClientNode 
eClientSession 
eCommand 
eMultiline 
eProtocolDump 
eDebugConsole 
eDumpNSNotifications 
eNumberOfOptions 
eCID 
eInputFile 
eOutputFile 
eNumberOfOptions 

Definition at line 48 of file cidtool.hpp.

Modified on Sun Apr 21 03:40:15 2024 by modify_doxy.py rev. 669887