The Sleuth Kit Framework  4.1
Public Member Functions | List of all members
TskExecutableModule Class Reference

Supports launching a process via an executable file to perform some analysis on a TskFile object in a TskPipeline. More...

#include <TskExecutableModule.h>

Inheritance diagram for TskExecutableModule:
TskModule

Public Member Functions

std::string getOutput () const
 
virtual Status report ()
 Run the module in the reporting pipeline.
 
virtual Status run (TskFile *fileToAnalyze)
 Run the module on the given file.
 
void setOutput (const std::string &outFile)
 Set the output location.
 
virtual void setPath (const std::string &location)
 Set the path of the executable to run. More...
 
 TskExecutableModule ()
 Constructor.
 
virtual ~TskExecutableModule ()
 Destructor.
 
- Public Member Functions inherited from TskModule
std::string getArguments () const
 Get the arguments.
 
std::string getDescription () const
 Get the module description.
 
int getModuleId () const
 Get the module id.
 
std::string getName () const
 Get the module name.
 
virtual std::string getPath () const
 Returns the fully qualified path to the module.
 
std::string getVersion () const
 Get the module version.
 
void setArguments (const std::string &args)
 Set the arguments to be passed to the module.
 
void setModuleId (int moduleId)
 Set the module id.
 

Additional Inherited Members

- Public Types inherited from TskModule
enum  Status { OK = 0, FAIL, STOP }
 Standard values that module methods can return. More...
 
- Static Public Attributes inherited from TskModule
static const std::string CURRENT_FILE_MACRO = "#CURRENT_FILE#"
 The TskModule class supports the use of a string macro that is expanded to the path of the file currently under analysis. More...
 
- Static Protected Member Functions inherited from TskModule
static std::string expandArgumentMacros (const std::string &args, const TskFile *fileToAnalyze)
 
- Protected Attributes inherited from TskModule
std::string m_arguments
 
std::string m_description
 
int m_moduleId
 
std::string m_modulePath
 
std::string m_name
 
std::string m_version
 

Detailed Description

Supports launching a process via an executable file to perform some analysis on a TskFile object in a TskPipeline.

Member Function Documentation

void TskExecutableModule::setPath ( const std::string &  location)
virtual

Set the path of the executable to run.

Confirm that an executable file exists at location.

Reimplemented from TskModule.

References LOGERROR, TskModule::setPath(), and TskException::what().


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

Copyright © 2011-2013 Brian Carrier. (carrier -at- sleuthkit -dot- org)
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.