IlvFeatureAttributeProperty Class Reference

This class is used to store the values of map attributes. More...

Inheritance diagram for IlvFeatureAttributeProperty:

List of all members.

Public Member Functions
	IlvFeatureAttributeProperty (IlvInputFile &input, IlvSymbol *symbol)
	Creates a new IlvFeatureAttributeProperty object from an IlvInputStream object.
	IlvFeatureAttributeProperty (const IlvFeatureAttributeProperty &source)
	Creates a new IlvFeatureAttributeProperty object by copying an existing one.
	IlvFeatureAttributeProperty (IlvFeatureAttributeInfo *info, IlvFeatureAttribute **values, IlvMapsError &status)
	Creates an instance of the class IlvFeatureAttributeProperty.
virtual IlvNamedProperty *	copy () const
	Copies the property.
const IlvFeatureAttribute *	getAttribute (const char *name) const
	Returns the attribute specified by its name.
const IlvFeatureAttribute *	getAttribute (int i) const
	Returns the attribute of the specified index.
const IlvFeatureAttributeInfo *	getInfo () const
	Returns the attribute info.
IlvFeatureAttribute *	setAttribute (const char *name, IlvFeatureAttribute *value, IlvMapsError &status)
	Sets the value of the attribute specified by its name to value.
IlvFeatureAttribute *	setAttribute (IlUInt i, IlvFeatureAttribute *attribute, IlvMapsError &status)
	Sets the value of the attribute specified by the index i to value.
IlvFeatureAttribute *	unsafeSetAttribute (int i, IlvFeatureAttribute *attribute)
	Sets the value of the attribute specified by the index i to value, without checking any conditions.
void	write (IlvOutputFile &output) const
	Writes the object to an IlvOutputFile.
Static Public Member Functions
static const IlvSymbol *	GetName ()
	Returns the name of the property.
static IlvMapsError	NullableError ()
	Returns the error code for nullable objects error.

---

Detailed Description

This class is used to store the values of map attributes.

Library: ilvmaps

Since it is an IlvNamedProperty object, it can be attached to graphic object layers or managers, and, possibly, saved to ivl files.

---

Constructor & Destructor Documentation

IlvFeatureAttributeProperty::IlvFeatureAttributeProperty	(	IlvFeatureAttributeInfo *	info,
		IlvFeatureAttribute **	values,
		IlvMapsError &	status
	)

Creates an instance of the class IlvFeatureAttributeProperty.

Parameters:

	info	The description of the attributes (names, classes etc.).
	values	The array of feature attributes.
	status	An IlvMapsError in case of failure.

IlvFeatureAttributeProperty::IlvFeatureAttributeProperty

(

const IlvFeatureAttributeProperty &

source

)

Creates a new IlvFeatureAttributeProperty object by copying an existing one.

The IlvFeatureAttributeInfo is not copied, which means that the source and the copy will share the same instance of IlvFeatureAttributeInfo.

The attribute array and the attributes themselves are copied.

Parameters:

source

The feature attribute property to be copied.

IlvFeatureAttributeProperty::IlvFeatureAttributeProperty	(	IlvInputFile &	input,
		IlvSymbol *	symbol
	)

Creates a new IlvFeatureAttributeProperty object from an IlvInputStream object.

Parameters:

	input	The input file.
	symbol	The name of the property.

---

Member Function Documentation

virtual IlvNamedProperty* IlvFeatureAttributeProperty::copy

(

)

const [virtual]

Copies the property.

The IlvFeatureAttributeInfo is not copied, that is the source and the copy will share the same instance of IlvFeatureAttributeInfo.

The attribute array and the attributes themselves are copied.

Returns:

A copy of this feature attribute property.

Implements IlvNamedProperty.

const IlvFeatureAttribute* IlvFeatureAttributeProperty::getAttribute

(

const char *

name

)

const

Returns the attribute specified by its name.

Parameters:

name

The name of the attribute.

Returns:

The attribute.

const IlvFeatureAttribute* IlvFeatureAttributeProperty::getAttribute

(

int

i

)

const

Returns the attribute of the specified index.

Parameters:

i

The index of the attribute.

Returns:

The attribute at index i.

const IlvFeatureAttributeInfo* IlvFeatureAttributeProperty::getInfo

(

)

const

Returns the attribute info.

Returns:

The attribute info.

static const IlvSymbol* IlvFeatureAttributeProperty::GetName

(

)

[static]

Returns the name of the property.

Returns:

The property name.

IlvFeatureAttribute* IlvFeatureAttributeProperty::setAttribute	(	const char *	name,
		IlvFeatureAttribute *	value,
		IlvMapsError &	status
	)

Sets the value of the attribute specified by its name to value.

Parameters:

	name	The name of the attribute to be set.
	value	The value to which the specified attribute will be set.
	status	It can be one of the following: IlvMaps::NoError() IlvMaps::IndexError() IlvMaps::NullableError() IlvMaps::ClassError()

IlvFeatureAttribute* IlvFeatureAttributeProperty::setAttribute	(	IlUInt	i,
		IlvFeatureAttribute *	attribute,
		IlvMapsError &	status
	)

Sets the value of the attribute specified by the index i to value.

The attribute is then owned by the IlvFeatureAttributeProperty The attribute values you set must be checked against the following conditions:

• When the attribute value to be set is not nullable, the new value must not be null.
• The class associated with the attribute must be assignable from the class of the new value.

Parameters:

	i	The index of the attribute to be set.
	attribute	The value to which the specified attribute will be set.
	status	An error code indicating the status of the operation.

Returns:

The previous attribute of the specified index, which is no longer owned by the IlvFeatureAttributeProperty.

IlvFeatureAttribute* IlvFeatureAttributeProperty::unsafeSetAttribute	(	int	i,
		IlvFeatureAttribute *	attribute
	)

Sets the value of the attribute specified by the index i to value, without checking any conditions.

This method must be used with caution. If the conditions checked by the setAttribute method are not met, the object will be in an inconsistent state.

Parameters:

	i	The index of the attribute to be set.
	attribute	The value to which the specified attribute will be set.

Returns:

The previous attribute that was at position i.

void IlvFeatureAttributeProperty::write

(

IlvOutputFile &

output

)

const [virtual]

Writes the object to an IlvOutputFile.

Parameters:

output

The output file.

Implements IlvNamedProperty.