`pyGHDL.dom.Sequential`¶

Classes

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.
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).
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.
ForLoopStatement: A LoopStatement is a base-class for all loop statements.
SequentialSimpleSignalAssignment: A SequentialStatement is a base-class for all sequential statements.
SequentialProcedureCall: A SequentialStatement is a base-class for all sequential statements.
SequentialAssertStatement: A SequentialStatement is a base-class for all sequential statements.
SequentialReportStatement: A SequentialStatement is a base-class for all sequential statements.
NullStatement: A SequentialStatement is a base-class for all sequential statements.
WaitStatement: A SequentialStatement is a base-class for all sequential statements.

Classes

class pyGHDL.dom.Sequential.IfBranch(branchNode, condition, statements=None)[source]¶

Inheritance

Parameters:

branchNode (Iir) –
condition (Union[BaseExpression, QualifiedExpression, FunctionCall, TypeConversion, Constant, ConstantSymbol, Variable, VariableSymbol, Signal, SignalSymbol, Literal]) –
statements (Iterable[SequentialStatement]) –

__init__(branchNode, condition, statements=None)[source]¶

Initializes a VHDL model entity.

Parameters:

branchNode (Iir) –
condition (Union[BaseExpression, QualifiedExpression, FunctionCall, TypeConversion, Constant, ConstantSymbol, Variable, VariableSymbol, Signal, SignalSymbol, Literal]) –
statements (Iterable[SequentialStatement]) –

property Parent: ModelEntity¶

Returns a reference to the parent entity.

Return type:: ModelEntity
Returns:: Parent entity.

_parent: ModelEntity¶: Reference to a parent entity in the model.

class pyGHDL.dom.Sequential.ElsifBranch(branchNode, condition, statements=None)[source]¶

Inheritance

Parameters:

branchNode (Iir) –
condition (Union[BaseExpression, QualifiedExpression, FunctionCall, TypeConversion, Constant, ConstantSymbol, Variable, VariableSymbol, Signal, SignalSymbol, Literal]) –
statements (Iterable[SequentialStatement]) –

__init__(branchNode, condition, statements=None)[source]¶

Initializes a VHDL model entity.

Parameters:

branchNode (Iir) –
condition (Union[BaseExpression, QualifiedExpression, FunctionCall, TypeConversion, Constant, ConstantSymbol, Variable, VariableSymbol, Signal, SignalSymbol, Literal]) –
statements (Iterable[SequentialStatement]) –

property Parent: ModelEntity¶

Returns a reference to the parent entity.

Return type:: ModelEntity
Returns:: Parent entity.

_parent: ModelEntity¶: Reference to a parent entity in the model.

class pyGHDL.dom.Sequential.ElseBranch(branchNode, statements=None)[source]¶

Inheritance

Parameters:

branchNode (Iir) –
statements (Iterable[SequentialStatement]) –

__init__(branchNode, statements=None)[source]¶

Initializes a VHDL model entity.

Parameters:

branchNode (Iir) –
statements (Optional[Iterable[SequentialStatement]]) –

property Parent: ModelEntity¶

Returns a reference to the parent entity.

Return type:: ModelEntity
Returns:: Parent entity.

_parent: ModelEntity¶: Reference to a parent entity in the model.

class pyGHDL.dom.Sequential.IfStatement(ifNode, ifBranch, elsifBranches=None, elseBranch=None, label=None)[source]¶

Inheritance

Parameters:

ifNode (Iir) –
ifBranch (IfBranch) –
elsifBranches (Iterable[ElsifBranch]) –
elseBranch (ElseBranch) –
label (str) –

__init__(ifNode, ifBranch, elsifBranches=None, elseBranch=None, label=None)[source]¶

Initializes a VHDL model entity.

Parameters:

ifNode (Iir) –
ifBranch (IfBranch) –
elsifBranches (Optional[Iterable[ElsifBranch]]) –
elseBranch (Optional[ElseBranch]) –
label (Optional[str]) –

property Label: Optional[str]¶

Returns a model entity’s label.

Return type:: Optional[str]
Returns:: Label of a model entity.

property Parent: ModelEntity¶

Returns a reference to the parent entity.

Return type:: ModelEntity
Returns:: Parent entity.

_parent: ModelEntity¶: Reference to a parent entity in the model.

_label: Nullable[str]¶: The label of a model entity.

class pyGHDL.dom.Sequential.IndexedChoice(node, expression)[source]¶

Inheritance

Parameters:

node (Iir) –
expression (Union[BaseExpression, QualifiedExpression, FunctionCall, TypeConversion, Constant, ConstantSymbol, Variable, VariableSymbol, Signal, SignalSymbol, Literal]) –

__init__(node, expression)[source]¶

Initializes a VHDL model entity.

Parameters:

node (Iir) –
expression (Union[BaseExpression, QualifiedExpression, FunctionCall, TypeConversion, Constant, ConstantSymbol, Variable, VariableSymbol, Signal, SignalSymbol, Literal]) –

property Parent: ModelEntity¶

Returns a reference to the parent entity.

Return type:: ModelEntity
Returns:: Parent entity.

__str__()[source]¶

Return str(self).

Return type:: str

_parent: ModelEntity¶: Reference to a parent entity in the model.

class pyGHDL.dom.Sequential.RangedChoice(node, rng)[source]¶

Inheritance

Parameters:

node (Iir) –
rng (Range) –

__init__(node, rng)[source]¶

Initializes a VHDL model entity.

Parameters:

node (Iir) –
rng (Range) –

property Parent: ModelEntity¶

Returns a reference to the parent entity.

Return type:: ModelEntity
Returns:: Parent entity.

__str__()[source]¶

Return str(self).

Return type:: str

_parent: ModelEntity¶: Reference to a parent entity in the model.

class pyGHDL.dom.Sequential.Case(node, choices, statements=None)[source]¶

Inheritance

Parameters:

node (Iir) –
choices (Iterable[SequentialChoice]) –
statements (Iterable[SequentialStatement]) –

__init__(node, choices, statements=None)[source]¶

Initializes a VHDL model entity.

Parameters:

node (Iir) –
choices (Iterable[SequentialChoice]) –
statements (Optional[Iterable[SequentialStatement]]) –

property Parent: ModelEntity¶

Returns a reference to the parent entity.

Return type:: ModelEntity
Returns:: Parent entity.

__str__()[source]¶

Return str(self).

Return type:: str

_parent: ModelEntity¶: Reference to a parent entity in the model.

class pyGHDL.dom.Sequential.OthersCase(caseNode, statements=None)[source]¶

Inheritance

Parameters:

caseNode (Iir) –
statements (Iterable[SequentialStatement]) –

__init__(caseNode, statements=None)[source]¶

Initializes a VHDL model entity.

Parameters:

caseNode (Iir) –
statements (Optional[Iterable[SequentialStatement]]) –

property Parent: ModelEntity¶

Returns a reference to the parent entity.

Return type:: ModelEntity
Returns:: Parent entity.

__str__()[source]¶

Return str(self).

Return type:: str

_parent: ModelEntity¶: Reference to a parent entity in the model.

class pyGHDL.dom.Sequential.CaseStatement(caseNode, label, expression, cases)[source]¶

Inheritance

Parameters:

caseNode (Iir) –
label (str) –
expression (Union[BaseExpression, QualifiedExpression, FunctionCall, TypeConversion, Constant, ConstantSymbol, Variable, VariableSymbol, Signal, SignalSymbol, Literal]) –
cases (Iterable[SequentialCase]) –

__init__(caseNode, label, expression, cases)[source]¶

Initializes a VHDL model entity.

Parameters:

caseNode (Iir) –
label (str) –
expression (Union[BaseExpression, QualifiedExpression, FunctionCall, TypeConversion, Constant, ConstantSymbol, Variable, VariableSymbol, Signal, SignalSymbol, Literal]) –
cases (Iterable[SequentialCase]) –

property Label: Optional[str]¶

Returns a model entity’s label.

Return type:: Optional[str]
Returns:: Label of a model entity.

property Parent: ModelEntity¶

Returns a reference to the parent entity.

Return type:: ModelEntity
Returns:: Parent entity.

_parent: ModelEntity¶: Reference to a parent entity in the model.

_label: Nullable[str]¶: The label of a model entity.

class pyGHDL.dom.Sequential.ForLoopStatement(loopNode, loopIndex, rng, statements=None, label=None)[source]¶

Inheritance

Parameters:

loopNode (Iir) –
loopIndex (str) –
rng (Range) –
statements (Iterable[SequentialStatement]) –
label (str) –

__init__(loopNode, loopIndex, rng, statements=None, label=None)[source]¶

Initializes a VHDL model entity.

Parameters:

loopNode (Iir) –
loopIndex (str) –
rng (Range) –
statements (Optional[Iterable[SequentialStatement]]) –
label (Optional[str]) –

property Label: Optional[str]¶

Returns a model entity’s label.

Return type:: Optional[str]
Returns:: Label of a model entity.

property Parent: ModelEntity¶

Returns a reference to the parent entity.

Return type:: ModelEntity
Returns:: Parent entity.

_parent: ModelEntity¶: Reference to a parent entity in the model.

_label: Nullable[str]¶: The label of a model entity.

class pyGHDL.dom.Sequential.SequentialSimpleSignalAssignment(assignmentNode, target, waveform, label=None)[source]¶

Inheritance

Parameters:

assignmentNode (Iir) –
target (Name) –
waveform (Iterable[WaveformElement]) –
label (str) –

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

Initializes a VHDL model entity.

Parameters:

assignmentNode (Iir) –
target (Name) –
waveform (Iterable[WaveformElement]) –
label (Optional[str]) –

property Label: Optional[str]¶

Returns a model entity’s label.

Return type:: Optional[str]
Returns:: Label of a model entity.

property Parent: ModelEntity¶

Returns a reference to the parent entity.

Return type:: ModelEntity
Returns:: Parent entity.

_parent: ModelEntity¶: Reference to a parent entity in the model.

_label: Nullable[str]¶: The label of a model entity.

class pyGHDL.dom.Sequential.SequentialProcedureCall(callNode, procedureName, parameterMappings, label=None)[source]¶

Inheritance

Parameters:

callNode (Iir) –
procedureName (Name) –
parameterMappings (Iterable[ParameterAssociationItem]) –
label (str) –

__init__(callNode, procedureName, parameterMappings, label=None)[source]¶

Initializes a VHDL model entity.

Parameters:

callNode (Iir) –
procedureName (Name) –
parameterMappings (Iterable[ParameterAssociationItem]) –
label (Optional[str]) –

property Label: Optional[str]¶

Returns a model entity’s label.

Return type:: Optional[str]
Returns:: Label of a model entity.

property Parent: ModelEntity¶

Returns a reference to the parent entity.

Return type:: ModelEntity
Returns:: Parent entity.

_parent: ModelEntity¶: Reference to a parent entity in the model.

_label: Nullable[str]¶: The label of a model entity.

class pyGHDL.dom.Sequential.SequentialAssertStatement(assertNode, condition, message=None, severity=None, label=None)[source]¶

Inheritance

Parameters:

assertNode (Iir) –
condition (Union[BaseExpression, QualifiedExpression, FunctionCall, TypeConversion, Constant, ConstantSymbol, Variable, VariableSymbol, Signal, SignalSymbol, Literal]) –
message (Union[BaseExpression, QualifiedExpression, FunctionCall, TypeConversion, Constant, ConstantSymbol, Variable, VariableSymbol, Signal, SignalSymbol, Literal]) –
severity (Union[BaseExpression, QualifiedExpression, FunctionCall, TypeConversion, Constant, ConstantSymbol, Variable, VariableSymbol, Signal, SignalSymbol, Literal]) –
label (str) –

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

Initializes a VHDL model entity.

Parameters:

assertNode (Iir) –
condition (Union[BaseExpression, QualifiedExpression, FunctionCall, TypeConversion, Constant, ConstantSymbol, Variable, VariableSymbol, Signal, SignalSymbol, Literal]) –
message (Union[BaseExpression, QualifiedExpression, FunctionCall, TypeConversion, Constant, ConstantSymbol, Variable, VariableSymbol, Signal, SignalSymbol, Literal]) –
severity (Union[BaseExpression, QualifiedExpression, FunctionCall, TypeConversion, Constant, ConstantSymbol, Variable, VariableSymbol, Signal, SignalSymbol, Literal]) –
label (str) –

property Label: Optional[str]¶

Returns a model entity’s label.

Return type:: Optional[str]
Returns:: Label of a model entity.

property Parent: ModelEntity¶

Returns a reference to the parent entity.

Return type:: ModelEntity
Returns:: Parent entity.

_parent: ModelEntity¶: Reference to a parent entity in the model.

_label: Nullable[str]¶: The label of a model entity.

class pyGHDL.dom.Sequential.SequentialReportStatement(reportNode, message, severity=None, label=None)[source]¶

Inheritance

Parameters:

reportNode (Iir) –
message (Union[BaseExpression, QualifiedExpression, FunctionCall, TypeConversion, Constant, ConstantSymbol, Variable, VariableSymbol, Signal, SignalSymbol, Literal]) –
severity (Union[BaseExpression, QualifiedExpression, FunctionCall, TypeConversion, Constant, ConstantSymbol, Variable, VariableSymbol, Signal, SignalSymbol, Literal]) –
label (str) –

__init__(reportNode, message, severity=None, label=None)[source]¶

Initializes a VHDL model entity.

Parameters:

reportNode (Iir) –
message (Union[BaseExpression, QualifiedExpression, FunctionCall, TypeConversion, Constant, ConstantSymbol, Variable, VariableSymbol, Signal, SignalSymbol, Literal]) –
severity (Union[BaseExpression, QualifiedExpression, FunctionCall, TypeConversion, Constant, ConstantSymbol, Variable, VariableSymbol, Signal, SignalSymbol, Literal]) –
label (str) –

property Label: Optional[str]¶

Returns a model entity’s label.

Return type:: Optional[str]
Returns:: Label of a model entity.

property Parent: ModelEntity¶

Returns a reference to the parent entity.

Return type:: ModelEntity
Returns:: Parent entity.

_parent: ModelEntity¶: Reference to a parent entity in the model.

_label: Nullable[str]¶: The label of a model entity.

class pyGHDL.dom.Sequential.NullStatement(waitNode, label=None)[source]¶

Inheritance

Parameters:

waitNode (Iir) –
label (str) –

__init__(waitNode, label=None)[source]¶

Initializes a VHDL model entity.

Parameters:

waitNode (Iir) –
label (Optional[str]) –

property Label: Optional[str]¶

Returns a model entity’s label.

Return type:: Optional[str]
Returns:: Label of a model entity.

property Parent: ModelEntity¶

Returns a reference to the parent entity.

Return type:: ModelEntity
Returns:: Parent entity.

_parent: ModelEntity¶: Reference to a parent entity in the model.

_label: Nullable[str]¶: The label of a model entity.

class pyGHDL.dom.Sequential.WaitStatement(waitNode, sensitivityList=None, condition=None, timeout=None, label=None)[source]¶

Inheritance

Parameters:

waitNode (Iir) –
sensitivityList (Iterable[Name]) –
condition (Union[BaseExpression, QualifiedExpression, FunctionCall, TypeConversion, Constant, ConstantSymbol, Variable, VariableSymbol, Signal, SignalSymbol, Literal]) –
timeout (Union[BaseExpression, QualifiedExpression, FunctionCall, TypeConversion, Constant, ConstantSymbol, Variable, VariableSymbol, Signal, SignalSymbol, Literal]) –
label (str) –

__init__(waitNode, sensitivityList=None, condition=None, timeout=None, label=None)[source]¶

Initializes a VHDL model entity.

Parameters:

waitNode (Iir) –
sensitivityList (Iterable[Name]) –
condition (Union[BaseExpression, QualifiedExpression, FunctionCall, TypeConversion, Constant, ConstantSymbol, Variable, VariableSymbol, Signal, SignalSymbol, Literal]) –
timeout (Union[BaseExpression, QualifiedExpression, FunctionCall, TypeConversion, Constant, ConstantSymbol, Variable, VariableSymbol, Signal, SignalSymbol, Literal]) –
label (str) –

property Label: Optional[str]¶

Returns a model entity’s label.

Return type:: Optional[str]
Returns:: Label of a model entity.

property Parent: ModelEntity¶

Returns a reference to the parent entity.

Return type:: ModelEntity
Returns:: Parent entity.

_parent: ModelEntity¶: Reference to a parent entity in the model.

_label: Nullable[str]¶: The label of a model entity.

pyGHDL.dom.Sequential¶

`pyGHDL.dom.Sequential`¶