OFFilename Class Reference

class for managing filenames consisting either of conventional (8-bit) or wide (e.g. More...

List of all members.

Public Member Functions
	OFFilename (const char *filename)
	constructor expecting a conventional character string
	OFFilename (const OFString &filename)
	constructor expecting a character string as an OFString instance
	OFFilename (const OFFilename &arg)
	copy constructor
	~OFFilename ()
	destructor.
OFFilename &	operator= (const OFFilename &arg)
	assignment operator
void	swap (OFFilename &arg)
	fast, non-throwing swap function.
OFBool	isEmpty () const
	checks whether this object stores an empty filename
OFBool	usesWideChars () const
	checks whether this object stores a wide character filename
const char *	getCharPointer () const
	get stored filename consisting of conventional characters
Private Attributes
char *	filename_
	filename consisting of conventional characters (8-bit)

---

Detailed Description

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.

---

Constructor & Destructor Documentation

OFFilename::OFFilename

(

const char *

filename

)

[inline]

constructor expecting a conventional character string

Parameters:

filename

filename to be stored (8-bit characters)

OFFilename::OFFilename

(

const OFString &

filename

)

[inline]

constructor expecting a character string as an OFString instance

Parameters:

filename

filename to be stored (8-bit characters)

OFFilename::OFFilename

(

const OFFilename &

arg

)

[inline]

copy constructor

Parameters:

arg	filename object to be copied

OFFilename::~OFFilename

(

)

[inline]

destructor.

Frees memory.

---

Member Function Documentation

const char* OFFilename::getCharPointer

(

)

const [inline]

get stored filename consisting of conventional characters

Returns:

filename (might be NULL if none is stored)

OFBool OFFilename::isEmpty

(

)

const [inline]

checks whether this object stores an empty filename

Returns:

OFTrue if the filename is empty, OFFalse otherwise

OFFilename& OFFilename::operator=

(

const OFFilename &

arg

)

[inline]

assignment operator

Parameters:

arg	filename object to be copied

Returns:

reference to this filename object

void OFFilename::swap

(

OFFilename &

arg

)

[inline]

fast, non-throwing swap function.

The time complexity of this function is constant.

Parameters:

arg	filename object to swap with

OFBool OFFilename::usesWideChars

(

)

const [inline]

checks whether this object stores a wide character filename

Returns:

OFTrue if the filename uses wide characters, OFFalse otherwise

---

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

• ofstd/include/dcmtk/ofstd/offile.h