NCBI C++ ToolKit
Classes | Typedefs | Enumerations
Application Registry
+ Collaboration diagram for Application Registry:

Classes

class  IEnvRegMapper
 IEnvRegMapper –. More...
 
class  CEnvironmentRegistry
 CEnvironmentRegistry –. More...
 
class  CSimpleEnvRegMapper
 CSimpleEnvRegMapper –. More...
 
class  CNcbiEnvRegMapper
 CNcbiEnvRegMapper –. More...
 
class  IRegistry
 IRegistry –. More...
 
class  IRWRegistry
 IRWRegistry –. More...
 
class  CMemoryRegistry
 CMemoryRegistry –. More...
 
struct  CMemoryRegistry::SSection
 
struct  CMemoryRegistry::SEntry
 
class  CCompoundRegistry
 CCompoundRegistry –. More...
 
class  CTwoLayerRegistry
 CTwoLayerRegistry –. More...
 
class  CCompoundRWRegistry
 CCompoundRWRegistry –. More...
 
class  CNcbiRegistry
 CNcbiRegistry –. More...
 
class  CRegistryException
 CRegistryException –. More...
 
class  CRegistryReadGuard
 CRegistry{Read,Write}Guard –. More...
 

Typedefs

typedef CGuard< IRegistry, SSimpleWriteLock< IRegistry > > CRegistryWriteGuard
 

Enumerations

enum  CEnvironmentRegistry::EPriority { CEnvironmentRegistry::ePriority_Min = kMin_Int, CEnvironmentRegistry::ePriority_Default = 0, CEnvironmentRegistry::ePriority_Max = kMax_Int }
 
enum  IRegistry::EFlags {
  IRegistry::fTransient = 0x1, IRegistry::fPersistent = 0x100, IRegistry::fOverride = 0x2, IRegistry::fNoOverride = 0x200,
  IRegistry::fTruncate = 0x4, IRegistry::fNoTruncate = 0x400, IRegistry::fJustCore = 0x8, IRegistry::fNotJustCore = 0x800,
  IRegistry::fIgnoreErrors = 0x10, IRegistry::fInternalSpaces = 0x20, IRegistry::fWithNcbirc = 0x40, IRegistry::fCountCleared = 0x80,
  IRegistry::fSectionCase = 0x1000, IRegistry::fEntryCase = 0x2000, IRegistry::fSectionlessEntries = 0x4000, IRegistry::fSections = 0x8000,
  IRegistry::fPlaintextAllowed = 0x10000, IRegistry::fInSectionComments = 0x20000, IRegistry::fCoreLayers = fTransient | fPersistent | fJustCore, IRegistry::fAllLayers = fTransient | fPersistent | fNotJustCore,
  IRegistry::fCaseFlags = fSectionCase | fEntryCase
}
 Flags controlling the behavior of registry methods. More...
 
enum  IRegistry::EErrAction { IRegistry::eThrow, IRegistry::eErrPost, IRegistry::eReturn }
 What to do if parameter value is present but cannot be converted into the requested type. More...
 
enum  IRegistry::EMasks { IRegistry::fLayerFlags = fAllLayers | fJustCore, IRegistry::fTPFlags = fTransient | fPersistent }
 
enum  IRWRegistry::EOperation { IRWRegistry::eClear, IRWRegistry::eRead, IRWRegistry::eSet }
 Categories of modifying operations. More...
 
enum  CCompoundRegistry::EPriority { CCompoundRegistry::ePriority_Min = kMin_Int, CCompoundRegistry::ePriority_Default = 0, CCompoundRegistry::ePriority_Max = kMax_Int }
 Priority for sub-registries; entries in higher-priority sub-registries take precedence over (identically named) entries in lower-priority ones. More...
 
enum  CCompoundRWRegistry::EPriority { CCompoundRWRegistry::ePriority_MinUser = CCompoundRegistry::ePriority_Min, CCompoundRWRegistry::ePriority_Default = CCompoundRegistry::ePriority_Default, CCompoundRWRegistry::ePriority_MaxUser = CCompoundRegistry::ePriority_Max - 0x10000, CCompoundRWRegistry::ePriority_Reserved }
 Priority for sub-registries; entries in higher-priority sub-registries take precedence over (identically named) entries in lower-priority ones. More...
 
enum  CNcbiRegistry::ECompatFlags {
  CNcbiRegistry::eTransient = fTransient, CNcbiRegistry::ePersistent = fPersistent, CNcbiRegistry::eOverride = fOverride, CNcbiRegistry::eNoOverride = fNoOverride,
  CNcbiRegistry::eTruncate = fTruncate, CNcbiRegistry::eNoTruncate = fNoTruncate
}
 
enum  CNcbiRegistry::EReservedPriority { CNcbiRegistry::ePriority_File = ePriority_Reserved, CNcbiRegistry::ePriority_Overrides, CNcbiRegistry::ePriority_Environment, CNcbiRegistry::ePriority_RuntimeOverrides }
 
enum  CRegistryException::EErrCode {
  CRegistryException::eSection, CRegistryException::eEntry, CRegistryException::eValue, CRegistryException::eUnencrypted,
  CRegistryException::eDecryptionFailed, CRegistryException::eErr
}
 Error types that the Registry can generate. More...
 

Detailed Description

Typedef Documentation

Definition at line 957 of file ncbireg.hpp.

Enumeration Type Documentation

Enumerator
eTransient 
ePersistent 
eOverride 
eNoOverride 
eTruncate 
eNoTruncate 

Definition at line 828 of file ncbireg.hpp.

What to do if parameter value is present but cannot be converted into the requested type.

Enumerator
eThrow 

Throw an exception if an error occurs.

eErrPost 

Log the error message and return default value.

eReturn 

Return default value.

Definition at line 198 of file ncbireg.hpp.

Error types that the Registry can generate.

Enumerator
eSection 

Section name format error.

eEntry 

Entry name format error.

eValue 

General value format error.

eUnencrypted 

Value should have been encrypted, but wasn't.

eDecryptionFailed 

Value looked encrypted, but decryption failed.

eErr 

Other error.

Definition at line 921 of file ncbireg.hpp.

Flags controlling the behavior of registry methods.

Please note:

  • Although CNcbiRegistry supports a full complement of layers, other derived classes may ignore some or all level-related flags.
  • Most read-only operations consider all layers; the only exception is Write, which defaults to fPersistent and fJustCore.
  • The presence or absence of fSectionCase and fEntryCase is relevant ONLY when constructing new registry objects.
Enumerator
fTransient 

Transient – not saved by default.

fPersistent 

Persistent – saved when file is written.

fOverride 

Existing value can be overriden.

fNoOverride 

Cannot change existing value.

fTruncate 

Leading, trailing blanks can be truncated.

fNoTruncate 

Cannot truncate parameter value.

fJustCore 

Ignore auxiliary subregistries.

fNotJustCore 

Include auxiliary subregistries.

fIgnoreErrors 

Continue Read()ing after parse errors.

fInternalSpaces 

Allow internal whitespace in names.

fWithNcbirc 

Include .ncbirc (used only by CNcbiReg.)

fCountCleared 

Let explicitly cleared entries stand.

fSectionCase 

Create with case-sensitive section names.

fEntryCase 

Create with case-sensitive entry names.

fSectionlessEntries 

Allow empty section names (for test_res framework)

fSections 

Indicates that we want sections from x_Enumerate.

fPlaintextAllowed 
See also
GetEncryptedString()
fInSectionComments 

Indicates that we want in-section comments from x_Enumerate.

fCoreLayers 
fAllLayers 
fCaseFlags 

Definition at line 84 of file ncbireg.hpp.

enum IRegistry::EMasks
protected
Enumerator
fLayerFlags 
fTPFlags 

Definition at line 317 of file ncbireg.hpp.

Categories of modifying operations.

Enumerator
eClear 
eRead 
eSet 

Definition at line 362 of file ncbireg.hpp.

Enumerator
ePriority_Min 
ePriority_Default 
ePriority_Max 

Definition at line 97 of file env_reg.hpp.

Priority for sub-registries; entries in higher-priority sub-registries take precedence over (identically named) entries in lower-priority ones.

Ties are broken arbitrarily.

Enumerator
ePriority_Min 
ePriority_Default 
ePriority_Max 

Definition at line 579 of file ncbireg.hpp.

Priority for sub-registries; entries in higher-priority sub-registries take precedence over (identically named) entries in lower-priority ones.

Ties are broken arbitrarily.

Enumerator
ePriority_MinUser 
ePriority_Default 
ePriority_MaxUser 
ePriority_Reserved 

Everything greater is for internal use.

Definition at line 720 of file ncbireg.hpp.

Enumerator
ePriority_File 
ePriority_Overrides 
ePriority_Environment 
ePriority_RuntimeOverrides 

Definition at line 890 of file ncbireg.hpp.

Modified on Thu Jul 28 20:11:30 2016 by modify_doxy.py rev. 506947