|
DCMTK Version 3.6.9
OFFIS DICOM Toolkit
|
class for managing filenames consisting either of conventional (8-bit) or wide (e.g. 16-bit) characters. More...
Public Member Functions | |
| OFFilename () | |
| default constructor | |
| OFFilename (const char *filename, const OFBool convert=OFFalse) | |
| constructor expecting a conventional character string | |
| OFFilename (const OFString &filename, const OFBool convert=OFFalse) | |
| constructor expecting a character string as an OFString instance | |
| OFFilename (const OFpath &path, const OFBool convert=OFFalse) | |
| constructor expecting an OFpath instance | |
| OFFilename (const wchar_t *filename, const OFBool convert=OFTrue) | |
| constructor expecting a wide character string | |
| OFFilename (const OFFilename &arg) | |
| copy constructor | |
| ~OFFilename () | |
| destructor. | |
| OFFilename & | operator= (const OFFilename &arg) |
| assignment operator | |
| void | clear () |
| clear currently stored filename | |
| void | swap (OFFilename &arg) |
| fast, non-throwing swap function. | |
| OFBool | isEmpty () const |
| check whether this object stores an empty filename | |
| OFBool | usesWideChars () const |
| check whether this object stores a wide character filename | |
| const char * | getCharPointer () const |
| get stored filename consisting of conventional characters | |
| const wchar_t * | getWideCharPointer () const |
| get stored filename consisting of wide characters | |
| OFBool | isStandardStream () const |
| check whether the standard input or output streams should be used by comparing the filename with "-" | |
| void | set (const char *filename, const OFBool convert=OFFalse) |
| replace currently stored filename by given value | |
| void | set (const OFString &filename, const OFBool convert=OFFalse) |
| replace currently stored filename by given value | |
| void | set (const OFpath &path, const OFBool convert=OFFalse) |
| replace currently stored filename by given value | |
| void | set (const wchar_t *filename, const OFBool convert=OFTrue) |
| replace currently stored filename by given value | |
Private Attributes | |
| char * | filename_ |
| filename consisting of conventional characters (8-bit, e.g. UTF-8) | |
| wchar_t * | wfilename_ |
| filename consisting of wide characters (e.g. | |
class for managing filenames consisting either of conventional (8-bit) or wide (e.g. 16-bit) characters.
The wide character support is currently Windows-specific because most other operating systems use UTF-8, which is compatible with conventional 8-bit character strings.
| OFFilename::OFFilename | ( | const char * | filename, |
| const OFBool | convert = OFFalse ) |
constructor expecting a conventional character string
| filename | filename to be stored (8-bit characters, e.g. UTF-8) |
| convert | convert given filename to wide character encoding as an alternative representation. Only works on Windows systems. |
| OFFilename::OFFilename | ( | const OFString & | filename, |
| const OFBool | convert = OFFalse ) |
constructor expecting a character string as an OFString instance
| filename | filename to be stored (8-bit characters, e.g. UTF-8) |
| convert | convert given filename to wide character encoding as an alternative representation. Only works on Windows systems. |
| OFFilename::OFFilename | ( | const OFpath & | path, |
| const OFBool | convert = OFFalse ) |
| OFFilename::OFFilename | ( | const wchar_t * | filename, |
| const OFBool | convert = OFTrue ) |
constructor expecting a wide character string
| filename | filename to be stored (e.g. 16-bit characters) |
| convert | convert given filename to UTF-8 encoding as an alternative representation. Only works on Windows systems. |
| OFFilename::OFFilename | ( | const OFFilename & | arg | ) |
| OFFilename::~OFFilename | ( | ) |
destructor.
Frees memory.
|
inline |
get stored filename consisting of conventional characters
References filename_.
Referenced by OFFile::fopen(), and isStandardStream().
|
inline |
get stored filename consisting of wide characters
References wfilename_.
Referenced by OFFile::fopen(), and isStandardStream().
| OFBool OFFilename::isEmpty | ( | ) | const |
check whether this object stores an empty filename
|
inline |
check whether the standard input or output streams should be used by comparing the filename with "-"
References getCharPointer(), getWideCharPointer(), and usesWideChars().
| OFFilename & OFFilename::operator= | ( | const OFFilename & | arg | ) |
assignment operator
| arg | filename object to be copied |
References OFFilename().
| void OFFilename::set | ( | const char * | filename, |
| const OFBool | convert = OFFalse ) |
replace currently stored filename by given value
| filename | filename to be stored (8-bit characters, e.g. UTF-8) |
| convert | convert given filename to wide character encoding as an alternative representation. Only works on Windows systems. |
| void OFFilename::set | ( | const OFpath & | path, |
| const OFBool | convert = OFFalse ) |
| void OFFilename::set | ( | const OFString & | filename, |
| const OFBool | convert = OFFalse ) |
replace currently stored filename by given value
| filename | filename to be stored (8-bit characters, e.g. UTF-8) |
| convert | convert given filename to wide character encoding as an alternative representation). Only works on Windows systems. |
| void OFFilename::set | ( | const wchar_t * | filename, |
| const OFBool | convert = OFTrue ) |
replace currently stored filename by given value
| filename | filename to be stored (e.g. 16-bit characters) |
| convert | convert given filename to UTF-8 encoding as an alternative representation. Only works on Windows systems. |
| void OFFilename::swap | ( | OFFilename & | arg | ) |
fast, non-throwing swap function.
The time complexity of this function is constant.
| arg | filename object to swap with |
References OFFilename().
|
inline |
check whether this object stores a wide character filename
References wfilename_.
Referenced by OFFile::fopen(), and isStandardStream().
|
private |
filename consisting of wide characters (e.g.
16-bit on Windows)
Referenced by getWideCharPointer(), and usesWideChars().