IEEE

Summary

Package:

pyVHDLModel

Doc-string:

documented

File

Expected

Covered

Uncovered

Coverage

IEEE.py

75

68

7

90.7%

Source

pyVHDLModel/IEEE.pydocumentedundocumentedignoredexcludednot counted
32"""This module contains library and package declarations for VHDL library ``IEEE``."""
33
...
45
47@export
48class Ieee(PredefinedLibrary):
49	"""
50	Predefined VHDL library ``ieee``.
51
52	The following predefined packages are in this library:
53
54	* Math
55
56	  * :class:`~pyVHDLModel.IEEE.Math_Real`
57	  * :class:`~pyVHDLModel.IEEE.Math_Complex`
58
59	* Std_logic
60
61	  * :class:`~pyVHDLModel.IEEE.Std_Logic_1164`
62	  * :class:`~pyVHDLModel.IEEE.Std_Logic_TextIO`
63
64	* Numeric
65
66	  * :class:`~pyVHDLModel.IEEE.Numeric_Bit`
67	  * :class:`~pyVHDLModel.IEEE.Numeric_Bit_Unsigned`
68	  * :class:`~pyVHDLModel.IEEE.Numeric_Std`
69	  * :class:`~pyVHDLModel.IEEE.Numeric_Std_Unsigned`
70
71	* Fixed/floating point
72
73	  * :class:`~pyVHDLModel.IEEE.Fixed_Float_Types`
74	  * :class:`~pyVHDLModel.IEEE.Fixed_Generic_Pkg`
75	  * :class:`~pyVHDLModel.IEEE.Fixed_Pkg`
76	  * :class:`~pyVHDLModel.IEEE.Float_Generic_Pkg`
77	  * :class:`~pyVHDLModel.IEEE.Float_Pkg`
78
79	* Synopsys packages
80
81	  * :class:`~pyVHDLModel.IEEE.Std_Logic_Arith`
82	  * :class:`~pyVHDLModel.IEEE.Std_Logic_Misc`
83	  * :class:`~pyVHDLModel.IEEE.Std_Logic_Signed`
84	  * :class:`~pyVHDLModel.IEEE.Std_Logic_TextIO`
85	  * :class:`~pyVHDLModel.IEEE.Std_Logic_Unsigned`
86
87	* Mentor Graphics packages
88
89	  * :class:`~pyVHDLModel.IEEE.Std_Logic_Arith`
90
91	* VITAL packages
92
93	  * :class:`~pyVHDLModel.IEEE.VITAL_Timing`
94	  * :class:`~pyVHDLModel.IEEE.VITAL_Primitives`
95	  * :class:`~pyVHDLModel.IEEE.VITAL_Memory`
96
97	.. seealso::
98
99	   Other predefined libraries:
100	     * Library :class:`~pyVHDLModel.STD.Std`
101	"""
102
103	_flavor: IEEEFlavor  #: The flavor of the ``ieee`` library this instance provides.
104
105	def __init__(self, flavor: Nullable[IEEEFlavor] = None) -> None:
106		"""
107		Initializes the ``ieee`` library.
108
109		:param flavor:               The flavor of the ``ieee`` library this instance provides.
110		:raises VHDLModelException: If the given IEEE library flavor is unknown.
111		"""
		...
128
129	@readonly
130	def Flavor(self) -> IEEEFlavor:
131		"""
132		Read-only property to access the flavor (:attr:`_flavor`).
133
134		:returns: The flavor.
135		"""
		...
137
138	def LoadSynopsysPackages(self) -> None:
		...
144
145	def LoadMentorGraphicsPackages(self) -> None:
		...
151
152	def LoadVITALPackages(self) -> None:
		...
155
157@export
158class Math_Real(PredefinedPackage):
159	"""
160	Predefined package ``ieee.math_real``.
161	"""
162
164@export
165class Math_Real_Body(PredefinedPackageBody):
166	"""
167	Predefined package body of package ``ieee.math_real``.
168	"""
169
171@export
172class Math_Complex(PredefinedPackage):
173	"""
174	Predefined package ``ieee.math_complex``.
175	"""
176
177	def __init__(self) -> None:
178		"""
179		Initializes the ``math_complex`` package.
180		"""
		...
184
186@export
187class Math_Complex_Body(PredefinedPackageBody):
188	"""
189	Predefined package body of package ``ieee.math_complex``.
190	"""
191
192	def __init__(self) -> None:
193		"""
194		Initializes the ``math_complex`` package body.
195		"""
		...
199
201@export
202class Std_Logic_1164(PredefinedPackage):
203	"""
204	Predefined package ``ieee.std_logic_1164``.
205
206	Predefined types:
207
208	* ``std_ulogic``, ``std_ulogic_vector``
209	* ``std_logic``, ``std_logic_vector``
210	"""
211
212	def __init__(self) -> None:
213		"""
214		Initializes the ``std_logic_1164`` package.
215		"""
		...
247
249@export
250class Std_Logic_1164_Body(PredefinedPackageBody):
251	"""
252	Predefined package body of package ``ieee.std_logic_1164``.
253	"""
254
256@export
257class Std_Logic_TextIO(PredefinedPackage):
258	"""
259	Predefined package ``ieee.std_logic_textio``.
260	"""
261
262	def __init__(self) -> None:
263		"""
264		Initializes the ``std_logic_textio`` package.
265		"""
		...
271
273@export
274class Numeric_Bit(PredefinedPackage):
275	"""
276	Predefined package ``ieee.numeric_bit``.
277	"""
278
279	def __init__(self) -> None:
280		"""
281		Initializes the ``numeric_bit`` package.
282		"""
		...
286
288@export
289class Numeric_Bit_Body(PredefinedPackageBody):
290	"""
291	Predefined package body of package ``ieee.numeric_bit``.
292	"""
293
295@export
296class Numeric_Bit_Unsigned(PredefinedPackage):
297	"""
298	Predefined package ``ieee.numeric_bit_unsigned``.
299	"""
300
302@export
303class Numeric_Bit_Unsigned_Body(PredefinedPackageBody):
304	"""
305	Predefined package body of package ``ieee.numeric_bit_unsigned``.
306	"""
307
308	def __init__(self) -> None:
309		"""
310		Initializes the ``numeric_bit_unsigned`` package body.
311		"""
		...
316
318@export
319class Numeric_Std(PredefinedPackage):
320	"""
321	Predefined package ``ieee.numeric_std``.
322
323	Predefined types:
324
325	* ``unresolved_unsigned``, ``unsigned``
326	* ``unresolved_signed``, ``signed``
327	"""
328
329	def __init__(self) -> None:
330		"""
331		Initializes the ``numeric_std`` package.
332		"""
		...
356
358@export
359class Numeric_Std_Body(PredefinedPackageBody):
360	"""
361	Predefined package body of package ``ieee.numeric_std``.
362	"""
363
365@export
366class Numeric_Std_Unsigned(PredefinedPackage):
367	"""
368	Predefined package ``ieee.numeric_std_unsigned``.
369	"""
370
371	def __init__(self) -> None:
372		"""
373		Initializes the ``numeric_std_unsigned`` package.
374		"""
		...
379
381@export
382class Numeric_Std_Unsigned_Body(PredefinedPackageBody):
383	"""
384	Predefined package body of package ``ieee.numeric_std_unsigned``.
385	"""
386
387	def __init__(self) -> None:
388		"""
389		Initializes the ``numeric_std_unsigned`` package body.
390		"""
		...
395
397@export
398class Fixed_Float_Types(PredefinedPackage):
399	"""
400	Predefined package ``ieee.fixed_float_types``.
401	"""
402
404@export
405class Fixed_Generic_Pkg(PredefinedPackage):
406	"""
407	Predefined package ``ieee.fixed_generic_pkg``.
408	"""
409
410	def __init__(self) -> None:
411		"""
412		Initializes the ``fixed_generic_pkg`` package.
413		"""
		...
421
423@export
424class Fixed_Generic_Pkg_Body(PredefinedPackageBody):
425	"""
426	Predefined package body of package ``ieee.fixed_generic_pkg``.
427	"""
428
429	def __init__(self) -> None:
430		"""
431		Initializes the ``fixed_generic_pkg`` package body.
432		"""
		...
437
439@export
440class Fixed_Pkg(PredefinedPackage):
441	"""
442	Predefined package ``ieee.fixed_pkg``.
443	"""
444	def __init__(self) -> None:
445		"""
446		Initializes the ``fixed_pkg`` package.
447		"""
		...
451
453@export
454class Float_Generic_Pkg(PredefinedPackage):
455	"""
456	Predefined package ``ieee.float_generic_pkg``.
457	"""
458
459	def __init__(self) -> None:
460		"""
461		Initializes the ``float_generic_pkg`` package.
462		"""
		...
470
472@export
473class Float_Generic_Pkg_Body(PredefinedPackageBody):
474	"""
475	Predefined package body of package ``ieee.float_generic_pkg``.
476	"""
477
479@export
480class Float_Pkg(PredefinedPackage):
481	"""
482	Predefined package ``ieee.float_pkg``.
483	"""
484
485	def __init__(self) -> None:
486		"""
487		Initializes the ``float_pkg`` package.
488		"""
		...
492
494PACKAGES = (
495	(Math_Real,            Math_Real_Body),
496	(Math_Complex,         Math_Complex_Body),
497	(Std_Logic_1164,       Std_Logic_1164_Body),
498	(Std_Logic_TextIO,     None),
499	(Numeric_Bit,          Numeric_Bit_Body),
500	(Numeric_Bit_Unsigned, Numeric_Bit_Unsigned_Body),
501	(Numeric_Std,          Numeric_Std_Body),
502	(Numeric_Std_Unsigned, Numeric_Std_Unsigned_Body),
503	(Fixed_Float_Types,    None),
504	(Fixed_Generic_Pkg,    Fixed_Generic_Pkg_Body),
505	(Fixed_Pkg,            None),
506	(Float_Generic_Pkg,    Float_Generic_Pkg_Body),
507	(Float_Pkg,            None),
508)
509
511@export
512class Std_Logic_Arith_MentorGraphics(PredefinedPackage):
513	"""
514	Predefined Mentor Graphics package ``ieee.std_logic_arith``.
515	"""
516
517	def __init__(self) -> None:
518		"""
519		Initializes the ``std_logic_arith`` package.
520		"""
		...
524
529@export
530class Std_Logic_Arith_Body_MentorGraphics(PredefinedPackageBody):
531	"""
532	Predefined package body of Mentor Graphics package ``ieee.std_logic_arith``.
533	"""
534
535	def __init__(self) -> None:
536		"""
537		Initializes the ``std_logic_arith`` package body.
538		"""
		...
540
542MENTOR_GRAPHICS_PACKAGES = (
543	(Std_Logic_Arith_MentorGraphics, Std_Logic_Arith_Body_MentorGraphics),
544)
545
547@export
548class VITAL_Timing(PredefinedPackage):
549	"""
550	Predefined package ``ieee.VITAL_Timing``.
551	"""
552
553	def __init__(self) -> None:
554		"""
555		Initializes the ``VITAL_Timing`` package.
556		"""
		...
561
563@export
564class VITAL_Timing_Body(PredefinedPackageBody):
565	"""
566	Predefined package body of package ``ieee.VITAL_Timing``.
567	"""
568
569	def __init__(self) -> None:
570		"""
571		Initializes the ``VITAL_Timing`` package body.
572		"""
		...
577
579@export
580class VITAL_Primitives(PredefinedPackage):
581	"""
582	Predefined package ``ieee.VITAL_Primitives``.
583	"""
584
585	def __init__(self) -> None:
586		"""
587		Initializes the ``VITAL_Primitives`` package.
588		"""
		...
594
596@export
597class VITAL_Primitives_Body(PredefinedPackageBody):
598	"""
599	Predefined package body of package ``ieee.VITAL_Primitives``.
600	"""
601
602	def __init__(self) -> None:
603		"""
604		Initializes the ``VITAL_Primitives`` package body.
605		"""
		...
610
612@export
613class VITAL_Memory(PredefinedPackage):
614	"""
615	Predefined package ``ieee.VITAL_Memory``.
616	"""
617
618	def __init__(self) -> None:
619		"""
620		Initializes the ``VITAL_Memory`` package.
621		"""
		...
631
633@export
634class VITAL_Memory_Body(PredefinedPackageBody):
635	"""
636	Predefined package body of package ``ieee.VITAL_Memory``.
637	"""
638
639	def __init__(self) -> None:
640		"""
641		Initializes the ``VITAL_Memory`` package body.
642		"""
		...
652
654VITAL_PACKAGES = (
655	(VITAL_Timing,     VITAL_Timing_Body),
656	(VITAL_Primitives, VITAL_Primitives_Body),
657	(VITAL_Memory,     VITAL_Memory_Body)
658)
659
661@export
662class Std_Logic_Arith_Synopsys(PredefinedPackage):
663	"""
664	Predefined Synopsys package ``ieee.std_logic_arith``.
665	"""
666
667	def __init__(self) -> None:
668		"""
669		Initializes the ``std_logic_arith`` package.
670		"""
		...
675
677@export
678class Std_Logic_Misc(PredefinedPackage):
679	"""
680	Predefined Synopsys package ``ieee.std_logic_misc``.
681	"""
682
683	def __init__(self) -> None:
684		"""
685		Initializes the ``std_logic_misc`` package.
686		"""
		...
691
693@export
694class Std_Logic_Misc_Body(PredefinedPackageBody):
695	"""
696	Predefined package body of Synopsys package ``ieee.std_logic_misc``.
697	"""
698
700@export
701class Std_Logic_Signed(PredefinedPackage):
702	"""
703	Predefined Synopsys package ``ieee.std_logic_signed``.
704	"""
705
706	def __init__(self) -> None:
707		"""
708		Initializes the ``std_logic_signed`` package.
709		"""
		...
715
717@export
718class Std_Logic_TextIO_Synopsys(PredefinedPackage):
719	"""
720	Predefined Synopsys package ``ieee.std_logic_textio``.
721	"""
722
723	def __init__(self) -> None:
724		"""
725		Initializes the ``std_logic_textio`` package.
726		"""
		...
733
735@export
736class Std_Logic_Unsigned(PredefinedPackage):
737	"""
738	Predefined Synopsys package ``ieee.std_logic_unsigned``.
739	"""
740
741	def __init__(self) -> None:
742		"""
743		Initializes the ``std_logic_unsigned`` package.
744		"""
		...
750
752SYNOPSYS_PACKAGES = (
753	(Std_Logic_Arith_Synopsys,    None),
754	(Std_Logic_Misc,     Std_Logic_Misc_Body),
755	(Std_Logic_Signed,   None),
756	(Std_Logic_TextIO_Synopsys,   None),
757	(Std_Logic_Unsigned, None),
758)