ossimFilename Class Reference

#include <ossimFilename.h>

Inheritance diagram for ossimFilename:

Public Types
enum	AccessModes {   OSSIM_READ_WRITE = 6, OSSIM_READ = 4, OSSIM_WRITE = 2, OSSIM_EXE = 1,   OSSIM_EXIST = 0 }
Public Types inherited from ossimString
typedef std::string::const_iterator	const_iterator
typedef std::string::iterator	iterator
typedef std::string::size_type	size_type

Public Member Functions
	ossimFilename ()
	ossimFilename (const ossimFilename &src)
	ossimFilename (const ossimString &src)
	ossimFilename (const std::string &src)
	ossimFilename (const char *src)
const ossimFilename &	operator= (const ossimFilename &f)
template<class Iter >
	ossimFilename (Iter s, Iter e)
bool	operator== (const ossimFilename &rhs) const
bool	operator== (const ossimString &rhs) const
bool	operator== (const char *rhs) const
bool	setTimes (ossimLocalTm *accessTime, ossimLocalTm *modTime, ossimLocalTm *createTime) const
	Writes f to the output stream os. More...
bool	getTimes (ossimLocalTm *accessTime, ossimLocalTm *modTime, ossimLocalTm *createTime) const
ossim_int64	lastAccessed () const
	Time in seconds since last accessed. More...
bool	touch () const
ossimFilename	expand () const
	Method to do file name expansion. More...
bool	exists () const
bool	isFile () const
bool	isDir () const
bool	isReadable () const
bool	isUrl () const
bool	isWriteable () const
bool	isExecutable () const
ossim_int64	fileSize () const
ossimString	ext () const
ossimFilename	path () const
ossimFilename	drive () const
ossimFilename	file () const
ossimFilename	fileNoExtension () const
ossimFilename	noExtension () const
ossimFilename &	setExtension (const ossimString &e)
	Sets the extension of a file name. More...
ossimFilename &	setDrive (const ossimString &d)
	Sets the file path and drive. More...
ossimFilename &	setPath (const ossimString &p)
ossimFilename &	setFile (const ossimString &f)
void	split (ossimString &drivePart, ossimString &pathPart, ossimString &filePart, ossimString &extPart) const
void	merge (const ossimString &drivePart, const ossimString &pathPart, const ossimString &filePart, const ossimString &extPart)
ossimFilename	dirCat (const ossimFilename &file) const
bool	createDirectory (bool recurseFlag=true, int perm=0775) const
bool	rename (const ossimFilename &destFile, bool overwriteDestinationFlag=true) const
bool	remove () const
bool	wildcardRemove () const
bool	copyFileTo (const ossimFilename &outputFile) const
	Copies this file to output file. More...
bool	isRelative () const
	Checks whether file name is relative or absolute. More...
bool	needsExpansion () const
	Method to check if expansion is needed. More...
char	getPathSeparator () const
ossimFilename &	appendTimestamp ()
	Convenience method to append a generic timestamp to the base-name portion of the filename. More...
ossimFilename &	append (const ossimString &append_this_to_filename)
	Convenience method to append a string to the base-name portion of the filename. More...
std::string	native () const
Public Member Functions inherited from ossimString
	ossimString ()
	default constructor More...
	ossimString (const std::string &s)
	constructor that takes a std::string More...
	ossimString (const char *aString)
	constructor that takes char* NOTE: std::string construtor throws exception given null pointer; hence, the null check. More...
	ossimString (const ossimString &aString)
	copy constructor More...
	ossimString (std::string::size_type n, char c)
	constructor - constructs with n copies of c More...
	ossimString (char aChar)
	constructor - constructs with 1 c. More...
template<class Iter >
	ossimString (Iter startIter, Iter endIter)
	~ossimString ()
	destructor More...
bool	contains (char aChar) const
bool	contains (const ossimString &aString) const
bool	contains (const char *aString) const
	operator const std::string & () const
	Type conversion operator to a const std::string&. More...
	operator std::string & ()
	Type conversion operator to a std::string&. More...
	operator const char * () const
	Type conversion operator to a const char*. More...
const char *	chars () const
	For backward compatibility. More...
	operator bool () const
const ossimString &	operator= (const std::string &s)
const ossimString &	operator= (const char *s)
const ossimString &	operator= (char c)
const ossimString &	operator= (const ossimString &s)
const ossimString &	operator+= (const ossimString &s)
const ossimString &	operator+= (const std::string &s)
const ossimString &	operator+= (const char *s)
const ossimString &	operator+= (char c)
const ossimString &	append (const ossimString &s)
const ossimString &	append (const std::string &s)
const ossimString &	append (const char *s)
const char &	at (std::string::size_type n) const
	Provides access to the data contained in the string. More...
char &	at (std::string::size_type n)
	Provides access to the data contained in the string. More...
const ossimString &	append (std::string::size_type n, char c)
	Append n copies of c to *this. More...
ossimString	operator+ (const ossimString &s) const
ossimString	operator+ (const std::string &s) const
ossimString	operator+ (const char *s) const
ossimString	operator+ (char c) const
bool	operator== (const ossimString &rhs) const
	Test if this ossimString is equal to another ossimString. More...
bool	operator== (const char *rhs) const
	Test if this ossimString is equal to a C sting. More...
bool	operator!= (const ossimString &rhs) const
	Test if this ossimString is not equal to another ossimString. More...
bool	operator!= (const char *rhs) const
	Test if this ossimString is not equal to a C sting. More...
bool	operator< (const ossimString &rhs) const
bool	operator<= (const ossimString &rhs) const
bool	operator> (const ossimString &rhs) const
bool	operator>= (const ossimString &rhs) const
char &	operator[] (std::string::size_type i)
const char &	operator[] (std::string::size_type i) const
std::string &	insert (std::string::size_type pos, const char *s)
	If pos > size(), throws out_of_range. More...
void	push_back (char c)
	Equivalent to insert(end(), c). More...
std::string	substr (std::string::size_type pos=0, std::string::size_type n=std::string::npos) const
	Equivalent to basic_string(*this, pos, n). More...
ossimString	trim (const ossimString &valueToTrim=ossimString(" \\)) const
	this will strip lead and trailing character passed in. More...
ossimString &	trim (const ossimString &valueToTrim=ossimString(" \\))
ossimString	beforePos (std::string::size_type pos) const
ossimString	afterPos (std::string::size_type pos) const
ossimString	substitute (const ossimString &searchKey, const ossimString &replacementValue, bool replaceAll=false) const
	Substitutes searchKey string with replacementValue and returns a string. More...
ossimString &	gsub (const ossimString &searchKey, const ossimString &replacementValue, bool replaceAll=false)
	Substitutes searchKey string with replacementValue and returns a reference to *this. More...
std::vector< ossimString >	explode (const ossimString &delimeter) const
ossimString	expandEnvironmentVariable () const
	If the variable "$(env_var_name)" is found in the string, where "env_var_name" is any system environment variable resolvable by the getenv() function, the variable is expanded in place and the result returned. More...
ossimString &	upcase ()
	Upcases this string. More...
ossimString	upcase () const
ossimString &	downcase ()
	Downcases this string. More...
ossimString	downcase () const
const char *	c_str () const
	Returns a pointer to a null-terminated array of characters representing the string's contents. More...
const char *	data () const
	Returns a pointer to an array of characters (not necessarily null-terminated) representing the string's contents. More...
std::string::size_type	size () const
std::string::size_type	length () const
bool	empty () const
const std::string &	string () const
std::string &	string ()
std::string::iterator	begin ()
std::string::iterator	end ()
std::string::const_iterator	begin () const
std::string::const_iterator	end () const
void	clear ()
	Erases the entire container. More...
std::string::iterator	erase (std::string::iterator p)
	Erases the character at position p. More...
std::string::iterator	erase (std::string::iterator first, std::string::iterator last)
	Erases the range [first, last). More...
std::string &	erase (std::string::size_type pos=0, std::string::size_type n=std::string::npos)
	Erases a range. More...
std::string::size_type	find (const std::string &s, std::string::size_type pos=0) const
	Searches for s as a substring of *this, beginning at character pos of *this. More...
std::string::size_type	find (const char *s, std::string::size_type pos, std::string::size_type n) const
	Searches for the first n characters of s as a substring of *this, beginning at character pos of *this. More...
std::string::size_type	find (const char *s, std::string::size_type pos=0) const
	Searches for a null-terminated character array as a substring of *this, beginning at character pos of *this. More...
std::string::size_type	find (char c, std::string::size_type pos=0) const
	Searches for the character c, beginning at character position pos. More...
std::string::size_type	rfind (const std::string &s, std::string::size_type pos=0) const
	Searches backward for s as a substring of *this, beginning at character position min(pos, size()). More...
std::string::size_type	rfind (const char *s, std::string::size_type pos, std::string::size_type n) const
	Searches backward for the first n characters of s as a substring of *this, beginning at character position min(pos, size()). More...
std::string::size_type	rfind (const char *s, std::string::size_type pos=0) const
	Searches backward for a null-terminated character array as a substring of *this, beginning at character min(pos, size()). More...
std::string::size_type	rfind (char c, std::string::size_type pos=0) const
	Searches backward for the character c, beginning at character position min(pos, size(). More...
std::string::size_type	find_first_of (char c, std::string::size_type pos=0) const
	Equivalent to find(c, pos). More...
std::string::size_type	find_first_not_of (char c, std::string::size_type pos=0) const
	Returns the smallest character position N such that pos <= N < size(), and such that (*this)[N] does not compare equal to c. More...
std::string::size_type	find_first_of (const char *s, std::string::size_type pos=0) const
	Equivalent to find_first_of(s, pos, traits::length(s)). More...
std::string::size_type	find_first_not_of (const char *s, std::string::size_type pos=0) const
	Equivalent to find_first_not_of(s, pos, traits::length(s)). More...
std::string::size_type	find_last_of (char c, std::string::size_type pos=std::string::npos) const
	Equivalent to rfind(c, pos). More...
std::string &	assign (std::string::size_type n, char c)
	Erases the existing characters and replaces them by n copies of c. More...
std::string &	replace (std::string::size_type pos, std::string::size_type n, const std::string &s)
	Replaces a substring of *this with the string s. More...
std::string &	replace (std::string::iterator first, std::string::iterator last, const std::string &s)
	brief Equivalent to insert(erase(first, last), s.begin(), s.end()). More...
std::string &	replace (std::string::size_type pos, std::string::size_type n, const std::string &s, std::string::size_type pos1, std::string::size_type n1)
	Replaces a substring of *this with a substring of s. More...
void	reserve (std::string::size_type n)
	Requests that the string's capacity be changed. More...
ossimString	before (const ossimString &str, std::string::size_type pos=0) const
	METHOD: before(str, pos) Returns string beginning at pos and ending one before the token str If string not found or pos out of range the whole string will be returned. More...
ossimString	after (const ossimString &str, std::string::size_type pos=0) const
	METHOD: after(str, pos) Returns string immediately after the token str. More...
char *	stringDup () const
bool	toBool () const
	String to numeric methods. More...
ossim_uint8	toUInt8 () const
int	toInt () const
ossim_int16	toInt16 () const
ossim_uint16	toUInt16 () const
ossim_int32	toInt32 () const
ossim_uint32	toUInt32 () const
ossim_int64	toInt64 () const
ossim_uint64	toUInt64 () const
ossim_int64	memoryUnitToInt64 () const
	This takes a string and will test for numeric followed by a unit type: More...
long	toLong () const
	toLong's deprecated, please use the toInts... More...
unsigned long	toULong () const
ossim_float32	toFloat32 () const
ossim_float64	toFloat64 () const
double	toDouble () const
void	split (std::vector< ossimString > &result, const ossimString &separatorList, bool skipBlankFields=false) const
	Splits this string into a vector of strings (fields) using the delimiter list specified. More...
std::vector< ossimString >	split (const ossimString &separatorList, bool skipBlankFields=false) const
const ossimString &	join (const std::vector< ossimString > &stringList, const ossimString &separator)
ossimString	beforeRegExp (const char *regularExpressionPattern) const
	Returns from start of string up to but not including found pattern. More...
ossimString	fromRegExp (const char *regularExpressionPattern) const
	Returns from position of found pattern to end of string. More...
ossimString	afterRegExp (const char *regularExpressionPattern) const
	Returns from position after found pattern to end of string. More...
ossimString	match (const char *regularExpressionPattern) const
	Returns from found pattern to end of pattern. More...
ossimString	replaceAllThatMatch (const char *regularExpressionPattern, const char *value="") const
ossimString	replaceStrThatMatch (const char *regularExpressionPattern, const char *value="") const
ossimString	urlEncode () const
ossimString	getOssimId () const
	If OSSIM_ID_ENABLED returns the OSSIM_ID which currently is the expanded cvs. More...

Static Public Member Functions
static bool	remove (const ossimFilename &pathname)
	Removes pathname from filesystem if supported by platform. More...
static bool	wildcardRemove (const ossimFilename &pathname)
	Will use a wildcard remove. More...
Static Public Member Functions inherited from ossimString
static ossimString	upcase (const ossimString &aString)
static ossimString	downcase (const ossimString &aString)
static bool	toBool (const ossimString &aString)
static ossim_uint8	toUInt8 (const ossimString &aString)
static int	toInt (const ossimString &aString)
static ossim_int16	toInt16 (const ossimString &aString)
static ossim_uint16	toUInt16 (const ossimString &aString)
static ossim_int32	toInt32 (const ossimString &aString)
static ossim_uint32	toUInt32 (const ossimString &aString)
static ossim_int64	toInt64 (const ossimString &aString)
static ossim_uint64	toUInt64 (const ossimString &aString)
static ossim_int64	memoryUnitToInt64 (const ossimString &aString)
static long	toLong (const ossimString &aString)
static unsigned long	toULong (const ossimString &aString)
static ossim_float32	toFloat32 (const ossimString &aString)
static ossim_float64	toFloat64 (const ossimString &aString)
static double	toDouble (const ossimString &aString)
static ossimString	toString (bool aValue)
	Numeric to string methods. More...
static ossimString	toString (ossim_int16 aValue)
static ossimString	toString (ossim_uint16 aValue)
static ossimString	toString (ossim_int32 aValue)
static ossimString	toString (ossim_uint32 aValue)
static ossimString	toString (ossim_int64 aValue)
static ossimString	toString (ossim_uint64 aValue)
static ossimString	toString (ossim_float32 aValue, ossim_int32 precision=8, bool fixed=false)
static ossimString	toString (ossim_float64 aValue, ossim_int32 precision=15, bool fixed=false)
static ossimString	stripLeading (const ossimString &value, char characterToStrip)

Static Public Attributes
static const ossimFilename	NIL =("")
	This was taken from Wx widgets for performing touch and access date stamps. More...

Protected Member Functions
void	converPathSeparator ()
	Converts slashes of this to internal '/' format. More...

Static Protected Attributes
static const char	OSSIM_NATIVE_PATH_SEPARATOR = '/'
static const char	OSSIM_FILENAME_PATH_SEPARATOR = '/'

Additional Inherited Members
Protected Attributes inherited from ossimString
std::string	m_str

Detailed Description

Definition at line 20 of file ossimFilename.h.

Member Enumeration Documentation

AccessModes

enum ossimFilename::AccessModes

Enumerator
OSSIM_READ_WRITE
OSSIM_READ
OSSIM_WRITE
OSSIM_EXE
OSSIM_EXIST

Definition at line 23 of file ossimFilename.h.

   {
      OSSIM_READ_WRITE = 6,
      OSSIM_READ       = 4,
      OSSIM_WRITE      = 2,
      OSSIM_EXE        = 1, // The PC docs say that this is ignored
      OSSIM_EXIST      = 0
   };

Constructor & Destructor Documentation

ossimFilename() [1/6]

ossimFilename::ossimFilename

(

)

Definition at line 210 of file ossimFilename.cpp.

Referenced by createDirectory(), drive(), ext(), file(), fileNoExtension(), ossimTempFilename::generate(), merge(), path(), and wildcardRemove().

   : ossimString()
{}

ossimFilename() [2/6]

ossimFilename::ossimFilename

(

const ossimFilename &

src

)

Definition at line 214 of file ossimFilename.cpp.

   : ossimString(src)
{
}

ossimFilename() [3/6]

ossimFilename::ossimFilename

(

const ossimString &

src

)

Definition at line 219 of file ossimFilename.cpp.

References converPathSeparator(), and ossimString::m_str.

   : ossimString(src)
{
   if ( m_str.size() )
   {
      converPathSeparator();
      // convertToNative();
   }
}

ossimFilename() [4/6]

ossimFilename::ossimFilename

(

const std::string &

src

)

Definition at line 229 of file ossimFilename.cpp.

References converPathSeparator(), and ossimString::m_str.

   : ossimString(src)
{
   if ( m_str.size() )
   {
      converPathSeparator();
      // convertToNative();
   }
}

ossimFilename() [5/6]

ossimFilename::ossimFilename

(

const char *

src

)

Definition at line 239 of file ossimFilename.cpp.

References converPathSeparator(), and ossimString::m_str.

   : ossimString(src)
{
   if ( m_str.size() )
   {
      converPathSeparator();
      // convertToNative();
   }
}

ossimFilename() [6/6]

template<class Iter >

ossimFilename::ossimFilename	(	Iter	s,
		Iter	e
	)

Definition at line 258 of file ossimFilename.cpp.

References converPathSeparator(), and ossimString::m_str.

   : ossimString(s, e)
{
   if ( m_str.size() )
   {
      converPathSeparator();
      // convertToNative();
   }
}

Member Function Documentation

append()

ossimFilename & ossimFilename::append

(

const ossimString &

append_this_to_filename

)

Convenience method to append a string to the base-name portion of the filename.

Returns this.

Definition at line 1426 of file ossimFilename.cpp.

References merge(), and split().

Referenced by appendTimestamp(), and ossimTool::readTextFile().

{
   ossimString drivePart;
   ossimString pathPart;
   ossimString filePart;
   ossimString extPart;

   split(drivePart, pathPart, filePart, extPart);
   filePart += append_this;
   merge(drivePart, pathPart, filePart, extPart);

   return *this;
}

appendTimestamp()

ossimFilename & ossimFilename::appendTimestamp

(

)

Convenience method to append a generic timestamp to the base-name portion of the filename.

This is useful for establishing rolling names for temporary files and logs. Returns this.

Definition at line 1417 of file ossimFilename.cpp.

References append(), and ossim::getFormattedTime().

Referenced by ossimDemTool::loadJSON().

{
   const std::string format = "%Y%m%d-%H%Mh%Ss";
   std::string timestamp;
   ossim::getFormattedTime(format, true, timestamp);

   return append(timestamp);
}

converPathSeparator()

void ossimFilename::converPathSeparator ( )

protected

Converts slashes of this to internal '/' format.

Definition at line 1440 of file ossimFilename.cpp.

References ossimString::m_str, and OSSIM_FILENAME_PATH_SEPARATOR.

Referenced by ossimFilename().

{
   if ( m_str.size() )
   {
      std::replace( m_str.begin(), m_str.end(), '\\', OSSIM_FILENAME_PATH_SEPARATOR );
   }
}

copyFileTo()

bool ossimFilename::copyFileTo

(

const ossimFilename &

outputFile

)

const

Copies this file to output file.

Copies this to output file. If output file is a directory, this->file() is appended to output file.

Parameters

outputFile

File name to copy to.

Returns

True on success, false on error.

Definition at line 1289 of file ossimFilename.cpp.

References ossimString::c_str(), dirCat(), file(), isDir(), ossimNotify(), and ossimNotifyLevel_WARN.

{
   bool result = false;
   
   std::ifstream is(this->c_str(), std::ios::in|std::ios::binary);
   if ( is.good() )
   {
      ossimFilename f = outputFile;
      if ( f.isDir() )
      {
         f = f.dirCat( this->file() );
      }

      if ( f != *this )
      {
         std::ofstream os( f.c_str(), std::ios::out|std::ios::binary );
         if ( os.good() )
         {
            // Copy the file:
            char c;
            while(is.get(c))
            {
               os.put(c);
            }
            
            if ( is.eof() &&  !os.fail())
            {
               result = true;
            }
            else
            {
               ossimNotify(ossimNotifyLevel_WARN)
                  << "WARNING: "
                  << "ossimFilename::copyFileTo WARNING:"
                  << "\nError detected writing from file "
                  << this->c_str() << " to file " << f.c_str() << std::endl;
            }
         }
         else
         {
            ossimNotify(ossimNotifyLevel_WARN)
               << "WARNING: "
               << "ossimFilename::copyFileTo WARNING:"
               << "\nCannot open: " << f.c_str() << std::endl;
         }
      } //  if ( f != *this )
      else
      {
         ossimNotify(ossimNotifyLevel_WARN)
            << "WARNING: "
            << "ossimFilename::copyFileTo WARNING:"
            << "\nFiles the same!" << std::endl;
      }
      
   } // if ( is.good() )
   else
   {
      ossimNotify(ossimNotifyLevel_WARN)
         << "WARNING: "
         << "ossimFilename::copyFileTo WARNING:"
         << "\nCannot open: " << this->c_str() << std::endl;
   }
   
   return result;
}

createDirectory()

bool ossimFilename::createDirectory	(	bool	recurseFlag = true,
		int	perm = 0775
	)		const

Definition at line 1086 of file ossimFilename.cpp.

References ossimString::c_str(), ossimString::empty(), exists(), expand(), ossimString::length(), OSSIM_FILENAME_PATH_SEPARATOR, ossimFilename(), and ossimString::split().

Referenced by ossimBatchTest::execute(), ossimTempFilename::generate(), ossimBatchTest::getTempFileName(), ossimBatchTest::makeDefaultResultsDir(), and ossimToolClient::setProductFilePath().

{
   if(exists()) return true;

   if ( empty() ) return false;

   if(recurseFlag)
   {
      ossimString tempString = this->expand().c_str();

      vector<ossimString> result;
      tempString.split(result,OSSIM_FILENAME_PATH_SEPARATOR);

      if(result.size())
      {
         ossimString current = result[0];

// Reconstruct UNC paths under Windows.
#if defined(_WIN32)
         bool bGotUNC = false;
         if ( current.length() == 0 && tempString.length() > 2 )
         {
            const char* fstr = tempString.c_str();
            const char fstar0 = fstr[0];
            const char fstar1 = fstr[1];
            if ( fstar0=='\\' && fstar1=='\\' )
            {
               bGotUNC = true;
               current = OSSIM_FILENAME_PATH_SEPARATOR;
            }
         }
#endif

         for(ossim_uint32 i = 1; i < result.size(); ++i)
         {
            current += (OSSIM_FILENAME_PATH_SEPARATOR+result[i]);

#if defined(_WIN32)
            if ( bGotUNC == true && i==1 )
            {
               // The root of the UNC path is assumed to exist.
               continue;
            }
#endif
            
            if(current != OSSIM_FILENAME_PATH_SEPARATOR)
            {
               if(!ossimFilename(current).exists())
               {
#if defined(__BORLANDC__)
                  if ( _mkdir(current.c_str()) != 0 )
#elif defined(_WIN32)
                  if ( _mkdir(current.c_str()) != 0 )
#else
                  if ( mkdir(current.c_str(), perm) != 0 )
#endif
                  {
                     return false;
                  }
               }
            }
         }
      }
   }
   else
   {
#if defined (__BORLANDC__)
      if ( _mkdir(c_str()) != 0 )
#elif defined(_WIN32)
      if ( _mkdir(c_str()) != 0 )
#else
      if ( mkdir(c_str(), perm) != 0 )
#endif
      {
         return false;
      }
      else
      {
         return true;
      }
   }
   return true;
}

dirCat()

ossimFilename ossimFilename::dirCat

(

const ossimFilename &

file

)

const

Returns file appended onto this string. Path seperator is always placed between this and file. Returns file if this string is empty. Given: this = /foo and file = bar output = /foo/bar Given: this = /foo/ and file = bar output = /foo/bar

Definition at line 1002 of file ossimFilename.cpp.

References ossimString::begin(), ossimString::empty(), ossimString::end(), file(), OSSIM_FILENAME_PATH_SEPARATOR, ossimString::ossimString(), and ossimString::size().

Referenced by ossimSingleImageChain::addHistogramRemapper(), ossimVpfAnnotationFeatureInfo::buildEdgFeature(), ossimVpfAnnotationFeatureInfo::buildFaceFeature(), ossimVpfAnnotationFeatureInfo::buildPointFeature(), ossimVpfAnnotationFeatureInfo::buildTxtFeature(), ossimNadconGridDatum::checkGrid(), copyFileTo(), ossimImageHandler::createDefaultValidVerticesFilename(), ossimSrtmElevationDatabase::createFullPath(), ossimDtedElevationDatabase::createFullPath(), ossimGeneralRasterElevationDatabase::createFullPath(), ossimplugins::ossimPluginProjectionFactory::createProjection(), ossimDtedElevationDatabase::createRelativePath(), ossimBatchTest::execute(), expand(), ossimEnvironmentUtility::findData(), ossimEnvironmentUtility::findPlugin(), ossimTempFilename::generate(), ossimIgenGenerator::generateGeoTiledSpecList(), ossimIgenGenerator::generatePixelTiledSpecList(), ossimVpfLibrary::getCoverage(), ossimBatchTest::getDefaultTempFileDir(), ossimRpfUtil::getDotRfpFilenameForEntry(), ossimVpfCoverage::getExtent(), ossimImageHandler::getExternalImageGeometry(), ossimEnvironmentUtility::getInstalledOssimPluginDir(), ossimEnvironmentUtility::getInstalledOssimPreferences(), ossimTool::getKwlTemplate(), ossimH5ImageHandler::getLatLonDatasets(), ossimRpfToc::getSourceTocFile(), ossimVpfFeatureClass::getTable1(), ossimVpfFeatureClass::getTable2(), ossimBatchTest::getTempFileName(), ossimVpfLibrary::getTileName(), ossimVpfLibrary::getTileNames(), ossimEnvironmentUtility::getUserOssimPluginDir(), ossimEnvironmentUtility::getUserOssimPreferences(), ossimEnvironmentUtility::getUserOssimSupportDir(), ossimVerticesFinderTool::initialize(), ossimEpsgProjectionDatabase::initialize(), ossimInit::initializePlugins(), ossimplugins::ossimRadarSat2Model::InitLut(), ossimWktProjectionFactory::loadRecords(), ossimElevManager::loadStandardElevationPaths(), merge(), ossimGeoidNgs::open(), ossimplugins::ossimRadarSat2TiffReader::open(), ossimplugins::ossimTerraSarTiffReader::open(), ossimplugins::ossimPleiadesModel::open(), ossimplugins::ossimSpot6Model::open(), ossimplugins::ossimRadarSat2RPCModel::open(), ossimplugins::ossimRadarSat2Model::open(), ossimVpfCoverage::openCoverage(), ossimVpfFeatureClassSchema::openSchema(), ossimImageHandler::openValidVertices(), ossimNadconGridDatum::ossimNadconGridDatum(), ossimBilSplitter::output_multi_files(), ossimIgen::outputProduct(), ossimVpfCoverage::print(), ossimDirectoryData::read(), ossimAlphaSensorSupportData::readSupportFiles(), ossimToolClient::receiveFile(), ossimVpfLibrary::setCoverageNames(), ossimRpfFrameEntry::setEntry(), ossimVpfLibrary::setTileNames(), ossimSpot5Model::setupOptimizer(), and ossimplugins::ossimFormosatModel::setupOptimizer().

{
   // If this string is empty simply return the input file.
   if (empty()) return file;
   if (file.empty()) return *this;

   ossimFilename dir      = *this;
   ossimFilename tempFile = file;
      
   // Check the end and see if it already has a "/".
   string::const_iterator i = dir.end();

   --i; // decrement past the trailing null.

   if ( (*i) != OSSIM_FILENAME_PATH_SEPARATOR)
   {
      dir += ossimString(OSSIM_FILENAME_PATH_SEPARATOR);
   }

   // check for dot slash or just slash: ./foo or /foo   
   std::string::iterator iter = tempFile.begin();
   if (iter != tempFile.end())
   {
      if ((*iter) == OSSIM_FILENAME_PATH_SEPARATOR)
      {
         ++iter; // skip slash
      }
      else if (tempFile.size() > 1)
      {
         if ( ((*iter) == '.') &&  ( *(iter + 1) == OSSIM_FILENAME_PATH_SEPARATOR) )
         {
            iter = iter + 2; // skip dot slash
         }
      }
   }   

   dir += std::string(iter, tempFile.end());

   return dir;
}

drive()

ossimFilename ossimFilename::drive

(

)

const

Returns

"c:" if file is "c:\data\images\t1.tif".

Definition at line 804 of file ossimFilename.cpp.

References ossimString::begin(), ossimRegExp::end(), ossimRegExp::find(), ossimString::m_str, ossimFilename(), ossimString::ossimString(), and ossimRegExp::start().

Referenced by ossimImageHandler::getFilenameWithNoExtension(), and split().

{
   ossimFilename result;
   ossimRegExp regEx("^([a-z|A-Z])+:");
   if(regEx.find( m_str.c_str() ) )
   {
      result = ossimFilename(ossimString(this->begin() + regEx.start(),
                                         this->begin() + regEx.end()));
   }
   else
   {
      result = "";
   }

   return result;
}

exists()

bool ossimFilename::exists

(

)

const

Definition at line 650 of file ossimFilename.cpp.

References ossimString::c_str(), ossim::StreamFactoryRegistry::exists(), ossim::StreamFactoryRegistry::instance(), isUrl(), and OSSIM_EXIST.

Referenced by ossimGeoidNgs::addFile(), ossimHistogramMatchFilter::autoLoadInputHistogram(), ossimVpfAnnotationFeatureInfo::buildEdgFeature(), ossimVpfAnnotationFeatureInfo::buildFaceFeature(), ossimVpfAnnotationFeatureInfo::buildPointFeature(), ossimVpfAnnotationFeatureInfo::buildTxtFeature(), ossimSrtmElevationDatabase::createCell(), ossimDtedElevationDatabase::createCell(), createDirectory(), ossim::StreamFactory::createIstream(), ossimSensorModelFactory::createProjection(), ossimplugins::ossimPluginProjectionFactory::createProjection(), ossimMapProjectionFactory::createProjection(), ossimBatchTest::doDefaultClean(), ossimBatchTest::execute(), ossimplugins::ossimAlosPalsarModel::findAlosPalsarData(), ossimplugins::ossimAlosPalsarModel::findAlosPalsarLeader(), ossimSensorModelFactory::findCoarseGrid(), ossimEnvironmentUtility::findData(), ossimplugins::ossimErsSarModel::findErsLeader(), ossimLandsatTopoCorrectionFilter::findLandsatHeader(), ossimEnvironmentUtility::findPlugin(), ossimQuickbirdRpcModel::findSupportFile(), ossimplugins::ossimTerraSarModel::findTSXLeader(), ossimTempFilename::generate(), ossimVpfCoverage::getExtent(), ossimMrSidReader::getExternalImageGeometry(), ossimImageHandler::getExternalImageGeometry(), ossimGdalTileSource::getExternalImageGeometryFromXml(), ossimMrSidReader::getGeoProjection(), ossimQbTileFilesHandler::getImageGeometry(), ossimGeneralRasterTileSource::getImageGeometry(), ossimEnvironmentUtility::getInstalledOssimPluginDir(), ossimEnvironmentUtility::getInstalledOssimPreferences(), ossimEnvironmentUtility::getInstalledOssimSupportDir(), ossimH5ImageHandler::getLatLonDatasets(), ossimRpfToc::getSourceTocFile(), ossimVpfLibrary::getTileName(), ossimVpfLibrary::getTileNames(), getTimes(), ossimMultiBandHistogram::importHistogram(), ossimHistogram::importHistogram(), ossimLasReader::init(), ossimInit::initializePlugins(), ossimplugins::ossimRadarSat2Model::InitLut(), ossimAuxFileHandler::isAuxFile(), ossimCcfTileSource::isEcgGeom(), ossimArcInfoGridWriter::isOpen(), ossimDemUtil::isUsgsDem(), lastAccessed(), ossimGdalOgrVectorAnnotation::loadExternalGeometryFile(), ossimGdalOgrVectorAnnotation::loadExternalImageGeometryFromXml(), ossimDtedTileSource::loadMetaData(), ossimGdalOgrVectorAnnotation::loadOmdFile(), ossimInit::loadPlugins(), ossimElevManager::loadStandardElevationPaths(), ossimSrtmElevationDatabase::loadState(), ossimDtedElevationDatabase::loadState(), ossimGeneralRasterElevationDatabase::loadState(), ossimRgbLutDataObject::loadState(), ossimNBandLutDataObject::loadState(), ossimBatchTest::makeDefaultResultsDir(), ossimPointCloudImageHandlerFactory::open(), ossimGeoidNgs::open(), ossimArcInfoGridWriter::open(), ossimERSTileSource::open(), ossimEnviInfo::open(), ossimKakaduJpipHandler::open(), ossimplugins::ossimPleiadesModel::open(), ossimplugins::ossimSpot6Model::open(), ossimplugins::ossimErsSarModel::open(), ossimplugins::ossimRadarSatModel::open(), ossimplugins::ossimAlosPalsarModel::open(), ossimplugins::ossimRadarSat2RPCModel::open(), ossimplugins::ossimRadarSat2Model::open(), ossimGpkgWriter::open(), ossimVpfCoverage::openCoverage(), ossimVpfDatabase::openDatabase(), ossimGeneralRasterElevationDatabase::openGeneralRasterDirectory(), ossimVpfFeatureClassSchema::openSchema(), ossimAdrgHeader::ossimAdrgHeader(), ossimNitfRsmModel::parseFile(), ossimSrtmElevationDatabase::pointHasCoverage(), ossimDtedElevationDatabase::pointHasCoverage(), ossimCibCadrgTileSource::populateLut(), ossimGdalWriter::postProcessOutput(), ossimAlphaSensorSupportData::readSupportFiles(), rename(), ossimGeneralRasterElevFactory::setDirectory(), ossimRpfFrameEntry::setEntry(), ossimMapViewController::setFilename(), ossimGeneralRasterElevHandler::setFilename(), ossimBandLutFilter::setLut(), ossimIndexToRgbLutFilter::setLut(), ossimToolClient::setProductFilePath(), ossimSpot5Model::setupOptimizer(), ossimplugins::ossimFormosatModel::setupOptimizer(), ossimCibCadrgTileSource::updatePropertiesToFirstValidFrame(), ossimBatchTest::writeTemplate(), and ossimImageHandler::writeValidImageVertices().

{
   bool result = false;
   if ( isUrl() == false )
   {
#if defined(_WIN32)
      result = (_access(c_str(), ossimFilename::OSSIM_EXIST) == 0);
#else
      result = ((access(c_str(), ossimFilename::OSSIM_EXIST)) == 0);
#endif
   }
   else
   {
      result = ossim::StreamFactoryRegistry::instance()->exists( this->string() );
   }
   return result;
}

expand()

ossimFilename ossimFilename::expand

(

)

const

Method to do file name expansion.

Like: ~/docs will be expanded to /home/user/docs

Returns

The expanded file name.

Note

METHOD IS NOT COMPLETE YET.

Definition at line 494 of file ossimFilename.cpp.

References ossimString::begin(), ossimString::c_str(), dirCat(), ossimString::end(), ossimEnvironmentUtility::getUserDir(), ossimString::gsub(), ossimEnvironmentUtility::instance(), isRelative(), needsExpansion(), OSSIM_FILENAME_PATH_SEPARATOR, ossimString::ossimString(), and ossimString::size().

Referenced by createDirectory(), ossimImageHandler::getExternalImageGeometry(), ossimRpfToc::getRootDirectory(), ossimBatchTest::getTempFileName(), getTimes(), ossimplugins::ossimRadarSat2Model::InitLut(), lastAccessed(), ossim::Image::loadJSON(), ossimplugins::ossimRadarSat2TiffReader::open(), ossimplugins::ossimTerraSarTiffReader::open(), ossimplugins::ossimRadarSat2RPCModel::open(), ossimplugins::ossimTerraSarModel::open(), ossimplugins::ossimRadarSat2Model::open(), ossimBatchTest::processConfigList(), ossimAlphaSensorSupportData::readSupportFiles(), ossimInfo::testPlugin(), and touch().

{
   //---
   // Note:  ossimEnvironmentUtility::getCurrentWorkingDir() is returning
   // a blank string on windows with vs9.  This was resulting in seg faults
   // in this method so added checks were added for size of returned result.
   // (drb  20100113)
   //---
   ossimFilename result = "";
   if ( size() )
   {
      result = *this;
      
      if ( needsExpansion() )
      {

//#if defined(_WIN32)
//         result.convertBackToForwardSlashes();
//#endif

         bool addCwd = false;
         
         if ( (size() > 1) && (*(begin()) == '~') && (*(begin()+1) == OSSIM_FILENAME_PATH_SEPARATOR) )
         {
            ossimFilename homeDir =
               ossimEnvironmentUtility::instance()->getUserDir();
            
            ossimFilename s( (result.begin()+2) , result.end());
            result = homeDir.dirCat(s);
         }
         else if( (size() > 1) &&
                  (*(begin()) == '.') && (*(begin()+1) == OSSIM_FILENAME_PATH_SEPARATOR) )
         {
            // dot slash i.e. ./foo
            addCwd = true;
         }
         else if ( (size() > 2)  && (*(begin()) == '.')
                   && (*(begin()+1) == '.') && (*(begin()+2) == OSSIM_FILENAME_PATH_SEPARATOR) )
         {
            // ../foo
            addCwd = true;
         }
         else if (result == ".")
         {
            result = ossimEnvironmentUtility::instance()->
               getCurrentWorkingDir();
         }

         if (addCwd)
         {
            ossimFilename cwd = ossimEnvironmentUtility::instance()->
               getCurrentWorkingDir();
            result = cwd.dirCat(result);
         }
         else if ( result.isRelative() )
         {
            if ( result.size() && ((*(result.begin())) != '$') )
            {
               ossimFilename cwd = ossimEnvironmentUtility::instance()->
                  getCurrentWorkingDir();
               result = cwd.dirCat(result);
            }
         }
               
         // Check result to see if we're finished.
         if ( result.needsExpansion() )
         {
            // now expand any environment variable substitutions
            
            ossimFilename finalResult;
            const char* tempPtr = result.c_str();
            ossim_int32 startIdx = -1;
            ossim_int32 resultSize = (ossim_uint32)result.size();
            ossim_int32 scanIdx = 0;
            while(scanIdx < resultSize)
            {
               // look for start of substitution pattern
               if(tempPtr[scanIdx] == '$')
               {
                  if(tempPtr[scanIdx+1] == '(')
                  {
                     scanIdx += 2;
                     startIdx = scanIdx;
                  }
                  else
                  {
                     //---
                     // Infinite loop fix with below file on window:
                     // "\\kiosk\x$\SourceImagery\foo.ntf" (drb 21 Nov. 2016)
                     //---
                     finalResult += tempPtr[scanIdx];
                     ++scanIdx;
                  }
               }
               // look for an end pattern and apply if we found a start pattern
               else if(tempPtr[scanIdx] == ')')
               {
                  if(startIdx != -1)
                  {
                     ossimFilename value(
                        ossimEnvironmentUtility::instance()->
                        getEnvironmentVariable(ossimString(tempPtr+startIdx,
                                                           tempPtr+scanIdx)));
#if defined(_WIN32) // do windows style replacment
                     //                    value.convertBackToForwardSlashes();
#endif
                     finalResult += value;
                     // reset start idx indicator to not set so we are ready for next pattern
                     //
                     startIdx = -1;
                  }
                  else // if no start then tack on the )
                  {
                     finalResult += tempPtr[scanIdx];
                  }
                  ++scanIdx;
               }
               else if(startIdx == -1)
               {
                  finalResult += tempPtr[scanIdx];
                  ++scanIdx;
               }
               else
               {
                  ++scanIdx;
               }
            }
#if defined(_WIN32)

#else        
            finalResult.gsub("//", "/", true);
#endif       
            result = finalResult;
         
         } // matches:  if ( result.needsExpansion() )

#if defined(_WIN32)
         //        result.convertForwardToBackSlashes();
#endif        

      } // matches: if ( needsExpansion() )

      //---
      // If we had a size before "expand()" and now we don't something went
      // wrong...
      //---
      if (!result.size())
      {
         result = *this;
      }
      
   } // matches: if ( size() )
   
   return result;
}

ext()

ossimString ossimFilename::ext

(

)

const

Returns

"tif" if file is "/data/images/t1.tif".

Note

The '.' (dot) is not returned.

Definition at line 768 of file ossimFilename.cpp.

References ossimString::m_str, NIL, and ossimFilename().

Referenced by ossimSqliteInfoFactory::create(), ossimJpipProjectionFactory::createProjection(), ossimImageWriterFactoryRegistry::createWriter(), ossimShorelineTool::execute(), ossimQuickbirdRpcModel::findSupportFile(), ossimplugins::ossimTerraSarModel::findTSXLeader(), ossimIgenGenerator::generateGeoTiledSpecList(), ossimIgenGenerator::generatePixelTiledSpecList(), ossimBandSeparateHandler::getBandFileNames(), ossimKmlSuperOverlayWriter::getExtension(), ossimGeneralRasterTileSource::getImageGeometry(), ossimKmlSuperOverlayReaderFactory::hasExcludedExtension(), ossimH5ReaderFactory::hasExcludedExtension(), ossimMrSidReaderFactory::hasExcludedExtension(), ossimGeoPdfReaderFactory::hasExcludedExtension(), ossimJpeg12ReaderFactory::hasExcludedExtension(), ossimOpjReaderFactory::hasExcludedExtension(), ossimKakaduReaderFactory::hasExcludedExtension(), ossimDtedElevationDatabase::inititializeExtension(), ossimAuxFileHandler::isAuxFile(), ossimChipperUtil::isDemFile(), ossimFileWalker::isFiltered(), ossimOgrVectorTileSource::isOgrVectorDataSource(), ossimRpfInfo::isOpen(), ossimGeoPdfInfo::isOpen(), ossimGeoPdfReader::isOpen(), ossimRpfCacheTileSource::isOpen(), ossimplugins::ossimRadarSat2TiffReader::isRadarSat2ProductFile(), ossimAutRegUtil::isSrcFile(), ossimChipperUtil::isSrcFile(), ossimBitMaskTileSource::isSupportedExtension(), ossimHdfReader::isSupportedExtension(), ossimplugins::ossimTerraSarTiffReader::isTerraSarProductFile(), ossimplugins::ossimPluginProjectionFactory::isTileMap(), ossimDemUtil::isUsgsDem(), ossimPointCloudImageHandlerFactory::open(), ossimEnviInfo::open(), ossimGdalFactory::open(), ossimKakaduJpipHandler::open(), ossimHdf5PluginHandlerFactory::open(), ossimplugins::ossimRadarSat2TiffReader::open(), ossimCcfInfo::open(), ossimKakaduJpipInfo::open(), ossimKmlSuperOverlayReader::open(), ossimplugins::ossimTerraSarTiffReader::open(), ossimDtedInfo::open(), ossimplugins::ossimPleiadesModel::open(), ossimplugins::ossimSpot6Model::open(), ossimplugins::ossimTileMapModel::open(), ossimplugins::ossimRadarSat2RPCModel::open(), ossimplugins::ossimRadarSat2Model::open(), ossimImageHandlerRegistry::openBySuffix(), ossimGeneralRasterElevationDatabase::openGeneralRasterDirectory(), ossimInfo::openImage(), ossimInfo::openImageHandler(), ossimAdrgHeader::ossimAdrgHeader(), ossimXmpInfo::print(), ossimGeneralRasterElevFactory::setDirectory(), split(), and ossimImageFileWriter::writeWorldFile().

{
   std::string::size_type pos = m_str.rfind('.');
   if (pos == std::string::npos)
   {
      return ossimFilename::NIL;
   }

   return ossimFilename(m_str.substr(pos+1));
}

file()

ossimFilename ossimFilename::file

(

)

const

Returns

"t1.tif" if file is "/data/images/t1.tif".

Definition at line 779 of file ossimFilename.cpp.

References ossimString::m_str, OSSIM_FILENAME_PATH_SEPARATOR, and ossimFilename().

Referenced by ossimDirectoryTree::checkToPushDirectory(), copyFileTo(), ossimplugins::ossimPluginProjectionFactory::createProjection(), dirCat(), ossimDirectory::findAllFilesThatMatch(), ossimplugins::ossimTerraSarModel::findTSXLeader(), ossimGdalOverviewBuilder::generateHfaStats(), ossimRpfToc::getCorespondingEntry(), ossimImageHandler::getExternalImageGeometry(), ossimQuickbirdTiffTileSource::getImageGeometry(), ossimSharedPluginRegistry::getPlugin(), ossimplugins::ossimTerraSarModel::getPolLayerFromImageFile(), ossimPdfWriter::getTitle(), ossimDtedElevationDatabase::inititializeExtension(), ossimImageUtil::isFiltered(), ossimSharedPluginRegistry::isLoaded(), ossimTiffWorld::open(), ossimplugins::ossimSpot6Model::open(), ossimplugins::ossimPleiadesModel::open(), ossimQuickbirdRpcModel::parseTileData(), ossimAlphaSensorSupportData::readHdrFile(), ossimAlphaSensorSupportData::readSupportFiles(), ossimToolServer::sendFile(), ossimImageUtil::substituteFileStrings(), and wildcardRemove().

{
   std::string::size_type pos = m_str.rfind(OSSIM_FILENAME_PATH_SEPARATOR);
   if (pos == std::string::npos)
      return *this;
   else
      return ossimFilename(m_str.substr(pos+1));
}

fileNoExtension()

ossimFilename ossimFilename::fileNoExtension

(

)

const

Returns

"t1" if file is "/data/images/t1.tif".

Definition at line 821 of file ossimFilename.cpp.

References ossimString::begin(), ossimString::end(), ossimString::m_str, OSSIM_FILENAME_PATH_SEPARATOR, and ossimFilename().

Referenced by ossimSingleImageChain::addHistogramRemapper(), ossimImageHandler::createDefaultValidVerticesFilename(), ossimBatchTest::execute(), ossimplugins::ossimAlosPalsarModel::findAlosPalsarData(), ossimplugins::ossimAlosPalsarModel::findAlosPalsarLeader(), ossimSensorModelFactory::findCoarseGrid(), ossimplugins::ossimErsSarModel::findErsLeader(), ossimIgenGenerator::generateGeoTiledSpecList(), ossimIgenGenerator::generatePixelTiledSpecList(), ossimKmlSuperOverlayWriter::generateRootKml(), ossimVerticesFinderTool::initialize(), ossimDtedTileSource::loadMetaData(), ossimERSTileSource::open(), ossimIkonosMetaData::open(), ossimImageHandler::openValidVertices(), ossimAdrgHeader::parse(), ossimQuickbirdRpcModel::parseRpcData(), ossimBatchTest::processTest(), ossimSrtmFilename::setFilename(), split(), and ossimKakaduJp2Writer::writeGeotiffBox().

{
   std::string::size_type dot_pos   = m_str.rfind('.');
   std::string::size_type slash_pos = m_str.rfind(OSSIM_FILENAME_PATH_SEPARATOR);

   if(dot_pos == std::string::npos)
   {
      if(slash_pos == std::string::npos)
      {
         return *this;
      }
      else
      {
         return ossimFilename(this->begin()+slash_pos+1,
                              this->end());
      }
   }
   else if(slash_pos == std::string::npos)
   {
      return ossimFilename(this->begin(), this->begin()+dot_pos);
   }
   else if(slash_pos < dot_pos)
   {
      return ossimFilename(this->begin()+slash_pos+1,
                           this->begin() + dot_pos);
   }

   return ossimFilename(this->begin()+slash_pos+1,
                        this->end());

}

fileSize()

ossim_int64 ossimFilename::fileSize

(

)

const

Definition at line 1043 of file ossimFilename.cpp.

References ossimString::c_str(), ossimFileInfoInterface::getFileSize(), ossim::StreamFactoryRegistry::instance(), isUrl(), and ossimString::size().

Referenced by ossimGeneralRasterTileSource::getXmlInfo(), ossimGeneralRasterInfo::initializeFromXml(), ossimSrtmHandler::open(), ossimGeneralRasterElevHandler::open(), ossimBilSplitter::ossimBilSplitter(), ossimplugins::ossimSpot6DimapSupportData::parseXmlFile(), ossimplugins::ossimPleiadesDimapSupportData::parseXmlFile(), and ossimGeoTiff::writeJp2GeotiffBox().

{
   ossim_int64 size = 0;

   if ( isUrl() == false )
   {
      struct stat sbuf;
      if ( stat( this->c_str(), &sbuf ) == 0 )
      {
         size = (ossim_int64)sbuf.st_size;
      }
      else
      {
         ifstream in(c_str());
         if(in)
         {
            in.seekg(0, std::ios_base::end);
            size = (ossim_int64)in.tellg();
         }
      }
   }
   else
   {
      std::shared_ptr<ossim::istream> in = ossim::StreamFactoryRegistry::instance()->
         createIstream( this->string() );
      if ( in )
      {
         ossimFileInfoInterface* intf = dynamic_cast<ossimFileInfoInterface*>( in.get() );
         if ( intf )
         {
            size = intf->getFileSize();
         }
         else
         {
            in->seekg(0, std::ios_base::end);
            size = (ossim_int64)in->tellg();
         }
      }
   }

   return size;
}

getPathSeparator()

char ossimFilename::getPathSeparator

(

)

const

Returns

The path separator.

Definition at line 1412 of file ossimFilename.cpp.

References OSSIM_FILENAME_PATH_SEPARATOR.

{
   return OSSIM_FILENAME_PATH_SEPARATOR;
}

getTimes()

bool ossimFilename::getTimes	(	ossimLocalTm *	accessTime,
		ossimLocalTm *	modTime,
		ossimLocalTm *	createTime
	)		const

Definition at line 375 of file ossimFilename.cpp.

References ossimString::c_str(), exists(), expand(), isDir(), and Read.

{
   if(!expand().exists()) return false;
   
#if defined(_WIN32)
   // we must use different methods for the files and directories under
   // Windows as CreateFile(GENERIC_READ) doesn't work for the directories and
   // CreateFile(FILE_FLAG_BACKUP_SEMANTICS) works -- but only under NT and
   // not 9x
   bool ok;
   FILETIME ftAccess, ftCreate, ftWrite;
   if ( isDir() )
   {
      ok = ossimGetDirectoryTimes(expand().c_str(),
                                  &ftAccess, &ftCreate, &ftWrite);
      ok = false;
   }
   else // file
   {
      ossimFileHandle fh(expand().c_str(), ossimFileHandle::Read);
      if ( fh.isOk() )
      {
         ok = ::GetFileTime(fh,
                            createTime ? &ftCreate : NULL,
                            accessTime ? &ftAccess : NULL,
                            modTime ? &ftWrite : NULL) != 0;
      }
      else
      {
         ok = false;
      }
   }

   if ( ok )
   {
      if ( createTime )
      {
         convertFileTimeToOssim(*createTime, ftCreate);
      }
      if ( accessTime )
      {
         convertFileTimeToOssim(*accessTime, ftAccess);
      }
      if ( modTime )
      {
         convertFileTimeToOssim(*modTime, ftWrite);
      }
        
      return true;
   }
#else
   struct stat sbuf;
   stat(c_str(), &sbuf);
   if ( stat( expand().c_str(), &sbuf) == 0 )
   {
      if ( accessTime )
      {
         *accessTime = ossimLocalTm(sbuf.st_atime);
      }
      if ( modTime )
      {
         *modTime = ossimLocalTm(sbuf.st_mtime);
      }
      if ( createTime )
      {
         *createTime = ossimLocalTm(sbuf.st_ctime);
      }
      return true;
   }
#endif // platforms


   return false;
}

isDir()

bool ossimFilename::isDir

(

)

const

Definition at line 683 of file ossimFilename.cpp.

References ossimString::beforePos(), ossimString::c_str(), ossimString::empty(), and ossimString::size().

Referenced by ossimSingleImageChain::addImageHandler(), ossimDirectoryTree::checkToPushDirectory(), copyFileTo(), ossimToolClient::execute(), ossimDirectoryTree::getFirst(), getTimes(), ossimDtedElevationDatabase::inititializeExtension(), ossimArcInfoGridWriter::isOpen(), ossim::JsonConfig::JsonConfig(), ossimElevManager::loadElevationPath(), ossimInit::loadPlugins(), ossimGeoidNgs::open(), ossimArcInfoGridWriter::open(), ossimGeneralRasterElevationDatabase::openGeneralRasterDirectory(), ossimImageHandlerFactory::openSrcRecord(), ossimDemTool::ossimDemTool(), ossimIgen::outputProduct(), ossimDirectoryData::read(), ossimDemToolConfig::readConfig(), ATP::AtpConfig::readConfig(), remove(), ossimGeneralRasterElevFactory::setDirectory(), ossimImageHandler::setSupplementaryDirectory(), and wildcardRemove().

{
   if ( empty() )
   {
      return false;
   }
   
   ossimFilename temp = c_str();
   const char& lastChar = temp[temp.size()-1];
   if ( lastChar == '/' || lastChar == '\\' )
   {
      temp = temp.beforePos(temp.size() - 1);
   }
    
#if defined(_WIN32)

   struct _stat sbuf;
   if ( _stat(temp.c_str(), &sbuf ) == -1)
      return false;
   return (_S_IFDIR & sbuf.st_mode ? true : false);
#else
   struct stat sbuf;
   if (stat(temp.c_str(), &sbuf) == -1)
      return false;
   return (S_ISDIR(sbuf.st_mode));
#endif
}

isExecutable()

bool ossimFilename::isExecutable

(

)

const

Definition at line 755 of file ossimFilename.cpp.

References ossimString::c_str(), and OSSIM_EXE.

{
#if defined(_WIN32)

   struct _stat sbuf;
   if ( _stat(c_str(), &sbuf ) == -1)
      return false;
   return (_S_IEXEC & sbuf.st_mode ? true : false);
#else
   return (access(c_str(), ossimFilename::OSSIM_EXE) == 0);
#endif
}

isFile()

bool ossimFilename::isFile

(

)

const

Definition at line 668 of file ossimFilename.cpp.

References ossimString::c_str().

Referenced by ossimDynamicLibrary::load(), ossimplugins::ossimRadarSat2RPCModel::open(), ossimplugins::ossimRadarSat2Model::open(), ossimElevationDatabaseFactory::open(), and ossimDirectoryData::read().

{
#if defined(_WIN32)
   struct _stat sbuf;
   if ( _stat(c_str(), &sbuf ) == -1)
      return false;
   return (_S_IFMT & sbuf.st_mode ? true : false);
#else
   struct stat sbuf;

   stat(c_str(), &sbuf);
   return ((sbuf.st_mode & S_IFMT) == S_IFREG);
#endif
}

isReadable()

bool ossimFilename::isReadable

(

)

const

Definition at line 711 of file ossimFilename.cpp.

References ossimString::c_str(), and OSSIM_READ.

Referenced by ossimVerticesFinderTool::initialize(), ossimEpsgProjectionDatabase::initialize(), ossimChipProcTool::loadDemFiles(), ossimWktProjectionFactory::loadRecords(), ossimRangeDomeTileSource::open(), and ossimBatchTest::processConfigList().

{
#if defined(_WIN32)
   
   struct _stat sbuf;
   if ( _stat(c_str(), &sbuf ) == -1)
      return false;
   return (_S_IREAD & sbuf.st_mode ? true : false);
#else
   return (access(c_str(), ossimFilename::OSSIM_READ) == 0);
#endif
}

isRelative()

bool ossimFilename::isRelative

(

)

const

Checks whether file name is relative or absolute.

Returns

true if file name has a relative path, false if absolute.

Note

This will return true if file name is empty.

Definition at line 1359 of file ossimFilename.cpp.

References ossimString::begin(), ossimString::c_str(), ossimRegExp::find(), and ossimString::size().

Referenced by expand(), ossimEpsgProjectionDatabase::initialize(), ossimWktProjectionFactory::loadRecords(), and needsExpansion().

{
   bool result = true;
   if (size())
   {
      //---
      // Look for unix "/"...
      // ESH: Look for Windows "\" (with prepending escape character \)
      //---
      if ( (*(begin()) == '/') || (*(begin()) == '\\') )
      {
         result = false;
      }
      else
      {
         // Look for windows drive
         ossimRegExp regEx("^([a-z|A-Z])+:");
         if ( regEx.find(c_str()) == true)
         {
            result = false;
         }
      }
   }
   return result;
}

isUrl()

bool ossimFilename::isUrl

(

)

const

Definition at line 724 of file ossimFilename.cpp.

References ossimString::m_str.

Referenced by exists(), fileSize(), and needsExpansion().

{
   bool result = false;
   if ( m_str.size() )
   {
      //---
      // Must have at least room for a protocol and "://", e.g.
      // "s3://my_bucket/data1/foo.tif
      //---
      std::size_t found = m_str.find( std::string("://") );
      if ( ( found != std::string::npos ) && ( found > 1 ) )
      {
         result = true;
      }
   }
   return result;
}

isWriteable()

bool ossimFilename::isWriteable

(

)

const

Definition at line 742 of file ossimFilename.cpp.

References ossimString::c_str(), and OSSIM_WRITE.

Referenced by ossimToolClient::setProductFilePath().

{
#if defined(_WIN32)

   struct _stat sbuf;
   if ( _stat(c_str(), &sbuf ) == -1)
      return false;
   return (_S_IWRITE & sbuf.st_mode ? true : false);
#else
   return (access(c_str(), ossimFilename::OSSIM_WRITE) == 0);
#endif
}

lastAccessed()

ossim_int64 ossimFilename::lastAccessed

(

)

const

Time in seconds since last accessed.

Returns

The number of seconds since last accessed or -1 if file does not exist.

Definition at line 453 of file ossimFilename.cpp.

References ossimString::c_str(), exists(), expand(), and ossim::getTime().

{
   ossim_int64 result = -1;

   if( expand().exists() )
   {
      ossim_int64 currentTime = ossim::getTime();
      
#if defined(_WIN32)
      cerr << "ossimFilename::lastAccessed() not implemented for windows!" << endl;
#else
      struct stat sbuf;
      stat(c_str(), &sbuf);
      if ( stat( expand().c_str(), &sbuf) == 0 )
      {
         time_t atime = sbuf.st_atime; // This cast to seconds(time_t).
         result = currentTime - (ossim_int64)atime;
      }
#endif // platforms
   }

   return result;
}

merge()

void ossimFilename::merge	(	const ossimString &	drivePart,
		const ossimString &	pathPart,
		const ossimString &	filePart,
		const ossimString &	extPart
	)

Definition at line 976 of file ossimFilename.cpp.

References dirCat(), and ossimFilename().

Referenced by append(), ossimImageHandler::getFilenameWithNoExtension(), noExtension(), setDrive(), setExtension(), setFile(), and setPath().

{
   ossimFilename result = drivePart;

   if(pathPart != "")
   {
      result = result.dirCat(ossimFilename(pathPart));
   }

   if(filePart!="")
   {
      result = result.dirCat(ossimFilename(filePart));
   }

   if(extPart != "")
   {
      result += ".";
      result += extPart;
   }

   *this = result;
}

native()

std::string ossimFilename::native

(

)

const

Returns

This as a string converted to native slashes.

Definition at line 1448 of file ossimFilename.cpp.

References ossimString::m_str, OSSIM_FILENAME_PATH_SEPARATOR, and OSSIM_NATIVE_PATH_SEPARATOR.

{
#if defined(_WIN32)
   std::string s = m_str;
   std::replace( s.begin(), s.end(),OSSIM_FILENAME_PATH_SEPARATOR, OSSIM_NATIVE_PATH_SEPARATOR );
   return s;
#else
   return m_str;   
#endif  
}

needsExpansion()

bool ossimFilename::needsExpansion

(

)

const

Method to check if expansion is needed.

This checks if file isRelative() first if isRelative is false (has absolute path) it then walks the file and looks for '$'.

Returns

true if file name is relative or has environment vars.

Note

This will return false if file name is empty.

Definition at line 1385 of file ossimFilename.cpp.

References isRelative(), isUrl(), and ossimString::m_str.

Referenced by expand().

{
   bool result = false;
   if ( m_str.size() )
   {
      // Do not expand URLs.
      if ( isUrl() == false )
      {
         result = isRelative();
         if (result == false)
         {
            // Check for '$'
            std::string::size_type pos = m_str.find('$', 0);
            {
               if (pos != std::string::npos)
               {
                  // found '$'
                  result = true;
               }
            }
            
         }
      }
   }
   return result;
}

noExtension()

ossimFilename ossimFilename::noExtension

(

)

const

Returns

"/data/images/t1" if file is "/data/images/t1.tif".

Note

The '.' (dot) is not returned.

Definition at line 852 of file ossimFilename.cpp.

References ossimString::clear(), merge(), and split().

Referenced by ossimBitMaskWriter::connectMyInputTo(), ossimHdf5Tool::execute(), ossimGdalTileSource::getExternalImageGeometryFromXml(), ossimKmlSuperOverlayReader::getTopLevelKmlFileInfo(), ossimGdalOgrVectorAnnotation::loadExternalImageGeometryFromXml(), main(), ossimImageUtil::substituteFileStrings(), and ossimImageFileWriter::writeReadmeFile().

{
   ossimString drivePart;
   ossimString pathPart;
   ossimString filePart;
   ossimString extPart;

   split(drivePart, pathPart, filePart, extPart);

   extPart.clear();

   ossimFilename result;
   
   result.merge(drivePart, pathPart, filePart, extPart);
   
   return result;
}

operator=()

const ossimFilename & ossimFilename::operator=

(

const ossimFilename &

f

)

Definition at line 249 of file ossimFilename.cpp.

References ossimString::m_str.

{
   if ( this != &f )
   {
      m_str = f.m_str;
   }
   return *this;
}

operator==() [1/3]

bool ossimFilename::operator==

(

const ossimFilename &

rhs

)

const

Definition at line 268 of file ossimFilename.cpp.

References ossimString::operator==.

{
   return ossimString::operator==(rhs);
}

operator==() [2/3]

bool ossimFilename::operator==

(

const ossimString &

rhs

)

const

Definition at line 273 of file ossimFilename.cpp.

References ossimString::operator==.

{
   return ossimString::operator==(rhs);
}

operator==() [3/3]

bool ossimFilename::operator==

(

const char *

rhs

)

const

Definition at line 278 of file ossimFilename.cpp.

References ossimString::operator==.

{
   return ossimString::operator ==(rhs);
}

path()

ossimFilename ossimFilename::path

(

)

const

Returns

"/data/images" if file is "/data/images/t1.tif".

Definition at line 788 of file ossimFilename.cpp.

References ossimString::m_str, NIL, OSSIM_FILENAME_PATH_SEPARATOR, and ossimFilename().

Referenced by ossimSingleImageChain::addImageHandler(), ossimImageHandler::createDefaultValidVerticesFilename(), ossimplugins::ossimPluginProjectionFactory::createProjection(), ossimToolClient::execute(), ossimSensorModelFactory::findCoarseGrid(), ossimLandsatTopoCorrectionFilter::findLandsatHeader(), ossimplugins::ossimTerraSarModel::findTSXLeader(), ossimIgenGenerator::generateGeoTiledSpecList(), ossimIgenGenerator::generatePixelTiledSpecList(), ossimBandSeparateHandler::getBandFileNames(), ossimH5ImageHandler::getLatLonDatasets(), ossimVpfDatabase::getLibraryNamesFullPath(), ossimVpfDatabase::getPath(), ossimRpfToc::getRootDirectory(), ossimRpfToc::getSourceTocFile(), ossimVerticesFinderTool::initialize(), ossimInit::initializePlugins(), ossimplugins::ossimRadarSat2Model::InitLut(), ossimArcInfoGridWriter::open(), ossimTiffWorld::open(), ossimERSTileSource::open(), ossimplugins::ossimRadarSat2TiffReader::open(), ossimplugins::ossimTerraSarTiffReader::open(), ossimplugins::ossimSpot6Model::open(), ossimplugins::ossimPleiadesModel::open(), ossimplugins::ossimRadarSat2RPCModel::open(), ossimplugins::ossimRadarSat2Model::open(), ossimVpfDatabase::openDatabase(), ossimImageHandlerFactory::openSrcRecord(), ossimImageHandler::openValidVertices(), ossimIgen::outputProduct(), ossimBatchTest::processConfigList(), ossimKeywordlist::readPreprocDirective(), ossimAlphaSensorSupportData::readSupportFiles(), ossimImageHandler::setSupplementaryDirectory(), ossimSpot5Model::setupOptimizer(), ossimplugins::ossimFormosatModel::setupOptimizer(), split(), ossimImageUtil::substituteFileStrings(), and wildcardRemove().

{
   // finds the last occurrence of the given string; in this case '/';
   std::string::size_type pos = m_str.rfind(OSSIM_FILENAME_PATH_SEPARATOR);

   if (pos == 0)
      return ossimFilename(ossimFilename(OSSIM_FILENAME_PATH_SEPARATOR));
   if (pos == std::string::npos)
   {
      // We got to the end of the file and did not find a path separator.
      return ossimFilename::NIL;
   }

   return ossimFilename(m_str.substr(0, pos));
}

remove() [1/2]

bool ossimFilename::remove ( const ossimFilename &  pathname )

static

Removes pathname from filesystem if supported by platform.

If pathname is a directory it will only be removed if empty. If supported will set errno and output equivalent string if one occurs.

Returns

true on success, false on error.

Definition at line 1171 of file ossimFilename.cpp.

References ossimString::c_str(), and isDir().

Referenced by ossimGpkgWriter::open(), ossimGdalWriter::postProcessOutput(), rename(), and ossimGeoTiff::writeJp2GeotiffBox().

{
   bool result = true;

#if defined(__VISUALC__)  || defined(__BORLANDC__) || defined(__WATCOMC__) || \
   defined(__GNUWIN32__) || defined(_MSC_VER)

   // Note: not sure if these work on all of the above flavors. drb - 14 Sep. 2011.
   if(pathname.isDir())
   {
      // Note this only removes empty directories.
      result = ( RemoveDirectory( pathname.c_str() ) != 0 );
   }
   else
   {
      result = ( DeleteFile( pathname.c_str() ) != 0 );
   }
#else /* Unix flavor from unistd.h. */
   if(pathname.isDir())
   {
      result = ( rmdir( pathname.c_str() ) == 0 );
   }
   else
   {
      result = ( unlink( pathname.c_str() ) == 0 );
   }
#endif

   return result;
}

remove() [2/2]

bool ossimFilename::remove

(

)

const

Definition at line 1279 of file ossimFilename.cpp.

{
   return ossimFilename::remove(*this);
}

rename()

bool ossimFilename::rename	(	const ossimFilename &	destFile,
		bool	overwriteDestinationFlag = true
	)		const

Definition at line 1250 of file ossimFilename.cpp.

References ossimString::c_str(), exists(), ossimNotify(), ossimNotifyLevel_WARN, remove(), and ossimString::string().

Referenced by ossimKmlSuperOverlayReader::getTopLevelKmlFileInfo().

{
   bool result = true;
   if ( this->string() != destFile.string() )
   {
      if ( overwriteDestinationFlag && destFile.exists() )
      {
         destFile.remove();
      }

      if ( destFile.exists() == false )
      {
         // std::rename from cstdio returns 0 on success.
         if ( std::rename(this->c_str(), destFile.c_str()) != 0 )
         {
            result = false;
         }
      }
      else
      {
         ossimNotify(ossimNotifyLevel_WARN)
            << "ossimFilenam::rename WARNING:"
            << "\nDestination File Exists: " << destFile << std::endl;
         result = false;
      }
   }
   return result;
}

setDrive()

ossimFilename & ossimFilename::setDrive

(

const ossimString &

d

)

Sets the file path and drive.

Input: the drive to be set (this should come from the user's preferences) Example: "x:" Given: "/filepath/file.ext"

Returns

"c:\filepath\file.ext".

Definition at line 900 of file ossimFilename.cpp.

References merge(), and split().

{
   ossimString drivePart;
   ossimString pathPart;
   ossimString filePart;
   ossimString extPart;

   split(drivePart,
         pathPart,
         filePart,
         extPart);

   merge(d,
         pathPart,
         filePart,
         extPart);

   return *this;
}

setExtension()

ossimFilename & ossimFilename::setExtension

(

const ossimString &

e

)

Sets the extension of a file name.

Given: ossimFilename f = "foo"; f.setExtension("tif"); f now equals "foo.tif"

Given: ossimFilename f = "foo.jpg"; f.setExtension("tif"); f now equals "foo.tif"

Given: ossimFilename f = "foo.jpg"; f.setExtension(".tif"); f now equals "foo.tif"

Given: ossimFilename f = "foo."; ossimFilename f2; f2 = f.setExtension("tif"); f now equals "foo.tif" f2 now equals "foo.tif"

Parameters

e	Extension to add or replace.

Returns

a reference to this.

Definition at line 870 of file ossimFilename.cpp.

References ossimString::begin(), ossimString::end(), merge(), ossimString::ossimString(), and split().

Referenced by ossimSingleImageChain::addHistogramRemapper(), ossimBitMaskWriter::connectMyInputTo(), ossimSensorModelFactory::createProjection(), ossimplugins::ossimPluginProjectionFactory::createProjection(), ossimMapProjectionFactory::createProjection(), ossimSrtmElevationDatabase::createRelativePath(), ossimShorelineTool::execute(), ossimSubImageTool::execute(), ossimSensorModelFactory::findCoarseGrid(), ossimLandsatTopoCorrectionFilter::findLandsatHeader(), ossimQuickbirdRpcModel::findSupportFile(), ossimDtedHandler::gatherStatistics(), ossimTempFilename::generate(), ossimIgenGenerator::generateGeoTiledSpecList(), ossimIgenGenerator::generatePixelTiledSpecList(), ossimImageHandler::getFilenameWithNoExtension(), ossimMrSidReader::getGeoProjection(), ossimQbTileFilesHandler::getImageGeometry(), ossimGeneralRasterTileSource::getImageGeometry(), ossimGdalOverviewBuilder::getOutputFile(), ossimCcfTileSource::isEcgGeom(), ossimDemUtil::isUsgsDem(), ossimGdalOgrVectorAnnotation::loadExternalGeometryFile(), ossimDemTool::loadJSON(), ossimDtedTileSource::loadMetaData(), ossimGdalOgrVectorAnnotation::loadOmdFile(), ossimPointCloudImageHandlerFactory::open(), ossimEnviInfo::open(), ossimQuickbirdMetaData::open(), ossimplugins::ossimPleiadesModel::open(), ossimAdrgHeader::ossimAdrgHeader(), ossimQuickbirdRpcModel::parseMetaData(), ossimQuickbirdRpcModel::parseNitfFile(), ossimQuickbirdRpcModel::parseRpcData(), ossimQuickbirdRpcModel::parseTileData(), ossimChipProcTool::processRemainingArgs(), ossimGeneralRasterElevHandler::setFilename(), ossimSpot5Model::setupOptimizer(), ossimplugins::ossimFormosatModel::setupOptimizer(), ossimImageData::write(), ossimImageFileWriter::writeEnviHeaderFile(), ossimImageFileWriter::writeErsHeaderFile(), ossimImageFileWriter::writeExternalGeometryFile(), ossimImageFileWriter::writeFgdcFile(), ossimImageFileWriter::writeHistogramFile(), ossimImageFileWriter::writeJpegWorldFile(), ossimImageFileWriter::writeOverviewFile(), ossimImageFileWriter::writeTiffWorldFile(), and ossimImageFileWriter::writeWorldFile().

{
   ossimString newExtPart = e;

   //---
   // If e has a dot "." in the front of it strip it off...
   //---
   if ( (e.begin() != e.end()) && ((*(e.begin())) == '.') )
   {
      newExtPart = ossimString(e.begin() + 1, e.end());
   }

   ossimString drivePart;
   ossimString pathPart;
   ossimString filePart;
   ossimString extPart;

   split(drivePart,
         pathPart,
         filePart,
         extPart);

   merge(drivePart,
         pathPart,
         filePart,
         newExtPart);

   return *this;
}

setFile()

ossimFilename & ossimFilename::setFile

(

const ossimString &

f

)

Definition at line 940 of file ossimFilename.cpp.

References merge(), and split().

Referenced by ossimplugins::ossimAlosPalsarModel::findAlosPalsarData(), ossimplugins::ossimAlosPalsarModel::findAlosPalsarLeader(), ossimSensorModelFactory::findCoarseGrid(), ossimplugins::ossimErsSarModel::findErsLeader(), and ossimplugins::ossimPleiadesModel::open().

{
   ossimString drivePart;
   ossimString pathPart;
   ossimString filePart;
   ossimString extPart;

   split(drivePart,
         pathPart,
         filePart,
         extPart);

   merge(drivePart,
         pathPart,
         f,
         extPart);

   return *this;
}

setPath()

ossimFilename & ossimFilename::setPath

(

const ossimString &

p

)

Definition at line 920 of file ossimFilename.cpp.

References merge(), and split().

Referenced by ossimBandSeparateHandler::getBandFileNames(), ossimDemTool::ossimDemTool(), ossimBatchTest::processConfigList(), ossimDemToolConfig::readConfig(), and ATP::AtpConfig::readConfig().

{
   ossimString drivePart;
   ossimString pathPart;
   ossimString filePart;
   ossimString extPart;

   split(drivePart,
         pathPart,
         filePart,
         extPart);

   merge(drivePart,
         p,
         filePart,
         extPart);

   return *this;
}

setTimes()

bool ossimFilename::setTimes	(	ossimLocalTm *	accessTime,
		ossimLocalTm *	modTime,
		ossimLocalTm *	createTime
	)		const

Writes f to the output stream os.

Definition at line 314 of file ossimFilename.cpp.

References ossimLocalTm::getTicks(), and Write.

Referenced by touch().

{
#if defined(_WIN32)
   if(isDir())
   {
      // need to implement this later
      return false;
   }
   else
   {
      ossimFileHandle fh(this->expand(), ossimFileHandle::Write);
      if(fh.isOk())
      {
         FILETIME ftAccess, ftCreate, ftWrite;
         
         if ( createTime )
         {
            convertOssimToFileTime(&ftCreate, *createTime);
         }
         if ( accessTime )
         {
            convertOssimToFileTime(&ftAccess, *accessTime);
         }
         if ( modTime )
         {
            convertOssimToFileTime(&ftWrite, *modTime);
         }
         if ( ::SetFileTime(fh,
                            createTime ? &ftCreate : NULL,
                            accessTime ? &ftAccess : NULL,
                            modTime ? &ftWrite : NULL) )
         {
            return true;
         }
      }
   }
#else
   if ( !accessTime && !modTime )
   {
      // can't modify the creation time anyhow, don't try
      return true;
   }
   utimbuf utm;
   utm.actime = accessTime ? accessTime->getTicks() : modTime->getTicks();
   utm.modtime = modTime ? modTime->getTicks() : accessTime->getTicks();
   if ( utime(expand().c_str(), &utm) == 0 )
   {
      return true;
   }
    
#endif

   return false;
}

split()

void ossimFilename::split	(	ossimString &	drivePart,
		ossimString &	pathPart,
		ossimString &	filePart,
		ossimString &	extPart
	)		const

Definition at line 961 of file ossimFilename.cpp.

References drive(), ext(), fileNoExtension(), path(), and ossimString::substitute().

Referenced by append(), ossimImageHandler::getFilenameWithNoExtension(), noExtension(), setDrive(), setExtension(), setFile(), and setPath().

{
   drivePart = drive();
   pathPart  = path();
   if(drivePart != "")
   {
      pathPart = pathPart.substitute(drivePart, "");
   }
   filePart  = fileNoExtension();
   extPart   = ext();
}

touch()

bool ossimFilename::touch

(

)

const

Definition at line 477 of file ossimFilename.cpp.

References ossimString::c_str(), expand(), and setTimes().

{
#if defined( _WIN32 )
   ossimDate now;

   return setTimes(&now, &now, 0);
   
#else
   if ( utime(expand().c_str(), NULL) == 0 )
   {
      return true;
   }
   
   return false;
#endif   
}

wildcardRemove() [1/2]

bool ossimFilename::wildcardRemove ( const ossimFilename &  pathname )

static

Will use a wildcard remove.

NOTE: This is in a regular expression format so if you want all files with prefix myfile to be erased then you would give it <path>/myfile.*

The . here is a regular expression '.' character which says any character and the * "is any number of"

Definition at line 1202 of file ossimFilename.cpp.

References ossimString::c_str(), file(), ossimDirectory::findAllFilesThatMatch(), isDir(), ossimDirectory::open(), ossimFilename(), and path().

{
   std::vector<ossimFilename> fileListToRemove;
   ossimFilename tempPathname = pathname;
   
   if(!tempPathname.isDir())
   {
      ossimFilename file = tempPathname.file();
      ossimFilename path = tempPathname.path();
      if(path == "")
      {
         path = ".";
      }
      ossimDirectory dir;
      if(dir.open(path))
      {
         dir.findAllFilesThatMatch(fileListToRemove,
                                   file.c_str());
      }
      else
      {
      }
   }
   else
   {
      fileListToRemove.push_back(ossimFilename(pathname));
   }
   ossim_uint32 idx = 0;
   bool result = true;
   for(idx = 0; idx < fileListToRemove.size(); ++idx)
   {
#if defined(__VISUALC__)  || defined(__BORLANDC__) || defined(__WATCOMC__) || \
   defined(__GNUWIN32__) || defined(_MSC_VER)
      
      if(remove(fileListToRemove[idx].c_str()) != 0)
      {
         result = false;
      }
#else
      if (unlink(fileListToRemove[idx]) == -1)
      {
         result = false;
      }
#endif /* HAVE_UNISTD_H */
   }
   return result;
}

wildcardRemove() [2/2]

bool ossimFilename::wildcardRemove

(

)

const

Definition at line 1284 of file ossimFilename.cpp.

Referenced by ossimTempFilename::~ossimTempFilename().

{
   return ossimFilename::wildcardRemove(*this);
}

Member Data Documentation

NIL

const ossimFilename ossimFilename::NIL =("")

static

This was taken from Wx widgets for performing touch and access date stamps.

Definition at line 40 of file ossimFilename.h.

Referenced by ossimSingleImageChain::addHistogramRemapper(), ossimSrtmSupportData::clear(), ossimFgdcXmlDoc::close(), ext(), ossimHistogramRemapper::getHistogramFile(), ossimSrtmSupportData::getImageGeometry(), ossimKakaduNitfOverviewBuilder::getOutputFile(), ossimGdalOverviewBuilder::getOutputFile(), ossimGmlSupportData::initialize(), ossimVertexExtractor::open(), ossimplugins::ossimRadarSat2RPCModel::open(), ossimplugins::ossimTerraSarModel::open(), ossimplugins::ossimRadarSat2Model::open(), path(), ossimDirectoryData::read(), ossimSrtmSupportData::saveState(), and ossimFgdcFileWriter::writeFile().

OSSIM_FILENAME_PATH_SEPARATOR

const char ossimFilename::OSSIM_FILENAME_PATH_SEPARATOR = '/'

staticprotected

Definition at line 285 of file ossimFilename.h.

Referenced by converPathSeparator(), createDirectory(), dirCat(), expand(), file(), fileNoExtension(), getPathSeparator(), native(), and path().

OSSIM_NATIVE_PATH_SEPARATOR

const char ossimFilename::OSSIM_NATIVE_PATH_SEPARATOR = '/'

staticprotected

since windows uses \ for path separation and unix / we need to be consistent.

Definition at line 284 of file ossimFilename.h.

Referenced by native().

---

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

• ossimFilename.h
• ossimFilename.cpp