BDatumShiftInfo Class Reference

#include <BDatumShiftInfo.h>

List of all members.

---

Detailed Description

Encapsulates information about a datum shift.

Public Member Functions
	BDatumShiftInfo (const BDatumShiftInfo &dsi)
	Copy constructor.
	BDatumShiftInfo (const BString &issuer, const BString &code, const BString &shiftName, const BString &sourceDatumName, const BString &targetDatumName, const BString &envelopeName, const BString &shiftType, bool reversed)
	Constructor.
	BDatumShiftInfo ()
	Default Constructor.
BString	GetCode () const
	Gets the code used to identify the datum shift.
BString	GetEnvelopeName () const
	Gets the name of the envelope used by this datum shift.
BString	GetIssuer () const
	Gets the issuer used to identify the datum shift.
bool	GetReversed () const
	Gets the flag indicating whether this shift is reversed or not.
BString	GetShiftName () const
	Gets the common name for the datum shift.
BString	GetShiftType () const
	Gets the datum shift type.
BString	GetSourceDatumName () const
	Gets the common name of the source datum of this datum shift.
BString	GetTargetDatumName () const
	Gets the common name of the target datum of this datum shift.
BDatumShiftInfo &	operator= (const BDatumShiftInfo &rhs)
	Assignment operator.
void	SetCode (BString code)
	Sets the code used to identify the datum shift.
void	SetEnvelopeName (BString envelopeName)
	Sets the name of the envelope used by the datum shift.
void	SetIssuer (BString issuer)
	Sets the issuer used to identify the datum shift.
void	SetReversed (bool reversed)
	Sets the flag indicating whether this shift is reversed or not.
void	SetShiftName (BString shiftName)
	Sets the name for the datum shift.
void	SetShiftType (BString shiftType)
	Sets the datum shift type.
void	SetSourceDatumName (BString sourceDatumName)
	Sets the name for the source datum of the datum shift.
void	SetTargetDatumName (BString targetDatumName)
	Sets the name for the target datum of the datum shift.
virtual	~BDatumShiftInfo ()
	Destructor.

---

Constructor & Destructor Documentation

BDatumShiftInfo

(

)

Default Constructor.

All fields are left blank by this constructor.

BDatumShiftInfo	(	const BString &	issuer,
		const BString &	code,
		const BString &	shiftName,
		const BString &	sourceDatumName,
		const BString &	targetDatumName,
		const BString &	envelopeName,
		const BString &	shiftType,
		bool	reversed
	)

Constructor.

This constructor will fully populate a DatumShiftInfo.

Parameters:

	issuer	The issuer that identifies the datum shift within a data source.
	code	The code that identifies the datum shift within a data source.
	shiftName	The common name for the datum shift.
	sourceDatumName	The common name for the source datum of the datum shift.
	targetDatumName	The common name for the target datum of the datum shift.
	envelopeName	The common name for the evelope that gives the area in which the datum shift is intended to be used.
	shiftType	The datum shift method emplyed by the datum shift.
	reversed	Indicates if the datum shift is intended to shift from its source to its target (false) or from its target to its source (true).

BDatumShiftInfo

(

const BDatumShiftInfo &

dsi

)

Copy constructor.

Parameters:

dsi

The BDatumShiftInfo to copy.

virtual ~BDatumShiftInfo

(

)

[virtual]

Destructor.

---

Member Function Documentation

BString GetCode

(

)

const

Gets the code used to identify the datum shift.

Returns:

The code used to identify the datum shift.

BString GetEnvelopeName

(

)

const

Gets the name of the envelope used by this datum shift.

Returns:

The name of the envelope used by this datum shift.

BString GetIssuer

(

)

const

Gets the issuer used to identify the datum shift.

Returns:

The issuer used to identify the datum shift.

bool GetReversed

(

)

const

Gets the flag indicating whether this shift is reversed or not.

Returns:

A flag indicating whether the shift should be reversed or not. If the return value is true, then the datum shift will shift from source to target. If the return value is false, then the datum shift will shift from target to source.

BString GetShiftName

(

)

const

Gets the common name for the datum shift.

Returns:

The common name for the datum shift.

BString GetShiftType

(

)

const

Gets the datum shift type.

Returns:

The datum shift type.

BString GetSourceDatumName

(

)

const

Gets the common name of the source datum of this datum shift.

Returns:

The common name of the source datum of this datum shift.

BString GetTargetDatumName

(

)

const

Gets the common name of the target datum of this datum shift.

Returns:

The common name of the target datum of this datum shift.

BDatumShiftInfo& operator=

(

const BDatumShiftInfo &

rhs

)

Assignment operator.

Parameters:

rhs

The BDatumShiftInfo whose value shall be copied into this one.

Returns:

A reference to this BDatumShiftInfo.

void SetCode

(

BString

code

)

Sets the code used to identify the datum shift.

Parameters:

code

The code used to identify the datum shift.

void SetEnvelopeName

(

BString

envelopeName

)

Sets the name of the envelope used by the datum shift.

Parameters:

envelopeName

The name of the envelope used by the datum shift.

void SetIssuer

(

BString

issuer

)

Sets the issuer used to identify the datum shift.

Parameters:

issuer

The issuer used to identify the datum shift.

void SetReversed

(

bool

reversed

)

Sets the flag indicating whether this shift is reversed or not.

Parameters:

reversed

A flag indicating whether the shift should be reversed or not. If the value is true, then the datum shift will shift from source to target. If the value is false, then the datum shift will shift from target to source.

void SetShiftName

(

BString

shiftName

)

Sets the name for the datum shift.

Parameters:

shiftName

The new name for the datum shift.

void SetShiftType

(

BString

shiftType

)

Sets the datum shift type.

Parameters:

shiftType

The datum shift type.

void SetSourceDatumName

(

BString

sourceDatumName

)

Sets the name for the source datum of the datum shift.

Parameters:

sourceDatumName

The new name for the source datum of the datum shift.

void SetTargetDatumName

(

BString

targetDatumName

)

Sets the name for the target datum of the datum shift.

Parameters:

targetDatumName

The new name for the target datum of the datum shift.

---

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

• BDatumShiftInfo.h

---

GeoTranslate 5.0 From Blue Marble Geographics