NCBI C++ ToolKit
Public Types | Public Member Functions | Protected Attributes | List of all members
CNetCacheAPICF Class Reference

Search Toolkit Book for CNetCacheAPICF

+ Inheritance diagram for CNetCacheAPICF:
+ Collaboration diagram for CNetCacheAPICF:

Public Types

typedef SNetCacheAPIImpl TDriver
 
typedef SNetCacheAPIImpl IFace
 
typedef IFace TInterface
 
typedef IClassFactory< SNetCacheAPIImplTParent
 
typedef TParent::SDriverInfo TDriverInfo
 
typedef TParent::TDriverList TDriverList
 
- Public Types inherited from IClassFactory< SNetCacheAPIImpl >
typedef SNetCacheAPIImpl TInterface
 
typedef ncbi::SDriverInfo SDriverInfo
 
typedef ncbi::TDriverList TDriverList
 
typedef CDefaultDriverVersion< SNetCacheAPIImplTDefaultDriverVersion
 

Public Member Functions

 CNetCacheAPICF (const string &driver_name=kNetCacheAPIDriverName, int patch_level=-1)
 Construction. More...
 
virtual TInterfaceCreateInstance (const string &driver=kEmptyStr, CVersionInfo version=NCBI_INTERFACE_VERSION(IFace), const TPluginManagerParamTree *params=0) const
 Create instance of TDriver. More...
 
void GetDriverVersions (TDriverList &info_list) const
 Versions of the interface exported by the factory. More...
 
- Public Member Functions inherited from IClassFactory< SNetCacheAPIImpl >
virtual ~IClassFactory (void)
 

Protected Attributes

CVersionInfo m_DriverVersionInfo
 
string m_DriverName
 

Additional Inherited Members

- Static Public Member Functions inherited from IClassFactory< SNetCacheAPIImpl >
static const CVersionInfoGetDefaultDrvVers (void)
 
- Protected Member Functions inherited from IClassFactory< SNetCacheAPIImpl >
string GetParam (const string &driver_name, const TPluginManagerParamTree *params, const string &param_name, bool mandatory, const string &default_value) const
 Utility function to get an element of parameter tree Throws an exception when mandatory parameter is missing (or returns the default value) More...
 
const stringGetParam (const string &driver_name, const TPluginManagerParamTree *params, const string &param_name, bool mandatory) const
 This version always defaults to the empty string so that it can safely return a reference. More...
 

Detailed Description

Definition at line 979 of file netcache_api.cpp.

Member Typedef Documentation

◆ IFace

Definition at line 984 of file netcache_api.cpp.

◆ TDriver

Definition at line 983 of file netcache_api.cpp.

◆ TDriverInfo

Definition at line 987 of file netcache_api.cpp.

◆ TDriverList

Definition at line 988 of file netcache_api.cpp.

◆ TInterface

Definition at line 985 of file netcache_api.cpp.

◆ TParent

Definition at line 986 of file netcache_api.cpp.

Constructor & Destructor Documentation

◆ CNetCacheAPICF()

CNetCacheAPICF::CNetCacheAPICF ( const string driver_name = kNetCacheAPIDriverName,
int  patch_level = -1 
)
inline

Construction.

Parameters
driver_nameDriver name string
patch_levelPatch level implemented by the driver. By default corresponds to interface patch level.

Definition at line 997 of file netcache_api.cpp.

References _ASSERT, and m_DriverName.

Member Function Documentation

◆ CreateInstance()

virtual TInterface* CNetCacheAPICF::CreateInstance ( const string driver = kEmptyStr,
CVersionInfo  version = NCBI_INTERFACE_VERSION(IFace),
const TPluginManagerParamTree params = 0 
) const
inlinevirtual

Create instance of TDriver.

Implements IClassFactory< SNetCacheAPIImpl >.

Definition at line 1011 of file netcache_api.cpp.

References CVersionInfo::eNonCompatible, kEmptyStr, m_DriverName, NCBI_INTERFACE_VERSION, NULL, and version.

◆ GetDriverVersions()

void CNetCacheAPICF::GetDriverVersions ( TDriverList driver_list) const
inlinevirtual

Versions of the interface exported by the factory.

Implements IClassFactory< SNetCacheAPIImpl >.

Definition at line 1025 of file netcache_api.cpp.

References m_DriverName, and m_DriverVersionInfo.

Member Data Documentation

◆ m_DriverName

string CNetCacheAPICF::m_DriverName
protected

Definition at line 1031 of file netcache_api.cpp.

Referenced by CNetCacheAPICF(), CreateInstance(), and GetDriverVersions().

◆ m_DriverVersionInfo

CVersionInfo CNetCacheAPICF::m_DriverVersionInfo
protected

Definition at line 1030 of file netcache_api.cpp.

Referenced by GetDriverVersions().


The documentation for this class was generated from the following file:
Modified on Wed Jun 19 17:02:03 2024 by modify_doxy.py rev. 669887