GeoCore::BCoordTransformSettings

BCoordTransformSettings Class Reference

#include <BCoordTransformSettings.h>

List of all members.

Detailed Description

Encapsulates many of the parameters necessary to construct a BCoordTransform.

This object describes the nature of the datum shift(s) needed by a BCoordTransform, and it describes how they should be selected.

Public Member Functions

 BCoordTransformSettings (QWidget *parent=0, BAreaGeo *boundary=0, bool useDialog=true, bool requireShifts=true, bool ignoreHistory=false, const BDatumShiftInfoVector *defaultShifts=0, bool ignoreGridShifts=false)
 Constructor.
 BCoordTransformSettings (HWND parent, BAreaGeo *boundary=0, bool useDialog=true, bool requireShifts=true, bool ignoreHistory=false, const BDatumShiftInfoVector *defaultShifts=0, bool ignoreGridShifts=false)
 Constructor.
const BAreaGeo * GetBoundary () const
 Gets the area in which the BCoordTransform will be used.
const
BDatumShiftInfoVector * 		GetDefaultShifts () const
 Gets the details about the datum shift(s) that should be used by in the BCoordTransform.
HWND GetHWNDParent () const
 Gets the HWND parent for the datum shift selection dialog.
bool GetIgnoreGridShifts () const
 Indicates if grid datum shifts (NADCON, NTv2, etc) should be ignored when selecting datum shifts.
bool GetIgnoreHistory () const
 Indicates if new datum shifts should be found, even if this transformation has been performed before.
const QWidget * GetParent () const
 Gets the QWidget that acts as the parent for the datum shift selection dialog.
QWidget * GetParent ()
 Gets the QWidget that acts as the parent for the datum shift selection dialog.
bool GetRequireShift () const
 Indicates if a BException will be thrown in the case that no datum shift(s) are selected for the BCoordTransform.
bool GetUseDialog () const
 Indicates if the datum shift selection dialog will be used to select the datum shifts for the BCoordTransform.
bool isHWNDParent () const
 Indicates if a HWND parent has been supplied for the datum shift selection dialog.
void SetBoundary (BAreaGeo *boundary)
 Sets the area over which the BCoordTransform will be used.
void SetDefaultShifts (const BDatumShiftInfoVector *defaultShifts)
 Sets the datum shift(s) that will be used by the BCoordTransform.
void SetHWNDParent (HWND parent)
 Sets the parent for the datum shift selection dialog.
void SetIgnoreGridShifts (bool ignoreGridShifts)
 Specifies if grid datum shifts (NADCON, NTv2, etc) should be ignored.
void SetIgnoreHistory (bool ignoreHistory)
 Specifies if the datum shift history should be considered when selecting datum shifts.
void SetParent (QWidget *parent)
 Sets the QWidget that will act as the parent for the datum shift selection dialog.
void SetRequireShift (bool requireShift)
 Specifies if datum shift(s) are required for the BCoordTransform.
void SetUseDialog (bool useDialog)
 Specifies if the datum shift selection dialog should be used to select datum shift(s) for the BCoordTransform.
virtual ~BCoordTransformSettings ()
 Destructor.

Constructor & Destructor Documentation

BCoordTransformSettings ( HWND  parent,
BAreaGeo *  boundary = 0,
bool  useDialog = true,
bool  requireShifts = true,
bool  ignoreHistory = false,
const BDatumShiftInfoVector *  defaultShifts = 0,
bool  ignoreGridShifts = false 
)

Constructor.

Parameters:
parent The parent window for the Datum Shift selection dialog.
boundary The area in which this BCoordTransform will be used.
useDialog If this is set to true, a datum shift selection dialog will be used to select a datum shift between the source and target coordinate systems. If this value is false, then the BCoordTransform will try to silently find the best datum shift(s).
requireShifts If this is set to true, then a BException will be thrown if some appropriate datum shifts cannot be found. If this is set to false, then no exception will be thrown.
ignoreHistory If this is set to true, then even if the user has done a transformation between these coordinate systems previously, it will still make an attempt to find some datum shifts, rather than using the ones that were used previously. If this is set to false, then the datum shifts that were previously used will be used again.
defaultShifts Describes some datum shifts to use for the BCoordTransform.
ignoreGridShifts If this is set to true, then grid datum shifts will not be used (NADCON, NTv2, etc). If this is set to false, then any type of datum shift may be used.

BCoordTransformSettings ( QWidget *  parent = 0,
BAreaGeo *  boundary = 0,
bool  useDialog = true,
bool  requireShifts = true,
bool  ignoreHistory = false,
const BDatumShiftInfoVector *  defaultShifts = 0,
bool  ignoreGridShifts = false 
)

Constructor.

Parameters:
parent The parent widget for the Datum Shift selection dialog.
boundary The area in which this BCoordTransform will be used.
useDialog If this is set to true, a datum shift selection dialog will be used to select a datum shift between the source and target coordinate systems. If this value is false, then the BCoordTransform will try to silently find the best datum shift(s).
requireShifts If this is set to true, then a BException will be thrown if some appropriate datum shifts cannot be found. If this is set to false, then no exception will be thrown.
ignoreHistory If this is set to true, then even if the user has done a transformation between these coordinate systems previously, it will still make an attempt to find some datum shifts, rather than using the ones that were used previously. If this is set to false, then the datum shifts that were previously used will be used again.
defaultShifts Describes some datum shifts to use for the BCoordTransform.
ignoreGridShifts If this is set to true, then grid datum shifts will not be used (NADCON, NTv2, etc). If this is set to false, then any type of datum shift may be used.

virtual ~BCoordTransformSettings (  )  [virtual]

Destructor.

Member Function Documentation

const BAreaGeo* GetBoundary (  )  const

Gets the area in which the BCoordTransform will be used.

Returns:
The area in which the BCoordTransform will be used.

const BDatumShiftInfoVector* GetDefaultShifts (  )  const

Gets the details about the datum shift(s) that should be used by in the BCoordTransform.

Returns:
The details about the default datum shift(s).

HWND GetHWNDParent (  )  const

Gets the HWND parent for the datum shift selection dialog.

If no parent has been specified, or if the parent is a QWidget, then this will return 0.

Returns:
The HWND parent for the datum shift selection dialog.

bool GetIgnoreGridShifts (  )  const

Indicates if grid datum shifts (NADCON, NTv2, etc) should be ignored when selecting datum shifts.

Returns:
True if grid shifts should be ignored and false otherwise.

bool GetIgnoreHistory (  )  const

Indicates if new datum shifts should be found, even if this transformation has been performed before.

Returns:
A return value of true indicates that new datum shifts shall be selected even if this transformation has been performed before. A return value of false indicates that if this transformation has been performed before, then the new BCoordTransform should use the same datum shifts as the previous one.

const QWidget* GetParent (  )  const

Gets the QWidget that acts as the parent for the datum shift selection dialog.

Returns:
the QWidget that acts as the parent for the datum shift selection dialog.

QWidget* GetParent (  ) 

Gets the QWidget that acts as the parent for the datum shift selection dialog.

Returns:
the QWidget that acts as the parent for the datum shift selection dialog.

bool GetRequireShift (  )  const

Indicates if a BException will be thrown in the case that no datum shift(s) are selected for the BCoordTransform.

Returns:
True if a BException will be thrown in the case that no datum shift(s) are selected and false otherwise

bool GetUseDialog (  )  const

Indicates if the datum shift selection dialog will be used to select the datum shifts for the BCoordTransform.

Returns:
True if the datum shift selection dialog will be used and false if the BCoordTransform will try to silently select some datum shifts.

bool isHWNDParent (  )  const

Indicates if a HWND parent has been supplied for the datum shift selection dialog.

Returns:
True if a HWND parent has been specified and false otherwise.

void SetBoundary ( BAreaGeo *  boundary  ) 

Sets the area over which the BCoordTransform will be used.

Parameters:
boundary The area over which the BCoordTransform will be used.

void SetDefaultShifts ( const BDatumShiftInfoVector *  defaultShifts  ) 

Sets the datum shift(s) that will be used by the BCoordTransform.

Parameters:
defaultShifts A set of BDatumShiftInfo objects that describe the datum shift(s) that should be used by default.

void SetHWNDParent ( HWND  parent  ) 

Sets the parent for the datum shift selection dialog.

Parameters:
parent A handle to the window that will act as the parent to the datum shift selection dialog.

void SetIgnoreGridShifts ( bool  ignoreGridShifts  ) 

Specifies if grid datum shifts (NADCON, NTv2, etc) should be ignored.

Parameters:
ignoreGridShifts A value of true indicates that grid shifts should be ignored when selecting datum shift(s). A value of false indicates that all types of datum shift(s) should be considered.

void SetIgnoreHistory ( bool  ignoreHistory  ) 

Specifies if the datum shift history should be considered when selecting datum shifts.

Parameters:
ignoreHistory A value of true indicates that the history should be ignored and some new datum shift(s) should be selected even if this conversion has been performed before. A value of false indicates that the previously used datum shift(s) should be used again if this conversion has been performed before.

void SetParent ( QWidget *  parent  ) 

Sets the QWidget that will act as the parent for the datum shift selection dialog.

Parameters:
parent The QWidget that will act as the parent for the datum shift selection dialog.

void SetRequireShift ( bool  requireShift  ) 

Specifies if datum shift(s) are required for the BCoordTransform.

Parameters:
requireShift A value of true indicates that a BException should be thrown if datum shifts are not selected for the BCoordTransform. A value of false indicates that the BCoordTransform should be usable even if datum shifts are not selected.

void SetUseDialog ( bool  useDialog  ) 

Specifies if the datum shift selection dialog should be used to select datum shift(s) for the BCoordTransform.

Parameters:
useDialog A value of true indicates that the dialog should be used, and a value of false indicates that the BCoordTransform should try to silently find some datum shifts.

The documentation for this class was generated from the following file:
GeoTranslate 5.0 From Blue Marble Geographics