rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Maps Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvMapSegmentString Class Reference

This abstract class is the base class for segments that can be divided into other smaller segments. More...

#include <ilviews/maps/geometry/geosegstr.h>

Inheritance diagram for IlvMapSegmentString:
IlvMapSegment IlvMapCurve IlvMapGeometry IlvMapArcString IlvMapCurveString IlvMapLineString

List of all members.

Public Member Functions

virtual IlvMapGeometrycopy () const =0
 Returns a copy of the object.
virtual IlvClassInfogetClassInfo () const =0
 Returns the IlvClassInfo of the instance.
virtual const IlvCoordinategetEndPoint () const =0
 Returns the end point of the last segment, if it exists, otherwise, it returns an IlvCoordinate set to (0,0).
virtual const IlvMapSegmentgetSegment (IlUInt index) const =0
 Returns the segment of index index.
virtual IlUInt getSegmentCount () const =0
 Returns the number of segments contained in the string.
virtual const IlvCoordinategetStartPoint () const =0
 Returns the start point of the first segment, if it exists, otherwise, it returns an IlvCoordinate set to (0,0).
virtual const IlvMapGeometrygetSubElement (IlUInt index) const
 Returns the sub element of index index if the geometry is a collection.
virtual IlUInt getSubElementCount () const
 Returns the number of elements contained in the geometry if the geometry is a collection.
virtual IlBoolean isCollection () const
 Returns IlTrue if the geometry is a collection of other geometries.
virtual void removeAll ()=0
 Removes all the segments in the string and sets the start point to (0,0).
virtual void setEndPoint (const IlvCoordinate &end)=0
 Sets the end point of the last segment if it exists.
virtual void setStartPoint (const IlvCoordinate &start)=0
 Sets the start point of the first segment.

Protected Member Functions

 IlvMapSegmentString ()
 Constructor.

Detailed Description

This abstract class is the base class for segments that can be divided into other smaller segments.

The IlvMapCurveString is a generic implementation that can handle any type of IlvMapSegment, while other subclasses are optimized to handle uniform lists of segments. The instances of the predefined subclasses of IlvMapSegmentString can be rendered by an IlvDefaultFeatureRenderer or by an IlvDefaultCurveRenderer. Library: ilvmaps


Constructor & Destructor Documentation

IlvMapSegmentString::IlvMapSegmentString (  )  [protected]

Constructor.

The constructor of this abstract class is protected.


Member Function Documentation

virtual IlvMapGeometry* IlvMapSegmentString::copy (  )  const [pure virtual]

Returns a copy of the object.

Returns:
An IlvMapGeometry that must be deleted by the user.

Implements IlvMapSegment.

Implemented in IlvMapArcString, IlvMapCurveString, and IlvMapLineString.

virtual IlvClassInfo* IlvMapSegmentString::getClassInfo (  )  const [pure virtual]

Returns the IlvClassInfo of the instance.

Returns:
An IlvClassInfo that should not be modified nor deleted.

Implements IlvMapCurve.

Implemented in IlvMapArcString, IlvMapCurveString, and IlvMapLineString.

virtual const IlvCoordinate& IlvMapSegmentString::getEndPoint (  )  const [pure virtual]

Returns the end point of the last segment, if it exists, otherwise, it returns an IlvCoordinate set to (0,0).

Returns:
The end point.

Implements IlvMapSegment.

Implemented in IlvMapArcString, IlvMapCurveString, and IlvMapLineString.

virtual const IlvMapSegment* IlvMapSegmentString::getSegment ( IlUInt  index  )  const [pure virtual]

Returns the segment of index index.

Parameters:
index The index of the segment to be retrieved. index must have a value between 0 and getSegmentCount() - 1.
Returns:
An IlvMapSegment object that should not be modified nor deleted by the user. The returned IlvMapSegment is volatile. This means that it may be modified or deleted by the IlvMapSegmentString itself after an other call to this function, or after any modification.

Implemented in IlvMapArcString, IlvMapCurveString, and IlvMapLineString.

virtual IlUInt IlvMapSegmentString::getSegmentCount (  )  const [pure virtual]

Returns the number of segments contained in the string.

Returns:
The number of segments.

Implemented in IlvMapArcString, IlvMapCurveString, and IlvMapLineString.

virtual const IlvCoordinate& IlvMapSegmentString::getStartPoint (  )  const [pure virtual]

Returns the start point of the first segment, if it exists, otherwise, it returns an IlvCoordinate set to (0,0).

Returns:
The start point.

Implements IlvMapSegment.

Implemented in IlvMapArcString, IlvMapCurveString, and IlvMapLineString.

virtual const IlvMapGeometry* IlvMapSegmentString::getSubElement ( IlUInt  index  )  const [virtual]

Returns the sub element of index index if the geometry is a collection.

Otherwise, it returns a null pointer.

Returns:
The sub element of index index if the geometry is a collection.

Implements IlvMapGeometry.

virtual IlUInt IlvMapSegmentString::getSubElementCount (  )  const [virtual]

Returns the number of elements contained in the geometry if the geometry is a collection.

Otherwise, it returns 0.

Returns:
The number of elements contained in the geometry if the geometry is a collection. Otherwise, it returns 0.

Implements IlvMapGeometry.

virtual IlBoolean IlvMapSegmentString::isCollection (  )  const [virtual]

Returns IlTrue if the geometry is a collection of other geometries.

The composite geometries predefined in Rogue Wave Views Maps are: IlvMapGeometryCollection, IlvMapMultiPoint, IlvMapSegmentString and its subclasses, IlvMapMultiCurve and IlvMapMultiArea.

Returns:
IlTrue if the geometry is a collection of other geometries.

Implements IlvMapGeometry.

virtual void IlvMapSegmentString::setEndPoint ( const IlvCoordinate end  )  [pure virtual]

Sets the end point of the last segment if it exists.

Otherwise, it does nothing.

Parameters:
end The end point.

Implements IlvMapSegment.

Implemented in IlvMapArcString, IlvMapCurveString, and IlvMapLineString.

virtual void IlvMapSegmentString::setStartPoint ( const IlvCoordinate start  )  [pure virtual]

Sets the start point of the first segment.

Parameters:
start The start point.

Implements IlvMapSegment.

Implemented in IlvMapArcString, IlvMapCurveString, and IlvMapLineString.


© Copyright 2012, 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.