LuciadCPillar  2021.0
luciad

The LuciadCPillar API. More...

Modules

 cartesian
 Basic constructs of Cartesian geometry.
 
 containers
 Basic container utilities.
 
 controllers
 Provides interaction with the data presented on a Map.
 
 create
 Supports interactive creation of Features on the Map.
 
 datamodels
 This package provides an API to describe domain objects in a unified way.
 
 drawing
 Drawing-related concepts like Icons, Color, Image, ...
 
 edit
 Supports interactive editing of Features on the Map.
 
 expressions
 Support for creating expressions over an abstract object model.
 
 formats
 Support for accessing data in various formats.
 
 geodesy
 Coordinate references and geodesy calculations.
 
 geometries
 Everything related to representing geometries.
 
 images
 
 inputs
 Everything that is used as input to interact with the map.
 
 layers
 Support for rendering of data on a Map.
 
 maps
 Supports display of data on screen using a map with layers.
 
 models
 Models provide content to be displayed in a Map.
 
 symbology
 Support for various symbology standards.
 
 text
 
 utils
 general utility classes.
 

Classes

class  luciad::Environment
 Container of global state in this library. More...
 
class  luciad::ErrorInfo
 This class exposes details for a failed method call returning a luciad::expected. More...
 
class  luciad::Exception
 Represents errors that occur during application execution. More...
 
class  luciad::ILoggingBackend
 Backend for the logging in this library. More...
 
class  luciad::InvalidArgumentException
 The exception that is thrown when one of the arguments provided to a method is not valid. More...
 
class  luciad::LicenseException
 The exception that is thrown when the CPillar license is not valid. More...
 
class  luciad::LogicException
 The exception that represents an error in the program logic. More...
 
class  luciad::NotImplementedException
 The exception that is thrown when a requested method or operation is not implemented. More...
 
class  luciad::NullArgumentException
 The exception that is thrown when a null pointer/empty value is passed to a method that does not accept it as a valid argument. More...
 
class  luciad::ParseException
 The exception that is thrown when an unexpected token/grammatical error is encountered during the parsing of a text file. More...
 
class  luciad::RuntimeException
 The generic exception that is thrown during the normal operation. More...
 

Enumerations

enum  luciad::ErrorCode {
  luciad::ErrorCode::Unsupported = 1, luciad::ErrorCode::FileNotFound, luciad::ErrorCode::RuntimeError, luciad::ErrorCode::InvalidParameter,
  luciad::ErrorCode::Cancelled
}
 
enum  luciad::LogLevel {
  luciad::LogLevel::Error, luciad::LogLevel::Warning, luciad::LogLevel::Info, luciad::LogLevel::Debug,
  luciad::LogLevel::Trace
}
 Various levels for logging messages. More...
 

Detailed Description

The LuciadCPillar API.

The header files are distributed over a directory structure based on functional area. We use the module structure to show this distribution.

Make sure to initialize an Environment before using the CPillar functionality. You can find more within the tutorial on making your first map application.

Enumeration Type Documentation

◆ ErrorCode

enum luciad::ErrorCode
strong
Enumerator
Unsupported 
FileNotFound 
RuntimeError 
InvalidParameter 
Cancelled 

◆ LogLevel

enum luciad::LogLevel
strong

Various levels for logging messages.

Enumerator
Error 

Indicates a problem from which no recovery is possible.

Warning 

Indicates a problem from which we can recover.

Recovery could be to give up whatever we attempted.

Info 

Indicates information of general interest.

Debug 

Indicates information of use for figuring out a problem.

Trace 

Indicates extremely detailed information that is probably only useful to the maintainer of the code.