DataSource Class

Uses

GeoCalcPBW::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

EstablishDatumShift

Gets DatumShifts for a CoordTransform

ExportCoordSysToFile

Saves a WKT definition of the specified CoordSys to a file

ExportCoordSysToString

Gets a WKT definition of the specified CoordSys

ExportCoordSysToStrings

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

get_CalculatedSignature

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

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_DSInstancePtr

This returns a pointer to the current datasource that can passed to a "set" function in another Blue Marble Geographics geodetic processing library.

get_Editable

Indicates if 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_IsLoaded

Indicates if a DataSource file has been loaded

get_IsSignatureValid

Indicates if the base data source file has been manually edited since the last time it was saved.

get_SignatureFromFile

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

GetAngularUnit

Gets an AngularUnit from the DataSource

GetCartesianPoint

Gets a CartesianPoint from the DataSource

GetCoordTransform

Gets a CoordTransform from the DataSource

GetDataPath

Gets the path to this DataSource.

GetDatumShift

Gets a DatumShift from the DataSource

GetEllipsoid

Gets an Ellipsoid from the DataSource

GetEnvelope

Gets an Envelope from the DataSource

GetFittedCoordSys

Gets a FittedCoordSys from the DataSource

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

GetHeightModel

Gets a HeightModel from the DataSource

GetHorizontalDatum

Gets a HorizontalDatum from the DataSource

GetIgnoreEnvelope

Indicates if Envelope::InBounds should always return true

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

GetProjectedCoordSys

Gets a ProjectedCoordSys from the DataSource

GetProjectedPoint

Gets a ProjectedPoint from the DataSource

GetSerializable

Gets a Serializable from the DataSource

GetValidDatumShifts

Finds all valid DatumShifts for the specified source and target CoordSys

GetVerticalDatum

Gets a VerticalDatum from the DataSource

GetVerticalReference

Gets a VerticalReference from the DataSource

GetWKTForceMatch

Indicates if 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

ImportCoordSysFromString

Loads a CoordSys from a WKT string

ImportCoordSysFromStrings

Returns a CoordSys that matches the GeoCalc 5.x keys

ImportFile

Loads a CoordSys into 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

PutCoordTransform

Adds a CoordTransform to the DataSource

PutDatumShift

Adds a DatumShift to the DataSource

PutEllipsoid

Adds an Ellipsoid to the DataSource

PutEnvelope

Adds an Envelope 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

PutHeightModel

Adds a HeightModel 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

PutSerializable

Adds a Serializable to the DataSource

PutVerticalDatum

Adds a VerticalDatum to the DataSource

PutVerticalReference

Adds a VerticalReference to the DataSource

RemoveAngularUnit

Removes an AngularUnit from the DataSource

RemoveCartesianPoint

Removes a CartesianPoint from the DataSource

RemoveCoordTransform

Removes a CoordTransform from the DataSource

RemoveDatumShift

Removes a DatumShift from the DataSource

RemoveEllipsoid

Removes an Ellipsoid from the DataSource

RemoveEnvelope

Removes an Envelope 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

RemoveHeightModel

Removes a HeightModel 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

RemoveSerializable

Removes a Serializable from the DataSource

RemoveVerticalDatum

Removes a VerticalDatum from the DataSource

RemoveVerticalReference

Removes a VerticalReference from the DataSource

set_DefaultIssuer

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

set_DSInstancePtr

This function is used for cross Library development. It takes a pointer to an already created Datasource object.

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.

SetDataPath

Sets the path to this DataSource.

SetIgnoreEnvelope

Specifies if Envelope::InBounds should always return true

SetWKTForceMatch

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