Nymph  v1.5.2
Flow-Based Data Processing Framework
Public Member Functions | Protected Member Functions | Friends | List of all members
KTCacheDirectory Class Reference

#include <KTCacheDirectory.hh>

Inheritance diagram for KTCacheDirectory:
Inheritance graph

Public Member Functions

bool Configure (const scarab::param_node &node)
 Should perform parameter store and command-line configurations. More...
 
bool IsReady () const
 Check if everything has been correctly configured. More...
 
- Public Member Functions inherited from KTDirectory
 KTDirectory ()
 
virtual ~KTDirectory ()
 
const std::string & GetPath () const
 
bool GetPathExists () const
 
Access GetAccess () const
 
bool SetPath (const std::string &strPath)
 
- Public Member Functions inherited from KTSelfConfigurable
 KTSelfConfigurable (const std::string &name="default-self-name")
 
virtual ~KTSelfConfigurable ()
 
virtual bool Configure ()
 Configure by getting the top-level node from the parameter store. More...
 
bool GetIsConfigured ()
 
- Public Member Functions inherited from KTConfigurable
 KTConfigurable (const std::string &name="default-name")
 
virtual ~KTConfigurable ()
 
bool Configure (const std::string &config)
 Implement the option for calling Configure without passing a parameter store node. More...
 
const std::string & GetConfigName () const
 
void SetConfigName (const std::string &name)
 

Protected Member Functions

 KTCacheDirectory (const std::string &name="cache-directory")
 
virtual ~KTCacheDirectory ()
 

Friends

class scarab::singleton< KTCacheDirectory >
 
class scarab::destroyer< KTCacheDirectory >
 

Additional Inherited Members

- Public Types inherited from KTDirectory
enum  Access { eNone, eRead, eReadWrite }
 
- Protected Attributes inherited from KTDirectory
boost::filesystem::path fPath
 
bool fPathExists
 
Access fAccess
 
- Protected Attributes inherited from KTConfigurable
KTCommandLineHandlerfCLHandler
 
std::string fConfigName
 

Detailed Description

Definition at line 19 of file KTCacheDirectory.hh.

Constructor & Destructor Documentation

◆ KTCacheDirectory()

KTCacheDirectory ( const std::string &  name = "cache-directory")
protected

Definition at line 19 of file KTCacheDirectory.cc.

◆ ~KTCacheDirectory()

~KTCacheDirectory ( )
protectedvirtual

Definition at line 25 of file KTCacheDirectory.cc.

Member Function Documentation

◆ Configure()

bool Configure ( const scarab::param_node &  node)
virtual

Should perform parameter store and command-line configurations.

Implements KTSelfConfigurable.

Definition at line 29 of file KTCacheDirectory.cc.

◆ IsReady()

bool IsReady ( ) const
inlinevirtual

Check if everything has been correctly configured.

Implements KTSelfConfigurable.

Definition at line 36 of file KTCacheDirectory.hh.

Friends And Related Function Documentation

◆ scarab::destroyer< KTCacheDirectory >

friend class scarab::destroyer< KTCacheDirectory >
friend

Definition at line 23 of file KTCacheDirectory.hh.

◆ scarab::singleton< KTCacheDirectory >

friend class scarab::singleton< KTCacheDirectory >
friend

Definition at line 22 of file KTCacheDirectory.hh.


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