DFConstantTie¶
DFConstantTie represents a constant value that can be driven onto any port. It is used in conjuction with DFConnection to provide tie-offs and constant value inputs to ports of a DFBlock.
As with every tag, DFConstantTie inherits from DFBase, so has support for all of the core attributes (id, description, and attributes). However DFConstantTie are not often named, or described, so the id and description properties may be left empty.
{
"id": "optional_id",
"description": "Optional free-form description - not often populated",
"value": 54531,
"reset": false,
"block": "my_root.my_block"
}
| Property | Usage |
|---|---|
| value | If reset is false, then the port is tied to this value |
| reset | When reset is true, the port is tied to the reset value of the DFInterconnect |
| block | Hierarchical path to the block that holds this DFConstantTie |
Python API¶
-
class
designformat.constant_tie.DFConstantTie(value='', reset=False, block=None)¶ DesignFormat representation of a tie to a constant value
-
__init__(value='', reset=False, block=None)¶ Constructor for the constant tie value
- Parameters
value – The constant value represented by this tie
reset – Ignore the value field, instead tie to the DFInterconnect’s reset value.
block – Reference to the block holding this tie
-
addConnection(conn)¶ Associate a DFConnection with this constant tie value
- Parameters
conn – The connection to associate
-
dumpObject(project)¶ Dump out this node so that it can be reloaded
- Parameters
project – Project definition used to calculate references
-
hierarchicalPath()¶ Returns the full hierarchical path to this block from the root
-
loadObject(obj, root)¶ Reload this node from passed in object.
- Parameters
obj – Description of this node
root – Root object in the tree
-
Javascript API¶
-
class
DFConstantTie(value, reset, block)¶ DesignFormat representation of a tie to a constant value
Constructor for the constant tie value
- Arguments
value (integer) – The constant value represented by this tie
reset (boolean) – Ignore the value field, instead tie to the DFInterconnect’s reset value.
block (DFBlock) – Reference to the block holding this tie
-
DFConstantTie.addConnection(conn)¶ Associate a DFConnection with this constant tie value
- Arguments
conn (DFConnection) – The connection to associate
-
DFConstantTie.dumpObject(project)¶ Dump out this node so that it can be reloaded
- Arguments
project (DFProject) – Project definition used to calculate references
-
DFConstantTie.hierarchicalPath()¶ Returns the full hierarchical path to this block from the root