IlvS57EnumerationArray Class Reference

This class is used to store a set of S57 enumeration objects. More...

#include <ilviews/maps/format/s57/s57enum.h>

Public Member Functions
	IlvS57EnumerationArray ()
	Initializes a new instance of the array.
void	add (const char *ascii, IlInt value, const char *label, IlBoolean show=IlTrue)
	Adds an enumeration. More...
void	add (IlvS57Enumeration *enumeration)
	Adds an enumeration. More...
IlInt	count ()
	Returns the number of enumerations. More...
IlvS57Enumeration *	operator[] (IlInt index)
	Returns an enumeration. More...

Detailed Description

This class is used to store a set of S57 enumeration objects.

Library: ilvmaps
This class is used to store IlvS57Enumeration objects. Each IlvS57Enumeration object is locked when it is added to an object of this class. And unlocked when the array is deleted.

See also

IlvS57Enumeration.

Member Function Documentation

add() [1/2]

void IlvS57EnumerationArray::add	(	const char *	ascii,
		IlInt	value,
		const char *	label,
		IlBoolean	show = IlTrue
	)

Adds an enumeration.

Creates an enumeration using the given parameters before adding it to the array. The created enumeration is locked.

Parameters

ascii	The ascii value of the enumeration.
value	The integer value of the enumeration.
label	The label of the enumeration.
show	The visibility of the enumeration.

add() [2/2]

void IlvS57EnumerationArray::add

(

IlvS57Enumeration *

enumeration

)

Adds an enumeration.

Adds an enumeration to the array. The enumeration is locked by the array.

Parameters

enumeration

The enumeration.

count()

IlInt IlvS57EnumerationArray::count

(

)

Returns the number of enumerations.

Returns

The number of enumerations.

operator[]()

IlvS57Enumeration* IlvS57EnumerationArray::operator[]

(

IlInt

index

)

Returns an enumeration.

Parameters

index

The enumeration index which starts at 0.

Returns

The enumeration if the index is valid otherwise returns 0.