TransZoneSystemInfo#

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

Bases: ZoneSystemInfo

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 Summary

model_computed_fields

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

Attributes Documentation

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}#

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[Dict[str, FieldInfo]] = {'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)}#

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.