SPAIOptions Class Reference

The SPAIOptions list class. More...

#include <SPAIOptions.h>

Inheritance diagram for SPAIOptions:

[legend]

Collaboration diagram for SPAIOptions:

[legend]

List of all members.

Public Member Functions
SPAIResult	Add (const SPAIOptionName &iOptionName, const SPAIValue &iOptionValue)
	Adds an option to the option list.
void *	GetData () const
	For Spatial Corp.
SPAIResult	GetOptionAt (int iIndex, SPAIOptionName &oOptionName, SPAIValue &oOptionValue)
	Get the option name and value.
int	GetOptionsCount ()
	Return the number of options.
virtual bool	IsValid () const
SPAIResult	Load (const SPAIFile &iOptionFile)
	Loads options from an option file.
void	SetData (void *ipData)
	For Spatial Corp.
	SPAIOptions ()
	Constructor.
virtual	~SPAIOptions ()
	Destructor.
Protected Member Functions
int	Ref ()
int	Unref ()
Protected Attributes
SPAIObjectType	_type

---

Detailed Description

The SPAIOptions list class.

SPAIOptions stores a list of options with associated values. A SPAIOptions object can be passed to a SPAIConverter object in order to customize the translation. Options can be loaded from an option file or added one by one. The list of available options is provided in the Interop documentation.

See also:

SPAIOptionName

SPAIConverter::SetOptions

---

Constructor & Destructor Documentation

SPAIOptions::SPAIOptions

(

)

Constructor.

virtual SPAIOptions::~SPAIOptions

(

)

[virtual]

Destructor.

---

Member Function Documentation

SPAIResult SPAIOptions::Add	(	const SPAIOptionName &	iOptionName,
		const SPAIValue &	iOptionValue
	)

Adds an option to the option list.

Parameters:

	iOptionName,:	Name of the option to add
	iOptionValue,:	Value of the option to add

void* SPAIObject::GetData

(

)

const [inherited]

For Spatial Corp.

internal use only.

SPAIResult SPAIOptions::GetOptionAt	(	int	iIndex,
		SPAIOptionName &	oOptionName,
		SPAIValue &	oOptionValue
	)

Get the option name and value.

Parameters:

	iIndex,:	Index between 0 included and the options count excluded of the option.
	iOptionName,:	The returned option name
	iOptionValue,:	The returned option value

int SPAIOptions::GetOptionsCount

(

)

Return the number of options.

virtual bool SPAIObject::IsValid

(

)

const [virtual, inherited]

Returns:

true if this object was correctly initialized ; false otherwise.

SPAIResult SPAIOptions::Load

(

const SPAIFile &

iOptionFile

)

Loads options from an option file.

Parameters:

iOptionFile,:

the file object to the option file

int SPAIObject::Ref

(

)

[protected, inherited]

void SPAIObject::SetData

(

void *

ipData

)

[inherited]

For Spatial Corp.

internal use only.

int SPAIObject::Unref

(

)

[protected, inherited]

---

Member Data Documentation

SPAIObjectType SPAIObject::_type [protected, inherited]