RVC::SHAPE::LINKPARMS Class Reference

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...

#include <rvc/shape.h>

Inheritance diagram for RVC::SHAPE::LINKPARMS:

[legend]

List of all members.

Public Member Functions
virtual	~LINKPARMS ()
CHAR_ENCODING	GetEncoding () const
const MISTRING &	GetLinkString () const
SHAPE::LINKTYPE	GetLinkType () const
bool	GetStorePasswordInLinkObject () const
const MISTRING &	GetTableName () const
Protected Member Functions
	LINKPARMS (const MISTRING &LinkString, SHAPE::LINKTYPE LinkType, CHAR_ENCODING Encoding, bool StorePasswordInLinkObject)
void	SetTableName (const MISTRING &TableName)

---

Detailed Description

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.

---

Constructor & Destructor Documentation

virtual RVC::SHAPE::LINKPARMS::~LINKPARMS

(

)

[inline, virtual]

Destructor.

RVC::SHAPE::LINKPARMS::LINKPARMS	(	const MISTRING &	LinkString,
		SHAPE::LINKTYPE	LinkType,
		CHAR_ENCODING	Encoding,
		bool	StorePasswordInLinkObject
	)			[inline, protected]

---

Member Function Documentation

CHAR_ENCODING RVC::SHAPE::LINKPARMS::GetEncoding

(

)

const [inline]

Get the encoding of the external table.

const MISTRING& RVC::SHAPE::LINKPARMS::GetLinkString

(

)

const [inline]

Get the link stirng.

Returns:

Link string

SHAPE::LINKTYPE RVC::SHAPE::LINKPARMS::GetLinkType

(

)

const [inline]

Get the type of external link.

Returns:

External link type

bool RVC::SHAPE::LINKPARMS::GetStorePasswordInLinkObject

(

)

const [inline]

Get whether or not to store the password in the link object.

This is ignored for link types which do not require a password. It is used mainly for links to RDBMS-based shape objects such as PostGIS and Oracle Spatial.

const MISTRING& RVC::SHAPE::LINKPARMS::GetTableName

(

)

const [inline]

Get the table name.

Only useful for data source type spatial objects

Returns:

Table name

void RVC::SHAPE::LINKPARMS::SetTableName

(

const MISTRING &

TableName

)

[inline, protected]

---

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

• rvc/shape.h