IlvS57Enumeration Class Reference

This class is used to store the data of S57 Enumeration. More...

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

Inheritance diagram for IlvS57Enumeration:

List of all members.

Public Member Functions
	IlvS57Enumeration (const char *ascii, IlInt value, const char *label, IlBoolean show=IlTrue)
	Initializes an enumeration.
	IlvS57Enumeration ()
	Initializes an enumeration with default values.
const char *	asciiValue () const
	Returns the ascii value.
IlInt	binaryValue () const
	Returns the integer value.
const char *	getLabel () const
	Returns the label.
void	set (const char *ascii, IlInt value, const char *label, IlBoolean show=IlTrue)
	Sets new values for an enumeration.

---

Detailed Description

This class is used to store the data of S57 Enumeration.

Library: ilvmaps

An S57 Enumeration is defined by a label, an ascii value which is a short label, an integer value and a visibility which is used by the internal model. The IlvS57Enumeration are reference counting objects, you must lock and unlock the objects of this class, you can't delete directly these objects because there are shared by several other objects.

See also:

IlvS57EnumerationArray, IlvS57Record

---

Constructor & Destructor Documentation

IlvS57Enumeration::IlvS57Enumeration

(

)

Initializes an enumeration with default values.

Creates an enumeration with default values.

IlvS57Enumeration::IlvS57Enumeration	(	const char *	ascii,
		IlInt	value,
		const char *	label,
		IlBoolean	show = IlTrue
	)

Initializes an enumeration.

Creates an enumeration with the following parameters:

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.

---

Member Function Documentation

const char* IlvS57Enumeration::asciiValue

(

)

const

Returns the ascii value.

Returns:

The ascii value of the enumeration.

IlInt IlvS57Enumeration::binaryValue

(

)

const

Returns the integer value.

Returns:

The integer value of the enumeration.

const char* IlvS57Enumeration::getLabel

(

)

const

Returns the label.

Returns:

The label of the enumeration.

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

Sets new values for an enumeration.

Changes the values of the enumeration.

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.