LuciadCPillar 2024.0.08
All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
luciad

The LuciadCPillar API. More...

Modules

 animations
 Animations API.
 
 cameras
 Camera API.
 
 cartesian
 Basic constructs of Cartesian geometry.
 
 concurrent
 Utility classes for handling concurrent access.
 
 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.
 
 grids
 Functionality related to grids.
 
 input
 Everything that is used as input to interact with the map.
 
 layers
 Support for rendering of data on a Map.
 
 loaders
 Base classes related to loading data for network resources.
 
 maps
 Supports display of data on screen using a map with layers.
 
 models
 Models provide content to be displayed in a Map.
 
 net
 Programming interface for network operations.
 
 rasters
 Classes for modeling raster data.
 
 symbology
 Support for various symbology standards.
 
 text
 Text related functionality.
 
 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. 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::IOException
 The exception that is thrown when encountering an exception while reading a resource. 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 nullptr 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 class  luciad::ErrorCode {
  luciad::ErrorCode::Unsupported = 1 , luciad::ErrorCode::FileNotFound , luciad::ErrorCode::RuntimeError , luciad::ErrorCode::InvalidParameter ,
  luciad::ErrorCode::Canceled , luciad::ErrorCode::Unauthorized
}
 luciad/ErrorInfo.h More...
 
enum class  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 class luciad::ErrorCode
strong

luciad/ErrorInfo.h

Enumerator
Unsupported 

Unsupported.

FileNotFound 

When a file cannot be found.

RuntimeError 

Runtime error condition.

InvalidParameter 

Invalid argument.

Canceled 

Operation is canceled.

Unauthorized 

Not authenticated.

Since
2024.0

◆ LogLevel

enum class luciad::LogLevel
strong

Various levels for logging messages.

luciad/ILoggingBackend.h

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.