cavcalc.parameters.parameter.ArgParameter
#
Overview
- class cavcalc.parameters.parameter.ArgParameter(name_or_ptype, value: ~typing.Optional[~pint.quantity.build_quantity_class.<locals>.Quantity] = None, index: ~typing.Optional[int] = None, axis: ~typing.Optional[int] = None)#
Bases:
Parameter
Cavity parameters which represent arguments given to cavcalc.
Note
You should never need to instantiate objects of this type manually. These are constructed during the argument parsing, and calculation process.
Properties
The axis that the parameter corresponds to, as an integer indexed from zero. |
|
The name of the parameter in a CLI argument format. |
|
The index of the argument in the sequence of specified args. |
|
Whether this parameter was used in its associated |