PaperConfig

class PaperConfig(name, y_axis_up, origin_location, paper_size=None, paper_orientation=None, x_range=None, y_range=None, origin_location_reference='topleft', info='', rotate_180=False, set_ps=None, final_pu_params=None, aka_names=[])

Data class containing configuration for a give plotter type/paper size combinations.

Methods

__delattr__

Attached to frozen classes as __delattr__.

__eq__

Method generated by attrs for class PaperConfig.

__ge__

Method generated by attrs for class PaperConfig.

__gt__

Method generated by attrs for class PaperConfig.

__hash__

Method generated by attrs for class PaperConfig.

__init__

Method generated by attrs for class PaperConfig.

__le__

Method generated by attrs for class PaperConfig.

__lt__

Method generated by attrs for class PaperConfig.

__ne__

Method generated by attrs for class PaperConfig.

__repr__

Method generated by attrs for class PaperConfig.

__setattr__

Attached to frozen classes as __setattr__.

from_config

rtype

PaperConfig

Attributes

__annotations__

__attrs_attrs__

name

name of the paper format

y_axis_up

if True, the Y axis point upwards instead of downwards

origin_location

location on paper of the (0, 0) plotter unit coordinates

paper_size

X/Y axis convention of the plotter

paper_orientation

orientation of the plotter coordinate system on paper

x_range

admissible range of X coordinates

y_range

admissible range of Y coordinates

origin_location_reference

reference for origin_location

info

information printed to the user when paper is used

rotate_180

if True, the geometries are rotated by 180 degrees on the page

set_ps

if not None, call PS with corresponding value

final_pu_params

if not None, these params are added to the final PU command

aka_names

alternative paper names (will be found by paper_config()

Methods

PaperConfig.__delattr__(name)

Attached to frozen classes as __delattr__.

PaperConfig.__eq__(other)

Method generated by attrs for class PaperConfig.

PaperConfig.__ge__(other)

Method generated by attrs for class PaperConfig.

PaperConfig.__gt__(other)

Method generated by attrs for class PaperConfig.

PaperConfig.__hash__()

Method generated by attrs for class PaperConfig.

PaperConfig.__init__(name, y_axis_up, origin_location, paper_size=None, paper_orientation=None, x_range=None, y_range=None, origin_location_reference='topleft', info='', rotate_180=False, set_ps=None, final_pu_params=None, aka_names=[])

Method generated by attrs for class PaperConfig.

PaperConfig.__le__(other)

Method generated by attrs for class PaperConfig.

PaperConfig.__lt__(other)

Method generated by attrs for class PaperConfig.

PaperConfig.__ne__(other)

Method generated by attrs for class PaperConfig.

PaperConfig.__repr__()

Method generated by attrs for class PaperConfig.

PaperConfig.__setattr__(name, value)

Attached to frozen classes as __setattr__.

classmethod PaperConfig.from_config(data)
Return type

PaperConfig

Attributes

PaperConfig.__annotations__ = {'aka_names': typing.List[str], 'final_pu_params': typing.Union[str, NoneType], 'info': <class 'str'>, 'name': <class 'str'>, 'origin_location': typing.Tuple[float, float], 'origin_location_reference': typing.Union[str, NoneType], 'paper_orientation': typing.Union[str, NoneType], 'paper_size': typing.Union[typing.Tuple[float, float], NoneType], 'rotate_180': <class 'bool'>, 'set_ps': typing.Union[int, NoneType], 'x_range': typing.Union[typing.Tuple[int, int], NoneType], 'y_axis_up': <class 'bool'>, 'y_range': typing.Union[typing.Tuple[int, int], NoneType]}
PaperConfig.__attrs_attrs__ = (Attribute(name='name', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=<class 'str'>, converter=None, kw_only=False, inherited=False, on_setattr=None), Attribute(name='y_axis_up', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=<class 'bool'>, converter=None, kw_only=False, inherited=False, on_setattr=None), Attribute(name='origin_location', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=typing.Tuple[float, float], converter=None, kw_only=False, inherited=False, on_setattr=None), Attribute(name='paper_size', default=None, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=typing.Union[typing.Tuple[float, float], NoneType], converter=None, kw_only=False, inherited=False, on_setattr=None), Attribute(name='paper_orientation', default=None, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=typing.Union[str, NoneType], converter=None, kw_only=False, inherited=False, on_setattr=None), Attribute(name='x_range', default=None, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=typing.Union[typing.Tuple[int, int], NoneType], converter=None, kw_only=False, inherited=False, on_setattr=None), Attribute(name='y_range', default=None, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=typing.Union[typing.Tuple[int, int], NoneType], converter=None, kw_only=False, inherited=False, on_setattr=None), Attribute(name='origin_location_reference', default='topleft', validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=typing.Union[str, NoneType], converter=None, kw_only=False, inherited=False, on_setattr=None), Attribute(name='info', default='', validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=<class 'str'>, converter=None, kw_only=False, inherited=False, on_setattr=None), Attribute(name='rotate_180', default=False, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=<class 'bool'>, converter=None, kw_only=False, inherited=False, on_setattr=None), Attribute(name='set_ps', default=None, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=typing.Union[int, NoneType], converter=None, kw_only=False, inherited=False, on_setattr=None), Attribute(name='final_pu_params', default=None, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=typing.Union[str, NoneType], converter=None, kw_only=False, inherited=False, on_setattr=None), Attribute(name='aka_names', default=[], validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=typing.List[str], converter=None, kw_only=False, inherited=False, on_setattr=None))
PaperConfig.name: str

name of the paper format

PaperConfig.y_axis_up: bool

if True, the Y axis point upwards instead of downwards

PaperConfig.origin_location: Tuple[float, float]

location on paper of the (0, 0) plotter unit coordinates

PaperConfig.paper_size: Optional[Tuple[float, float]]

X/Y axis convention of the plotter

PaperConfig.paper_orientation: Optional[str]

orientation of the plotter coordinate system on paper

PaperConfig.x_range: Optional[Tuple[int, int]]

admissible range of X coordinates

PaperConfig.y_range: Optional[Tuple[int, int]]

admissible range of Y coordinates

PaperConfig.origin_location_reference: Optional[str]

reference for origin_location

PaperConfig.info: str

information printed to the user when paper is used

PaperConfig.rotate_180: bool

if True, the geometries are rotated by 180 degrees on the page

PaperConfig.set_ps: Optional[int]

if not None, call PS with corresponding value

PaperConfig.final_pu_params: Optional[str]

if not None, these params are added to the final PU command

PaperConfig.aka_names: List[str]

alternative paper names (will be found by paper_config()