RVC::SHAPE Class Reference

Manages RVC::OBJTYPE_Shape RVC objects. More...

#include <rvc/shape.h>

Inheritance diagram for RVC::SHAPE:

[legend]

Classes
class	ELEMENT
	Container for the geometric information pertaining to an element. More...
class	ELEMITERATOR
	Constant iterator class. More...
class	LINKPARM_ARCSHAPE
	Setup parameters to link to an Arc/Info Shape file. More...
class	LINKPARM_GEODATABASE
	Setup parameters to link to an Arc GeoDatabase external database table. More...
class	LINKPARM_LAS
	Setup parameters to link to a LiDAR LAS file. More...
class	LINKPARM_MYSQL
	Setup parameters to link to a MySQL external database table. More...
class	LINKPARM_ORACLE
	Setup parameters to link to an Oracle Spatial external database table. More...
class	LINKPARM_ORACLE_OO4O
	Setup parameters to link to an Oracle Spatial external database table. More...
class	LINKPARM_POSTGIS
	Setup parameters to link to a PostGIS external database table. More...
class	LINKPARMS
	Base class definition for link parameters to link to external shape objects An instance of this class cannot be created, must use the derived classes below. More...
class	MAKEPARM_ARCSHAPE
class	MAKEPARM_ORACLE
class	MAKEPARMS
	Base class definition for make parameters to make external shape objects An instance of this class cannot be created, must use the derived classes below. More...
Public Types
enum	ELEMENTTYPE { ELEMENTTYPE_Unknown = 0, ELEMENTTYPE_Point, ELEMENTTYPE_Line, ELEMENTTYPE_SubRegion, ELEMENTTYPE_MultiPoint, ELEMENTTYPE_MultiLine, ELEMENTTYPE_Region, ELEMENTTYPE_MaxTypes }
enum	LINKTYPE { LINKTYPE_Internal = 0, LINKTYPE_Oracle, LINKTYPE_ArcShape, LINKTYPE_Geodatabase, LINKTYPE_PostGIS, LINKTYPE_MySQL, LINKTYPE_OracleOCCI, LINKTYPE_LAS }
Public Member Functions
	SHAPE (const RVC::SHAPE &rhs)
	SHAPE ()
virtual	~SHAPE ()
INT32	Add (const ELEMENT &Element)
ERRVALUE	AssignTable (ELEMENT &Element)
ERRVALUE	Delete (INT32 ElemNum)
ELEMITERATOR	ElementBegin () const
ELEMITERATOR	ElementEnd () const
ERRVALUE	GenerateRegionSubobject ()
ERRVALUE	GetConnectionString (MISTRING &ConnectString)
ELEMENTTYPE	GetElementType () const
LINKTYPE	GetLinkType () const
ERRVALUE	Link (const RVC::OBJITEM &ObjItem, const LINKPARMS &LinkParms, const char Source=0, const CREDENTIALS Credentials=0)
ERRVALUE	Link (RVC::OBJECT &parent, const DESCRIPTOR &Descriptor, const LINKPARMS &LinkParms, const CREDENTIALS *Credentials RVC_DEFAULT_CREDENTIALS)
ERRVALUE	Make (RVC::OBJITEM &ObjItem, const MAKEPARMS &MakeParms, const char Source=0, const CREDENTIALS Credentials=0)
ERRVALUE	Make (const RVC::OBJECT &parent, const DESCRIPTOR &Descriptor, const MAKEPARMS &MakeParms, const CREDENTIALS *Credentials RVC_DEFAULT_CREDENTIALS)
RVC::SHAPE &	operator= (const RVC::SHAPE &rhs)
ERRVALUE	Read (INT32 ElemNum, ELEMENT &Element) const
ERRVALUE	Refresh ()
ERRVALUE	Write (INT32 ElemNum, const ELEMENT &Element)

Detailed Description

Manages RVC::OBJTYPE_Shape RVC objects.

RVC Object Types that this class supports: RVC::OBJTYPE_Shape.

Valid parents for this class:

Member Enumeration Documentation

enum RVC::SHAPE::ELEMENTTYPE

Enumerator:

ELEMENTTYPE_Unknown
ELEMENTTYPE_Point
ELEMENTTYPE_Line
ELEMENTTYPE_SubRegion
ELEMENTTYPE_MultiPoint
ELEMENTTYPE_MultiLine
ELEMENTTYPE_Region
ELEMENTTYPE_MaxTypes

enum RVC::SHAPE::LINKTYPE

Type of external object.

Enumerator:

LINKTYPE_Internal	TNTmips internal format.
LINKTYPE_Oracle	Oracle Spatial via OO4O.
LINKTYPE_ArcShape	Arc/Info shapefile.
LINKTYPE_Geodatabase	Personal Geodatabase (*.mdb).
LINKTYPE_PostGIS	PostgreSQL PostGIS.
LINKTYPE_MySQL	MySQL Spatial.
LINKTYPE_OracleOCCI	Oracle Spatial via OCCI.
LINKTYPE_LAS	LiDAR point data via LAS file.

Constructor & Destructor Documentation

RVC::SHAPE::SHAPE ( )

Default constructor.

RVC::SHAPE::SHAPE ( const RVC::SHAPE & rhs )

Copy constructor.

virtual RVC::SHAPE::~SHAPE ( ) [virtual]

Destructor.

Member Function Documentation

INT32 RVC::SHAPE::Add ( const ELEMENT & Element )

Add an element to the shape object Valid only if GEOMETRIC::CAPABILITY_CanAddToEnd is true.

See HasCapability() for usage.

Returns:: Number of the element added or <0 if an error occured

ERRVALUE RVC::SHAPE::AssignTable ( ELEMENT & Element )

Assign the record member of 'Element' to the base table.

ERRVALUE RVC::SHAPE::Delete ( INT32 ElemNum )

Delete an element from the shape object Valid only if GEOMETRIC::CAPABILITY_CanDeleteAnyElement is true.

See HasCapability() for usage.

ELEMITERATOR RVC::SHAPE::ElementBegin ( ) const

Obtain an element iterator to the beginning of the element list.

ELEMITERATOR RVC::SHAPE::ElementEnd ( ) const

Obtain an element iterator to the end of the element list.

ERRVALUE RVC::SHAPE::GenerateRegionSubobject ( )

Generate a region subobject corresponding to the exterior outline of the shape object.

Only valid if HasCapability(CAPABILITY_CanGenerateRegion) returns true.

ERRVALUE RVC::SHAPE::GetConnectionString ( MISTRING & ConnectString )

Obtain the connection string used to connect to the external data.

ELEMENTTYPE RVC::SHAPE::GetElementType ( ) const

Obtain the element type set for this shape object.

LINKTYPE RVC::SHAPE::GetLinkType ( ) const

Obtain the LINKTYPE for this shape object.

ERRVALUE RVC::SHAPE::Link	(	const RVC::OBJITEM &	ObjItem,
		const LINKPARMS &	LinkParms,
		const char *	Source = `0`,
		const CREDENTIALS *	Credentials = `0`
	)

Link to new shape object given RVC::OBJITEM, creation parameters, and source.

Parameters:

Credentials

User credentials passed in, NULL for default behavior

ERRVALUE RVC::SHAPE::Link	(	RVC::OBJECT &	parent,
		const DESCRIPTOR &	Descriptor,
		const LINKPARMS &	LinkParms,
		const CREDENTIALS *Credentials	RVC_DEFAULT_CREDENTIALS
	)

Link to an external shape object.

Parameters:

RVC_DEFAULT_CREDENTIALS

User credentials passed in, NULL for default behavior

ERRVALUE RVC::SHAPE::Make	(	RVC::OBJITEM &	ObjItem,
		const MAKEPARMS &	MakeParms,
		const char *	Source = `0`,
		const CREDENTIALS *	Credentials = `0`
	)

Create new shape object given RVC::OBJITEM, creation parameters, and source.

Parameters:

	ObjItem	Parent object and DESCRIPTOR of object to create, new location RETURNED
	Credentials	User credentials passed in, NULL for default behavior

ERRVALUE RVC::SHAPE::Make	(	const RVC::OBJECT &	parent,
		const DESCRIPTOR &	Descriptor,
		const MAKEPARMS &	MakeParms,
		const CREDENTIALS *Credentials	RVC_DEFAULT_CREDENTIALS
	)

Create new shape object given parent object, name, description, creation parameters, and source.

Parameters:

RVC_DEFAULT_CREDENTIALS

User credentials passed in, NULL for default behavior

RVC::SHAPE& RVC::SHAPE::operator= ( const RVC::SHAPE & rhs )

Assignment, will close and re-open object if possible.

Reimplemented from RVC::GEOMETRIC.

ERRVALUE RVC::SHAPE::Read	(	INT32	ElemNum,
		ELEMENT &	Element
	)			const

Read an element from the shape object source.

ERRVALUE RVC::SHAPE::Refresh ( )

Refresh the result set to reflect the current data source Only useful on systems like Oracle Spatial that can have the data changed out from underneath.

ERRVALUE RVC::SHAPE::Write	(	INT32	ElemNum,
		const ELEMENT &	Element
	)

Update / change an element in the shape object Valid only if GEOMETRIC::CAPABILITY_CanChangeElements is true.

See HasCapability() for usage.

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

rvc/shape.h

RVC::SHAPE Class Reference

Classes

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation