Dike layers module.

BuilderProtocol

Bases: Protocol

build() -> Any

Instantiates a concrete object to separate its initalization from the data structure.

Returns:

Name Type Description
Any Any

Intance of a created object within Koswat domain.

KoswatLayerBuilderProtocol

Bases: BuilderProtocol, Protocol

build() -> KoswatLayerProtocol

Builds an instance of a KoswatLayerProtocol based on the provided upper_linestring and layer_data

Returns:

Name Type Description
KoswatLayerProtocol KoswatLayerProtocol

Valid instance of a KoswatLayerProtocol.

KoswatLayerProtocol

Bases: Protocol

as_data_dict() -> dict

Returns the information related to an instance of the KoswatLayerProtocol.

Returns:

Name Type Description
dict dict

custom dictionary with the relevant data.

KoswatLayerProtocol

Bases: Protocol

as_data_dict() -> dict

Returns the information related to an instance of the KoswatLayerProtocol.

Returns:

Name Type Description
dict dict

custom dictionary with the relevant data.

Layers wrapper

BuilderProtocol

Bases: Protocol

build() -> Any

Instantiates a concrete object to separate its initalization from the data structure.

Returns:

Name Type Description
Any Any

Intance of a created object within Koswat domain.

KoswatLayersWrapperBuilderProtocol

Bases: BuilderProtocol, Protocol

build() -> KoswatLayersWrapperProtocol

Builds an instance of KoswatLayersWrapperProtocol based on the class required fields layers_data and profile_points.

Returns:

Name Type Description
KoswatLayersWrapperProtocol KoswatLayersWrapperProtocol

Valid initialized instance of a KoswatLayersWrapperProtocol.

KoswatLayersWrapperProtocol

Bases: Protocol

as_data_dict() -> dict

Returns the layers as a dictionary.

Returns:

Name Type Description
dict dict

Dictionary containing all the information of the wrapper layers (KoswatLayerProtocol).

KoswatLayerProtocol

Bases: Protocol

as_data_dict() -> dict

Returns the information related to an instance of the KoswatLayerProtocol.

Returns:

Name Type Description
dict dict

custom dictionary with the relevant data.

KoswatLayersWrapperProtocol

Bases: Protocol

as_data_dict() -> dict

Returns the layers as a dictionary.

Returns:

Name Type Description
dict dict

Dictionary containing all the information of the wrapper layers (KoswatLayerProtocol).