geos::noding::SegmentString Class Reference

An interface for classes which represent a sequence of contiguous line segments. More...

#include <SegmentString.h>

Inheritance diagram for geos::noding::SegmentString:

Public Types
typedef std::vector< const SegmentString * >	ConstVect
typedef std::vector< SegmentString * >	NonConstVect

Public Member Functions
	SegmentString (const void *newContext, geom::CoordinateSequence *newSeq)
	Construct a SegmentString. More...
const void *	getData () const
	Gets the user-defined data for this segment string. More...
void	setData (const void *data)
	Sets the user-defined data for this segment string. More...
std::size_t	size () const
template<typename CoordType = geom::Coordinate>
const CoordType &	getCoordinate (std::size_t i) const
const geom::CoordinateSequence *	getCoordinates () const
	Return a pointer to the CoordinateSequence associated with this SegmentString. More...
geom::CoordinateSequence *	getCoordinates ()
int	getSegmentOctant (std::size_t index) const
	Gets the octant of the segment starting at vertex index. More...
const geom::CoordinateXY &	nextInRing (std::size_t index) const
const geom::CoordinateXY &	prevInRing (std::size_t index) const
bool	isClosed () const
virtual std::ostream &	print (std::ostream &os) const

Static Public Member Functions
static int	getSegmentOctant (const SegmentString &ss, std::size_t index)

Protected Attributes
geom::CoordinateSequence *	seq

Friends
std::ostream &	operator<< (std::ostream &os, const SegmentString &ss)

Detailed Description

An interface for classes which represent a sequence of contiguous line segments.

SegmentStrings can carry a context object, which is useful for preserving topological or parentage information.

Constructor & Destructor Documentation

SegmentString()

geos::noding::SegmentString::SegmentString ( const void *  newContext, geom::CoordinateSequence *  newSeq  )

inline

Construct a SegmentString.

Parameters

newContext	the context associated to this SegmentString
newSeq	coordinates of this SegmentString

Member Function Documentation

getCoordinates()

const geom::CoordinateSequence* geos::noding::SegmentString::getCoordinates ( void  ) const

inline

Return a pointer to the CoordinateSequence associated with this SegmentString.

Note

The CoordinateSequence is owned by this SegmentString!

getData()

const void* geos::noding::SegmentString::getData ( ) const

inline

Gets the user-defined data for this segment string.

Returns

the user-defined data

getSegmentOctant()

int geos::noding::SegmentString::getSegmentOctant ( std::size_t  index ) const

inline

Gets the octant of the segment starting at vertex index.

Parameters

index

the index of the vertex starting the segment. Must not be the last index in the vertex list

Returns

the octant of the segment at the vertex

nextInRing()

const geom::CoordinateXY& geos::noding::SegmentString::nextInRing ( std::size_t  index ) const

inline

Gets the next vertex in a ring from a vertex index.

Parameters

index

the vertex index

Returns

the next vertex in the ring

See also

isClosed

prevInRing()

const geom::CoordinateXY& geos::noding::SegmentString::prevInRing ( std::size_t  index ) const

inline

Gets the previous vertex in a ring from a vertex index.

Parameters

index

the vertex index

Returns

the previous vertex in the ring

See also

isClosed

setData()

void geos::noding::SegmentString::setData ( const void *  data )

inline

Sets the user-defined data for this segment string.

Parameters

data	an Object containing user-defined data

---

The documentation for this class was generated from the following file:

• SegmentString.h