DataSource Class

Inherits from

GEOCALCPBW_NAMESPACE::GeoBase

 

Description

The DataSource class provides properties and methods that allow the user to interact with a data source XML file.  A description of how to use the DataSource can be found here.

 

Public Constructors

Constructor

Description

DataSource

Creates a new instance of the DataSource class

CreateDataSource

Creates a new instance of the DataSource class

 

Public Methods

Method

Description

CommitToFile

Saves the DataSource to a file

CoordSysFromGML

Initializes a CoordSys from a GML string

ConstructHTDPTransformation

Constructs an HTDP transformation between two input coordinate reference systems

ConstructTimeDependentHelmert

Constructs a Time Dependent Helmert transformation between two input coordinate reference systems

EstablishTransform

Returns a single transform that is used to populate a ConcatenatedTransform that converts between the specified source and targets, as limited by the settings in the TransformPreferences provided

Exists

Determines if a Serializable exists in the DataSource

ExportCoordSysToFile

Saves a WKT definition of the specified CoordSys to a file

ExportCoordSysToGeoTIFF

Saves a GeoTIFF definition of the specifed CoordSys to a file

ExportCoordSysToMIFString

Saves a MapInfo MIF definition of the specifed CoordSys to a file

ExportCoordSysToString

 

Gets a WKT definition of the specified CoordSys

ExportCoordSysToPRJString

 

Gets an Esri PRJ definition of the specified CoordSys

ExportCoordSysToStrings

Gets the GeoCalc 5.x keys that identify the specified CoordSys

ExportDatumTransformToString

 

Exports a DatumTransform to a WKT String.

ExportGMLCoordSysToLocalFile

Generates a GML file that represents the specified CoordSys

ExportToSupplementaryFile

Saves a set of datasource objects out as an xsp file

ExportToSupplementaryString

Saves a set of datasource objects out as a string

FindByEPSG

Retrieves a list of objects with the specified EPSG code (EPSG codes are not unique across all object types)

FindEquivalentObjects

Retrieves a list of objects equivalent to a given Serializable

get_ApplicationID

 

Retrieves the ApplicationID

get_AutoSaveView

Retrieves the flag that indicates whether modifications that happen to the default view during the datasource load should be automatically saved

get_CalculatedSignature

The get_CalculatedSignature method returns the signature calculated from the current contents of the base data source file.

get_CalculatedSignatureCustom

This method returns the signature calculated from the current contents of the custom datasource file.

get_ChangeLog

Gets the ChangeLog used to track changes to base objects

get_CustomChangeLog

Gets the ChangeLog used to track changes to custom objects

get_CustomFileName

The get_CustomFileName method returns the path and name of the custom data source file that is currently loaded into the DataSource.

get_DefaultIssuer

Returns the default issuer used with the Get/Put/Remove methods

get_DefaultView

Retrieves the default view for this DataSource

get_DSInstancePtr

Gets a pointer to the internal datasource, so that it may be passed to, and shared with, another of Blue Marble Geographics geodetic processing libraries.

get_Editable

Indicates whether the DataSource can be modified

get_FailOnInvalidSig

Indicates whether we should throw an exception during the LoadFile if the base data source file has been manually edited.

get_FileName

Indicates the file that is currently loaded into the DataSource

get_HasChangeLog

Returns whether there is an active log file for changes to the base datasource

get_HasCustomChangeLog

Returns whether there is an active log file for changes to the custom datasource

get_IsLoaded

Indicates whether a DataSource file has been loaded

get_IsSignatureValid

Indicates whether the base datasource file has been manually edited since the last time it was saved.

get_IsSignatureValidCustom

Indicates whether the custom datasource file has been manually edited since the last time it was saved.

get_RefreshViewHidden

Retrieves the flag that indicates whether new objects that are found in the base datasource that are not in the view should be added as hidden (new custom objects will always be added as visible)

get_SignatureFromFile

This method returns the signature stored in the base data source file.

get_SignatureFromFileCustom

This method returns the signature stored in the custom datasource file.

GetAngularUnit

Gets an AngularUnit from the DataSource

GetCartesianPoint

Gets a CartesianPoint from the DataSource

GetCartographicFlag

Gets the state of a flag that enables better handling of certain projections for visual presentation.

GetCenteringMargin

This function returns the margin of error that is used when judging whether a projected point should be corrected to "wrap around" to the other side when centering the transformation results on the Central Meridian of the projection.

GetCenterOnMeridianFlag

This function allows the user to get how the central meridian of a projection affects the transformation of points.

GetCoordTransform

Gets a CoordTransform from the DataSource

GetDataPath

Gets the path to this DataSource.

GetDatumTransform

Gets a DatumTransform from the DataSource

GetDisplayableNameForObject

Retrieves the Display name for the object from the DataView, if it exists, or otherwise returns the DataSource name.

GetEllipsoid

Gets an Ellipsoid from the DataSource

GetAreaOfUse

Gets an AreaOfUse from the DataSource

GetFittedCoordSys

Gets a FittedCoordSys from the DataSource

GetFTPDownloadEnabled

Gets the FTP Download flag

GetGeocentricCoordSys

Gets a GeocentricCoordSys from the DataSource

GetGeodeticCoordSys

Gets a GeodeticCoordSys from the DataSource

GetGeodeticPoint

Gets a GeodeticPoint from the DataSource

GetGMLObjectListFromIndicio

Populates a collection with GML object names and their URN strings from data in the OGP's Indicio server, given an object type

GetHorizontalDatum

Gets a HorizontalDatum from the DataSource

GetIgnore3dTransform

Gets the flag indicating if all CoordTransforms should ignore the vertical

GetLinearUnit

Gets a LinearUnit from the DataSource

GetNumberOfModifications

Returns the number of changes that have been made to the DataSource since it was loaded.

GetPrimeMeridian

Gets a PrimeMeridian from the DataSource

GetPreserveNullString

Sets a flag preventing NULL String values from being considered '0'

GetProjectedCoordSys

Gets a ProjectedCoordSys from the DataSource

GetProjectedPoint

Gets a ProjectedPoint from the DataSource

GetProjectionTypeString

Gets a user-friendly display name for the specified projection type

GetScalarUnit

Gets a ScalarUnit from the DataSource

GetSerializable

Gets a Serializable from the DataSource

GetShowDeprecated

Returns the status of the ShowDeprecated flag on the DataSource

GetVerticalDatum

Gets a VerticalDatum from the DataSource

GetWKTForceMatch

Indicates whether GeoCalc will try to find a match with an existing CoordSys when importing a CoordSys from a WKT string

ImportCoordSysFromFile

Loads a CoordSys from a file

ImportCoordSysFromGeoTIFF

Imports a CoordSys from a GeoTiff file

ImportCoordSysFromPRJ

Imports a CoordSys from an ESRI PRJ String.

ImportCoordSysFromString

Loads a CoordSys from a WKT string

ImportCoordSysFromStrings

Returns a CoordSys that matches the GeoCalc 5.x keys

ImportDatumTransformFromFile

Imports a DatumTransform from a GTF file

ImportDatumTransformFromString

Imports a DatumTransform from a WKT string

ImportFile

Loads a CoordSys into the DataSource

ImportFromSupplementaryFile

Reads in a specified .xsp file and adds any new objects to the DataSource

ImportFromSupplementaryString

Reads in a string and adds any new objects to the DataSource

ImportGMLObjectFromIndicio

Composes GeoCalc objects for all URNs in the specified collection.

LoadFile

Loads a data source file into this DataSource

PutAngularUnit

Adds an AngularUnit to the DataSource

PutCartesianPoint

Adds a CartesianPoint to the DataSource

PutEllipsoid

Adds an Ellipsoid to the DataSource

PutAreaOfUse

Adds an AreaOfUse to the DataSource

PutFittedCoordSys

Adds a FittedCoordSys to the DataSource

PutGeocentricCoordSys

Adds a GeocentricCoordSys to the DataSource

PutGeodeticCoordSys

Adds a GeodeticCoordSys to the DataSource

PutGeodeticPoint

Adds a GeodeticPoint to the DataSource

PutHorizontalDatum

Adds a HorizontalDatum to the DataSource

PutLinearUnit

Adds a LinearUnit to the DataSource

PutPrimeMeridian

Adds a PrimeMeridian to the DataSource

PutProjectedCoordSys

Adds a ProjectedCoordSys to the DataSource

PutProjectedPoint

Adds a ProjectedPoint to the DataSource

PutScalarUnit

Adds a ScalarUnit to the DataSource

PutScope

Adds a Scope to the DataSource

PutSerializable

Adds a Serializable to the DataSource

PutUsage

Adds a Usage to the DataSource

PutVerticalDatum

Adds a VerticalDatum to the DataSource

RemoveAngularUnit

Removes an AngularUnit from the DataSource

RemoveCartesianPoint

Removes a CartesianPoint from the DataSource

RemoveEllipsoid

Removes an Ellipsoid from the DataSource

RemoveAreaOfUse

Removes an AreaOfUse from the DataSource

RemoveFittedCoordSys

Removes a FittedCoordSys from the DataSource

RemoveGeocentricCoordSys

Removes a GeocentricCoordSys from the DataSource

RemoveGeodeticCoordSys

Removes a GeodeticCoordSys from the DataSource

RemoveGeodeticPoint

Removes a GeodeticPoint from the DataSource

RemoveHorizontalDatum

Removes a HorizontalDatum from the DataSource

RemoveLinearUnit

Removes a LinearUnit from the DataSource

RemovePrimeMeridian

Removes a PrimeMeridian from the DataSource

RemoveProjectedCoordSys

Removes a ProjectedCoordSys from the DataSource

RemoveProjectedPoint

Removes a ProjectedPoint from the DataSource

RemoveScalarUnit

Removes a ScalarUnit from the DataSource

RemoveScope

Removes a Scope from the DataSource

RemoveSerializable

Removes a Serializable from the DataSource

RemoveUsage

Removes a Usage from the DataSource

RemoveVerticalDatum

Removes a VerticalDatum from the DataSource

set_ApplicationID

Sets the ApplicationID which will show up when a Change is made

set_AutoSaveView

Sets the flag that indicates whether modifications that happen to the default view during the datasource load should be automatically saved

set_CurrentUserID

Sets the Current User ID which will show up when a Change is made

set_DefaultIssuer

Sets the default issuer used with the Get/Put/Remove methods

set_DefaultView

Sets the default view for this DataSource

set_DSInstancePtr

Initializes this DataSource instance using a pointer to an internal datasource object obtained from one of Blue Marble Geographics' other geodetic processing libraries.

set_Editable

Sets whether this DataSource can be modified

set_FailOnInvalidSig

Sets whether we should throw an exception during the LoadFile call if the base data source file has been manually edited.

set_RefreshViewHidden

Sets the flag that indicates whether new objects that are found in the base datasource that are not in the view should be added as hidden (new custom objects will always be added as visible)

SetCartographicFlag

Sets a flag that enables better handling of certain projections for visual presentation.

SetCenteringMargin

This function sets the margin of error that is used when judging whether a projected point should be corrected to "wrap around" to the other side when centering the transformation results on the Central Meridian of the projection.

SetCenterOnMeridianFlag

This function allows the user to set how the central meridian of a projection affects the transformation of points.

SetDataPath

Sets the path to this DataSource

SetFTPDownloadEnabled

 

Sets the FTP enabled flag

SetIgnore3dTransform

Sets whether all CoordTransforms should ignore 3d conversions.

SetPreserveNullString

Sets a flag preventing NULL String values from being considered '0'

SetShowDeprecated

Sets the status of the ShowDeprecated flag on the DataSource

SetWKTForceMatch

Specifies if GeoCalc should try to find an existing CoordSys when importing a CoordSys from a WKT string.

operator=

Assigns a new value to this Datum