TransZoneSystemInfo#

class caf.space.inputs.TransZoneSystemInfo(*, name, shapefile, id_col, point_shapefile=None)[source]#

Input data for primary zone systems in translation.

Inherits from ZoneSystemInfo.

Parameters:

point_shapefile (Optional[Path]) – A shapefile of point zones to be joined to the main shapefile. This shapefile must contain the same id_col as the main shapefile as the two will be concatenated on this column. If this is provided set ‘point_handling’ to True in the main config class or it will be effectively ignored.
name (str)
shapefile (Path)
id_col (str)

Attributes

`model_computed_fields`
`model_config`	Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
`model_extra`	Get extra fields set during validation.
`model_fields`
`model_fields_set`	Returns the set of fields that have been explicitly set on this model instance.
`point_shapefile`
`name`
`shapefile`
`id_col`

Methods

Attributes Documentation

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_extra#

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to “allow”.

model_fields = {'id_col': FieldInfo(annotation=str, required=True), 'name': FieldInfo(annotation=str, required=True), 'point_shapefile': FieldInfo(annotation=Union[Path, NoneType], required=False, default=None), 'shapefile': FieldInfo(annotation=Path, required=True)}#

model_fields_set#

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.