Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages

SourceFile Class Reference
[Metadata]

#include <OpenMS/METADATA/SourceFile.h>

List of all members.


Detailed Description

Description of a file location, used to store the origin of (meta) data.

Public Member Functions

 SourceFile ()
 Constructor.
 SourceFile (const SourceFile &source)
 Copy constructor.
 ~SourceFile ()
 Destructor.
SourceFileoperator= (const SourceFile &source)
 Assignment operator.
bool operator== (const SourceFile &rhs) const
 Equality operator.
bool operator!= (const SourceFile &rhs) const
 Equality operator.
const StringgetNameOfFile () const
 returns the file name
void setNameOfFile (const String &name_of_file)
 sets the file name
const StringgetPathToFile () const
 returns the file path
void setPathToFile (const String &path_path_to_file)
 sets the file path
Real getFileSize () const
 returns the file size in MB
void setFileSize (Real file_size)
 sets the file size in MB
const StringgetFileType () const
 returns the file type
void setFileType (const String &file_type)
 sets the file type
const StringgetSha1 () const
 returns the source file's SHA1 hash value
void setSha1 (const String &sha1)
 sets the source file's SHA1 hash value
bool isFileEmpty () const
 returns if the SourceFile is empty

Protected Attributes

String name_of_file_
String path_to_file_
float file_size_
String file_type_
String sha1_

Constructor & Destructor Documentation

SourceFile (  ) 

Constructor.

SourceFile ( const SourceFile source  ) 

Copy constructor.

~SourceFile (  ) 

Destructor.


Member Function Documentation

SourceFile& operator= ( const SourceFile source  ) 

Assignment operator.

bool operator== ( const SourceFile rhs  )  const

Equality operator.

bool operator!= ( const SourceFile rhs  )  const

Equality operator.

const String& getNameOfFile (  )  const

returns the file name

void setNameOfFile ( const String name_of_file  ) 

sets the file name

const String& getPathToFile (  )  const

returns the file path

void setPathToFile ( const String path_path_to_file  ) 

sets the file path

Real getFileSize (  )  const

returns the file size in MB

void setFileSize ( Real  file_size  ) 

sets the file size in MB

const String& getFileType (  )  const

returns the file type

void setFileType ( const String file_type  ) 

sets the file type

const String& getSha1 (  )  const

returns the source file's SHA1 hash value

void setSha1 ( const String sha1  ) 

sets the source file's SHA1 hash value

bool isFileEmpty (  )  const

returns if the SourceFile is empty


Member Data Documentation

String name_of_file_ [protected]

String path_to_file_ [protected]

float file_size_ [protected]

String file_type_ [protected]

String sha1_ [protected]


The documentation for this class was generated from the following file:
Generated Tue Apr 1 15:36:47 2008 -- using doxygen 1.5.4 OpenMS / TOPP 1.1