dtpf::FileParameter Class Reference

#include <Parameter.h>

Inheritance diagram for dtpf::FileParameter:

List of all members.

---

Detailed Description

FileParameter is a SpecificParameter with values identifying objects on the filesystem (e.g., files, directories, etc).

Public Member Functions
	FileParameter (const muscle::String &name, const T &default)
	Construct a FileParameter with the given name and default value.
virtual	~FileParameter ()
	Destroy a FileParameter.
virtual void	SetValue (const T &value)
	Set a file parameter's value.
bool	IsFile () const
	Find out if a file parameter's value is a normal file.
bool	IsDirectory () const
	Find out if a file parameter's value is a directory.
virtual void	SetUIType (ParameterUIType uiType)
	Set the UI type to one comaptible with a file parameter.

---

Constructor & Destructor Documentation

dtpf::FileParameter::FileParameter (  const muscle::String &  name, const T &  default )  [inline]

Construct a FileParameter with the given name and default value. Parameters: name  The name of the parameter. default  The default parameter value.

virtual dtpf::FileParameter::~FileParameter (   )  [inline, virtual]

Destroy a FileParameter.

---

Member Function Documentation

bool dtpf::FileParameter::IsDirectory (   )  const [inline]

Find out if a file parameter's value is a directory. Returns: true if the parameter's current value is directory.

bool dtpf::FileParameter::IsFile (   )  const [inline]

Find out if a file parameter's value is a normal file. Returns: true if the parameter's current value is a file.

virtual void dtpf::FileParameter::SetUIType (  ParameterUIType  uiType  )  [inline, virtual]

Set the UI type to one comaptible with a file parameter. Parameters: uiType  The new ParameterUIType. Implements dtpf::Parameter.

virtual void dtpf::FileParameter::SetValue (  const T &  value  )  [inline, virtual]

Set a file parameter's value. Parameters: value  The new filesystem object. Reimplemented from dtpf::SpecificParameter.

---

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

• Lib/Parameter.h

---