Views
Maps Package API Reference Guide
Product Documentation:
Views Documentation Home
List of all members | Public Member Functions
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:
IlvI8211RefCount

Public Member Functions

 IlvS57Enumeration ()
 Initializes a new enumeration with default values. More...
 
 IlvS57Enumeration (const char *ascii, IlInt value, const char *label, IlBoolean show=IlTrue)
 Initializes a new enumeration. More...
 
const char * asciiValue () const
 Returns the ascii value. More...
 
IlInt binaryValue () const
 Returns the integer value. More...
 
const char * getLabel () const
 Returns the label. More...
 
void set (const char *ascii, IlInt value, const char *label, IlBoolean show=IlTrue)
 Sets new values for an enumeration. More...
 
- Public Member Functions inherited from IlvI8211RefCount
void lock ()
 Locks the object. More...
 
void unLock ()
 Unlocks the object. More...
 

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() [1/2]

IlvS57Enumeration::IlvS57Enumeration ( )

Initializes a new enumeration with default values.

Creates an enumeration with default values.

◆ IlvS57Enumeration() [2/2]

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

Initializes a new enumeration.

Parameters
asciiThe ascii value of the enumeration.
valueThe integer value of the enumeration.
labelThe label of the enumeration.
showThe visibility of the enumeration.

Member Function Documentation

◆ asciiValue()

const char* IlvS57Enumeration::asciiValue ( ) const

Returns the ascii value.

Returns
The ascii value of the enumeration.

◆ binaryValue()

IlInt IlvS57Enumeration::binaryValue ( ) const

Returns the integer value.

Returns
The integer value of the enumeration.

◆ getLabel()

const char* IlvS57Enumeration::getLabel ( ) const

Returns the label.

Returns
The label of the enumeration.

◆ set()

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
asciiThe ascii value of the enumeration.
valueThe integer value of the enumeration.
labelThe label of the enumeration.
showThe visibility of the enumeration.