xmipp_filename.h File Reference

#include <unistd.h>
#include "xmipp_strings.h"
#include <fcntl.h>

Include dependency graph for xmipp_filename.h:

Go to the source code of this file.

Classes
class	FileName
class	FileNameComparison
class	FileLock

Macros
#define	FILENAMENUMBERLENGTH   6
#define	METADATA_XMIPP_STAR   "# XMIPP_STAR_1"
#define	METADATA_XMIPP_SQLITE   "SQLite format 3"
#define	AT   '@'
#define	COMMA   ','
#define	COLON   ':'
#define	NUM   '#'

Typedefs
typedef struct stat	Stat
String	FileNameVersion
char *	getXmippPath ()
char *	getXmippSrcPath ()
bool	fileExists (const char *filename)
bool	fileExists (const FileName &filename)
void	copyImage (const FileName &source, const FileName &target)
void	deleteFile (const FileName &fn)
void	setMetadataVersion (String version)
String	getMetadataVersion (void)

Macro Definition Documentation

AT

#define AT   '@'

Some filename macros

Definition at line 52 of file xmipp_filename.h.

COLON

#define COLON   ':'

Definition at line 54 of file xmipp_filename.h.

COMMA

#define COMMA   ','

Definition at line 53 of file xmipp_filename.h.

FILENAMENUMBERLENGTH

#define FILENAMENUMBERLENGTH   6

Definition at line 39 of file xmipp_filename.h.

METADATA_XMIPP_SQLITE

#define METADATA_XMIPP_SQLITE   "SQLite format 3"

Definition at line 48 of file xmipp_filename.h.

METADATA_XMIPP_STAR

#define METADATA_XMIPP_STAR   "# XMIPP_STAR_1"

Definition at line 47 of file xmipp_filename.h.

NUM

#define NUM   '#'

Definition at line 55 of file xmipp_filename.h.

Typedef Documentation

Stat

typedef struct stat Stat

Definition at line 41 of file xmipp_filename.h.

Function Documentation

copyImage()

void copyImage	(	const FileName &	source,
		const FileName &	target
	)

Copy one image

Definition at line 872 of file xmipp_filename.cpp.

{
    ImageGeneric img(source);
    img.write(target);
}

deleteFile()

void deleteFile

(

const FileName &

fn

)

Delete file

Definition at line 878 of file xmipp_filename.cpp.

{
    fn.deleteFile();
}

fileExists() [1/2]

bool fileExists ( const char *  filename )

inline

Check if the file exists using the stat function

Definition at line 696 of file xmipp_filename.h.

{
    // do not use stat since updates the atime flag. This may be dangerous
    // for mpi processes in which the same file is accessed many times
    // from different computers even if not writting is made 
    //return ( stat(filename, &buffer) == 0 ? true : false );
    return ( access (filename, F_OK)  == 0 ? true : false);

}

fileExists() [2/2]

bool fileExists ( const FileName &  filename )

inline

Check if the file exists using the stat function

Definition at line 708 of file xmipp_filename.h.

{
    return fileExists(filename.c_str());
}

getMetadataVersion()

String getMetadataVersion

(

void

)

Definition at line 46 of file xmipp_filename.cpp.

{
    return FileNameVersion;
}

getXmippPath()

char* getXmippPath

(

)

Returns the base directory of the Xmipp installation

Definition at line 853 of file xmipp_filename.cpp.

{
    char* path = getenv("XMIPP_HOME");
    if (path == NULL)
        REPORT_ERROR(ERR_VALUE_EMPTY, "getXmippPath::Variable XMIPP_HOME is not defined");
    return path;

}

getXmippSrcPath()

char* getXmippSrcPath

(

)

Returns the source directory of Xmipp

Definition at line 863 of file xmipp_filename.cpp.

{
    char* path = getenv("XMIPP_SRC");
    if (path == NULL)
        REPORT_ERROR(ERR_VALUE_EMPTY, "getXmippSrcPath::Variable XMIPP_HOME is not defined");
    return path;

}

setMetadataVersion()

void setMetadataVersion

(

String

version

)

Definition at line 41 of file xmipp_filename.cpp.

{
    FileNameVersion=version;
}

Variable Documentation

FileNameVersion

String FileNameVersion

Definition at line 39 of file xmipp_filename.cpp.