pyVHDLModel.Sequential

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

Declarations for sequential statements.

Classes

SequentialStatement: A SequentialStatement is a base-class for all sequential statements.
SequentialStatementsMixin: Undocumented.
SequentialProcedureCall: A SequentialStatement is a base-class for all sequential statements.
SequentialSignalAssignment: A SequentialStatement is a base-class for all sequential statements.
SequentialSimpleSignalAssignment: A SequentialStatement is a base-class for all sequential statements.
SequentialVariableAssignment: A SequentialStatement is a base-class for all sequential statements.
SequentialReportStatement: A SequentialStatement is a base-class for all sequential statements.
SequentialAssertStatement: A SequentialStatement is a base-class for all sequential statements.
CompoundStatement: A CompoundStatement is a base-class for all compound statements.
Branch: A Branch is a base-class for all branches in a if statement.
IfBranch: A Branch is a base-class for all branches in a if statement.
ElsifBranch: A Branch is a base-class for all branches in a if statement.
ElseBranch: A Branch is a base-class for all branches in a if statement.
IfStatement: A CompoundStatement is a base-class for all compound statements.
SequentialChoice: A SequentialChoice is a base-class for all sequential choices (in case statements).
IndexedChoice: A SequentialChoice is a base-class for all sequential choices (in case statements).
RangedChoice: A SequentialChoice is a base-class for all sequential choices (in case statements).
SequentialCase: A Case is a base-class for all cases.
Case: A Case is a base-class for all cases.
OthersCase: A Case is a base-class for all cases.
CaseStatement: A CompoundStatement is a base-class for all compound statements.
LoopStatement: A LoopStatement is a base-class for all loop statements.
EndlessLoopStatement: A LoopStatement is a base-class for all loop statements.
ForLoopStatement: A LoopStatement is a base-class for all loop statements.
WhileLoopStatement: A LoopStatement is a base-class for all loop statements.
LoopControlStatement: A LoopControlStatement is a base-class for all loop controlling statements.
NextStatement: A LoopControlStatement is a base-class for all loop controlling statements.
ExitStatement: A LoopControlStatement is a base-class for all loop controlling statements.
NullStatement: A SequentialStatement is a base-class for all sequential statements.
ReturnStatement: A SequentialStatement is a base-class for all sequential statements.
WaitStatement: A SequentialStatement is a base-class for all sequential statements.
SequentialDeclarationsMixin: Undocumented.

Classes

class pyVHDLModel.Sequential.SequentialStatement(label=None, parent=None)[source]

A SequentialStatement is a base-class for all sequential statements.

Inheritance

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.Sequential.SequentialStatementsMixin(statements=None)[source]

Inheritance

Parameters:: statements (Iterable[SequentialStatement] | None)

__init__(statements=None)[source]

Parameters:: statements (Iterable[SequentialStatement] | None)
Return type:: None

property Statements: List[SequentialStatement]

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

Returns:: A list of sequential statements.

class pyVHDLModel.Sequential.SequentialProcedureCall(procedureName, parameterMappings=None, label=None, parent=None)[source]

Inheritance

Parameters:

procedureName (Symbol)
parameterMappings (Iterable[ParameterAssociationItem] | None)
label (str | None)
parent (ModelEntity)

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

Initializes a VHDL model entity.

Parameters:

parent (ModelEntity) – The parent model entity of this entity.
procedureName (Symbol)
parameterMappings (Iterable[ParameterAssociationItem] | None)
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.Sequential.SequentialSignalAssignment(target, label=None, parent=None)[source]

Inheritance

Parameters:

target (Symbol)
label (str | None)
parent (ModelEntity)

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

Initializes a VHDL model entity.

Parameters:

parent (ModelEntity) – The parent model entity of this entity.
target (Symbol)
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.Sequential.SequentialSimpleSignalAssignment(target, waveform, label=None, parent=None)[source]

Inheritance

Parameters:

target (Symbol)
waveform (Iterable[WaveformElement])
label (str | None)
parent (ModelEntity)

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

Initializes a VHDL model entity.

Parameters:

parent (ModelEntity) – The parent model entity of this entity.
target (Symbol)
waveform (Iterable[WaveformElement])
label (str | None)

Return type:

None

property Waveform: List[WaveformElement]

Read-only property to access the list waveform elements (_waveform).

Returns:: A list of waveform elements.

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.Sequential.SequentialVariableAssignment(target, expression, label=None, parent=None)[source]

Inheritance

Parameters:

target (Symbol)
expression (BaseExpression | QualifiedExpression | FunctionCall | TypeConversion | Literal)
label (str | None)
parent (ModelEntity)

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

Initializes a VHDL model entity.

Parameters:

parent (ModelEntity) – The parent model entity of this entity.
target (Symbol)
expression (BaseExpression | QualifiedExpression | FunctionCall | TypeConversion | Literal)
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: 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.Sequential.SequentialReportStatement(message, severity=None, label=None, parent=None)[source]

Inheritance

Parameters:

message (BaseExpression | QualifiedExpression | FunctionCall | TypeConversion | Literal)
severity (BaseExpression | QualifiedExpression | FunctionCall | TypeConversion | Literal | None)
label (str | None)
parent (ModelEntity)

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

Initializes a VHDL model entity.

Parameters:

parent (ModelEntity) – The parent model entity of this entity.
message (BaseExpression | QualifiedExpression | FunctionCall | TypeConversion | Literal)
severity (BaseExpression | QualifiedExpression | FunctionCall | TypeConversion | Literal | None)
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: 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.Sequential.SequentialAssertStatement(condition, message=None, severity=None, label=None, parent=None)[source]

Inheritance

Parameters:

condition (BaseExpression | QualifiedExpression | FunctionCall | TypeConversion | Literal)
message (BaseExpression | QualifiedExpression | FunctionCall | TypeConversion | Literal | None)
severity (BaseExpression | QualifiedExpression | FunctionCall | TypeConversion | Literal | None)
label (str | None)
parent (ModelEntity)

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

Initializes a VHDL model entity.

Parameters:

parent (ModelEntity) – The parent model entity of this entity.
condition (BaseExpression | QualifiedExpression | FunctionCall | TypeConversion | Literal)
message (BaseExpression | QualifiedExpression | FunctionCall | TypeConversion | Literal | None)
severity (BaseExpression | QualifiedExpression | FunctionCall | TypeConversion | Literal | None)
label (str | None)

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.

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.Sequential.CompoundStatement(label=None, parent=None)[source]

A CompoundStatement is a base-class for all compound statements.

Inheritance

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.Sequential.Branch(statements=None, parent=None)[source]

A Branch is a base-class for all branches in a if statement.

Inheritance

Parameters:

statements (Iterable[SequentialStatement] | None)
parent (ModelEntity)

__init__(statements=None, parent=None)[source]

Initializes a VHDL model entity.

Parameters:

parent (ModelEntity) – The parent model entity of this entity.
statements (Iterable[SequentialStatement] | None)

Return type:

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.

property Statements: List[SequentialStatement]

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

Returns:: A list of sequential statements.

_parent: ModelEntity: Reference to a parent entity in the logical model hierarchy.

class pyVHDLModel.Sequential.IfBranch(condition, statements=None, parent=None)[source]

Inheritance

Parameters:

condition (BaseExpression | QualifiedExpression | FunctionCall | TypeConversion | Literal)
statements (Iterable[SequentialStatement] | None)
parent (ModelEntity)

__init__(condition, statements=None, parent=None)[source]

Initializes a VHDL model entity.

Parameters:

parent (ModelEntity) – The parent model entity of this entity.
condition (BaseExpression | QualifiedExpression | FunctionCall | TypeConversion | Literal)
statements (Iterable[SequentialStatement] | None)

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.

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.

_parent: ModelEntity: Reference to a parent entity in the logical model hierarchy.

class pyVHDLModel.Sequential.ElsifBranch(condition, statements=None, parent=None)[source]

Inheritance

Parameters:

condition (BaseExpression | QualifiedExpression | FunctionCall | TypeConversion | Literal)
statements (Iterable[SequentialStatement] | None)
parent (ModelEntity)

__init__(condition, statements=None, parent=None)[source]

Initializes a VHDL model entity.

Parameters:

parent (ModelEntity) – The parent model entity of this entity.
condition (BaseExpression | QualifiedExpression | FunctionCall | TypeConversion | Literal)
statements (Iterable[SequentialStatement] | None)

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.

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.

_parent: ModelEntity: Reference to a parent entity in the logical model hierarchy.

class pyVHDLModel.Sequential.ElseBranch(statements=None, parent=None)[source]

Inheritance

Parameters:

statements (Iterable[SequentialStatement] | None)
parent (ModelEntity)

__init__(statements=None, parent=None)[source]

Initializes a VHDL model entity.

Parameters:

parent (ModelEntity) – The parent model entity of this entity.
statements (Iterable[SequentialStatement] | None)

Return type:

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.

property Statements: List[SequentialStatement]

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

Returns:: A list of sequential statements.

_parent: ModelEntity: Reference to a parent entity in the logical model hierarchy.

class pyVHDLModel.Sequential.IfStatement(ifBranch, elsifBranches=None, elseBranch=None, label=None, parent=None)[source]

Inheritance

Parameters:

ifBranch (IfBranch)
elsifBranches (Iterable[ElsifBranch] | None)
elseBranch (ElseBranch | None)
label (str | None)
parent (ModelEntity)

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

Initializes a VHDL model entity.

Parameters:

parent (ModelEntity) – The parent model entity of this entity.
ifBranch (IfBranch)
elsifBranches (Iterable[ElsifBranch] | None)
elseBranch (ElseBranch | None)
label (str | None)

Return type:

None

property IfBranch: IfBranch

Read-only property to access the if-branch of the if-statement (_ifBranch).

Returns:: The if-branch.

property ElsIfBranches: List[ElsifBranch]

Read-only property to access the elsif-branch of the if-statement (_elsifBranch).

Returns:: The elsif-branch.

property ElseBranch: ElseBranch | None

Read-only property to access the else-branch of the if-statement (_elseBranch).

Returns:: The else-branch.

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.Sequential.SequentialChoice(parent=None)[source]

A SequentialChoice is a base-class for all sequential choices (in case statements).

Inheritance

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.Sequential.IndexedChoice(expression, parent=None)[source]

Inheritance

Parameters:

expression (BaseExpression | QualifiedExpression | FunctionCall | TypeConversion | Literal)
parent (ModelEntity)

__init__(expression, parent=None)[source]

Initializes a VHDL model entity.

Parameters:

parent (ModelEntity) – The parent model entity of this entity.
expression (BaseExpression | QualifiedExpression | FunctionCall | TypeConversion | Literal)

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.Sequential.RangedChoice(rng, parent=None)[source]

Inheritance

Parameters:

rng (Range)
parent (ModelEntity)

__init__(rng, parent=None)[source]

Initializes a VHDL model entity.

Parameters:

parent (ModelEntity) – The parent model entity of this entity.
rng (Range)

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.Sequential.SequentialCase(statements=None, parent=None)[source]

Inheritance

Parameters:

statements (Iterable[SequentialStatement] | None)
parent (ModelEntity)

__init__(statements=None, parent=None)[source]

Initializes a VHDL model entity.

Parameters:

parent (ModelEntity) – The parent model entity of this entity.
statements (Iterable[SequentialStatement] | None)

Return type:

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.

property Statements: List[SequentialStatement]

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

Returns:: A list of sequential statements.

_parent: ModelEntity: Reference to a parent entity in the logical model hierarchy.

class pyVHDLModel.Sequential.Case(choices, statements=None, parent=None)[source]

Inheritance

Parameters:

choices (Iterable[SequentialChoice])
statements (Iterable[SequentialStatement] | None)
parent (ModelEntity)

__init__(choices, statements=None, parent=None)[source]

Initializes a VHDL model entity.

Parameters:

parent (ModelEntity) – The parent model entity of this entity.
choices (Iterable[SequentialChoice])
statements (Iterable[SequentialStatement] | None)

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.

property Statements: List[SequentialStatement]

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

Returns:: A list of sequential statements.

_parent: ModelEntity: Reference to a parent entity in the logical model hierarchy.

class pyVHDLModel.Sequential.OthersCase(statements=None, parent=None)[source]

Inheritance

Parameters:

statements (Iterable[SequentialStatement] | None)
parent (ModelEntity)

__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.

property Statements: List[SequentialStatement]

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

Returns:: A list of sequential statements.

__init__(statements=None, parent=None)

Initializes a VHDL model entity.

Parameters:

parent (ModelEntity) – The parent model entity of this entity.
statements (Iterable[SequentialStatement] | None)

Return type:

None

_parent: ModelEntity: Reference to a parent entity in the logical model hierarchy.

class pyVHDLModel.Sequential.CaseStatement(expression, cases, label=None, parent=None)[source]

Inheritance

Parameters:

expression (BaseExpression | QualifiedExpression | FunctionCall | TypeConversion | Literal)
cases (Iterable[SequentialCase])
label (str | None)
parent (ModelEntity)

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

Initializes a VHDL model entity.

Parameters:

parent (ModelEntity) – The parent model entity of this entity.
expression (BaseExpression | QualifiedExpression | FunctionCall | TypeConversion | Literal)
cases (Iterable[SequentialCase])
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: 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.Sequential.LoopStatement(statements=None, label=None, parent=None)[source]

A LoopStatement is a base-class for all loop statements.

Inheritance

Parameters:

statements (Iterable[SequentialStatement] | None)
label (str | None)
parent (ModelEntity)

__init__(statements=None, label=None, parent=None)[source]

Initializes a VHDL model entity.

Parameters:

parent (ModelEntity) – The parent model entity of this entity.
statements (Iterable[SequentialStatement] | None)
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.

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.Sequential.EndlessLoopStatement(statements=None, label=None, parent=None)[source]

Inheritance

Parameters:

statements (Iterable[SequentialStatement] | None)
label (str | None)
parent (ModelEntity)

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.

__init__(statements=None, label=None, parent=None)

Initializes a VHDL model entity.

Parameters:

parent (ModelEntity) – The parent model entity of this entity.
statements (Iterable[SequentialStatement] | None)
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.Sequential.ForLoopStatement(loopIndex, rng, statements=None, label=None, parent=None)[source]

Inheritance

Parameters:

loopIndex (str)
rng (Range)
statements (Iterable[SequentialStatement] | None)
label (str | None)
parent (ModelEntity)

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

Initializes a VHDL model entity.

Parameters:

parent (ModelEntity) – The parent model entity of this entity.
loopIndex (str)
rng (Range)
statements (Iterable[SequentialStatement] | None)
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.

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.Sequential.WhileLoopStatement(condition, statements=None, label=None, parent=None)[source]

Inheritance

Parameters:

condition (BaseExpression | QualifiedExpression | FunctionCall | TypeConversion | Literal)
statements (Iterable[SequentialStatement] | None)
label (str | None)
parent (ModelEntity)

__init__(condition, statements=None, label=None, parent=None)[source]

Initializes a VHDL model entity.

Parameters:

parent (ModelEntity) – The parent model entity of this entity.
condition (BaseExpression | QualifiedExpression | FunctionCall | TypeConversion | Literal)
statements (Iterable[SequentialStatement] | None)
label (str | None)

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.

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: 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.Sequential.LoopControlStatement(condition=None, loopLabel=None, parent=None)[source]

A LoopControlStatement is a base-class for all loop controlling statements.

Inheritance

Parameters:

condition (BaseExpression | QualifiedExpression | FunctionCall | TypeConversion | Literal | None)
loopLabel (str | None)
parent (ModelEntity)

__init__(condition=None, loopLabel=None, parent=None)[source]

Initializes a VHDL model entity.

Parameters:

parent (ModelEntity) – The parent model entity of this entity.
condition (BaseExpression | QualifiedExpression | FunctionCall | TypeConversion | Literal | None)
loopLabel (str | None)

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.

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.Sequential.NextStatement(condition=None, loopLabel=None, parent=None)[source]

Inheritance

Parameters:

condition (BaseExpression | QualifiedExpression | FunctionCall | TypeConversion | Literal | None)
loopLabel (str | None)
parent (ModelEntity)

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.

__init__(condition=None, loopLabel=None, parent=None)

Initializes a VHDL model entity.

Parameters:

parent (ModelEntity) – The parent model entity of this entity.
condition (BaseExpression | QualifiedExpression | FunctionCall | TypeConversion | Literal | None)
loopLabel (str | None)

Return type:

None

_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.Sequential.ExitStatement(condition=None, loopLabel=None, parent=None)[source]

Inheritance

Parameters:

condition (BaseExpression | QualifiedExpression | FunctionCall | TypeConversion | Literal | None)
loopLabel (str | None)
parent (ModelEntity)

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.

__init__(condition=None, loopLabel=None, parent=None)

Initializes a VHDL model entity.

Parameters:

parent (ModelEntity) – The parent model entity of this entity.
condition (BaseExpression | QualifiedExpression | FunctionCall | TypeConversion | Literal | None)
loopLabel (str | None)

Return type:

None

_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.Sequential.NullStatement(label=None, parent=None)[source]

Inheritance

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.Sequential.ReturnStatement(returnValue=None, parent=None)[source]

Inheritance

Parameters:

returnValue (BaseExpression | QualifiedExpression | FunctionCall | TypeConversion | Literal | None)
parent (ModelEntity)

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.

__init__(returnValue=None, parent=None)[source]

Initializes a VHDL model entity.

Parameters:

parent (ModelEntity) – The parent model entity of this entity.
returnValue (BaseExpression | QualifiedExpression | FunctionCall | TypeConversion | Literal | None)

Return type:

None

_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.Sequential.WaitStatement(sensitivityList=None, condition=None, timeout=None, label=None, parent=None)[source]

Inheritance

Parameters:

sensitivityList (Iterable[Symbol] | None)
condition (BaseExpression | QualifiedExpression | FunctionCall | TypeConversion | Literal | None)
timeout (BaseExpression | QualifiedExpression | FunctionCall | TypeConversion | Literal | None)
label (str | None)
parent (ModelEntity)

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__(sensitivityList=None, condition=None, timeout=None, label=None, parent=None)[source]

Initializes a VHDL model entity.

Parameters:

parent (ModelEntity) – The parent model entity of this entity.
sensitivityList (Iterable[Symbol] | None)
condition (BaseExpression | QualifiedExpression | FunctionCall | TypeConversion | Literal | None)
timeout (BaseExpression | QualifiedExpression | FunctionCall | TypeConversion | Literal | None)
label (str | None)

Return type:

None

class pyVHDLModel.Sequential.SequentialDeclarationsMixin(declaredItems)[source]

Inheritance

Parameters:: declaredItems (Iterable)

__init__(declaredItems)[source]

Parameters:: declaredItems (Iterable)
Return type:: None