luciad::LonLatGridLayer::Builder Class Reference

Builder for creating a LonLatGridLayer. More...

#include <luciad/layers/grids/lonlat/LonLatGridLayer.h>

Public Member Functions
	Builder (Builder &&other) noexcept
	Builder (const Builder &other)
	~Builder ()
std::shared_ptr< LonLatGridLayer >	build () const
	Returns the LonLat layer. More...
Builder &	grid (const LonLatGrid &grid)
	Sets the LonLat grid settings. More...
Builder &	labeled (bool labeled)
	Sets whether the layer should display labels initially. More...
Builder &	operator= (Builder other) noexcept
Builder &	title (std::string title)
	Sets the title to use for the layer. More...
Builder &	visible (bool visible)
	Sets whether the layer should be visible initially. More...

Detailed Description

Builder for creating a LonLatGridLayer.

Configuration on how to display the LonLat grid is done using a luciad::LonLatGrid which can be created using a luciad::LonLatGrid::Builder.

Since

2023.1

Constructor & Destructor Documentation

Builder() [1/2]

luciad::LonLatGridLayer::Builder::Builder

(

const Builder &

other

)

Builder() [2/2]

luciad::LonLatGridLayer::Builder::Builder ( Builder &&  other )

noexcept

~Builder()

luciad::LonLatGridLayer::Builder::~Builder

(

)

Member Function Documentation

build()

std::shared_ptr< LonLatGridLayer > luciad::LonLatGridLayer::Builder::build

(

)

const

Returns the LonLat layer.

Returns

a layer, based on the properties set on this builder.

Exceptions

luciad::LogicException

If not all mandatory parameters are set.

grid()

Builder & luciad::LonLatGridLayer::Builder::grid

(

const LonLatGrid &

grid

)

Sets the LonLat grid settings.

Parameters

grid	the LonLat grid settings.

Returns

this builder.

labeled()

Builder & luciad::LonLatGridLayer::Builder::labeled

(

bool

labeled

)

Sets whether the layer should display labels initially.

Default is true.

Parameters

labeled

whether the layer should display labels initially.

Returns

this builder.

operator=()

Builder & luciad::LonLatGridLayer::Builder::operator= ( Builder  other )

noexcept

title()

Builder & luciad::LonLatGridLayer::Builder::title

(

std::string

title

)

Sets the title to use for the layer.

If not set, the title defaults to 'LonLat'.

Parameters

title

the title for the layer.

Returns

this builder.

visible()

Builder & luciad::LonLatGridLayer::Builder::visible

(

bool

visible

)

Sets whether the layer should be visible initially.

Default is true.

Parameters

visible

the visibility.

Returns

this builder.