#include <Definition.h>

Collaboration diagram for BoxSP:

Public Member Functions
BoxSP *	constructorBoxSP (int32 lx, int32 ly, int32 hx, int32 hy, BoxSP result, char *error)
	Constructs a spatial box from x and y coordinates. More...

BoxSP *	constructorHighBoxSP (const PointSP l, const PointSP h, BoxSP result, char *error)
	Constructs a spatial box from the low and high points. More...

BoxSP *	inBoxSP (const char str, BoxSP result, char **error)
	Constructs a spatial box from the text representation of the object. More...

char *	outBoxSP (const BoxSP *box)
	Constructs the text representation of a spatial box. More...

bytea *	BoxSP2Bytea (const BoxSP *box)
	Gives the byte array of a spatial box. More...

bool	equalsBoxSP (const BoxSP boxA, const BoxSP boxB)
	Checks if the two boxes are equal. More...

Data Fields
PointSP	l

PointSP	h

Detailed Description

BoxSP is spatial data type and is comprised of two PointSP(i,e) components where “l” is the low left point and “h” is the high right point

lh ___ h
| |
|___|
l hl
This is an axis-aligned box.

See also: BoxSP/Casts.sql; BoxSP/Definition.sql; BoxSP/Distance.sql; BoxSP/Interactions.sql; BoxSP/Properties.sql; BoxSP/RelationalOperators.sql

Member Function Documentation

bytea * BoxSP2Bytea ( const BoxSP * box )

Gives the byte array of a spatial box.

Parameters

[in] box pointer to a BoxSP object.

Returns: The byte array.

Referenced by hashBoxSP(), and sendBoxSP().

BoxSP * constructorBoxSP	(	int32	lx,
		int32	ly,
		int32	hx,
		int32	hy,
		BoxSP *	result,
		char **	error
	)

Constructs a spatial box from x and y coordinates.

Correct examples (best practices)

BoxSP box; constructorBoxSP(0,0, 1,1, &box, NULL);
char *error = NULL; BoxSP *box = constructorBoxSP(0,0, 1,1, NULL, &error);

Wrong examples (common mistakes)

BoxSP *box = constructorBoxSP(1,1, 0,0, NULL, NULL); pfree(box);

Parameters

[in]	lx	lowest x
[in]	ly	lowest y
[in]	hx	highest x
[in]	hy	highest y
[out]	result	the box to update.
[out]	error	error message, if any.

Returns: Pointer to a BoxSP or null pointer if an error has occurred. You should check if the returned pointer is NULL before you deallocate it with pfree()!

Referenced by constructorBoxSPV1().

BoxSP * constructorHighBoxSP	(	const PointSP *	l,
		const PointSP *	h,
		BoxSP *	result,
		char **	error
	)

Constructs a spatial box from the low and high points.

Parameters

[in]	l	lowest point
[in]	h	highest point
[out]	result	same as constructorBoxSP().
[out]	error	same as constructorBoxSP().

Returns: same as constructorBoxSP().

Referenced by constructorHighBoxSPV1().

bool equalsBoxSP	(	const BoxSP *	boxA,
		const BoxSP *	boxB
	)

Checks if the two boxes are equal.

Parameters

[in]	boxA	pointer to the first BoxSP object.
[in]	boxB	pointer to the second BoxSP object.

Returns: True if they are equal. False otherwise.

Referenced by equalsBoxSPV1().

BoxSP * inBoxSP	(	const char *	str,
		BoxSP *	result,
		char **	error
	)

Constructs a spatial box from the text representation of the object.

Parameters

[in]	str	text representation and the format is "((lx, ly), (hx, hy))".
[out]	result	same as constructorBoxSP().
[out]	error	same as constructorBoxSP().

Returns: same as constructorBoxSP().

Referenced by inBoxSPV1().

char * outBoxSP ( const BoxSP * box )

Constructs the text representation of a spatial box.

Parameters

[in] box pointer to a BoxSP object.

Returns: the text representation of the box.

Referenced by outBoxSPV1().

Field Documentation

PointSP BoxSP::h

The top right point

Referenced by areaBoxSP(), BoxSP2Bytea(), BoxSP2RangeSP(), BoxST2Bytea(), bufferBoxST(), centerBoxSP(), centerXBoxSP(), centerYBoxSP(), consistentGiSTSegmentST(), constructorBoxSP(), constructorBoxST(), constructorHighBoxSP(), constructorHighBoxST(), containedProperlySegmentSP_BoxSP(), containedSegmentSP_BoxSP(), containsBoxSP_BoxSP(), containsBoxSP_PointSP(), containsProperlyBoxSP_BoxSP(), containsProperlyBoxSP_PointSP(), distanceBoxSP_BoxSP(), eastBoxSP_BoxSP(), enlargeBoxST(), equalsBoxSP(), equalsBoxST(), h_hlBoxSP(), h_lBoxSP(), h_lhBoxSP(), heightBoxSP(), hl_hBoxSP(), hl_lBoxSP(), hl_lhBoxSP(), hlBoxSP(), inBoxSP(), inBoxST(), intersectionBoxSP_BoxSP(), intersectionBoxST_BoxST(), intersectionSegmentSP_BoxSP(), intersectsBoxSP_BoxSP(), isPunctalBoxSP(), l_hBoxSP(), l_hlBoxSP(), l_lhBoxSP(), lh_hBoxSP(), lh_hlBoxSP(), lh_lBoxSP(), lhBoxSP(), northBoxSP_BoxSP(), outBoxSP(), outBoxST(), penaltyGiSTSegmentST(), picksplitGiSTBoxST(), picksplitGiSTSegmentST(), PointSP2BoxSP(), PointST2BoxST(), RangeSP2BoxSP(), recvBoxSP(), recvBoxST(), sameGiSTSegmentST(), SegmentSP2BoxSP(), southBoxSP_BoxSP(), southBoxSP_PointSP(), Trajectory2BoxSP(), Trajectory2BoxST(), unionBoxSP_BoxSP(), unionBoxSP_PointSP(), unionBoxSP_SegmentSP(), unionBoxST_BoxST(), unionBoxST_PointST(), unionBoxST_SegmentST(), westBoxSP_BoxSP(), westBoxSP_PointSP(), and widthBoxSP().

PointSP BoxSP::l

The bottom left point

Referenced by areaBoxSP(), BoxSP2Bytea(), BoxSP2RangeSP(), BoxST2Bytea(), bufferBoxST(), centerBoxSP(), centerXBoxSP(), centerYBoxSP(), consistentGiSTSegmentST(), constructorBoxSP(), constructorBoxST(), constructorHighBoxSP(), constructorHighBoxST(), containedProperlySegmentSP_BoxSP(), containedSegmentSP_BoxSP(), containsBoxSP_BoxSP(), containsBoxSP_PointSP(), containsProperlyBoxSP_BoxSP(), containsProperlyBoxSP_PointSP(), distanceBoxSP_BoxSP(), eastBoxSP_BoxSP(), eastBoxSP_PointSP(), enlargeBoxST(), equalsBoxSP(), equalsBoxST(), h_hlBoxSP(), h_lBoxSP(), h_lhBoxSP(), heightBoxSP(), hl_hBoxSP(), hl_lBoxSP(), hl_lhBoxSP(), hlBoxSP(), inBoxSP(), inBoxST(), intersectionBoxSP_BoxSP(), intersectionBoxST_BoxST(), intersectionSegmentSP_BoxSP(), intersectionSegmentSP_SegmentSP(), intersectsBoxSP_BoxSP(), isPunctalBoxSP(), l_hBoxSP(), l_hlBoxSP(), l_lhBoxSP(), lh_hBoxSP(), lh_hlBoxSP(), lh_lBoxSP(), lhBoxSP(), northBoxSP_BoxSP(), northBoxSP_PointSP(), outBoxSP(), outBoxST(), penaltyGiSTSegmentST(), picksplitGiSTBoxST(), picksplitGiSTSegmentST(), PointSP2BoxSP(), PointST2BoxST(), RangeSP2BoxSP(), recvBoxSP(), recvBoxST(), sameGiSTSegmentST(), SegmentSP2BoxSP(), southBoxSP_BoxSP(), Trajectory2BoxSP(), Trajectory2BoxST(), unionBoxSP_BoxSP(), unionBoxSP_PointSP(), unionBoxSP_SegmentSP(), unionBoxST_BoxST(), unionBoxST_PointST(), unionBoxST_SegmentST(), westBoxSP_BoxSP(), and widthBoxSP().

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

Hermes/C Library/h/Spatial/BoxSP/Definition.h

Public Member Functions

Data Fields

Detailed Description

Member Function Documentation

Field Documentation