Class TopologyLocation

A TopologyLocation is the labelling of a GraphComponent's topological relationship to a single Geometry.

Inheritance

object

TopologyLocation

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: NetTopologySuite.GeometriesGraph

Assembly: NetTopologySuite.dll

Syntax

public class TopologyLocation

Remarks

If the parent component is an area edge, each side and the edge itself have a topological location. These locations are named:

On	on the edge
Left	left-hand side of the edge
Right	right-hand side

If the parent component is a line edge or node, there is a single topological relationship attribute, On.

The possible values of a topological location are { Null, Exterior, Boundary, Interior }

The labelling is stored in an array _location[j] where where j has the values On, Left, Right.

Constructors

| Edit this page View Source

TopologyLocation(Location)

Declaration

public TopologyLocation(Location on)

Parameters

Type	Name	Description
Location	on

| Edit this page View Source

TopologyLocation(Location, Location, Location)

Constructs a TopologyLocation specifying how points on, to the left of, and to the right of some GraphComponent relate to some Geometry. Possible values for the parameters are Location.Null, Location.Exterior, Location.Boundary, and Location.Interior.

Declaration

public TopologyLocation(Location on, Location left, Location right)

Parameters

Type	Name	Description
Location	on	`Location` for On position
Location	left	`Location` for Left position
Location	right	`Location` for Right position

| Edit this page View Source

TopologyLocation(Location[])

Declaration

public TopologyLocation(Location[] location)

Parameters

Type	Name	Description
Location[]	location

| Edit this page View Source

TopologyLocation(TopologyLocation)

Declaration

public TopologyLocation(TopologyLocation gl)

Parameters

Type	Name	Description
TopologyLocation	gl

Properties

| Edit this page View Source

IsAnyNull

Declaration

public bool IsAnyNull { get; }

Property Value

Type	Description
bool	`true` if any locations are Null.

| Edit this page View Source

IsArea

Declaration

public bool IsArea { get; }

Property Value

Type	Description
bool

| Edit this page View Source

IsLine

Declaration

public bool IsLine { get; }

Property Value

Type	Description
bool

| Edit this page View Source

IsNull

Declaration

public bool IsNull { get; }

Property Value

Type	Description
bool	`true` if all locations are Null.

| Edit this page View Source

this[Position]

Get calls Get(Positions posIndex), Set calls SetLocation(Positions locIndex, Location locValue)

Declaration

public Location this[Position posIndex] { get; set; }

Parameters

Type	Name	Description
Position	posIndex

Property Value

Type	Description
Location

| Edit this page View Source

this[Positions]

Get calls Get(Positions posIndex), Set calls SetLocation(Positions locIndex, Location locValue)

Declaration

[Obsolete("Use the Geometries.Position indexer instead")]
public Location this[Positions posIndex] { get; set; }

Parameters

Type	Name	Description
Positions	posIndex

Property Value

Type	Description
Location

Methods

| Edit this page View Source

AllPositionsEqual(Location)

Declaration

public bool AllPositionsEqual(Location loc)

Parameters

Type	Name	Description
Location	loc

Returns

Type	Description
bool

| Edit this page View Source

Flip()

Declaration

public void Flip()

| Edit this page View Source

Get(Position)

Declaration

public Location Get(Position posIndex)

Parameters

Type	Name	Description
Position	posIndex

Returns

Type	Description
Location

| Edit this page View Source

Get(Positions)

Declaration

[Obsolete("Use Get(Geometries.Position)")]
public Location Get(Positions posIndex)

Parameters

Type	Name	Description
Positions	posIndex

Returns

Type	Description
Location

| Edit this page View Source

GetLocations()

Declaration

public Location[] GetLocations()

Returns

Type	Description
Location[]

| Edit this page View Source

IsEqualOnSide(TopologyLocation, int)

Declaration

public bool IsEqualOnSide(TopologyLocation le, int locIndex)

Parameters

Type	Name	Description
TopologyLocation	le
int	locIndex

Returns

Type	Description
bool

| Edit this page View Source

Merge(TopologyLocation)

Merge updates only the Null attributes of this object with the attributes of another.

Declaration

public void Merge(TopologyLocation gl)

Parameters

Type	Name	Description
TopologyLocation	gl

| Edit this page View Source

SetAllLocations(Location)

Declaration

public void SetAllLocations(Location locValue)

Parameters

Type	Name	Description
Location	locValue

| Edit this page View Source

SetAllLocationsIfNull(Location)

Declaration

public void SetAllLocationsIfNull(Location locValue)

Parameters

Type	Name	Description
Location	locValue

| Edit this page View Source

SetLocation(Location)

Declaration

public void SetLocation(Location locValue)

Parameters

Type	Name	Description
Location	locValue

| Edit this page View Source

SetLocation(Position, Location)

Declaration

public void SetLocation(Position locIndex, Location locValue)

Parameters

Type	Name	Description
Position	locIndex
Location	locValue

| Edit this page View Source

SetLocation(Positions, Location)

Declaration

[Obsolete("Use SetLocation(Geometries.Position, Location)")]
public void SetLocation(Positions locIndex, Location locValue)

Parameters

Type	Name	Description
Positions	locIndex
Location	locValue

| Edit this page View Source

SetLocations(Location, Location, Location)

Declaration

public void SetLocations(Location on, Location left, Location right)

Parameters

Type	Name	Description
Location	on
Location	left
Location	right

| Edit this page View Source

SetLocations(TopologyLocation)

Declaration

public void SetLocations(TopologyLocation gl)

Parameters

Type	Name	Description
TopologyLocation	gl

| Edit this page View Source

ToString()

Declaration

public override string ToString()

Returns

Type	Description
string

Overrides

object.ToString()