DataSource Class

Inherits from

System.Object

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.

Constructors

Constructor	Description
DataSource	Creates a new instance of the DataSource class

Properties

Property	Description
ApplicationID	Accesses the application identifier string.
ApplicationName	Gets or sets the application name, used primarily for dialogs.
AuthToken	Gets or sets the authorization token needed to submit requests to the online service indicated by ServiceURL.
AutoSaveView	A flag indicating whether or not to automatically save the current view when it is refreshed.
CartographicFlag	Gets or sets whether or not to be "lenient" when near the edges of projections.
CenteringMargin	Gets or sets the centering margin to at which to bound geodetic longitudes if CenterOnMeridianFlag is set.
CenterOnMeridianFlag	Gets or sets whether or not to use the central meridan as the "center" of the projection math.
ChangeLog	Gets the change log associated with the primary datasource.
ChangeLogComment	Accesses the change log comment string.
Container	Gets the IContainer that contains the Component. (Inherited from Component).
Creating	Gets whether or not the datasource is being created, i.e. loading.
CurrentUserID	Accesses the current user identifier string.
CurrentView	The view file that this datasource is using.
CustomChangeLog	Gets the change log associated with the custom datasource.
CustomFileName	The file name of the custom datasource.
CustomNumberOfModifications	The number of modifications made on the custom datasource since it was loaded.
CustomSignature	The signature of the custom datasource, if any.
DataPath	Gets or sets the primary path for extra files i.e. DatumTransforms, verticals, etc.
DefaultIssuer	Gets or sets the default issuer, used primaryily when writing out the datasource.
DownloadEnabled	Gets or sets whether download of datafiles is enabled.
Editable	The editable status of the base datasource.
EnterpriseChangeLog	Gets the change log associated with the enterprise datasource.
EnterpriseFileName	The file name of the enterprise datasource.
EnterpriseSignature	The signature of the enterprise datasource, if any.
Expiration	Gets the expiration date of the license, String.Empty if not licensed.
FailOnInvalidSignature	A flag indicating whether or not to throw if the signature in a datasource is invalid.
FileName	The file name of the primary datasource.
FileVersion	A string containing the version from the current datsource file. Note that this may be different than the current version of the library code.
HasChangeLog	Gets whether the primary datasource has an associated change log.
HasCustomChangeLog	Gets whether the custom datasource has an associated change log.
HasEnterpriseChangeLog	Gets whether the enterprise datasource has an associated change log.
History	Gets the History.
HorizontalInterpolationType	Gets or sets the interpolation type for calculating horizontal shifts from grid files.
HTTPURL	Gets or sets the HTTP URL for downloading missing grid files.
Ignore3DTransform	Gets or sets whether or not to ignore changes to the height coordinate value during datum transforms.
IgnorePolygonAreaOfUse	Gets or sets whether or not to ignore Polygon AreaOfUses during conversions.
IsCustomSignatureValid	A flag indicating if the custom datasource has a valid signature.
IsEnterpriseSignatureValid	A flag indicating if the custom datasource has a valid signature.
IsLicensed	Gets whether the datasource component has a valid license.
IsLoaded	A flag indicating if the primary datasource is loaded.
IsSignatureValid	A flag indicating if the primary datasource has a valid signature.
IsTrial	Gets whether the datasource component has a trial license.
LastUpdateTime	Gets the date of when this datasource was last updated. If unknown, will return Minvalue.
NumberOfModifications	The number of modifications made on the primary datasource since it was loaded.
PivotSystem	The GC code identifying the pivot horizontal coordinate system used when generating new Early Bound Coordinate Systems.
RefreshViewHidden	A flag indicating whether or not to add objects during View refresh as hidden.
ServiceURL	Gets or sets the online service URL.
ShowDeprecated	Gets or sets whether or not to show deprecated objects.
Signature	The signature of the primary datasource.
Site	Gets or sets the ISite of the Component. (Inherited from Component).
UpgradeLogPath	The optional directory where log files for imports and upgrades should be written.
VerticalInterpolationType	Gets or sets the interpolation type for calculating vertical shifts from grid files.
WKTForceMatch	Gets or sets whether or not to force WKT matching.

Methods

Method	Description
ApplyIssuerMap	The compliment of MapIssuers. This takes the mapping that was generated from one datasource and populates this datasource with the mapping, adding the tgtIssuerToMap codes into this datasource.
ApplyOnlineChanges	Apply the latest datasource changes from the online webservice.
ApplyTransformInfo	Populate the transform with the transforminfo.
ApplyView	Set the view the DataSource will use as its current view.
CanUseAreaOfUse	Checks to see if the AOU code is valid and if so, return the corresponding issuer.
CheckIfNeedsUpgrade	Checks if the specified file is a pre-GeoCalc 7 datasource that will need to be updated.
CheckServiceStatus	Check whether the service specified is currently active and responding to requests.
CommitCustomToStream	Write out the in memory custom datasource to a stream.
CommitToFile	Write out the in memory datasource to file.
ConstructCanadianVelocityGrid	Construct a Canadian Velocity Grid datum transformation.
ConstructHTDPTransformation	Construct a time dependent (HTDP) datum transformation.
ConstructTimeDependentHelmert	Construct a Time Dependent Helmert datum transformation.
ConstructTimeDependentTransform	Construct a Time Dependent Helmert datum transformation.
CreateCoordSysFromLegacyString	Uses coordinate system string definition from the geocalc.dat file which was shipped with version 5.x of the toolkit, and creates a coordinate system object from them.
CreateObjRef	Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject).
Dispose	Releases all resources used by the Component. (Inherited from Component).
Equals	Determines whether the specified object is equal to the current object. (Inherited from Object).
EstablishTransform	Set up a "best" concatenated transform to convert between the sources and targets on the passed-in transform, using the specified preferences, without popping a picker dialog.
Exists	Whether the specific object exists in the data source.
ExportCompoundCoordSysToWKT2	Serializes a set of horizontal and vertical coordinate systems to a well-known text file as a compound coordinate reference system.
ExportCoordSys	Composes a string containing a WKT or PRJ coordinate system definition and writes it to a stream.
ExportCoordSysToFile	Composes a string containing a WKT or PRJ coordinate system definition and writes it to a text file.
ExportCoordSysToGML	Serializes coordinate systems to a GML file.
ExportCoordSysToJSONEncoding	Writes a JSON encoded CRS or EBCRS based on the specifications provided.
ExportCoordSysToMIFString	Composes a string containing a MIF Clause. If the coord sys provided cannot be rendered as a MIF Clause the string returned will be empty.
ExportCoordSysToString	Composes a string containing a WKT or PRJ coordinate system definition.
ExportCoordSysToWKT2	Serializes coordinate systems to a well-known text file.
ExportCoordTransformToWKT2	Serializes coordinate transforms to a well-known text file.
ExportDatumTransformToGTF	Composes a string containing a GTF datum transformation definition and writes it to a Stream.
ExportDatumTransformToGTFString	Composes a string containing a GTF datum transformation definition.
ExportToCTLFile	Exports a collection of objects to the specified file.
ExportToESRIPEDB	Exports a collection of GeoCalc objects to the ESRI custom projection engine DB int the specified ESRI DB directory.
ExportToSupplementaryFile	Exports a collection of objects to the specified file.
ExportToSupplementaryStream	Exports a collection of objects to the specified stream.
Finalize	Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component).
FindByIssuer	Get the List of objects that match a given issuer/code.
FindDependencies	Finds all other objects that depend on the object in question.
FindEquivalentObjects	Searches the datasource for all objects that are equivalent to the specified object.
FindMostRecentUpdate	Finds the most recent revision date and indicates which object is the first occurrance of that date.
FindNearlyEqualObjects	Searches the datasource for all objects that are nearly equal to the specified object. Primarily used for datasource merging where identifier codes on sub-objects matter.
FindObjectOfUnknownIssuer	Gets an object containing a specified identifier code.
FindTransforms	A helper function to return all the information needed to display tranform choices to a user, via a UI.
GetAngularUnit	Get the AngularUnit from the datasource.
GetAreaOfUse	Get the AreaOfUse from the dataSource.
GetCartesianPoint	Get the CartesianPoint from the dataSource.
GetConcatenatedTransform	Get the ConcatenatedTransform from the dataSource.
GetCoordinateSystem	Get the CoordSys from the dataSource.
GetCoordinateTransform	Gets the coordinate transform referenced by the issuer/code pair.
GetCoordPoint	Get the CoordPoint from the datasource.
GetCoordSysOfUnknownIssuer	Gets the coordinate reference system containing a specified identifier code.
GetDatum	Gets the datum referenced by the issuer/code pair.
GetDatumTransform	Get the DatumTransform from the dataSource.
GetDefiningIdentifierList	Gets a list of all identifier codes that define this coordinate system. If the first code defines the actual object as it is, that will be all but if there are sub-changes those id's will also be returned.
GetDisplayableNameForObject	Gets either the View Display name or the Serializable name.
GetEarlyBoundCoordSys	Get the ProjectedCoordSys from the datasource.
GetEllipsoid	Get the Ellipsoid from the datasource
GetFittedCoordSys	Get the FittedCoordSys from the datasource.
GetGeocentricCoordSys	Get the GeocentricCoordSys from the datasource.
GetGeodeticCoordSys	Get the GeodeticCoordSys from the datasource.
GetGeodeticCoordSysFromDatum	Get the GeodeticCoordSys based on the provided code from a HorizontalDatum.
GetGeodeticPoint	Get the GeodeticPoint from the datasource.
GetGMLObjectListFromRegistry	Gets list of GML objects from the registry.
GetHashCode	Serves as the default hash function. (Inherited from Object).
GetHorizontalDatum	Get the HorizontalDatum from the datasource
GetIdentifierList	Gets a list of all identifier codes currently used in the datasource.
GetLifetimeService	Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject).
GetLinearUnit	Get the LinearUnit from the datasource.
GetObjectHistory	Gets the history for the given object.
GetOnlineChangesZip	Get the latest datasource changes from the online webservice as a stream.
GetOnlineCRSString	Get the CoordSys from the online web service.
GetOnlineErrorMessage	Gets the message (error, exception or other) that occurred on previous webrequest call.
GetParametricTransform	Get the ParametricTransform from the datasource.
GetPrimeMeridian	Get the PrimeMeridian from the datasource.
GetProjectedCoordSys	Get the ProjectedCoordSys from the datasource.
GetProjectedPoint	Get the ProjectedPoint from the datasource.
GetScalarUnit	Get the ScalarUnit from the datasource.
GetScope	Get the Scope from the datasource.
GetSerializable	Get the Serializable from the datasource.
GetSingleCoordinateTransform	Get the CoordTransform from the datasource.
GetStringCoordSys	Get the StringCoordSys from the datasource.
GetStringPoint	Get the StringPoint from the datasource.
GetType	Gets the Type of the current instance. (Inherited from Object).
GetUnit	Get the Unit from the datasource.
GetUsage	Get the Usage from the datasource.
GetUsageForAOU	Find or create a placeholder usage for an AOU.
GetVerticalCoordSys	Get the VerticalCoordSys from the datasource.
GetVerticalDatum	Get the VerticalDatum from the datasource.
GetVerticalPoint	Get the VerticalPoint from the datasource.
GetVerticalTransform	Get the VerticalTransform from the datasource.
HasOnlineChanges	Check whether there are datasource changes on the online service that have not been applied.
ImportCoordSys	Parses an input stream containing a WKT or PRJ coordinate system definition and creates horizontal and/or vertical coordinate system objects from it.
ImportCoordSysFromFile	Parses a text file containing a TAB, WKT or PRJ coordinate system definition and creates a coordiante system object from it.
ImportCoordSysFromGML	Parses a string containing a GML coordinate system definition and creates coordinate system objects from it.
ImportCoordSysFromString	Parses a string containing a WKT, WKT2 or PRJ coordinate system definition and creates horizontal and/or vertical coordinate system objects from it.
ImportCoordSysFromStrings	Uses strings defined in the geocalc.dat file which was shipped with version 5.x of the toolkit, and creates a coordinate system object from them.
ImportCoordTransform	Parses an input stream from a WKT or GTF file containing a coord transform and creates transform object from it.
ImportCoordTransformFromWKT2	Parses an input stream containing a WKT2 coordinate transform definition and creates datum or vertical transform object from it.
ImportCoordTransformsFromWKT2	Parses an input stream containing WKT2 coordinate transforms definition and creates datum or vertical transform objects from it.
ImportDatumTransformFromGTF	Parses an input stream from a GTF file containing a datum transform and creates datum transform object from it.
ImportDatumTransformFromGTFString	Parses a string containing a GTF datum transform definition and creates a coordinate transform object from it.
ImportFromCTLFile	Imports a collection of objects from the specified CTL file into the current DataSource.
ImportFromCTLStream	Imports a collection of objects from the specified CTL file into the current DataSource.
ImportFromESRIPEDB	Imports a collection of ESRI projection engine DB custom objects from the specified ESRI DB directory.
ImportFromSupplementaryFile	Imports a collection of supplementary objects from the specified file.
ImportFromSupplementaryStream	Imports a collection of supplementary objects from the stream.
ImportGeneralUpdates	Imports a set of additional per-object information into the current DataSource and updates the appropriate objects. May also add new Early Bound Coordinate Systems if needed.
ImportGMLObjectFromRegistry	Imports a GML object from the registry into the current DataSource.
ImportGMLObjectsFromRegistry	Imports GML objects from the registry into the current DataSource.
ImportIdentifiers	Loads the specified alternate datasource, and imports any identifiers that are not in the base already, for equivalent objects.
ImportObjectFromGML	Imports an object from a GML string.
InitializeLifetimeService	Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject).
IsObjectWriteProtected	Whether the specific object is write-protected in the datasource.
IsSingleType	Find out if the passed in type is a single object, or a mask representing multiple datasource objects.
LoadFile	Load the geocalc xml datasource.
MapIssuers	Goes through the datasource and finds all objects that have both srcIssuerToMap and tgtIssuerToMap codes and returns the list of these code mappings based on object type. This is useful if we have 1 datasource with issuer/codes that we want to populate another datasource with.
MatchOldStringFormat	Takes the code and display settings for a pre-GeoCalc7 string coord sys and returns the GC code identifying the system in the current datasource.
MatchOldVerticalReference	Takes the code for a pre-GeoCalc7 vertical reference and returns the GC code identifying the vertical coord sys system and vertical transforms that correspond to it in the current datasource.
Put<T>	Put the object into the datasource.
PutAngularUnit	Put the AngularUnit into the datasource.
PutAreaOfUse	Put the AreaOfUse into the datasource.
PutCartesianPoint	Put the CartesianPoint into the datasource.
PutConcatenatedTransform	Put the ConcatenatedTransform into the datasource.
PutDatumTransform	Put the DatumTransform into the datasource.
PutDependentObjects	Put the object into the datasource but checks to make sure that all objects that it depends on have also been checked in first.
PutEarlyBoundCoordSys	Put the EarlyBoundCoordSys into the datasource.
PutEllipsoid	Put the Ellipsoid into the datasource.
PutFittedCoordSys	Put the FittedCoordSys into the datasource.
PutGeocentricCoordSys	Put the GeocentricCoordSys into the datasource.
PutGeodeticCoordSys	Put the GeodeticCoordSys into the datasource.
PutGeodeticPoint	Put the GeodeticPoint into the datasource.
PutHorizontalDatum	Put the HorizontalDatum into the datasource.
PutLinearUnit	Put the LinearUnit into the datasource.
PutParametricTransform	Put the ParametricTransform into the datasource.
PutPrimeMeridian	Put the PrimeMeridian into the datasource.
PutProjectedCoordSys	Put the ProjectedCoordSys into the datasource.
PutProjectedPoint	Put the ProjectedPoint into the datasource.
PutScalarUnit	Put the ScalarUnit into the datasource.
PutScope	Put the Scope into the datasource.
PutSerializable	Put the Serializable into the datasource.
PutStringCoordSys	Put the StringCoordSys into the datasource.
PutStringPoint	Put the StringPoint into the datasource.
PutUsage	Put the Usage into the datasource.
PutVerticalCoordSys	Put the VerticalCoordSys into the datasource.
PutVerticalDatum	Put the VerticalDatum into the datasource.
PutVerticalPoint	Put the VerticalPoint into the datasource
PutVerticalTransform	Puts the VerticalTransform into the datasource.
RemoveAngularUnit	Removes an AngularUnit from the datasource.
RemoveAreaOfUse	Removes an AreaOfUse from the datasource.
RemoveCartesianPoint	Removes a CartesianPoint from the datasource.
RemoveConcatenatedTransform	Removes a ConcatenatedTransform from the datasource.
RemoveDatumTransform	Removes a DatumTransform from the datasource.
RemoveEarlyBoundCoordSys	Removes an EarlyBoundCoordSys from the datasource.
RemoveEllipsoid	Removes an Ellipsoid 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.
RemoveParametricTransform	Removes a ParametricTransform 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.
RemoveSerializable	Removes a Serializable from the datasource.
RemoveStringCoordSys	Removes a StringCoordSys from the datasource.
RemoveStringPoint	Removes a StringPoint from the datasource.
RemoveVerticalCoordSys	Removes a VerticalCoordSys from the datasource.
RemoveVerticalDatum	Removes a VerticalDatum from the datasource.
RemoveVerticalPoint	Removes a VerticalPoint from the datasource.
RemoveVerticalTransform	Removes a VerticalTransform from the datasource.
SearchByFilter	Returns a list of Serializable objects matching the specified object type and filter.
SearchByFilters	Returns a list of Serializable objects matching the specified object type and filters.
SearchDB<T>	Get a list of all objects of a given ObjectType.
set_localLicense	Set license from string.
SetAllowedClassTypes	Sets the allowed class types for a specified object type.
ToString	Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component).

Events

Event	Description
OnlineDownloadComplete	An event that clients can use to be notified whenever the elements of the list change.
OnlineDownloadProgress	An event that clients can use to be notified whenever the elements of the list change.
Inherited Event	Description
Disposed	Occurs when the component is disposed by a call to the Dispose() method. (Inherited from Component).