fileio/
mgfffilename__define.pro
This class represents a filename (or directory name).
This class corrects many of the errors found in FILEPATH, FILE_DIRNAME, and FILE_BASENAME.
Class description for mgfffilename
Properties
Properties in mgfffilename
- _ref_extra init
- basename get
characters after the last path separator in the filename; the entire filename if no path separator
- directories get
array of directories as listed in dirname
- dirname get
characters before the last path separator in the filename; empty if no path separator
- extension get set
characters after the last dot in the basename
Routines
Routines from mgfffilename__define.pro
mgfffilename::getProperty, extension=extension, basename=basename, dirname=dirname, directories=directoriesGet properties.
mgfffilename::setProperty, extension=extensionSet properties.
mgfffilename::compose [, basename] [, /clock_basename] [, subdirectory=string/strarr] [, /tmp] [, root_dir=string]Create a filename by specifying its parts.
result = mgfffilename::toString( [format=string])Returns the filename as a string.
mgfffilename::cleanupFree resources.
result = mgfffilename::init( [basename] [, _ref_extra=keywords])Create a filename object.
mgfffilename__defineDefine instance variables.
Routine details
top mgfffilename::getProperty
mgfffilename::getProperty, extension=extension, basename=basename, dirname=dirname, directories=directories
Get properties.
Keywords
- extension
characters after the last dot in the basename
- basename
characters after the last path separator in the filename; the entire filename if no path separator
- dirname
characters before the last path separator in the filename; empty if no path separator
- directories
array of directories as listed in dirname
top mgfffilename::setProperty
mgfffilename::setProperty, extension=extension
Set properties.
Keywords
- extension
characters after the last dot in the basename
top mgfffilename::compose
mgfffilename::compose [, basename] [, /clock_basename] [, subdirectory=string/strarr] [, /tmp] [, root_dir=string]
Create a filename by specifying its parts. Parts are assumed to be empty if
not specified (unlike FILEPATH).
Parameters
- basename in optional type=string
basename or full filename of filename
Keywords
- clock_basename in optional type=boolean
set to use
basenameas a C-style format string to insert the number of milliseconds since 1 January 1970 into- subdirectory in optional type=string/strarr
subdirectory or subdirectories
- tmp in optional type=boolean
set to ignore
ROOT_DIRkeyword and use a root directory specially designated for temporary files- root_dir in optional type=string
root directory
top mgfffilename::toString
result = mgfffilename::toString( [format=string])
Returns the filename as a string.
Return value
string
Keywords
- format in optional type=string
format string with a single string specifier in it (%s or A, depending on the format type) in it
top mgfffilename::init
result = mgfffilename::init( [basename] [, _ref_extra=keywords])
Create a filename object.
Parameters
- basename in optional type=string
basename or full filename of the new filename object
Keywords
- _ref_extra in out optional type=keywords
input keywords to ::compose and output keywords to ::getProperty
File attributes
| Modification date: | Wed May 14 15:07:14 2014 |
| Lines: | 74 |
| Docformat: | rst rst |
Contact me if you have enhancement requests or bug fixes.