Views
Maps Package API Reference Guide
Product Documentation:
Views Documentation Home
List of all members | Public Member Functions
IlvFRIDRecord Class Reference

This class corresponds to the FRID record of the S57 format. More...

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

Inheritance diagram for IlvFRIDRecord:
IlvS57Record IlvI8211RefCount

Public Member Functions

 IlvFRIDRecord (const IlvI8211Record &record)
 Initializes a new FRID record. More...
 
IlvFeatureAttributeInfogetAttributeInfo ()
 Returns information about attributes. More...
 
IlvS57EnumerationgetCode ()
 Returns the object label. More...
 
IlvDSPMRecordgetDspmRecord ()
 Returns the DSPM record. More...
 
IlvFeatureAttributePropertygetFeatureProperties (IlvMapsError &status)
 Returns the properties of the feature. More...
 
IlvFRIDRecord ** getFridRecords ()
 Returns the FRID records attached to this record. More...
 
IlvS57EnumerationArraygetFridRinds ()
 Returns the relationship of the attached FRID records. More...
 
IlInt getGrup ()
 Returns the group. More...
 
IlvS57AssocIdgetId ()
 Returns the internal identifier. More...
 
IlvS57AssocIdgetLongId ()
 Returns the internal long identifier. More...
 
IlvS57EnumerationgetPrimType ()
 Returns the object geometric primitive. More...
 
IlInt getPrimTypeAsBinary ()
 Returns the identifier of the object geometric primitive. More...
 
IlInt getRcid ()
 Returns the record identifier number. More...
 
IlInt getRcnm ()
 Returns the record name. More...
 
IlvS57EnumerationgetRuinType ()
 Returns the record update instruction. More...
 
IlInt getRver ()
 Returns the record version. More...
 
IlvS57EnumerationArraygetVridMasks ()
 Returns the masking indicators of the attached VRID records. More...
 
IlvS57EnumerationArraygetVridOrnts ()
 Returns the orientation of the attached VRID records. More...
 
IlvVRIDRecordgetVridRecord (IlInt index)
 Returns an attached VRID record. More...
 
IlInt getVridRecordCount ()
 Returns the number of attached VRID records. More...
 
IlvVRIDRecord ** getVridRecords ()
 Returns the attached VRID records. More...
 
IlvS57EnumerationArraygetVridUsags ()
 Returns the usage indicators of the attached VRID records. More...
 
- Public Member Functions inherited from IlvS57Record
 IlvS57Record ()
 Initializes a new record.
 
- Public Member Functions inherited from IlvI8211RefCount
void lock ()
 Locks the object. More...
 
void unLock ()
 Unlocks the object. More...
 

Detailed Description

This class corresponds to the FRID record of the S57 format.

Library: ilvmaps

The IlvFRIDRecord are reference counting objecst, you must lock and unlock the objects of this class, you cannot directly delete these objects because there are shared by several other objects.

See also
IlvS57Record, IlvVRIDRecord, IlvDSIDRecord, IlvDSPMRecord, IlvS57Reader.

Constructor & Destructor Documentation

◆ IlvFRIDRecord()

IlvFRIDRecord::IlvFRIDRecord ( const IlvI8211Record record)

Initializes a new FRID record.

Parameters
recordThe values to initialize the record.

Member Function Documentation

◆ getAttributeInfo()

IlvFeatureAttributeInfo* IlvFRIDRecord::getAttributeInfo ( )

Returns information about attributes.

Attributes are necessary to achieve the creation of the IlvMapFeature objects.

If you wish to store the returned object for future use, you must lock it, because it is shared by several objects. Then when you want to delete it, use the unLock() function.

Returns
Information about attributes.

◆ getCode()

IlvS57Enumeration* IlvFRIDRecord::getCode ( )

Returns the object label.

Returns
The object label.

◆ getDspmRecord()

IlvDSPMRecord* IlvFRIDRecord::getDspmRecord ( )

Returns the DSPM record.

Returns
The DSPM record.

◆ getFeatureProperties()

IlvFeatureAttributeProperty* IlvFRIDRecord::getFeatureProperties ( IlvMapsError &  status)

Returns the properties of the feature.

Parameters
statusContains the error message if necessary.
Returns
The properties. You must manage the deletion of the returned object.

◆ getFridRecords()

IlvFRIDRecord** IlvFRIDRecord::getFridRecords ( )

Returns the FRID records attached to this record.

Returns
The FRID records attached to this record.

◆ getFridRinds()

IlvS57EnumerationArray& IlvFRIDRecord::getFridRinds ( )

Returns the relationship of the attached FRID records.

Returns
The relationship of the attached FRID records.

◆ getGrup()

IlInt IlvFRIDRecord::getGrup ( )

Returns the group.

Returns
The group.

◆ getId()

IlvS57AssocId& IlvFRIDRecord::getId ( )

Returns the internal identifier.

Returns
The internal identifier.

◆ getLongId()

IlvS57AssocId& IlvFRIDRecord::getLongId ( )

Returns the internal long identifier.

Returns
The internal long identifier.

◆ getPrimType()

IlvS57Enumeration* IlvFRIDRecord::getPrimType ( )

Returns the object geometric primitive.

Returns
The object geometric primitive.

◆ getPrimTypeAsBinary()

IlInt IlvFRIDRecord::getPrimTypeAsBinary ( )

Returns the identifier of the object geometric primitive.

Returns
The identifier of the object geometric primitive.

◆ getRcid()

IlInt IlvFRIDRecord::getRcid ( )

Returns the record identifier number.

Returns
The record identifier number.

◆ getRcnm()

IlInt IlvFRIDRecord::getRcnm ( )

Returns the record name.

Returns
The record name.

◆ getRuinType()

IlvS57Enumeration* IlvFRIDRecord::getRuinType ( )

Returns the record update instruction.

Returns
The record update instruction.

◆ getRver()

IlInt IlvFRIDRecord::getRver ( )

Returns the record version.

Returns
The record version.

◆ getVridMasks()

IlvS57EnumerationArray& IlvFRIDRecord::getVridMasks ( )

Returns the masking indicators of the attached VRID records.

Returns
The masking indicators of the attached VRID records.

◆ getVridOrnts()

IlvS57EnumerationArray& IlvFRIDRecord::getVridOrnts ( )

Returns the orientation of the attached VRID records.

Returns
The orientation of the attached VRID records.

◆ getVridRecord()

IlvVRIDRecord* IlvFRIDRecord::getVridRecord ( IlInt  index)

Returns an attached VRID record.

Parameters
indexThe index of the VRID record, the first value is 0.
Returns
The attached VRID record if the index is valid otherwise returns 0.

◆ getVridRecordCount()

IlInt IlvFRIDRecord::getVridRecordCount ( )

Returns the number of attached VRID records.

Returns
The number of attached VRID records.

◆ getVridRecords()

IlvVRIDRecord** IlvFRIDRecord::getVridRecords ( )

Returns the attached VRID records.

Returns
The attached VRID records.

◆ getVridUsags()

IlvS57EnumerationArray& IlvFRIDRecord::getVridUsags ( )

Returns the usage indicators of the attached VRID records.

Returns
The usage indicators of the attached VRID records.