pyVHDLModel.Concurrent

This module contains parts of an abstract document language model for VHDL.

Concurrent defines all concurrent statements used in entities, architectures, generates and block statements.

Classes


Classes

class pyVHDLModel.Concurrent.ConcurrentStatement(label=None, parent=None)[source]

A base-class for all concurrent statements.

Inheritance

Inheritance diagram of ConcurrentStatement

Parameters:

label (str | None)

property Label: str | None

Returns a model entity’s label.

Returns:

Label of a model entity.

property NormalizedLabel: str | None

Returns a model entity’s normalized (lower case) label.

Returns:

Normalized label of a model entity.

property Parent: ModelEntity

Read-only property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:

Reference to the parent entity.

__init__(label=None, parent=None)

Initializes a VHDL model entity.

Parameters:
  • parent – The parent model entity of this entity.

  • label (str | None)

Return type:

None

_label: Optional[str]

The label of a model entity.

_normalizedLabel: Optional[str]

The normalized (lower case) label of a model entity.

_parent: ModelEntity

Reference to a parent entity in the logical model hierarchy.

class pyVHDLModel.Concurrent.ConcurrentStatementsMixin(statements=None)[source]

A mixin-class for all language constructs supporting concurrent statements.

See also

Todo

concurrent declaration region

Inheritance

Inheritance diagram of ConcurrentStatementsMixin

Parameters:

statements (Iterable[ConcurrentStatement] | None)

__init__(statements=None)[source]
Parameters:

statements (Iterable[ConcurrentStatement] | None)

Return type:

None

class pyVHDLModel.Concurrent.Instantiation(label, genericAssociations=None, portAssociations=None, parent=None)[source]

A base-class for all (component) instantiations.

Inheritance

Inheritance diagram of Instantiation

Parameters:
__init__(label, genericAssociations=None, portAssociations=None, parent=None)[source]

Initializes a VHDL model entity.

Parameters:
Return type:

None

property Label: str | None

Returns a model entity’s label.

Returns:

Label of a model entity.

property NormalizedLabel: str | None

Returns a model entity’s normalized (lower case) label.

Returns:

Normalized label of a model entity.

property Parent: ModelEntity

Read-only property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:

Reference to the parent entity.

_label: Optional[str]

The label of a model entity.

_normalizedLabel: Optional[str]

The normalized (lower case) label of a model entity.

_parent: ModelEntity

Reference to a parent entity in the logical model hierarchy.

class pyVHDLModel.Concurrent.ComponentInstantiation(label, componentSymbol, genericAssociations=None, portAssociations=None, parent=None)[source]

Represents a component instantiation by referring to a component name.

Example

inst : component Counter;

Inheritance

Inheritance diagram of ComponentInstantiation

Parameters:
__init__(label, componentSymbol, genericAssociations=None, portAssociations=None, parent=None)[source]

Initializes a VHDL model entity.

Parameters:
Return type:

None

property Label: str | None

Returns a model entity’s label.

Returns:

Label of a model entity.

property NormalizedLabel: str | None

Returns a model entity’s normalized (lower case) label.

Returns:

Normalized label of a model entity.

property Parent: ModelEntity

Read-only property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:

Reference to the parent entity.

_label: Optional[str]

The label of a model entity.

_normalizedLabel: Optional[str]

The normalized (lower case) label of a model entity.

_parent: ModelEntity

Reference to a parent entity in the logical model hierarchy.

class pyVHDLModel.Concurrent.EntityInstantiation(label, entitySymbol, architectureSymbol=None, genericAssociations=None, portAssociations=None, parent=None)[source]

Represents an entity instantiation by referring to an entity name with optional architecture name.

Example

inst : entity work. Counter;

Inheritance

Inheritance diagram of EntityInstantiation

Parameters:
__init__(label, entitySymbol, architectureSymbol=None, genericAssociations=None, portAssociations=None, parent=None)[source]

Initializes a VHDL model entity.

Parameters:
Return type:

None

property Label: str | None

Returns a model entity’s label.

Returns:

Label of a model entity.

property NormalizedLabel: str | None

Returns a model entity’s normalized (lower case) label.

Returns:

Normalized label of a model entity.

property Parent: ModelEntity

Read-only property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:

Reference to the parent entity.

_label: Optional[str]

The label of a model entity.

_normalizedLabel: Optional[str]

The normalized (lower case) label of a model entity.

_parent: ModelEntity

Reference to a parent entity in the logical model hierarchy.

class pyVHDLModel.Concurrent.ConfigurationInstantiation(label, configurationSymbol, genericAssociations=None, portAssociations=None, parent=None)[source]

Represents a configuration instantiation by referring to a configuration name.

Example

inst : configuration Counter;

Inheritance

Inheritance diagram of ConfigurationInstantiation

Parameters:
__init__(label, configurationSymbol, genericAssociations=None, portAssociations=None, parent=None)[source]

Initializes a VHDL model entity.

Parameters:
Return type:

None

property Label: str | None

Returns a model entity’s label.

Returns:

Label of a model entity.

property NormalizedLabel: str | None

Returns a model entity’s normalized (lower case) label.

Returns:

Normalized label of a model entity.

property Parent: ModelEntity

Read-only property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:

Reference to the parent entity.

_label: Optional[str]

The label of a model entity.

_normalizedLabel: Optional[str]

The normalized (lower case) label of a model entity.

_parent: ModelEntity

Reference to a parent entity in the logical model hierarchy.

class pyVHDLModel.Concurrent.ProcessStatement(label=None, declaredItems=None, statements=None, sensitivityList=None, documentation=None, parent=None)[source]

Represents a process statement with sensitivity list, sequential declaration region and sequential statements.

Example

proc: process(Clock)
  -- sequential declarations
begin
  -- sequential statements
end process;

Inheritance

Inheritance diagram of ProcessStatement

Parameters:
__init__(label=None, declaredItems=None, statements=None, sensitivityList=None, documentation=None, parent=None)[source]

Initializes a VHDL model entity.

Parameters:
Return type:

None

_documentation: Optional[str]

The associated documentation of a model entity.

property Documentation: str | None

Returns a model entity’s associated documentation.

Returns:

Associated documentation of a model entity.

property Label: str | None

Returns a model entity’s label.

Returns:

Label of a model entity.

property NormalizedLabel: str | None

Returns a model entity’s normalized (lower case) label.

Returns:

Normalized label of a model entity.

property Parent: ModelEntity

Read-only property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:

Reference to the parent entity.

property Statements: List[SequentialStatement]

Read-only property to access the list of sequential statements (_statements).

Returns:

A list of sequential statements.

_label: Optional[str]

The label of a model entity.

_normalizedLabel: Optional[str]

The normalized (lower case) label of a model entity.

_parent: ModelEntity

Reference to a parent entity in the logical model hierarchy.

class pyVHDLModel.Concurrent.ConcurrentProcedureCall(label, procedureName, parameterMappings=None, parent=None)[source]

Inheritance

Inheritance diagram of ConcurrentProcedureCall

Parameters:
__init__(label, procedureName, parameterMappings=None, parent=None)[source]

Initializes a VHDL model entity.

Parameters:
Return type:

None

property Label: str | None

Returns a model entity’s label.

Returns:

Label of a model entity.

property NormalizedLabel: str | None

Returns a model entity’s normalized (lower case) label.

Returns:

Normalized label of a model entity.

property Parent: ModelEntity

Read-only property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:

Reference to the parent entity.

_label: Nullable[str]

The label of a model entity.

_normalizedLabel: Nullable[str]

The normalized (lower case) label of a model entity.

_parent: ModelEntity

Reference to a parent entity in the logical model hierarchy.

class pyVHDLModel.Concurrent.ConcurrentBlockStatement(label, portItems=None, declaredItems=None, statements=None, documentation=None, parent=None)[source]

Inheritance

Inheritance diagram of ConcurrentBlockStatement

Parameters:
__init__(label, portItems=None, declaredItems=None, statements=None, documentation=None, parent=None)[source]

Initializes a VHDL model entity.

Parameters:
Return type:

None

_label: Nullable[str]

The label of a model entity.

_normalizedLabel: Nullable[str]

The normalized (lower case) label of a model entity.

_declaredItems: List

List of all declared items in this concurrent declaration region.

_types: Dict[str, FullType]

Dictionary of all types declared in this concurrent declaration region.

_subtypes: Dict[str, Subtype]

Dictionary of all subtypes declared in this concurrent declaration region.

_constants: Dict[str, Constant]

Dictionary of all constants declared in this concurrent declaration region.

_signals: Dict[str, Signal]

Dictionary of all signals declared in this concurrent declaration region.

_sharedVariables: Dict[str, SharedVariable]

Dictionary of all shared variables declared in this concurrent declaration region.

_files: Dict[str, File]

Dictionary of all files declared in this concurrent declaration region.

_functions: Dict[str, Dict[str, Function]]

Dictionary of all functions declared in this concurrent declaration region.

_procedures: Dict[str, Dict[str, Procedure]]

Dictionary of all procedures declared in this concurrent declaration region.

_documentation: Nullable[str]

The associated documentation of a model entity.

property Documentation: str | None

Returns a model entity’s associated documentation.

Returns:

Associated documentation of a model entity.

IndexDeclaredItems()

Index declared items listed in the concurrent declaration region.

Return type:

None

Algorithm

  1. Iterate all declared items:

    • Every declared item is added to _namespace.

    • If the declared item is a FullType, then add an entry to _types.

    • If the declared item is a SubType, then add an entry to _subtypes.

    • If the declared item is a Function, then add an entry to _functions.

    • If the declared item is a Procedure, then add an entry to _procedures.

    • If the declared item is a Constant, then add an entry to _constants.

    • If the declared item is a Signal, then add an entry to _signals.

    • If the declared item is a Variable, TODO.

    • If the declared item is a SharedVariable, then add an entry to _sharedVariables.

    • If the declared item is a File, then add an entry to _files.

    • If the declared item is neither of these types, call _IndexOtherDeclaredItem().
      Derived classes may override this virtual function.

See also

pyVHDLModel.Design.IndexPackages()

Iterate all packages in the design and index declared items.

pyVHDLModel.Library.IndexPackages()

Iterate all packages in the library and index declared items.

pyVHDLModel.Library._IndexOtherDeclaredItem()

Iterate all packages in the library and index declared items.

property Label: str | None

Returns a model entity’s label.

Returns:

Label of a model entity.

property NormalizedLabel: str | None

Returns a model entity’s normalized (lower case) label.

Returns:

Normalized label of a model entity.

property Parent: ModelEntity

Read-only property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:

Reference to the parent entity.

_parent: ModelEntity

Reference to a parent entity in the logical model hierarchy.

class pyVHDLModel.Concurrent.GenerateBranch(declaredItems=None, statements=None, alternativeLabel=None, parent=None)[source]

A base-class for all branches in a generate statements.

Inheritance

Inheritance diagram of GenerateBranch

Parameters:
__init__(declaredItems=None, statements=None, alternativeLabel=None, parent=None)[source]

Initializes a VHDL model entity.

Parameters:
Return type:

None

_declaredItems: List

List of all declared items in this concurrent declaration region.

_types: Dict[str, FullType]

Dictionary of all types declared in this concurrent declaration region.

_subtypes: Dict[str, Subtype]

Dictionary of all subtypes declared in this concurrent declaration region.

_constants: Dict[str, Constant]

Dictionary of all constants declared in this concurrent declaration region.

_signals: Dict[str, Signal]

Dictionary of all signals declared in this concurrent declaration region.

_sharedVariables: Dict[str, SharedVariable]

Dictionary of all shared variables declared in this concurrent declaration region.

_files: Dict[str, File]

Dictionary of all files declared in this concurrent declaration region.

_functions: Dict[str, Dict[str, Function]]

Dictionary of all functions declared in this concurrent declaration region.

_procedures: Dict[str, Dict[str, Procedure]]

Dictionary of all procedures declared in this concurrent declaration region.

IndexDeclaredItems()

Index declared items listed in the concurrent declaration region.

Return type:

None

Algorithm

  1. Iterate all declared items:

    • Every declared item is added to _namespace.

    • If the declared item is a FullType, then add an entry to _types.

    • If the declared item is a SubType, then add an entry to _subtypes.

    • If the declared item is a Function, then add an entry to _functions.

    • If the declared item is a Procedure, then add an entry to _procedures.

    • If the declared item is a Constant, then add an entry to _constants.

    • If the declared item is a Signal, then add an entry to _signals.

    • If the declared item is a Variable, TODO.

    • If the declared item is a SharedVariable, then add an entry to _sharedVariables.

    • If the declared item is a File, then add an entry to _files.

    • If the declared item is neither of these types, call _IndexOtherDeclaredItem().
      Derived classes may override this virtual function.

See also

pyVHDLModel.Design.IndexPackages()

Iterate all packages in the design and index declared items.

pyVHDLModel.Library.IndexPackages()

Iterate all packages in the library and index declared items.

pyVHDLModel.Library._IndexOtherDeclaredItem()

Iterate all packages in the library and index declared items.

property Parent: ModelEntity

Read-only property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:

Reference to the parent entity.

_parent: ModelEntity

Reference to a parent entity in the logical model hierarchy.

class pyVHDLModel.Concurrent.IfGenerateBranch(condition, declaredItems=None, statements=None, alternativeLabel=None, parent=None)[source]

Represents if-generate branch in a generate statement with a concurrent declaration region and concurrent statements.

Example

gen: if condition generate
  -- concurrent declarations
begin
  -- concurrent statements
elsif condition generate
  -- ...
else generate
  -- ...
end generate;

Inheritance

Inheritance diagram of IfGenerateBranch

Parameters:
__init__(condition, declaredItems=None, statements=None, alternativeLabel=None, parent=None)[source]

Initializes a VHDL model entity.

Parameters:
Return type:

None

property Condition: BaseExpression | QualifiedExpression | FunctionCall | TypeConversion | Literal

Read-only property to access the condition of a statement (_condition).

Returns:

The expression representing the condition of a statement.

IndexDeclaredItems()

Index declared items listed in the concurrent declaration region.

Return type:

None

Algorithm

  1. Iterate all declared items:

    • Every declared item is added to _namespace.

    • If the declared item is a FullType, then add an entry to _types.

    • If the declared item is a SubType, then add an entry to _subtypes.

    • If the declared item is a Function, then add an entry to _functions.

    • If the declared item is a Procedure, then add an entry to _procedures.

    • If the declared item is a Constant, then add an entry to _constants.

    • If the declared item is a Signal, then add an entry to _signals.

    • If the declared item is a Variable, TODO.

    • If the declared item is a SharedVariable, then add an entry to _sharedVariables.

    • If the declared item is a File, then add an entry to _files.

    • If the declared item is neither of these types, call _IndexOtherDeclaredItem().
      Derived classes may override this virtual function.

See also

pyVHDLModel.Design.IndexPackages()

Iterate all packages in the design and index declared items.

pyVHDLModel.Library.IndexPackages()

Iterate all packages in the library and index declared items.

pyVHDLModel.Library._IndexOtherDeclaredItem()

Iterate all packages in the library and index declared items.

property Parent: ModelEntity

Read-only property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:

Reference to the parent entity.

_constants: Dict[str, Constant]

Dictionary of all constants declared in this concurrent declaration region.

_declaredItems: List

List of all declared items in this concurrent declaration region.

_files: Dict[str, File]

Dictionary of all files declared in this concurrent declaration region.

_functions: Dict[str, Dict[str, Function]]

Dictionary of all functions declared in this concurrent declaration region.

_parent: ModelEntity

Reference to a parent entity in the logical model hierarchy.

_procedures: Dict[str, Dict[str, Procedure]]

Dictionary of all procedures declared in this concurrent declaration region.

_sharedVariables: Dict[str, SharedVariable]

Dictionary of all shared variables declared in this concurrent declaration region.

_signals: Dict[str, Signal]

Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dict[str, Subtype]

Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dict[str, FullType]

Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.Concurrent.ElsifGenerateBranch(condition, declaredItems=None, statements=None, alternativeLabel=None, parent=None)[source]

Represents elsif-generate branch in a generate statement with a concurrent declaration region and concurrent statements.

Example

gen: if condition generate
  -- ...
elsif condition generate
  -- concurrent declarations
begin
  -- concurrent statements
else generate
  -- ...
end generate;

Inheritance

Inheritance diagram of ElsifGenerateBranch

Parameters:
__init__(condition, declaredItems=None, statements=None, alternativeLabel=None, parent=None)[source]

Initializes a VHDL model entity.

Parameters:
Return type:

None

property Condition: BaseExpression | QualifiedExpression | FunctionCall | TypeConversion | Literal

Read-only property to access the condition of a statement (_condition).

Returns:

The expression representing the condition of a statement.

IndexDeclaredItems()

Index declared items listed in the concurrent declaration region.

Return type:

None

Algorithm

  1. Iterate all declared items:

    • Every declared item is added to _namespace.

    • If the declared item is a FullType, then add an entry to _types.

    • If the declared item is a SubType, then add an entry to _subtypes.

    • If the declared item is a Function, then add an entry to _functions.

    • If the declared item is a Procedure, then add an entry to _procedures.

    • If the declared item is a Constant, then add an entry to _constants.

    • If the declared item is a Signal, then add an entry to _signals.

    • If the declared item is a Variable, TODO.

    • If the declared item is a SharedVariable, then add an entry to _sharedVariables.

    • If the declared item is a File, then add an entry to _files.

    • If the declared item is neither of these types, call _IndexOtherDeclaredItem().
      Derived classes may override this virtual function.

See also

pyVHDLModel.Design.IndexPackages()

Iterate all packages in the design and index declared items.

pyVHDLModel.Library.IndexPackages()

Iterate all packages in the library and index declared items.

pyVHDLModel.Library._IndexOtherDeclaredItem()

Iterate all packages in the library and index declared items.

property Parent: ModelEntity

Read-only property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:

Reference to the parent entity.

_constants: Dict[str, Constant]

Dictionary of all constants declared in this concurrent declaration region.

_declaredItems: List

List of all declared items in this concurrent declaration region.

_files: Dict[str, File]

Dictionary of all files declared in this concurrent declaration region.

_functions: Dict[str, Dict[str, Function]]

Dictionary of all functions declared in this concurrent declaration region.

_parent: ModelEntity

Reference to a parent entity in the logical model hierarchy.

_procedures: Dict[str, Dict[str, Procedure]]

Dictionary of all procedures declared in this concurrent declaration region.

_sharedVariables: Dict[str, SharedVariable]

Dictionary of all shared variables declared in this concurrent declaration region.

_signals: Dict[str, Signal]

Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dict[str, Subtype]

Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dict[str, FullType]

Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.Concurrent.ElseGenerateBranch(declaredItems=None, statements=None, alternativeLabel=None, parent=None)[source]

Represents else-generate branch in a generate statement with a concurrent declaration region and concurrent statements.

Example

gen: if condition generate
  -- ...
elsif condition generate
  -- ...
else generate
  -- concurrent declarations
begin
  -- concurrent statements
end generate;

Inheritance

Inheritance diagram of ElseGenerateBranch

Parameters:
__init__(declaredItems=None, statements=None, alternativeLabel=None, parent=None)[source]

Initializes a VHDL model entity.

Parameters:
Return type:

None

IndexDeclaredItems()

Index declared items listed in the concurrent declaration region.

Return type:

None

Algorithm

  1. Iterate all declared items:

    • Every declared item is added to _namespace.

    • If the declared item is a FullType, then add an entry to _types.

    • If the declared item is a SubType, then add an entry to _subtypes.

    • If the declared item is a Function, then add an entry to _functions.

    • If the declared item is a Procedure, then add an entry to _procedures.

    • If the declared item is a Constant, then add an entry to _constants.

    • If the declared item is a Signal, then add an entry to _signals.

    • If the declared item is a Variable, TODO.

    • If the declared item is a SharedVariable, then add an entry to _sharedVariables.

    • If the declared item is a File, then add an entry to _files.

    • If the declared item is neither of these types, call _IndexOtherDeclaredItem().
      Derived classes may override this virtual function.

See also

pyVHDLModel.Design.IndexPackages()

Iterate all packages in the design and index declared items.

pyVHDLModel.Library.IndexPackages()

Iterate all packages in the library and index declared items.

pyVHDLModel.Library._IndexOtherDeclaredItem()

Iterate all packages in the library and index declared items.

property Parent: ModelEntity

Read-only property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:

Reference to the parent entity.

_constants: Dict[str, Constant]

Dictionary of all constants declared in this concurrent declaration region.

_declaredItems: List

List of all declared items in this concurrent declaration region.

_files: Dict[str, File]

Dictionary of all files declared in this concurrent declaration region.

_functions: Dict[str, Dict[str, Function]]

Dictionary of all functions declared in this concurrent declaration region.

_parent: ModelEntity

Reference to a parent entity in the logical model hierarchy.

_procedures: Dict[str, Dict[str, Procedure]]

Dictionary of all procedures declared in this concurrent declaration region.

_sharedVariables: Dict[str, SharedVariable]

Dictionary of all shared variables declared in this concurrent declaration region.

_signals: Dict[str, Signal]

Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dict[str, Subtype]

Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dict[str, FullType]

Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.Concurrent.GenerateStatement(label=None, parent=None)[source]

A base-class for all generate statements.

Inheritance

Inheritance diagram of GenerateStatement

Parameters:
__init__(label=None, parent=None)[source]

Initializes a VHDL model entity.

Parameters:
  • parent (ModelEntity) – The parent model entity of this entity.

  • label (str | None)

Return type:

None

property Label: str | None

Returns a model entity’s label.

Returns:

Label of a model entity.

property NormalizedLabel: str | None

Returns a model entity’s normalized (lower case) label.

Returns:

Normalized label of a model entity.

property Parent: ModelEntity

Read-only property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:

Reference to the parent entity.

_label: Optional[str]

The label of a model entity.

_normalizedLabel: Optional[str]

The normalized (lower case) label of a model entity.

_parent: ModelEntity

Reference to a parent entity in the logical model hierarchy.

class pyVHDLModel.Concurrent.IfGenerateStatement(label, ifBranch, elsifBranches=None, elseBranch=None, parent=None)[source]

Represents an if…generate statement.

Example

gen: if condition generate
  -- ...
elsif condition generate
  -- ...
else generate
  -- ...
end generate;

Inheritance

Inheritance diagram of IfGenerateStatement

Parameters:
__init__(label, ifBranch, elsifBranches=None, elseBranch=None, parent=None)[source]

Initializes a VHDL model entity.

Parameters:
Return type:

None

property Label: str | None

Returns a model entity’s label.

Returns:

Label of a model entity.

property NormalizedLabel: str | None

Returns a model entity’s normalized (lower case) label.

Returns:

Normalized label of a model entity.

property Parent: ModelEntity

Read-only property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:

Reference to the parent entity.

_label: Optional[str]

The label of a model entity.

_normalizedLabel: Optional[str]

The normalized (lower case) label of a model entity.

_parent: ModelEntity

Reference to a parent entity in the logical model hierarchy.

class pyVHDLModel.Concurrent.ConcurrentChoice(parent=None)[source]

A base-class for all concurrent choices (in case…generate statements).

Inheritance

Inheritance diagram of ConcurrentChoice

Parameters:

parent (ModelEntity | None)

property Parent: ModelEntity

Read-only property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:

Reference to the parent entity.

__init__(parent=None)

Initializes a VHDL model entity.

Parameters:

parent (Optional[ModelEntity]) – The parent model entity of this entity.

Return type:

None

_parent: ModelEntity

Reference to a parent entity in the logical model hierarchy.

class pyVHDLModel.Concurrent.IndexedGenerateChoice(expression, parent=None)[source]

Inheritance

Inheritance diagram of IndexedGenerateChoice

Parameters:
__init__(expression, parent=None)[source]

Initializes a VHDL model entity.

Parameters:
Return type:

None

__str__()[source]

Return str(self).

Return type:

str

property Parent: ModelEntity

Read-only property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:

Reference to the parent entity.

_parent: ModelEntity

Reference to a parent entity in the logical model hierarchy.

class pyVHDLModel.Concurrent.RangedGenerateChoice(rng, parent=None)[source]

Inheritance

Inheritance diagram of RangedGenerateChoice

Parameters:
__init__(rng, parent=None)[source]

Initializes a VHDL model entity.

Parameters:
Return type:

None

__str__()[source]

Return str(self).

Return type:

str

property Parent: ModelEntity

Read-only property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:

Reference to the parent entity.

_parent: ModelEntity

Reference to a parent entity in the logical model hierarchy.

class pyVHDLModel.Concurrent.ConcurrentCase(declaredItems=None, statements=None, alternativeLabel=None, parent=None)[source]

Inheritance

Inheritance diagram of ConcurrentCase

Parameters:
__init__(declaredItems=None, statements=None, alternativeLabel=None, parent=None)[source]

Initializes a VHDL model entity.

Parameters:
Return type:

None

_label: Nullable[str]

The label of a model entity.

_normalizedLabel: Nullable[str]

The normalized (lower case) label of a model entity.

_declaredItems: List

List of all declared items in this concurrent declaration region.

_types: Dict[str, FullType]

Dictionary of all types declared in this concurrent declaration region.

_subtypes: Dict[str, Subtype]

Dictionary of all subtypes declared in this concurrent declaration region.

_constants: Dict[str, Constant]

Dictionary of all constants declared in this concurrent declaration region.

_signals: Dict[str, Signal]

Dictionary of all signals declared in this concurrent declaration region.

_sharedVariables: Dict[str, SharedVariable]

Dictionary of all shared variables declared in this concurrent declaration region.

_files: Dict[str, File]

Dictionary of all files declared in this concurrent declaration region.

_functions: Dict[str, Dict[str, Function]]

Dictionary of all functions declared in this concurrent declaration region.

_procedures: Dict[str, Dict[str, Procedure]]

Dictionary of all procedures declared in this concurrent declaration region.

IndexDeclaredItems()

Index declared items listed in the concurrent declaration region.

Return type:

None

Algorithm

  1. Iterate all declared items:

    • Every declared item is added to _namespace.

    • If the declared item is a FullType, then add an entry to _types.

    • If the declared item is a SubType, then add an entry to _subtypes.

    • If the declared item is a Function, then add an entry to _functions.

    • If the declared item is a Procedure, then add an entry to _procedures.

    • If the declared item is a Constant, then add an entry to _constants.

    • If the declared item is a Signal, then add an entry to _signals.

    • If the declared item is a Variable, TODO.

    • If the declared item is a SharedVariable, then add an entry to _sharedVariables.

    • If the declared item is a File, then add an entry to _files.

    • If the declared item is neither of these types, call _IndexOtherDeclaredItem().
      Derived classes may override this virtual function.

See also

pyVHDLModel.Design.IndexPackages()

Iterate all packages in the design and index declared items.

pyVHDLModel.Library.IndexPackages()

Iterate all packages in the library and index declared items.

pyVHDLModel.Library._IndexOtherDeclaredItem()

Iterate all packages in the library and index declared items.

property Label: str | None

Returns a model entity’s label.

Returns:

Label of a model entity.

property NormalizedLabel: str | None

Returns a model entity’s normalized (lower case) label.

Returns:

Normalized label of a model entity.

property Parent: ModelEntity

Read-only property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:

Reference to the parent entity.

_parent: ModelEntity

Reference to a parent entity in the logical model hierarchy.

class pyVHDLModel.Concurrent.GenerateCase(choices, declaredItems=None, statements=None, alternativeLabel=None, parent=None)[source]

Inheritance

Inheritance diagram of GenerateCase

Parameters:
__init__(choices, declaredItems=None, statements=None, alternativeLabel=None, parent=None)[source]

Initializes a VHDL model entity.

Parameters:
Return type:

None

__str__()[source]

Return str(self).

Return type:

str

IndexDeclaredItems()

Index declared items listed in the concurrent declaration region.

Return type:

None

Algorithm

  1. Iterate all declared items:

    • Every declared item is added to _namespace.

    • If the declared item is a FullType, then add an entry to _types.

    • If the declared item is a SubType, then add an entry to _subtypes.

    • If the declared item is a Function, then add an entry to _functions.

    • If the declared item is a Procedure, then add an entry to _procedures.

    • If the declared item is a Constant, then add an entry to _constants.

    • If the declared item is a Signal, then add an entry to _signals.

    • If the declared item is a Variable, TODO.

    • If the declared item is a SharedVariable, then add an entry to _sharedVariables.

    • If the declared item is a File, then add an entry to _files.

    • If the declared item is neither of these types, call _IndexOtherDeclaredItem().
      Derived classes may override this virtual function.

See also

pyVHDLModel.Design.IndexPackages()

Iterate all packages in the design and index declared items.

pyVHDLModel.Library.IndexPackages()

Iterate all packages in the library and index declared items.

pyVHDLModel.Library._IndexOtherDeclaredItem()

Iterate all packages in the library and index declared items.

property Label: str | None

Returns a model entity’s label.

Returns:

Label of a model entity.

property NormalizedLabel: str | None

Returns a model entity’s normalized (lower case) label.

Returns:

Normalized label of a model entity.

property Parent: ModelEntity

Read-only property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:

Reference to the parent entity.

_constants: Dict[str, Constant]

Dictionary of all constants declared in this concurrent declaration region.

_declaredItems: List

List of all declared items in this concurrent declaration region.

_files: Dict[str, File]

Dictionary of all files declared in this concurrent declaration region.

_functions: Dict[str, Dict[str, Function]]

Dictionary of all functions declared in this concurrent declaration region.

_label: Nullable[str]

The label of a model entity.

_normalizedLabel: Nullable[str]

The normalized (lower case) label of a model entity.

_parent: ModelEntity

Reference to a parent entity in the logical model hierarchy.

_procedures: Dict[str, Dict[str, Procedure]]

Dictionary of all procedures declared in this concurrent declaration region.

_sharedVariables: Dict[str, SharedVariable]

Dictionary of all shared variables declared in this concurrent declaration region.

_signals: Dict[str, Signal]

Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dict[str, Subtype]

Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dict[str, FullType]

Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.Concurrent.OthersGenerateCase(declaredItems=None, statements=None, alternativeLabel=None, parent=None)[source]

Inheritance

Inheritance diagram of OthersGenerateCase

Parameters:
__str__()[source]

Return str(self).

Return type:

str

IndexDeclaredItems()

Index declared items listed in the concurrent declaration region.

Return type:

None

Algorithm

  1. Iterate all declared items:

    • Every declared item is added to _namespace.

    • If the declared item is a FullType, then add an entry to _types.

    • If the declared item is a SubType, then add an entry to _subtypes.

    • If the declared item is a Function, then add an entry to _functions.

    • If the declared item is a Procedure, then add an entry to _procedures.

    • If the declared item is a Constant, then add an entry to _constants.

    • If the declared item is a Signal, then add an entry to _signals.

    • If the declared item is a Variable, TODO.

    • If the declared item is a SharedVariable, then add an entry to _sharedVariables.

    • If the declared item is a File, then add an entry to _files.

    • If the declared item is neither of these types, call _IndexOtherDeclaredItem().
      Derived classes may override this virtual function.

See also

pyVHDLModel.Design.IndexPackages()

Iterate all packages in the design and index declared items.

pyVHDLModel.Library.IndexPackages()

Iterate all packages in the library and index declared items.

pyVHDLModel.Library._IndexOtherDeclaredItem()

Iterate all packages in the library and index declared items.

property Label: str | None

Returns a model entity’s label.

Returns:

Label of a model entity.

property NormalizedLabel: str | None

Returns a model entity’s normalized (lower case) label.

Returns:

Normalized label of a model entity.

property Parent: ModelEntity

Read-only property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:

Reference to the parent entity.

__init__(declaredItems=None, statements=None, alternativeLabel=None, parent=None)

Initializes a VHDL model entity.

Parameters:
Return type:

None

_constants: Dict[str, Constant]

Dictionary of all constants declared in this concurrent declaration region.

_declaredItems: List

List of all declared items in this concurrent declaration region.

_files: Dict[str, File]

Dictionary of all files declared in this concurrent declaration region.

_functions: Dict[str, Dict[str, Function]]

Dictionary of all functions declared in this concurrent declaration region.

_label: Nullable[str]

The label of a model entity.

_normalizedLabel: Nullable[str]

The normalized (lower case) label of a model entity.

_parent: ModelEntity

Reference to a parent entity in the logical model hierarchy.

_procedures: Dict[str, Dict[str, Procedure]]

Dictionary of all procedures declared in this concurrent declaration region.

_sharedVariables: Dict[str, SharedVariable]

Dictionary of all shared variables declared in this concurrent declaration region.

_signals: Dict[str, Signal]

Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dict[str, Subtype]

Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dict[str, FullType]

Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.Concurrent.CaseGenerateStatement(label, expression, cases, parent=None)[source]

Represents a case…generate statement.

Example

gen: case selector generate
  case choice1 =>
    -- ...
  case choice2 =>
    -- ...
  case others =>
    -- ...
end generate;

Inheritance

Inheritance diagram of CaseGenerateStatement

Parameters:
__init__(label, expression, cases, parent=None)[source]

Initializes a VHDL model entity.

Parameters:
Return type:

None

property Label: str | None

Returns a model entity’s label.

Returns:

Label of a model entity.

property NormalizedLabel: str | None

Returns a model entity’s normalized (lower case) label.

Returns:

Normalized label of a model entity.

property Parent: ModelEntity

Read-only property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:

Reference to the parent entity.

_label: Optional[str]

The label of a model entity.

_normalizedLabel: Optional[str]

The normalized (lower case) label of a model entity.

_parent: ModelEntity

Reference to a parent entity in the logical model hierarchy.

class pyVHDLModel.Concurrent.ForGenerateStatement(label, loopIndex, rng, declaredItems=None, statements=None, parent=None)[source]

Represents a for…generate statement.

Example

gen: for i in 0 to 3 generate
  -- ...
end generate;

Inheritance

Inheritance diagram of ForGenerateStatement

Parameters:
_declaredItems: List

List of all declared items in this concurrent declaration region.

_types: Dict[str, FullType]

Dictionary of all types declared in this concurrent declaration region.

_subtypes: Dict[str, Subtype]

Dictionary of all subtypes declared in this concurrent declaration region.

_constants: Dict[str, Constant]

Dictionary of all constants declared in this concurrent declaration region.

_signals: Dict[str, Signal]

Dictionary of all signals declared in this concurrent declaration region.

_sharedVariables: Dict[str, SharedVariable]

Dictionary of all shared variables declared in this concurrent declaration region.

_files: Dict[str, File]

Dictionary of all files declared in this concurrent declaration region.

_functions: Dict[str, Dict[str, Function]]

Dictionary of all functions declared in this concurrent declaration region.

_procedures: Dict[str, Dict[str, Procedure]]

Dictionary of all procedures declared in this concurrent declaration region.

IndexDeclaredItems()

Index declared items listed in the concurrent declaration region.

Return type:

None

Algorithm

  1. Iterate all declared items:

    • Every declared item is added to _namespace.

    • If the declared item is a FullType, then add an entry to _types.

    • If the declared item is a SubType, then add an entry to _subtypes.

    • If the declared item is a Function, then add an entry to _functions.

    • If the declared item is a Procedure, then add an entry to _procedures.

    • If the declared item is a Constant, then add an entry to _constants.

    • If the declared item is a Signal, then add an entry to _signals.

    • If the declared item is a Variable, TODO.

    • If the declared item is a SharedVariable, then add an entry to _sharedVariables.

    • If the declared item is a File, then add an entry to _files.

    • If the declared item is neither of these types, call _IndexOtherDeclaredItem().
      Derived classes may override this virtual function.

See also

pyVHDLModel.Design.IndexPackages()

Iterate all packages in the design and index declared items.

pyVHDLModel.Library.IndexPackages()

Iterate all packages in the library and index declared items.

pyVHDLModel.Library._IndexOtherDeclaredItem()

Iterate all packages in the library and index declared items.

property Label: str | None

Returns a model entity’s label.

Returns:

Label of a model entity.

property NormalizedLabel: str | None

Returns a model entity’s normalized (lower case) label.

Returns:

Normalized label of a model entity.

property Parent: ModelEntity

Read-only property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:

Reference to the parent entity.

_label: Nullable[str]

The label of a model entity.

_normalizedLabel: Nullable[str]

The normalized (lower case) label of a model entity.

_parent: ModelEntity

Reference to a parent entity in the logical model hierarchy.

__init__(label, loopIndex, rng, declaredItems=None, statements=None, parent=None)[source]

Initializes a VHDL model entity.

Parameters:
Return type:

None

class pyVHDLModel.Concurrent.ConcurrentSignalAssignment(label, target, parent=None)[source]

A base-class for concurrent signal assignments.

Inheritance

Inheritance diagram of ConcurrentSignalAssignment

Parameters:
property Label: str | None

Returns a model entity’s label.

Returns:

Label of a model entity.

property NormalizedLabel: str | None

Returns a model entity’s normalized (lower case) label.

Returns:

Normalized label of a model entity.

property Parent: ModelEntity

Read-only property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:

Reference to the parent entity.

_label: Nullable[str]

The label of a model entity.

_normalizedLabel: Nullable[str]

The normalized (lower case) label of a model entity.

_parent: ModelEntity

Reference to a parent entity in the logical model hierarchy.

__init__(label, target, parent=None)[source]

Initializes a VHDL model entity.

Parameters:
  • parent (ModelEntity) – The parent model entity of this entity.

  • label (str)

  • target (Name)

Return type:

None

class pyVHDLModel.Concurrent.ConcurrentSimpleSignalAssignment(label, target, waveform, parent=None)[source]

Inheritance

Inheritance diagram of ConcurrentSimpleSignalAssignment

Parameters:
property Label: str | None

Returns a model entity’s label.

Returns:

Label of a model entity.

property NormalizedLabel: str | None

Returns a model entity’s normalized (lower case) label.

Returns:

Normalized label of a model entity.

property Parent: ModelEntity

Read-only property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:

Reference to the parent entity.

_label: Nullable[str]

The label of a model entity.

_normalizedLabel: Nullable[str]

The normalized (lower case) label of a model entity.

_parent: ModelEntity

Reference to a parent entity in the logical model hierarchy.

__init__(label, target, waveform, parent=None)[source]

Initializes a VHDL model entity.

Parameters:
Return type:

None

class pyVHDLModel.Concurrent.ConcurrentSelectedSignalAssignment(label, target, expression, parent=None)[source]

Inheritance

Inheritance diagram of ConcurrentSelectedSignalAssignment

Parameters:
property Label: str | None

Returns a model entity’s label.

Returns:

Label of a model entity.

property NormalizedLabel: str | None

Returns a model entity’s normalized (lower case) label.

Returns:

Normalized label of a model entity.

property Parent: ModelEntity

Read-only property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:

Reference to the parent entity.

_label: Nullable[str]

The label of a model entity.

_normalizedLabel: Nullable[str]

The normalized (lower case) label of a model entity.

_parent: ModelEntity

Reference to a parent entity in the logical model hierarchy.

__init__(label, target, expression, parent=None)[source]

Initializes a VHDL model entity.

Parameters:
Return type:

None

class pyVHDLModel.Concurrent.ConcurrentConditionalSignalAssignment(label, target, expression, parent=None)[source]

Inheritance

Inheritance diagram of ConcurrentConditionalSignalAssignment

Parameters:
property Label: str | None

Returns a model entity’s label.

Returns:

Label of a model entity.

property NormalizedLabel: str | None

Returns a model entity’s normalized (lower case) label.

Returns:

Normalized label of a model entity.

property Parent: ModelEntity

Read-only property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:

Reference to the parent entity.

_label: Nullable[str]

The label of a model entity.

_normalizedLabel: Nullable[str]

The normalized (lower case) label of a model entity.

_parent: ModelEntity

Reference to a parent entity in the logical model hierarchy.

__init__(label, target, expression, parent=None)[source]

Initializes a VHDL model entity.

Parameters:
Return type:

None

class pyVHDLModel.Concurrent.ConcurrentAssertStatement(condition, message, severity=None, label=None, parent=None)[source]

Inheritance

Inheritance diagram of ConcurrentAssertStatement

Parameters:
property Condition: BaseExpression | QualifiedExpression | FunctionCall | TypeConversion | Literal

Read-only property to access the condition of a statement (_condition).

Returns:

The expression representing the condition of a statement.

property Label: str | None

Returns a model entity’s label.

Returns:

Label of a model entity.

property NormalizedLabel: str | None

Returns a model entity’s normalized (lower case) label.

Returns:

Normalized label of a model entity.

property Parent: ModelEntity

Read-only property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:

Reference to the parent entity.

_label: Nullable[str]

The label of a model entity.

_normalizedLabel: Nullable[str]

The normalized (lower case) label of a model entity.

_parent: ModelEntity

Reference to a parent entity in the logical model hierarchy.

__init__(condition, message, severity=None, label=None, parent=None)[source]

Initializes a VHDL model entity.

Parameters:
Return type:

None