Rogue Wave Views
Maps Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions
IlvS57AssocId Class Reference

This class enables you to use long identifiers stored as 64 bits. More...

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

Public Member Functions

 IlvS57AssocId (IlInt h=0, IlInt l=0)
 Initializes the values of both parts of the identifier. More...
 
 IlvS57AssocId (const IlvS57AssocId &src)
 Initializes an identifier with the value of another identifier. More...
 
const char * getValue ()
 Returns the identifier as a string. More...
 
IlBoolean isNull () const
 Returns IlTrue if the identifier is null. More...
 
int operator== (const IlvS57AssocId &obj) const
 The equality operator. More...
 
void set (IlInt h, IlInt l)
 Sets the values of both parts of the identifier. More...
 

Detailed Description

This class enables you to use long identifiers stored as 64 bits.

Library: ilvmaps

A long identifier is used to identify a FRID record. These identifiers are stored as 64 bits (or two integers). If both integers are equal to 0, the identifier is considered as null.

See also
IlvFRIDRecord

Constructor & Destructor Documentation

IlvS57AssocId::IlvS57AssocId ( IlInt  h = 0,
IlInt  l = 0 
)

Initializes the values of both parts of the identifier.

Parameters
hThe higher(left) part of the 64 bit identifier.
lThe lower(right) part of the 64 bit identifier.
IlvS57AssocId::IlvS57AssocId ( const IlvS57AssocId src)

Initializes an identifier with the value of another identifier.

Parameters
srcThe original identifier.

Member Function Documentation

const char* IlvS57AssocId::getValue ( )

Returns the identifier as a string.

Returns
The identifier as a string. Do not delete the string because it is stored in a static buffer. If you call this function twice, the first string value is erased by the second string value.
IlBoolean IlvS57AssocId::isNull ( ) const

Returns IlTrue if the identifier is null.

Returns
IlTrue if the identifier is null. An identifier is null if the higher(left) and lower(right) parts are equal to 0.
int IlvS57AssocId::operator== ( const IlvS57AssocId obj) const

The equality operator.

Parameters
objThe second identifier.
Returns
0 if the identifiers are different otherwise returns 1.
void IlvS57AssocId::set ( IlInt  h,
IlInt  l 
)

Sets the values of both parts of the identifier.

Parameters
hThe higher(left) part of the 64 bit identifier.
lThe lower(right) part of the 64 bit identifier.

© Copyright 2016, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.