LuciadCPillar C# 2023.1.02
Luciad.Environment.Initializer Class Reference

Initializer for the global Environment needed by this library. More...

Inheritance diagram for Luciad.Environment.Initializer:

Public Member Functions

void Dispose ()
 
Luciad.Environment Initialize ()
 Create and initialize an Environment. More...
 
Luciad.Environment.Initializer ShouldInitializeCurl (bool shouldInitializeCurl)
 Specify whether this library should initialize the curl library. More...
 
Luciad.Environment.Initializer ShouldInitializeGdal (bool shouldInitializeGdal)
 Specify whether this library should initialize the gdal library. More...
 
Luciad.Environment.Initializer WithCredentialsProvider (Luciad.Loaders.ICredentialsProvider credentialsProvider, bool wrapWithCache=true)
 Specify that the given credential provider should be used. More...
 
Luciad.Environment.Initializer WithLicenseText (string licenseText)
 Specify the content of the LuciadCPillar license file. More...
 
Initializer WithLoggingBackend (Luciad.ILoggingBackend loggingBackend)
 Specify that the given logging backend should be used. More...
 
Luciad.Environment.Initializer WithProxySelector (Luciad.Loaders.IProxySelector proxySelector)
 Specify that the given proxy selector should be used. More...
 
Luciad.Environment.Initializer WithResourcePath (string resourcePath)
 Specify where LuciadCPillar can look for its internal resource. More...
 

Detailed Description

Initializer for the global Environment needed by this library.

It allows you to configure what and how some things are to be initialized.

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::Environment::Initializer.

Member Function Documentation

◆ Dispose()

void Luciad.Environment.Initializer.Dispose ( )
inline

◆ Initialize()

Luciad.Environment Luciad.Environment.Initializer.Initialize ( )
inline

Create and initialize an Environment.

the Environment

luciad::LicenseException

when the license text is invalid.

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::Environment::Initializer::initialize.

◆ ShouldInitializeCurl()

Luciad.Environment.Initializer Luciad.Environment.Initializer.ShouldInitializeCurl ( bool  shouldInitializeCurl)
inline

Specify whether this library should initialize the curl library.

curl is used for network requests done by this library. It contains global initialization and cleanup routines that should be performed only once during the application lifetime. If you set this to false, but want to use network access-based functionality from this library, you will have to initialize curl yourself.

shouldInitializeCurl

true to initialize curl, false not to do so, defaults to true

this initializer

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::Environment::Initializer::shouldInitializeCurl.

◆ ShouldInitializeGdal()

Luciad.Environment.Initializer Luciad.Environment.Initializer.ShouldInitializeGdal ( bool  shouldInitializeGdal)
inline

Specify whether this library should initialize the gdal library.

gdal is used for reading raster data. It contains global routines that should be performed only once during the application lifetime. If you set this to false, but want to use this library, you will have to initialize gdal yourself.

shouldInitializeGdal

true to initialize gdal, false not to do so, defaults to true

this initializer

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::Environment::Initializer::shouldInitializeGdal.

◆ WithCredentialsProvider()

Luciad.Environment.Initializer Luciad.Environment.Initializer.WithCredentialsProvider ( Luciad.Loaders.ICredentialsProvider  credentialsProvider,
bool  wrapWithCache = true 
)
inline

Specify that the given credential provider should be used.

This allows you to connect to network resources requiring authentication.

credentialsProvider

the credential provider to use

wrapWithCache

whether you want the credential provider to be wrapped with a caching instance. If not, caching is the responsibility of the credentials provider. The default value is true.

this initializer

2022.0

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::Environment::Initializer::withCredentialsProvider.

◆ WithLicenseText()

Luciad.Environment.Initializer Luciad.Environment.Initializer.WithLicenseText ( string  licenseText)
inline

Specify the content of the LuciadCPillar license file.

It is up to the caller to load the license content.

licenseText

the content of the license file for LuciadCPillar.

this initializer.

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::Environment::Initializer::withLicenseText.

◆ WithLoggingBackend()

Luciad.Environment.Initializer Luciad.Environment.Initializer.WithLoggingBackend ( Luciad.ILoggingBackend  loggingBackend)
inline

Specify that the given logging backend should be used.

If this function is never called by the program, a default implementation is used which writes information to the standard output streams.

loggingBackend

the backend to use

this initializer

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::Environment::Initializer::withLoggingBackend.

◆ WithProxySelector()

Luciad.Environment.Initializer Luciad.Environment.Initializer.WithProxySelector ( Luciad.Loaders.IProxySelector  proxySelector)
inline

Specify that the given proxy selector should be used.

This allows you to connect to network resources which require use of a proxy.

proxySelector

the proxy selector to use

this initializer

2022.0

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::Environment::Initializer::withProxySelector.

◆ WithResourcePath()

Luciad.Environment.Initializer Luciad.Environment.Initializer.WithResourcePath ( string  resourcePath)
inline

Specify where LuciadCPillar can look for its internal resource.

If this method is not invoked, the library with look for its data in the current directory.

resourcePath

this initializer.

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::Environment::Initializer::withResourcePath.