zeus::TPropertyFile Class Reference

#include <PropertyFile.h>

Inheritance diagram for zeus::TPropertyFile:

List of all members.

Public Member Functions
	TPropertyFile (const IString &rFileName)
Retval	load ()
virtual Retval MQUALIFIER	addProperty (const IString &rName, const IString &rValue)
virtual bool MQUALIFIER	existsProperty (const IString &rName) const
virtual void MQUALIFIER	getPropertyNames (IStringList &rList) const
virtual void MQUALIFIER	getPropertyNamesByNameSpace (const IString &rNameSpace, IStringList &rList) const
virtual Retval MQUALIFIER	getPropertyValue (const IString &rName, IString &rValue) const
virtual Retval MQUALIFIER	setPropertyValue (const IString &rName, const IString &rValue)
virtual Retval MQUALIFIER	getPropertyPathValue (const IString &rName, IString &rValue) const
virtual Retval MQUALIFIER	getPropertyFileValue (const IString &rName, IString &rValue) const
virtual Retval MQUALIFIER	askForInterface (const InterfaceID &rInterfaceID, IZUnknown *&rpIface)
virtual void MQUALIFIER	addRef () const
virtual void MQUALIFIER	release () const
Protected Member Functions
virtual	~TPropertyFile ()

---

Detailed Description

This interface defines the access to a property collection (file)

---

Constructor & Destructor Documentation

TPropertyFile::TPropertyFile

(

const IString &

rFileName )

Creates a new property file

TPropertyFile::~TPropertyFile

(

)

[protected, virtual]

Destroys a property file

---

Member Function Documentation

Retval MQUALIFIER TPropertyFile::addProperty	(	const IString &	rName,
		const IString &	rValue
	)		[virtual]

See also:

IPropertyAccess::addProperty

Implements zeus::IPropertyAccess.

virtual void MQUALIFIER zeus::TPropertyFile::addRef

(

)

const [virtual]

This method increases the reference counter of this object. The call is const because it will not change the content of the object, since the reference counter is not an object data. This allows to handle const reference using addRef() and release().

Implements zeus::IZUnknown.

virtual Retval MQUALIFIER zeus::TPropertyFile::askForInterface	(	const InterfaceID &	rInterfaceID,
		IZUnknown *&	rpIface
	)		[virtual]

This method is used to cast to different interface types. This is a secure way asking for other implemented interfaces, since C++ does not reject invalid casts.

Parameters:

rInterfaceID	: ID of the requested interface
rpIface	: return value of the interface. The pointer contains the address of the requested interface

Return values:

RET_NOERROR	: Interface returned
RET_UNKNOWN_INTERFACE	: Interface is not valid or not implemented

Implements zeus::IZUnknown.

bool MQUALIFIER zeus::TPropertyFile::existsProperty

(

const IString &

rName )

const [inline, virtual]

See also:

IPropertyAccess::existsProperty

Implements zeus::IPropertyAccess.

Retval MQUALIFIER TPropertyFile::getPropertyFileValue	(	const IString &	rName,
		IString &	rValue
	)		const [virtual]

See also:

IPropertyAccess::getPropertyFileValue

Implements zeus::IPropertyAccess.

void MQUALIFIER TPropertyFile::getPropertyNames

(

IStringList &

rList )

const [virtual]

See also:

IPropertyAccess::getPropertyNames

Implements zeus::IPropertyAccess.

void MQUALIFIER TPropertyFile::getPropertyNamesByNameSpace	(	const IString &	rNameSpace,
		IStringList &	rList
	)		const [virtual]

See also:

IPropertyAccess::getPropertyNames

Implements zeus::IPropertyAccess.

Retval MQUALIFIER TPropertyFile::getPropertyPathValue	(	const IString &	rName,
		IString &	rValue
	)		const [virtual]

See also:

IPropertyAccess::getPropertyPathValue

Implements zeus::IPropertyAccess.

Retval MQUALIFIER TPropertyFile::getPropertyValue	(	const IString &	rName,
		IString &	rValue
	)		const [virtual]

See also:

IPropertyAccess::getPropertyValue

Implements zeus::IPropertyAccess.

Retval TPropertyFile::load

(

)

Loads the data from the file

Return values:

RET_NOERROR	: Properties loaded
RET_REQUEST_FAILED	: Could not load properties

virtual void MQUALIFIER zeus::TPropertyFile::release

(

)

const [virtual]

This method decreases the reference counter of this object. This call is const as well (like addRef()). The killing of an object is allowed by const method, because the content is not used any more.

Implements zeus::IZUnknown.

Retval MQUALIFIER TPropertyFile::setPropertyValue	(	const IString &	rName,
		const IString &	rValue
	)		[virtual]

See also:

IPropertyAccess::setPropertyValue

Implements zeus::IPropertyAccess.

---

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

• PropertyFile.h
• PropertyFile.cpp