Label.h

Go to the documentation of this file.

/**********************************************************************
 *
 * GEOS - Geometry Engine Open Source
 * http://geos.osgeo.org
 *
 * Copyright (C) 2005-2006 Refractions Research Inc.
 * Copyright (C) 2001-2002 Vivid Solutions Inc.
 *
 * This is free software; you can redistribute and/or modify it under
 * the terms of the GNU Lesser General Public Licence as published
 * by the Free Software Foundation.
 * See the COPYING file for more information.
 *
 **********************************************************************
 *
 * Last port: geomgraph/Label.java r428 (JTS-1.12+)
 *
 **********************************************************************/


#ifndef GEOS_GEOMGRAPH_LABEL_H
#define GEOS_GEOMGRAPH_LABEL_H

#include <geos/export.h>
#include <geos/geom/Location.h>
#include <geos/geomgraph/TopologyLocation.h>

#include <geos/inline.h>

#include <iosfwd> // for operator<<

namespace geos {
namespace geomgraph { // geos.geomgraph

class GEOS_DLL Label {

public:

    friend std::ostream& operator<< (std::ostream&, const Label&);

    static Label toLineLabel(const Label& label);

    Label(geom::Location onLoc);

    Label(uint32_t geomIndex, geom::Location onLoc);

    Label(geom::Location onLoc, geom::Location leftLoc, geom::Location rightLoc);

    Label(const Label& l);

    Label& operator= (const Label& l);

    Label();

    Label(uint32_t geomIndex, geom::Location onLoc, geom::Location leftLoc, geom::Location rightLoc);

    void flip();

    geom::Location getLocation(uint32_t geomIndex, uint32_t posIndex) const;

    geom::Location getLocation(uint32_t geomIndex) const;

    void setLocation(uint32_t geomIndex, uint32_t posIndex, geom::Location location);

    void setLocation(uint32_t geomIndex, geom::Location location);

    void setAllLocations(uint32_t geomIndex, geom::Location location);

    void setAllLocationsIfNull(uint32_t geomIndex, geom::Location location);

    void setAllLocationsIfNull(geom::Location location);

    void merge(const Label& lbl);

    int getGeometryCount() const;

    bool isNull() const;

    bool isNull(uint32_t geomIndex) const;

    bool isAnyNull(uint32_t geomIndex) const;

    bool isArea() const;

    bool isArea(uint32_t geomIndex) const;

    bool isLine(uint32_t geomIndex) const;

    bool isEqualOnSide(const Label& lbl, uint32_t side) const;

    bool allPositionsEqual(uint32_t geomIndex, geom::Location loc) const;

    void toLine(uint32_t geomIndex);

    std::string toString() const;

private:

    TopologyLocation elt[2];
};

std::ostream& operator<< (std::ostream&, const Label&);

} // namespace geos.geomgraph
} // namespace geos


#ifdef GEOS_INLINE
# include "geos/geomgraph/Label.inl"
#endif

#endif // ifndef GEOS_GEOMGRAPH_LABEL_H