amal.eda.ipxact_de.tgi.ipxact.v1685_2022 package

Submodules

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition module

Abstraction definition category TGI functions.

Provides traversal of ports, parameters, choices and basic metadata getters for AbstractionDefinition objects.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.addAbstractionDefChoice(abstractionDefinitionID, name)

Add a choice element.

Section: F.7.3.1.

A minimal enumeration entry is created automatically using name as the enumeration value to satisfy schema requirements.

Parameters:

• abstractionDefinitionID (str) – Handle of the parent abstractionDefinition.

• name (str) – Choice name.

Returns:

Handle of the created choice element.

Raises:

TgiError – If the abstractionDefinition handle is invalid.

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.addAbstractionDefPort(abstractionDefinitionID, logicalName, type)

Add an abstractionDefPort.

Section: F.7.3.2.

Creates a new port with the requested style. Supported type values: wire, transactional and packet. For packet an empty packets container is created; packet content must be added separately via addAbstractionDefPortPacket().

Parameters:

• abstractionDefinitionID (str) – Parent abstractionDefinition handle.

• logicalName (str) – Logical port name.

• type (str) – Port style (‘wire’, ‘transactional’, ‘packet’).

Returns:

Handle of the created port.

Raises:

TgiError – If the abstractionDefinition handle is invalid or the type is unsupported.

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.addAbstractionDefPortMode(abstractionDefPortID, mode)

Add a mode (initiator/target) to a port.

Section: F.7.3.3.

This helper creates onInitiator or onTarget entries for wire and transactional styles. System entries use dedicated onSystem add functions.

Parameters:

• abstractionDefPortID (str) – Port handle.

• mode (str) – ‘initiator’ or ‘target’.

Returns:

Handle of the created element (existing one reused if already present).

Raises:

TgiError – If the port handle is invalid or mode unsupported.

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.addAbstractionDefPortPacket(absDefPortID, packetName, packetFieldName, packetFieldWidth)

Add a port packet with one field.

Section: F.7.3.4.

Creates (if necessary) the packets container and adds a new packet with a single field.

Parameters:

• absDefPortID (str) – Port handle.

• packetName (str) – Packet name.

• packetFieldName (str) – Field name.

• packetFieldWidth (str) – Width expression string.

Returns:

Handle of the created packet element.

Raises:

TgiError – If the port handle is invalid.

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.addAbstractionDefPortTransactionalOnSystem(portID, group)

Add a transactional onSystem element.

Section: F.7.3.5.

Parameters:

• portID (str) – Transactional port handle.

• group (str) – Group name.

Returns:

Handle of the created onSystem element.

Raises:

TgiError – If the port is invalid or not transactional.

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.addAbstractionDefPortWireOnSystem(portID, group)

Add a wire onSystem element.

Section: F.7.3.6.

Parameters:

• portID (str) – Wire port handle.

• group (str) – Group name.

Returns:

Handle of the created onSystem element.

Raises:

TgiError – If the port is invalid or not wire style.

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.getAbstractionDefBusTypeRefByVLNV(abstractionDefinitionID)

Return busType VLNV tuple.

Section: F.7.2.1.

Parameters:

abstractionDefinitionID (str) – Handle to an abstractionDefinition (or instance) element.

Returns:

Tuple (vendor, library, name, version) with each item possibly None if the busType reference is absent.

Return type:

tuple[str | None, str | None, str | None, str | None]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.getAbstractionDefChoiceIDs(abstractionDefinitionID)

Return handles of all choice children.

Section: F.7.2.2.

Parameters:

abstractionDefinitionID (str) – Handle to an abstractionDefinition element.

Returns:

List of choice element handles (empty if none defined).

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.getAbstractionDefExtendsRefByVLNV(abstractionDefinitionID)

Return the extends VLNV tuple.

Section: F.7.2.3.

Parameters:

abstractionDefinitionID (str) – Handle to an abstractionDefinition element.

Returns:

Tuple (vendor, library, name, version) or all None if no extends present.

Return type:

tuple[str | None, str | None, str | None, str | None]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.getAbstractionDefPortIDs(abstractionDefinitionID)

Return handles of all logical ports.

Section: F.7.2.4.

Parameters:

abstractionDefinitionID (str) – Handle to an abstractionDefinition element.

Returns:

List of port handles (empty if no ports defined).

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.getAbstractionDefPortLogicalName(abstractionDefPortID)

Return the logicalName of a port.

Section: F.7.2.5.

Parameters:

abstractionDefPortID (str) – Handle to an abstractionDefPort element.

Returns:

Logical name string or None if not present.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.getAbstractionDefPortMatch(abstractionDefPortID)

Return the match flag of a port.

Section: F.7.2.6.

Parameters:

abstractionDefPortID (str) – Handle to an abstractionDefPort element.

Returns:

Boolean value or None if the element is absent.

Return type:

bool | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.getAbstractionDefPortOnSystemIDs(abstractionDefPortID)

Return handles of transactional onSystem elements.

Section: F.7.2.7 (transactional port context).

Parameters:

abstractionDefPortID (str) – Handle to an abstractionDefPort element.

Returns:

List of onSystem handles (empty if none or port not transactional).

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.getAbstractionDefPortPacketIDs(abstractionDefPortID)

Return handles of packet elements under the port.

Section: F.7.2.8.

Parameters:

abstractionDefPortID (str) – Handle to an abstractionDefPort element.

Returns:

List of packet handles (empty if none or not a packet style port).

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.getAbstractionDefPortStyle(abstractionDefPortModeID)

Return the style of a port (wire, transactional, packet).

Section: F.7.2.9.

Parameters:

abstractionDefPortModeID (str) – Handle to an abstractionDefPort element.

Returns:

Style string or None if style cannot be determined.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.getAbstractionDefPortTransactionalModeBusWidth(abstractionDefPortModeID)

Return transactional busWidth resolved value.

Section: F.7.2.10.

Parameters:

abstractionDefPortModeID (str) – Handle to a transactional abstractionDefPort element.

Returns:

Integer width or None if not specified / not transactional.

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.getAbstractionDefPortTransactionalModeBusWidthExpression(abstractionDefPortModeID)

Return transactional busWidth expression.

Section: F.7.2.11.

Parameters:

abstractionDefPortModeID (str) – Handle to a transactional port element.

Returns:

Expression string or None if absent.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.getAbstractionDefPortTransactionalModeBusWidthID(abstractionDefPortModeID)

Return handle to busWidth element.

Section: F.7.2.12.

Parameters:

abstractionDefPortModeID (str) – Handle to a transactional port element.

Returns:

Handle string or None if not present.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.getAbstractionDefPortTransactionalModeInitiative(abstractionDefPortModeID)

Return initiative value across loci.

Section: F.7.2.13.

Parameters:

abstractionDefPortModeID (str) – Handle to a transactional port element.

Returns:

Initiative enumeration value or None.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.getAbstractionDefPortTransactionalModeKindID(abstractionDefPortModeID)

Return handle to kind element.

Section: F.7.2.14.

Parameters:

abstractionDefPortModeID (str) – Handle to a transactional port element.

Returns:

Handle string or None if absent.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.getAbstractionDefPortTransactionalModePresence(abstractionDefPortModeID)

Return presence value.

Section: F.7.2.15.

Parameters:

abstractionDefPortModeID (str) – Handle to a transactional port element.

Returns:

Presence enumeration value or None.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.getAbstractionDefPortTransactionalModeProtocolID(abstractionDefPortModeID)

Return protocol handle.

Section: F.7.2.16.

Parameters:

abstractionDefPortModeID (str) – Handle to a transactional port element.

Returns:

Handle to protocol element or None.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.getAbstractionDefPortTransactionalOnInitiatorID(abstractionDefPortID)

Return transactional onInitiator handle.

Section: F.7.2.17.

Parameters:

abstractionDefPortID (str) – Handle to a transactional port element.

Returns:

Handle string or None if absent.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.getAbstractionDefPortTransactionalOnSystemIDs(abstractionDefPortID)

Return transactional onSystem handles.

Section: F.7.2.18.

Parameters:

abstractionDefPortID (str) – Handle to a transactional port element.

Returns:

List of handles (may be empty).

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.getAbstractionDefPortTransactionalOnTargetID(abstractionDefPortID)

Return transactional onTarget handle.

Section: F.7.2.19.

Parameters:

abstractionDefPortID (str) – Handle to a transactional port element.

Returns:

Handle string or None.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.getAbstractionDefPortTransactionalQualifierID(portID)

Return transactional qualifier handle.

Section: F.7.2.20.

Parameters:

portID (str) – Handle to a transactional port element.

Returns:

Handle string or None if absent.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.getAbstractionDefPortWireDefaultValue(abstractionDefPortID)

Return wire defaultValue numeric value.

Section: F.7.2.21.

Parameters:

abstractionDefPortID (str) – Handle to a wire port element.

Returns:

Integer value or None if not present / not wire.

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.getAbstractionDefPortWireDefaultValueExpression(abstractionDefPortID)

Return wire defaultValue expression.

Section: F.7.2.22.

Parameters:

abstractionDefPortID (str) – Handle to a wire port element.

Returns:

Expression string or None.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.getAbstractionDefPortWireDefaultValueID(abstractionDefPortModeID)

Return handle to wire defaultValue element.

Section: F.7.2.23.

Parameters:

abstractionDefPortModeID (str) – Handle to a wire port element.

Returns:

Handle string or None if absent.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.getAbstractionDefPortWireModeDirection(abstractionDefPortModeID)

Return wire direction.

Section: F.7.2.24.

Parameters:

abstractionDefPortModeID (str) – Handle to a wire port element.

Returns:

Direction enumeration or None.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.getAbstractionDefPortWireModeMirroredModeConstraintsID(abstractionDefPortModeID)

Return handle to mirroredModeConstraints.

Section: F.7.2.25.

Parameters:

abstractionDefPortModeID (str) – Handle to a wire port element.

Returns:

Handle string or None if absent.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.getAbstractionDefPortWireModeModeConstraintsID(abstractionDefPortModeID)

Return handle to modeConstraints.

Section: F.7.2.26.

Parameters:

abstractionDefPortModeID (str) – Handle to a wire port element.

Returns:

Handle string or None if not present.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.getAbstractionDefPortWireModePresence(abstractionDefPortModeID)

Return wire presence enumeration.

Section: F.7.2.27.

Parameters:

abstractionDefPortModeID (str) – Handle to a wire port element.

Returns:

Presence value string or None.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.getAbstractionDefPortWireModeWidth(abstractionDefPortModeID)

Return wire width numeric value.

Section: F.7.2.28.

Parameters:

abstractionDefPortModeID (str) – Handle to a wire port element.

Returns:

Integer width or None.

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.getAbstractionDefPortWireModeWidthExpression(abstractionDefPortModeID)

Return wire width expression.

Section: F.7.2.29.

Parameters:

abstractionDefPortModeID (str) – Handle to a wire port element.

Returns:

Expression string or None.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.getAbstractionDefPortWireModeWidthID(abstractionDefPortModeID)

Return handle of wire width element.

Section: F.7.2.30.

Parameters:

abstractionDefPortModeID (str) – Handle to a wire port element.

Returns:

Handle string or None if absent.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.getAbstractionDefPortWireOnInitiatorID(abstractionDefPortID)

F.7.2.31 Return handle to the wire onInitiator element.

Parameters:

abstractionDefPortID (str) – Handle to a logical wire port element.

Returns:

Handle to the onInitiator element or None if absent / not wire style.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.getAbstractionDefPortWireOnSystemIDs(portID)

F.7.2.32 Return handles to all wire onSystem elements.

Parameters:

portID (str) – Handle to a logical wire port element.

Returns:

List of onSystem element handles (may be empty).

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.getAbstractionDefPortWireOnTargetID(abstractionDefPortID)

F.7.2.33 Return handle to the wire onTarget element.

Parameters:

abstractionDefPortID (str) – Handle to a logical wire port element.

Returns:

Handle to onTarget element or None if absent / not wire style.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.getAbstractionDefPortWireQualifierID(portID)

F.7.2.34 Return handle to wire qualifier element.

Parameters:

portID (str) – Handle to a logical wire port element.

Returns:

Qualifier element handle or None if absent.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.getAbstractionDefPortWireRequiresDriver(abstractionDefPortID)

Return wire requiresDriver boolean value.

Section: F.7.2.35.

Parameters:

abstractionDefPortID (str) – Handle to a wire style abstractionDefPort element.

Returns:

Boolean value if the requiresDriver element is present, otherwise None if absent or the port is not wire style.

Return type:

bool | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.getAbstractionDefPortWireRequiresDriverID(abstractionDefPortModeID)

Return handle of wire requiresDriver element.

Section: F.7.2.36.

Parameters:

abstractionDefPortModeID (str) – Handle to a wire style abstractionDefPort element.

Returns:

Handle string if the requiresDriver element exists, otherwise None if absent or not a wire style port.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.getModeConstraintsDriveConstraintCellSpecificationID(modeConstraintsID)

Return handle to driveConstraint/cellSpecification.

Section: F.7.2.37.

Parameters:

modeConstraintsID (str) – Handle to a modeConstraints element.

Returns:

Handle to first cellSpecification element or None.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.getModeConstraintsLoadConstraintID(modeConstraintsID)

Return handle to loadConstraint.

Section: F.7.2.38.

Parameters:

modeConstraintsID (str) – Handle to a modeConstraints element.

Returns:

Handle string or None if absent.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.getModeConstraintsTimingConstraintIDs(modeConstraintsID)

Return timingConstraint handles.

Section: F.7.2.39.

Parameters:

modeConstraintsID (str) – Handle to a modeConstraints element.

Returns:

List of timingConstraint handles (possibly empty).

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.getOnSystemGroup(onSystemID)

Return onSystem group attribute.

Section: F.7.2.40.

Parameters:

onSystemID (str) – Handle to an onSystem element (transactional or wire).

Returns:

Group name string or None.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.getPacketEndianness(packetID)

Return packet endianness.

Section: F.7.2.41.

Parameters:

packetID (str) – Handle to a packet element.

Returns:

Endianness string (big/little) or None.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.getPacketFieldEndianness(packetFieldID)

Return packetField endianness.

Section: F.7.2.42.

Parameters:

packetFieldID (str) – Handle to a packetField element.

Returns:

Endianness string or None.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.getPacketFieldQualifierID(packetFieldID)

Return handle of packetField qualifier.

Section: F.7.2.43.

Parameters:

packetFieldID (str) – Handle to a packetField element.

Returns:

Qualifier handle string or None.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.getPacketFieldValue(packetFieldID)

Return numeric packetField value.

Section: F.7.2.44.

Parameters:

packetFieldID (str) – Handle to a packetField element.

Returns:

Integer value or None.

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.getPacketFieldValueExpression(packetFieldID)

Return packetField value expression.

Section: F.7.2.45.

Parameters:

packetFieldID (str) – Handle to a packetField element.

Returns:

Expression string or None.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.getPacketFieldWidth(packetFieldID)

Return packetField width numeric value.

Section: F.7.2.47.

Parameters:

packetFieldID (str) – Handle to a packetField element.

Returns:

Integer width or None.

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.getPacketFieldWidthExpression(packetFieldID)

Return packetField width expression.

Section: F.7.2.48.

Parameters:

packetFieldID (str) – Handle to a packetField element.

Returns:

Expression string or None.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.getPacketFieldWidthID(packetFieldID)

Return handle of packetField width element.

Section: F.7.2.49.

Parameters:

packetFieldID (str) – Handle to a packetField element.

Returns:

Width handle string or None.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.getPacketPacketFieldIDs(packetID)

Return packetField child handles of a packet.

Section: F.7.2.50.

Parameters:

packetID (str) – Handle to a packet element.

Returns:

List of packetField handles (possibly empty).

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.removeAbstractionDefChoice(choiceID)

Remove a choice element.

Section: F.7.3.9.

Parameters:

choiceID (str) – Choice handle.

Returns:

True if removed, False otherwise.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.removeAbstractionDefPort(portID)

Remove a port.

Section: F.7.3.11.

Parameters:

portID (str) – Port handle.

Returns:

True if removed, False otherwise.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.removeAbstractionDefPortMode(portModeID)

Remove a port mode element.

Section: F.7.3.13.

Parameters:

portModeID (str) – Handle of onInitiator/onTarget/onSystem element.

Returns:

True if removed, False otherwise.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.removeAbstractionDefPortTransactionalModeBusWidth(portID)

Remove transactional mode busWidth.

Section: F.7.3.14.

Parameters:

portID (str) – Handle of a transactional port.

Returns:

True if at least one busWidth element was removed, else False.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.removeAbstractionDefPortTransactionalModeInitiative(portID)

Remove transactional mode initiative across loci.

Section: F.7.3.15.

Parameters:

portID (str) – Transactional port handle.

Returns:

True if any initiative element cleared.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.removeAbstractionDefPortTransactionalModeKind(portID)

Remove transactional mode kind across loci.

Section: F.7.3.16.

Parameters:

portID (str) – Transactional port handle.

Returns:

True if any kind element cleared.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.removeAbstractionDefPortTransactionalModePresence(portID)

Remove transactional mode presence across loci.

Section: F.7.3.17.

Parameters:

portID (str) – Transactional port handle.

Returns:

True if any presence element cleared.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.removeAbstractionDefPortTransactionalModeProtocol(portID)

Remove transactional mode protocol across loci.

Section: F.7.3.18.

Parameters:

portID (str) – Transactional port handle.

Returns:

True if any protocol element cleared.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.removeAbstractionDefPortTransactionalOnInitiator(portID)

Remove the transactional onInitiator element.

Section: F.7.3.19.

Parameters:

portID (str) – Transactional port handle.

Returns:

True if removed, False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.removeAbstractionDefPortTransactionalOnSystem(onSystemID)

Remove a transactional onSystem element.

Section: F.7.3.20.

Parameters:

onSystemID (str) – onSystem handle.

Returns:

True if removed, False otherwise.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.removeAbstractionDefPortTransactionalOnTarget(portID)

Remove the transactional onTarget element.

Section: F.7.3.20.

Parameters:

portID (str) – Transactional port handle.

Returns:

True if removed, else False.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.removeAbstractionDefPortTransactionalQualifier(portID)

Remove transactional qualifier element.

Section: F.7.3.21.

Parameters:

portID (str) – Transactional port handle.

Returns:

True if qualifier removed.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.removeAbstractionDefPortWireModeDirection(portID)

Remove wire mode direction.

Section: F.7.3.22.

Parameters:

portID (str) – Wire port handle.

Returns:

True if direction removed.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.removeAbstractionDefPortWireModeMirroredModeConstraints(portID)

Remove mirroredModeConstraints.

Section: F.7.3.23.

Parameters:

portID (str) – Wire port handle.

Returns:

True if element removed.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.removeAbstractionDefPortWireModeModeConstraints(portID)

Remove modeConstraints.

Section: F.7.3.24.

Parameters:

portID (str) – Wire port handle.

Returns:

True if element removed.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.removeAbstractionDefPortWireModePresence(portID)

Remove wire mode presence.

Section: F.7.3.25.

Parameters:

portID (str) – Wire port handle.

Returns:

True if presence removed.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.removeAbstractionDefPortWireModeWidth(portID)

Remove wire mode width.

Section: F.7.3.26.

Parameters:

portID (str) – Wire port handle.

Returns:

True if width removed.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.removeAbstractionDefPortWireOnInitiator(portID)

Remove wire onInitiator (not explicitly modeled).

Section: F.7.3.27 (stub – underlying schema lacks explicit element).

Parameters:

portID (str) – Wire port handle.

Returns:

Always False (no separate element to remove).

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.removeAbstractionDefPortWireOnSystem(onSystemID)

Remove a wire onSystem element.

Section: F.7.3.30.

Parameters:

onSystemID (str) – onSystem handle.

Returns:

True if removed, False otherwise.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.removeAbstractionDefPortWireOnTarget(portID)

Remove wire onTarget (not explicitly modeled).

Section: F.7.3.28 (stub – underlying schema lacks explicit element).

Parameters:

portID (str) – Wire port handle.

Returns:

Always False.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.removeAbstractionDefPortWireQualifier(portID)

Remove wire qualifier.

Section: F.7.3.29.

Parameters:

portID (str) – Wire port handle.

Returns:

True if qualifier removed.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.removeAbstractionDefPortWireRequiresDriver(portID)

Remove requiresDriver.

Section: F.7.3.30.

Parameters:

portID (str) – Wire port handle.

Returns:

True if element removed.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.setAbstractionDefExtends(abstractionDefinitionID, vendor, library, name, version)

Set the extends reference.

Section: F.7.3.44.

Parameters:

• abstractionDefinitionID (str) – Abstraction definition handle.

• vendor (str) – Vendor string.

• library (str) – Library string.

• name (str) – Name string.

• version (str) – Version string.

Returns:

True on success.

Raises:

TgiError – If the handle is invalid.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.setAbstractionDefPortTransactional(portID)

Ensure port has transactional style container.

Section: F.7.3.56.

Parameters:

portID (str) – Port handle.

Returns:

True (idempotent create).

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.setAbstractionDefPortTransactionalModeBusWidth(portID, value)

Set transactional mode busWidth.

Section: F.7.3.48.

Parameters:

• portID (str) – Transactional port handle.

• value (int | str) – Integer or expression for width.

Returns:

True on success.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.setAbstractionDefPortTransactionalModeInitiative(portID, value)

Set transactional mode initiative (stored on initiator locus).

Section: F.7.3.49.

Parameters:

• portID (str) – Transactional port handle.

• value (str) – Initiative enumeration string.

Returns:

True on success.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.setAbstractionDefPortTransactionalModeKind(portID, value)

Set transactional mode kind (stored on initiator locus or raw string).

Section: F.7.3.50.

Parameters:

• portID (str) – Transactional port handle.

• value (str) – Kind enumeration string.

Returns:

True on success.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.setAbstractionDefPortTransactionalModePresence(portID, value)

Set transactional mode presence (initiator locus).

Section: F.7.3.51.

Parameters:

• portID (str) – Transactional port handle.

• value (str) – Presence enumeration string.

Returns:

True on success.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.setAbstractionDefPortTransactionalModeProtocol(portID, protocol)

Set transactional mode protocol (initiator locus).

Section: F.7.3.52.

Parameters:

• portID (str) – Transactional port handle.

• protocol (str) – Protocol enumeration / identifier string.

Returns:

True on success.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.setAbstractionDefPortTransactionalOnInitiator(portID)

Ensure presence of onInitiator element.

Section: F.7.3.53.

Parameters:

portID (str) – Transactional port handle.

Returns:

True (idempotent).

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.setAbstractionDefPortTransactionalOnTarget(portID)

Ensure presence of onTarget element.

Section: F.7.3.54.

Parameters:

portID (str) – Transactional port handle.

Returns:

True (idempotent).

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.setAbstractionDefPortTransactionalQualifier(portID, qualifier)

Set transactional qualifier.

Section: F.7.3.55.

Parameters:

• portID (str) – Transactional port handle.

• qualifier (str) – Qualifier string.

Returns:

True on success.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.setAbstractionDefPortWire(portID)

Ensure port has wire style container.

Section: F.7.3.57.

Parameters:

portID (str) – Port handle.

Returns:

True (idempotent create).

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.setAbstractionDefPortWireDefaultValue(portID, value)

Set wire defaultValue.

Section: F.7.3.58.

Parameters:

• portID (str) – Wire port handle.

• value (int | str) – Integer or expression string.

Returns:

True on success.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.setAbstractionDefPortWireModeDirection(portID, direction)

Set wire mode direction.

Section: F.7.3.59.

Parameters:

• portID (str) – Wire port handle.

• direction (str) – Direction enumeration string.

Returns:

True on success.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.setAbstractionDefPortWireModeMirroredModeConstraints(portID)

Create mirroredModeConstraints container.

Section: F.7.3.60.

Parameters:

portID (str) – Wire port handle.

Returns:

True on success.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.setAbstractionDefPortWireModeModeConstraints(portID)

Create modeConstraints container.

Section: F.7.3.61.

Parameters:

portID (str) – Wire port handle.

Returns:

True on success.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.setAbstractionDefPortWireModePresence(portID, value)

Set wire mode presence.

Section: F.7.3.62.

Parameters:

• portID (str) – Wire port handle.

• value (str) – Presence enumeration string.

Returns:

True on success.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.setAbstractionDefPortWireModeWidth(portID, value)

Set wire mode width.

Section: F.7.3.63.

Parameters:

• portID (str) – Wire port handle.

• value (int | str) – Integer or expression string.

Returns:

True on success.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.setAbstractionDefPortWireOnInitiator(portID)

Stub: ensure wire onInitiator (no-op).

Section: F.7.3.64 (schema does not expose a distinct element).

Parameters:

portID (str) – Wire port handle.

Returns:

True (no-op).

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.setAbstractionDefPortWireOnTarget(portID)

Stub: ensure wire onTarget (no-op).

Section: F.7.3.65 (schema does not expose a distinct element).

Parameters:

portID (str) – Wire port handle.

Returns:

True (no-op).

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.setAbstractionDefPortWireQualifier(portID, qualifier)

Set wire qualifier.

Section: F.7.3.66.

Parameters:

• portID (str) – Wire port handle.

• qualifier (str) – Qualifier string.

Returns:

True on success.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstraction_definition.setAbstractionDefPortWireRequiresDriver(portID, flag)

Set requiresDriver flag.

Section: F.7.3.67.

Parameters:

• portID (str) – Wire port handle.

• flag (bool) – Boolean value.

Returns:

True on success.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstractor module

Abstractor category TGI functions (IEEE 1685-2022).

Implements BASE (F.7.4) and EXTENDED (F.7.5) Abstractor functions. Only 2022 standard APIs are exposed here. Functions raise TgiError with TgiFaultCode.INVALID_ID for invalid handles and TgiFaultCode.INVALID_ARGUMENT for semantic violations as per the general TGI error model.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstractor.addAbstractorAbstractorGenerator(abstractorID, name, generatorExecutable)

Create and append an abstractorGenerator.

Section: F.7.5.1.

Parameters:

• abstractorID (str)

• name (str)

• generatorExecutable (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstractor.addAbstractorChoice(abstractorID, name)

Add a choice element with the given name (no enumerations yet).

Section: F.7.5.2.

Parameters:

• abstractorID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstractor.addAbstractorComponentInstantiation(abstractorID, name)

Add a componentInstantiation under model.instantiations.

Section: F.7.5.3.

Parameters:

• abstractorID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstractor.addAbstractorFileSet(abstractorID, name)

Add a new fileSet under the abstractor.

Section: F.7.5.4.

Parameters:

• abstractorID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstractor.addAbstractorInterfaceAbstractionType(abstractorID, interfaceIndex, abstractionRefVLNV)

Add an abstractionType to one of the two abstractorInterfaces.

Section: F.7.5.5. :param interfaceIndex: 0 or 1 selecting which of the two interfaces. :param abstractionRefVLNV: (vendor, library, name, version) of abstractionDef.

Parameters:

• abstractorID (str)

• interfaceIndex (int)

• abstractionRefVLNV (tuple[str, str, str, str])

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstractor.addAbstractorStructuredInterfacePort(abstractorID, name, subPortName, structPortTypeDefTypeName)

Add a structured interface port (adds a subPort reference).

Section: F.7.5.8.

Parameters:

• abstractorID (str)

• name (str)

• subPortName (str)

• structPortTypeDefTypeName (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstractor.addAbstractorStructuredStructPort(abstractorID, name, subPortName, structPortTypeDefTypeName, direction=None)

Add a structured structPort with direction.

Section: F.7.5.9.

Parameters:

• abstractorID (str)

• name (str)

• subPortName (str)

• structPortTypeDefTypeName (str)

• direction (str | None)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstractor.addAbstractorStructuredUnionPort(abstractorID, name, structPortTypeDefTypeName, subPortName, direction=None)

Add a structured unionPort with direction.

Section: F.7.5.10.

Parameters:

• abstractorID (str)

• name (str)

• structPortTypeDefTypeName (str)

• subPortName (str)

• direction (str | None)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstractor.addAbstractorTransactionalPort(abstractorID, name, initiative=None)

Add a transactional model port.

Section: F.7.5.6.

Parameters:

• abstractorID (str)

• name (str)

• initiative (str | None)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstractor.addAbstractorView(abstractorID, name)

Add a view element under model.views.

Section: F.7.5.11.

Parameters:

• abstractorID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstractor.addAbstractorWirePort(abstractorID, name, direction=None)

Add a wire model port.

Section: F.7.5.7.

Parameters:

• abstractorID (str)

• name (str)

• direction (str | None)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstractor.getAbstractorAbstractorGeneratorIDs(abstractorID)

Return handles of all abstractorGenerator children.

Section: F.7.4.1.

Parameters:

abstractorID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstractor.getAbstractorAbstractorInterfaceIDs(abstractorID)

Return handles of the exactly two abstractorInterface elements.

Section: F.7.4.2.

Parameters:

abstractorID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstractor.getAbstractorAbstractorMode(abstractorID)

Return (modeValue, group) for the abstractorMode element.

Section: F.7.4.3. Returns (None, None) if not present.

Parameters:

abstractorID (str)

Return type:

tuple[str | None, str | None]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstractor.getAbstractorAbstractorModeID(abstractorID)

Return handle of the abstractorMode element.

Section: F.7.4.4. Returns None if absent.

Parameters:

abstractorID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstractor.getAbstractorBusTypeRefByVLNV(abstractorID)

Return busType VLNV reference.

Section: F.7.4.5.

Parameters:

abstractorID (str)

Return type:

tuple[str | None, str | None, str | None, str | None]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstractor.getAbstractorChoiceIDs(abstractorID)

Return handles of choice children.

Section: F.7.4.6.

Parameters:

abstractorID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstractor.getAbstractorComponentInstantiationIDs(abstractorID)

Return handles of componentInstantiation elements in model.instantiations.

Section: F.7.4.7.

Parameters:

abstractorID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstractor.getAbstractorFileSetIDs(abstractorID)

Return handles of fileSet children.

Section: F.7.4.8.

Parameters:

abstractorID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstractor.getAbstractorInterfaceAbstractionTypeIDs(abstractorID)

Return handles of abstractionType elements of both abstractorInterfaces.

Section: F.7.4.9.

Parameters:

abstractorID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstractor.getAbstractorPortIDs(abstractorID)

Return handles of all abstractor model ports.

Section: F.7.4.10.

Parameters:

abstractorID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstractor.getAbstractorViewIDs(abstractorID)

Return handles of view elements in model.views.

Section: F.7.4.11.

Parameters:

abstractorID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstractor.removeAbstractorAbstractorGenerator(abstractorGeneratorID)

Remove an abstractorGenerator.

Section: F.7.5.12.

Parameters:

abstractorGeneratorID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstractor.removeAbstractorChoice(choiceID)

Remove a choice element.

Section: F.7.5.13.

Parameters:

choiceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstractor.removeAbstractorComponentInstantiation(componentInstantiationID)

Remove a componentInstantiation.

Section: F.7.5.14.

Parameters:

componentInstantiationID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstractor.removeAbstractorFileSet(fileSetID)

Remove a fileSet element.

Section: F.7.5.15.

Parameters:

fileSetID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstractor.removeAbstractorInterfaceAbstractionType(abstractionTypeID)

Remove an abstractionType from an abstractorInterface.

Section: F.7.5.16.

Parameters:

abstractionTypeID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstractor.removeAbstractorPort(portID)

Remove a model port (any style).

Section: F.7.5.17.

Parameters:

portID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstractor.removeAbstractorView(viewID)

Remove a model view.

Section: F.7.5.18.

Parameters:

viewID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstractor.setAbstractorAbstractorMode(abstractorID, modeValue, group=None)

Set/replace the abstractorMode element.

Section: F.7.5.19.

Parameters:

• abstractorID (str)

• modeValue (str)

• group (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.abstractor.setAbstractorBusType(abstractorID, vlnv)

Set/replace the busType reference.

Section: F.7.5.20.

Parameters:

• abstractorID (str)

• vlnv (tuple[str, str, str, str])

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_handle module

Access handle category TGI functions.

Implements BASE (F.7.7) and EXTENDED (F.7.8) access handle functions covering enumeration of accessHandle elements, indices, slices and viewRef children plus add/remove/set operations. Access handles appear underneath several IP-XACT objects (registers, fields, banks, etc.) inside an optional accessHandles container; this module centralizes traversal and mutation logic.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_handle.addAccessHandle(parentID, type)

Add an accessHandle of the requested type.

Section: F.7.8.1.

Supported type strings: simple, sliced, port.

Parameters:

• parentID (str) – Handle of element that can own accessHandles.

• type (str) – Variant to create.

Returns:

Handle of the created accessHandle.

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_handle.addAccessHandleIndex(accessHandleID, value)

Add an index element to a portAccessHandle.

Section: F.7.8.2.

Parameters:

• accessHandleID (str)

• value (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_handle.addAccessHandlePathSegment(accessHandleID, value)

Add a pathSegment to a simpleAccessHandle.

Section: F.7.8.3.

Parameters:

• accessHandleID (str)

• value (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_handle.addAccessHandleSlice(accessHandleID, value)

Add a slice element to a port or sliced accessHandle.

Section: F.7.8.4.

Parameters:

• accessHandleID (str)

• value (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_handle.addAccessHandleViewRef(accessHandleID, viewName)

Add a viewRef child to any accessHandle variant.

Section: F.7.8.5.

Parameters:

• accessHandleID (str)

• viewName (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_handle.getAccessHandleForce(accessHandleID)

Return the force attribute of a port/sliced handle.

Section: F.7.7.1.

Parameters:

accessHandleID (str) – Handle of a portAccessHandle or slicedAccessHandle.

Returns:

Boolean force value or None if the handle is simpleAccessHandle (which lacks the attribute) or the attribute is absent.

Return type:

bool | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_handle.getAccessHandleIDs(parentID)

Return handles of accessHandle children of a parent.

Section: F.7.7.2.

Parameters:

parentID (str) – Handle to an element that may own an accessHandles container.

Returns:

List of accessHandle handles (possibly empty).

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_handle.getAccessHandleIndicesIDs(accessHandleID)

Return index element handles of a portAccessHandle.

Section: F.7.7.3.

Parameters:

accessHandleID (str) – Handle referencing a portAccessHandle.

Returns:

List of index element handles (empty when none / wrong type).

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_handle.getAccessHandlePathSegmentIDs(accessHandleID)

Return pathSegment handles of a simpleAccessHandle.

Section: F.7.7.4.

Parameters:

accessHandleID (str) – Handle referencing a simpleAccessHandle.

Returns:

List of pathSegment handles (empty when none / different type).

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_handle.getAccessHandleSliceIDs(accessHandleID)

Return slice handles of a portAccessHandle or slicedAccessHandle.

Section: F.7.7.5.

Parameters:

accessHandleID (str) – Handle referencing a slicedAccessHandle or portAccessHandle.

Returns:

List of slice handles (empty when none or unsupported type).

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_handle.getAccessHandleViewRefIDs(accessHandleID)

Return viewRef handles for any accessHandle variant.

Section: F.7.7.6.

Parameters:

accessHandleID (str) – Handle referencing a simple/sliced/port accessHandle.

Returns:

List of viewRef handles (empty if none / invalid type).

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_handle.removeAccessHandle(accessHandleID)

Remove an accessHandle element.

Section: F.7.8.6.

Parameters:

accessHandleID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_handle.removeAccessHandleIndex(indexID)

Remove an index element.

Section: F.7.8.7.

Parameters:

indexID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_handle.removeAccessHandlePathSegment(pathSegmentID)

Remove a pathSegment element.

Section: F.7.8.8.

Parameters:

pathSegmentID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_handle.removeAccessHandleSlice(sliceID)

Remove a slice element (port/sliced variants).

Section: F.7.8.9.

Parameters:

sliceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_handle.removeAccessHandleViewRef(viewRefID)

Remove a viewRef element.

Section: F.7.8.10.

Parameters:

viewRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_handle.setAccessHandleForce(accessHandleID, value)

Set or clear the force attribute of a sliced/port accessHandle.

Section: F.7.8.11.

Parameters:

• accessHandleID (str) – Handle referencing a slicedAccessHandle or portAccessHandle.

• value (bool | None) – Boolean to set or None to clear (restore default semantics).

Returns:

True on success, False if not applicable.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy module

Access policy category TGI functions (IEEE 1685-2022 Annex F).

Implements full BASE and EXTENDED coverage: * F.7.6: Legacy single getter (kept for continuity). * F.7.9: 49 BASE traversal / getter functions. * F.7.10: 49 EXTENDED add/remove/set functions.

Conventions: * Docstrings start with “Section: F.x.y.z” mirroring the specification numbering. * Absent optional XML -> None (scalar) or [] (collections). * Invalid / mismatched handles raise TgiError(TgiFaultCode.INVALID_ID). * Semantic misuse raises TgiError(TgiFaultCode.INVALID_ARGUMENT). * Parent/child relationships registered via register_parent; removals delegate to detach_child_by_handle. * Only specification defined public functions are exported in __all__.

NOTE: Some spec items (e.g. externalTypeDefinitions link) are schema absent in the generated model; these raise INVALID_ARGUMENT to indicate unsupported elements rather than silently omitting the API.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.addAccessRestrictionModeRef(accessRestrictionID, modeRef, priority=None)

Section: F.7.10.1 Add a modeRef to an accessRestriction.

Parameters:

• accessRestrictionID (str)

• modeRef (str)

• priority (int | None)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.addAddressBlockAccessPolicy(addressBlockID)

Section: F.7.10.2 Add accessPolicy to addressBlock.

Parameters:

addressBlockID (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.addAlternateRegisterAccessPolicy(registerID)

Section: F.7.10.3 Add accessPolicy to alternateRegister.

Parameters:

registerID (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.addExternalTypeDefinitionsResetTypeLink(*_args, **_kwargs)

Section: F.7.10.4 Not supported by generated schema (externalTypeDefinitions).

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.addFieldAccessPoliciesFieldAccessPolicy(fieldAccessPoliciesID)

Section: F.7.10.5 Add fieldAccessPolicy to fieldAccessPolicies.

Parameters:

fieldAccessPoliciesID (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.addFieldAccessPolicyAccessRestriction(fieldAccessPolicyID)

Section: F.7.10.6 Add accessRestriction to fieldAccessPolicy.

Parameters:

fieldAccessPolicyID (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.addFieldAccessPolicyBroadcastTo(fieldAccessPolicyID, memoryMapRef=None, addressBlockRef=None, registerRef=None, fieldRef=None)

Section: F.7.10.7 Add broadcastTo element to fieldAccessPolicy (subset of refs).

Parameters:

• fieldAccessPolicyID (str)

• memoryMapRef (str | None)

• addressBlockRef (str | None)

• registerRef (str | None)

• fieldRef (str | None)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.addFieldAccessPolicyModeRef(fieldAccessPolicyID, modeRef, priority=None)

Section: F.7.10.8 Add modeRef to fieldAccessPolicy.

Parameters:

• fieldAccessPolicyID (str)

• modeRef (str)

• priority (int | None)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.addFieldDefinitionFieldAccessPolicy(fieldDefinitionID)

Section: F.7.10.9 Add fieldAccessPolicy to a fieldDefinition (create container if absent).

Parameters:

fieldDefinitionID (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.addRegisterAccessPolicy(registerID)

Section: F.7.10.10 Add accessPolicy to register.

Parameters:

registerID (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.addRegisterFileAccessPolicy(registerFileID)

Section: F.7.10.11 Add accessPolicy to registerFile.

Parameters:

registerFileID (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getAccessPolicyAccess(accessPolicyID)

Section: F.7.9.1 Return access value of an accessPolicy.

Parameters:

accessPolicyID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getAccessPolicyModeRefByID(accessPolicyID, modeRef)

Section: F.7.9.2 Return handle of named modeRef in accessPolicy.

Parameters:

• accessPolicyID (str)

• modeRef (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getAccessPolicyModeRefByNames(accessPolicyID)

Section: F.7.9.3 Return list of modeRef names in accessPolicy.

Parameters:

accessPolicyID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getAccessPolicyModeRefIDs(accessPolicyID)

Section: F.7.9.4 Return handles of modeRef elements in accessPolicy.

Parameters:

accessPolicyID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getAccessRestrictionModeRefIDs(accessRestrictionID)

Section: F.7.9.5 Return modeRef handles of an accessRestriction.

Parameters:

accessRestrictionID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getAccessRestrictionModeRefbyID(accessRestrictionID, modeRef)

Section: F.7.9.6 Return handle of named modeRef in accessRestriction.

Parameters:

• accessRestrictionID (str)

• modeRef (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getAccessRestrictionModeRefbyNames(accessRestrictionID)

Section: F.7.9.7 Return list of modeRef names in accessRestriction.

Parameters:

accessRestrictionID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getAccessRestrictionReadAccessMask(accessRestrictionID)

Section: F.7.9.8 Return numeric readAccessMask value (if simple expression).

Parameters:

accessRestrictionID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getAccessRestrictionReadAccessMaskExpression(accessRestrictionID)

Section: F.7.9.9 Return readAccessMask expression string.

Parameters:

accessRestrictionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getAccessRestrictionReadAccessMaskID(accessRestrictionID)

Section: F.7.9.10 Return handle of readAccessMask element.

Parameters:

accessRestrictionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getAccessRestrictionWriteAccessMask(accessRestrictionID)

Section: F.7.9.11 Return numeric writeAccessMask value.

Parameters:

accessRestrictionID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getAccessRestrictionWriteAccessMaskExpression(accessRestrictionID)

Section: F.7.9.12 Return writeAccessMask expression string.

Parameters:

accessRestrictionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getAccessRestrictionWriteAccessMaskID(accessRestrictionID)

Section: F.7.9.13 Return handle of writeAccessMask element.

Parameters:

accessRestrictionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getAlternateRegisterAccessPolicyIDs(alternateRegisterID)

Section: F.7.9.14 Return accessPolicy handles of an alternateRegister.

Parameters:

alternateRegisterID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getBankAccessPoliciesIDs(bankID)

Section: F.7.9.15 Return accessPolicy handles of a bank.

Parameters:

bankID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getFieldAccessPoliciesFieldAccessPolicyIDs(fieldAccessPoliciesID)

Section: F.7.9.16 Return fieldAccessPolicy handles inside fieldAccessPolicies.

Parameters:

fieldAccessPoliciesID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getFieldAccessPolicyAccess(fieldAccessPolicyID)

Section: F.7.9.17 Return access value of a fieldAccessPolicy.

Parameters:

fieldAccessPolicyID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getFieldAccessPolicyAccessRestrictionIDs(fieldAccessPolicyID)

Section: F.7.9.18 Return accessRestriction handles of a fieldAccessPolicy.

Parameters:

fieldAccessPolicyID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getFieldAccessPolicyDefinitionAccess(definitionID)

Section: F.7.9 Get access value of a fieldAccessPolicyDefinition.

Parameters:

definitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getFieldAccessPolicyDefinitionDescription(definitionID)

Section: F.7.9 Get description of a fieldAccessPolicyDefinition.

Parameters:

definitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getFieldAccessPolicyDefinitionDisplayName(definitionID)

Section: F.7.9 Get displayName of a fieldAccessPolicyDefinition.

Parameters:

definitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getFieldAccessPolicyDefinitionIDs(fieldAccessPolicyDefinitionsID)

Section: F.7.9 Return handles of fieldAccessPolicyDefinition children.

Parameters:

fieldAccessPolicyDefinitionsID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getFieldAccessPolicyDefinitionModifiedWriteValue(definitionID)

Section: F.7.9 Get modifiedWriteValue of a fieldAccessPolicyDefinition.

Parameters:

definitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getFieldAccessPolicyDefinitionName(definitionID)

Section: F.7.9 Get name of a fieldAccessPolicyDefinition.

Parameters:

definitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getFieldAccessPolicyDefinitionReadAction(definitionID)

Section: F.7.9 Get readAction of a fieldAccessPolicyDefinition.

Parameters:

definitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getFieldAccessPolicyDefinitionReadResponse(definitionID)

Section: F.7.9 Get readResponse of a fieldAccessPolicyDefinition.

Parameters:

definitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getFieldAccessPolicyDefinitionShortDescription(definitionID)

Section: F.7.9 Get shortDescription of a fieldAccessPolicyDefinition.

Parameters:

definitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getFieldAccessPolicyDefinitionWriteValueConstraint(definitionID)

Section: F.7.9 Get writeValueConstraint (string) of a fieldAccessPolicyDefinition.

Parameters:

definitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getFieldAccessPolicyFieldAccessPolicyDefinitionRefByExternalTypeDefID(fieldAccessPolicyID)

Section: F.7.9.19 externalTypeDefinitions not represented -> raise INVALID_ARGUMENT.

Parameters:

fieldAccessPolicyID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getFieldAccessPolicyFieldAccessPolicyDefinitionRefByID(fieldAccessPolicyID)

Section: F.7.9.20 Definition reference resolves by name only -> return None.

Parameters:

fieldAccessPolicyID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getFieldAccessPolicyFieldAccessPolicyDefinitionRefByName(fieldAccessPolicyID)

Section: F.7.9.21 Return definition name from fieldAccessPolicyDefinitionRef.

Parameters:

fieldAccessPolicyID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getFieldAccessPolicyFieldAccessPolicyDefinitionRefID(fieldAccessPolicyID)

Section: F.7.9.22 Return handle of fieldAccessPolicyDefinitionRef element.

Parameters:

fieldAccessPolicyID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getFieldAccessPolicyModeRefByID(fieldAccessPolicyID, modeRefID)

Section: F.7.6.1 Return handle of indexed modeRef of a fieldAccessPolicy.

Parameters:

• fieldAccessPolicyID (str)

• modeRefID (int)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getFieldAccessPolicyModeRefByName(fieldAccessPolicyID)

Section: F.7.9.23 Return list of modeRef names of a fieldAccessPolicy.

Parameters:

fieldAccessPolicyID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getFieldAccessPolicyModeRefIDs(fieldAccessPolicyID)

Section: F.7.9.24 Return modeRef handles for a fieldAccessPolicy.

Parameters:

fieldAccessPolicyID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getFieldAccessPolicyModifiedWriteValue(fieldAccessPolicyID)

Section: F.7.9.25 Return modifiedWriteValue value.

Parameters:

fieldAccessPolicyID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getFieldAccessPolicyModifiedWriteValueID(fieldAccessPolicyID)

Section: F.7.9.26 Return handle of modifiedWriteValue element.

Parameters:

fieldAccessPolicyID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getFieldAccessPolicyReadAction(fieldAccessPolicyID)

Section: F.7.9.27 Return readAction value.

Parameters:

fieldAccessPolicyID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getFieldAccessPolicyReadActionID(fieldAccessPolicyID)

Section: F.7.9.28 Return handle of readAction element.

Parameters:

fieldAccessPolicyID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getFieldAccessPolicyReadResponse(fieldAccessPolicyID)

Section: F.7.9.29 Return numeric readResponse value.

Parameters:

fieldAccessPolicyID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getFieldAccessPolicyReadResponseExpression(fieldAccessPolicyID)

Section: F.7.9.30 Return readResponse expression string.

Parameters:

fieldAccessPolicyID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getFieldAccessPolicyReadResponseID(fieldAccessPolicyID)

Section: F.7.9.31 Return handle of readResponse element.

Parameters:

fieldAccessPolicyID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getFieldAccessPolicyReserved(fieldAccessPolicyID)

Section: F.7.9.32 Return reserved numeric value.

Parameters:

fieldAccessPolicyID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getFieldAccessPolicyReservedExpression(fieldAccessPolicyID)

Section: F.7.9.33 Return reserved expression string.

Parameters:

fieldAccessPolicyID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getFieldAccessPolicyReservedID(fieldAccessPolicyID)

Section: F.7.9.34 Return handle of reserved element.

Parameters:

fieldAccessPolicyID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getFieldAccessPolicyTestable(fieldAccessPolicyID)

Section: F.7.9.35 Return testable boolean value.

Parameters:

fieldAccessPolicyID (str)

Return type:

bool | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getFieldAccessPolicyTestableID(fieldAccessPolicyID)

Section: F.7.9.36 Return handle of testable element.

Parameters:

fieldAccessPolicyID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getFieldAccessPolicyWriteValueConstraintID(fieldAccessPolicyID)

Section: F.7.9.37 Return handle of writeValueConstraint element.

Parameters:

fieldAccessPolicyID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getFieldAccesspolicyBroadcastToIDs(fieldAccessPolicyID)

Section: F.7.9.38 Return broadcastTo handles under broadcasts.

Parameters:

fieldAccessPolicyID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getRegisterAccessPolicyIDs(registerID)

Section: F.7.9.39 Return accessPolicy handles of a register.

Parameters:

registerID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getRegisterFieldFieldAccessPoliciesID(registerFieldID)

Section: F.7.9.40 Return handle of fieldAccessPolicies container on a field.

Parameters:

registerFieldID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getTypeDefinitionsFieldAccessPolicyDefinitionIDs(typeDefinitionsID)

Section: F.7.9.41 Return fieldAccessPolicyDefinition handles under typeDefinitions.

Parameters:

typeDefinitionsID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getWriteValueConstraintMaximum(writeValueConstraintID)

Section: F.7.9.42 Return maximum numeric value.

Parameters:

writeValueConstraintID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getWriteValueConstraintMaximumExpression(writeValueConstraintID)

Section: F.7.9.43 Return maximum expression string.

Parameters:

writeValueConstraintID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getWriteValueConstraintMaximumID(writeValueConstraintID)

Section: F.7.9.44 Return handle of maximum element.

Parameters:

writeValueConstraintID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getWriteValueConstraintMinimum(writeValueConstraintID)

Section: F.7.9.45 Return minimum numeric value.

Parameters:

writeValueConstraintID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getWriteValueConstraintMinimumExpression(writeValueConstraintID)

Section: F.7.9.46 Return minimum expression string.

Parameters:

writeValueConstraintID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getWriteValueConstraintMinimumID(writeValueConstraintID)

Section: F.7.9.47 Return handle of minimum element.

Parameters:

writeValueConstraintID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getWriteValueConstraintUseEnumeratedValues(writeValueConstraintID)

Section: F.7.9.48 Return useEnumeratedValues flag.

Parameters:

writeValueConstraintID (str)

Return type:

bool | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.getWriteValueConstraintWriteAsRead(writeValueConstraintID)

Section: F.7.9.49 Return writeAsRead flag.

Parameters:

writeValueConstraintID (str)

Return type:

bool | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.removeAccessPolicyAccess(accessPolicyID)

Section: F.7.10.12 Remove access element from accessPolicy.

Parameters:

accessPolicyID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.removeAccessRestrictionModeRef(modeRefID)

Section: F.7.10.13 Remove a modeRef from an accessRestriction.

Parameters:

modeRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.removeAccessRestrictionReadAccessMask(accessRestrictionID)

Section: F.7.10.14 Remove readAccessMask element.

Parameters:

accessRestrictionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.removeAccessRestrictionWriteAccessMask(accessRestrictionID)

Section: F.7.10.15 Remove writeAccessMask element.

Parameters:

accessRestrictionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.removeAddressBlockAccessPolicyID(accessPolicyID)

Section: F.7.10.16 Remove accessPolicy (addressBlock container).

Parameters:

accessPolicyID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.removeAlternateRegisterAccessPolicy(accessPolicyID)

Section: F.7.10.17 Remove accessPolicy (alternateRegister container).

Parameters:

accessPolicyID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.removeFieldAccessPoliciesFieldAccessPolicy(fieldAccessPoliciesID, fieldAccessPolicyID)

Section: F.7.10.18 Remove fieldAccessPolicy from fieldAccessPolicies.

Parameters:

• fieldAccessPoliciesID (str)

• fieldAccessPolicyID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.removeFieldAccessPolicyAccess(fieldAccessPolicyID)

Section: F.7.10.19 Remove access from fieldAccessPolicy.

Parameters:

fieldAccessPolicyID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.removeFieldAccessPolicyAccessRestriction(accessRestrictionID)

Section: F.7.10.20 Remove accessRestriction.

Parameters:

accessRestrictionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.removeFieldAccessPolicyBroadcastTo(broadcastToID)

Section: F.7.10.21 Remove broadcastTo element.

Parameters:

broadcastToID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.removeFieldAccessPolicyFieldAccessPolicyDefinitionRef(fieldAccessPolicyID)

Section: F.7.10.22 Remove fieldAccessPolicyDefinitionRef.

Parameters:

fieldAccessPolicyID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.removeFieldAccessPolicyModeRef(modeRefID)

Section: F.7.10.23 Remove fieldAccessPolicy modeRef.

Parameters:

modeRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.removeFieldAccessPolicyModifiedWriteValue(fieldAccessPolicyID)

Section: F.7.10.24 Remove modifiedWriteValue.

Parameters:

fieldAccessPolicyID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.removeFieldAccessPolicyReadAction(fieldAccessPolicyID)

Section: F.7.10.25 Remove readAction.

Parameters:

fieldAccessPolicyID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.removeFieldAccessPolicyReadResponse(fieldAccessPolicyID)

Section: F.7.10.26 Remove readResponse.

Parameters:

fieldAccessPolicyID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.removeFieldAccessPolicyReserved(fieldAccessPolicyID)

Section: F.7.10.27 Remove reserved.

Parameters:

fieldAccessPolicyID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.removeFieldAccessPolicyTestable(fieldAccessPolicyID)

Section: F.7.10.28 Remove testable.

Parameters:

fieldAccessPolicyID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.removeFieldAccessPolicyWriteValueConstraint(fieldAccessPolicyID)

Section: F.7.10.29 Remove writeValueConstraint.

Parameters:

fieldAccessPolicyID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.removeFieldDefinitionFieldAccessPolicy(accessPolicyID)

Section: F.7.10.30 Remove fieldAccessPolicy from fieldDefinition.

Parameters:

accessPolicyID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.removeRegisterAccessPolicy(accessPolicyID)

Section: F.7.10.31 Remove accessPolicy from register.

Parameters:

accessPolicyID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.removeRegisterFileAccessPolicy(accessPolicyID)

Section: F.7.10.32 Remove accessPolicy from registerFile.

Parameters:

accessPolicyID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.setAccessPolicyAccess(accessPolicyID, access)

Section: F.7.10.33 Set access value on accessPolicy.

Parameters:

• accessPolicyID (str)

• access (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.setAccessRestrictionReadAccessMask(accessRestrictionID, value)

Section: F.7.10.34 Set readAccessMask expression/value.

Parameters:

• accessRestrictionID (str)

• value (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.setAccessRestrictionWriteAccessMask(accessRestrictionID, value)

Section: F.7.10.35 Set writeAccessMask expression/value.

Parameters:

• accessRestrictionID (str)

• value (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.setFieldAccessPolicyAccess(fieldAccessPolicyID, access)

Section: F.7.10.36 Set access of fieldAccessPolicy.

Parameters:

• fieldAccessPolicyID (str)

• access (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.setFieldAccessPolicyFieldAccessPolicyDefinitionRef(fieldAccessPolicyID, name, typeDefinitions=None)

Section: F.7.10.37 Set fieldAccessPolicyDefinitionRef values.

Parameters:

• fieldAccessPolicyID (str)

• name (str)

• typeDefinitions (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.setFieldAccessPolicyModifiedWriteValue(fieldAccessPolicyID, value, modify=None)

Section: F.7.10.38 Set modifiedWriteValue element.

Parameters:

• fieldAccessPolicyID (str)

• value (str)

• modify (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.setFieldAccessPolicyReadAction(fieldAccessPolicyID, value)

Section: F.7.10.39 Set readAction element.

Parameters:

• fieldAccessPolicyID (str)

• value (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.setFieldAccessPolicyReadResponse(fieldAccessPolicyID, value)

Section: F.7.10.40 Set readResponse element.

Parameters:

• fieldAccessPolicyID (str)

• value (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.setFieldAccessPolicyReserved(fieldAccessPolicyID, value)

Section: F.7.10.41 Set reserved element.

Parameters:

• fieldAccessPolicyID (str)

• value (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.setFieldAccessPolicyTestable(fieldAccessPolicyID, value, testConstraint=None)

Section: F.7.10.42 Set testable (boolean + optional constraint).

Parameters:

• fieldAccessPolicyID (str)

• value (bool)

• testConstraint (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.setFieldAccessPolicyWriteValueConstraintMinMax(fieldAccessPolicyID, minimum, maximum)

Section: F.7.10.43 Set minimum/maximum on writeValueConstraint (create if absent).

Parameters:

• fieldAccessPolicyID (str)

• minimum (str | None)

• maximum (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.setFieldAccessPolicyWriteValueConstraintUseEnumeratedValue(fieldAccessPolicyID, value)

Section: F.7.10.44 Set useEnumeratedValues flag.

Parameters:

• fieldAccessPolicyID (str)

• value (bool)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.setFieldAccessPolicyWriteValueConstraintWriteAsRead(fieldAccessPolicyID, value)

Section: F.7.10.45 Set writeAsRead flag.

Parameters:

• fieldAccessPolicyID (str)

• value (bool)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.setWriteValueConstraintMaximum(writeValueConstraintID, maximum)

Section: F.7.10.46 Set maximum element (None clears).

Parameters:

• writeValueConstraintID (str)

• maximum (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.setWriteValueConstraintMinimum(writeValueConstraintID, minimum)

Section: F.7.10.47 Set minimum element (None clears).

Parameters:

• writeValueConstraintID (str)

• minimum (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.setWriteValueConstraintUseEnumeratedValues(writeValueConstraintID, value)

Section: F.7.10.48 Set useEnumeratedValues flag (None clears).

Parameters:

• writeValueConstraintID (str)

• value (bool | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.access_policy.setWriteValueConstraintWriteAsRead(writeValueConstraintID, value)

Section: F.7.10.49 Set writeAsRead flag (None clears).

Parameters:

• writeValueConstraintID (str)

• value (bool | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.address_space module

Address space category TGI functions (IEEE 1685-2022).

Implements BASE (F.7.11) and EXTENDED (F.7.12) Address space functions. Only the 2022 schema is supported. Functions raise TgiError with TgiFaultCode.INVALID_ID for invalid handles and TgiFaultCode.INVALID_ARGUMENT for semantic violations.

Returned numeric getters follow the project convention of returning int | None for resolved numeric value and separate Expression getters returning the (string) expression as str | None. ID getters return a child handle or None and list traversal getters return an empty list if no children of the requested type exist.

Creation / mutation helpers create missing optional container elements where allowed by the schema.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.address_space.addAddressSpaceSegment(addressSpaceID, name, addressOffsetExpr, rangeExpr)

Create and append a segment to an addressSpace.

Section: F.7.12.1.

Parameters:

• addressSpaceID (str) – Parent addressSpace handle.

• name (str) – New segment name.

• addressOffsetExpr (str) – Expression for addressOffset.

• rangeExpr (str) – Expression for range.

Returns:

Handle of the newly created segment.

Return type:

str

Raises:

TgiError – If the parent handle is invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.address_space.addExecutableImageFileSetRef(addressSpaceID, fileSetName)

Add an executableImage fileSetRef (stub).

Section: F.7.12.2.

The 2022 generated schema in this project does not include the executable image container; this function therefore validates the parent handle and returns None.

Parameters:

• addressSpaceID (str) – Address space handle.

• fileSetName (str) – Name of the fileSet to reference (unused in stub).

Returns:

Always None until schema support is added.

Return type:

None

Raises:

TgiError – If the addressSpace handle is invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.address_space.addLocalMemoryMapAddressBlock(localMemoryMapID, name, baseAddressExpr, rangeExpr, widthExpr)

Create and append an addressBlock to a localMemoryMap.

Section: F.7.12.3.

Parameters:

• localMemoryMapID (str) – Parent localMemoryMap handle.

• name (str) – New addressBlock name.

• baseAddressExpr (str) – Expression for baseAddress.

• rangeExpr (str) – Expression for range.

• widthExpr (str) – Expression for width.

Returns:

Handle of the newly created addressBlock.

Return type:

str

Raises:

TgiError – If the localMemoryMap handle is invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.address_space.getAddressSpaceAddressUnitBits(addressSpaceID)

Get the evaluated integer value of addressUnitBits.

Section: F.7.11.1.

Parameters:

addressSpaceID (str) – Handle referencing an addressSpace element.

Returns:

Evaluated numeric value, or None when the element is absent or not numerically evaluable.

Return type:

int | None

Raises:

TgiError – If addressSpaceID is invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.address_space.getAddressSpaceAddressUnitBitsExpression(addressSpaceID)

Get the (string) expression of addressUnitBits.

Section: F.7.11.2.

Parameters:

addressSpaceID (str) – Handle of the parent addressSpace.

Returns:

Original expression string (not evaluated) or None if absent.

Return type:

str | None

Raises:

TgiError – If addressSpaceID is invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.address_space.getAddressSpaceAddressUnitBitsID(addressSpaceID)

Get the handle of the addressUnitBits element.

Section: F.7.11.3.

Parameters:

addressSpaceID (str) – Handle referencing an addressSpace.

Returns:

Child handle or None if element absent.

Return type:

str | None

Raises:

TgiError – If the parent handle is invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.address_space.getAddressSpaceLocalMemoryMapID(addressSpaceID)

Get the handle of the localMemoryMap element.

Section: F.7.11.4.

Parameters:

addressSpaceID (str) – Handle referencing an addressSpace.

Returns:

Handle of the localMemoryMap child or None if absent.

Return type:

str | None

Raises:

TgiError – If the parent handle is invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.address_space.getAddressSpaceRange(addressSpaceID)

Get evaluated numeric value of range.

Section: F.7.11.5.

Parameters:

addressSpaceID (str) – Handle of the addressSpace.

Returns:

Numeric value or None if absent or not evaluable.

Return type:

int | None

Raises:

TgiError – If the addressSpace handle is invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.address_space.getAddressSpaceRangeExpression(addressSpaceID)

Get expression string for range.

Section: F.7.11.6.

Parameters:

addressSpaceID (str) – Address space handle.

Returns:

Expression or None if absent.

Return type:

str | None

Raises:

TgiError – If handle invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.address_space.getAddressSpaceRangeID(addressSpaceID)

Get handle of the range element.

Section: F.7.11.7.

Parameters:

addressSpaceID (str) – Handle referencing an addressSpace.

Returns:

Child handle or None when absent.

Return type:

str | None

Raises:

TgiError – If parent handle invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.address_space.getAddressSpaceSegmentIDs(addressSpaceID)

List handles of segment children.

Section: F.7.11.8.

Parameters:

addressSpaceID (str) – Address space handle.

Returns:

List (possibly empty) of segment handles.

Return type:

list[str]

Raises:

TgiError – If parent handle invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.address_space.getAddressSpaceWidth(addressSpaceID)

Get evaluated numeric width value.

Section: F.7.11.9.

Parameters:

addressSpaceID (str) – Address space handle.

Returns:

Numeric width or None if absent or not evaluable.

Return type:

int | None

Raises:

TgiError – If handle invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.address_space.getAddressSpaceWidthExpression(addressSpaceID)

Get expression string for width.

Section: F.7.11.10.

Parameters:

addressSpaceID (str) – Address space handle.

Returns:

Expression or None when absent.

Return type:

str | None

Raises:

TgiError – If handle invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.address_space.getAddressSpaceWidthID(addressSpaceID)

Get handle of the width element.

Section: F.7.11.11.

Parameters:

addressSpaceID (str) – Address space handle.

Returns:

Child handle or None if absent.

Return type:

str | None

Raises:

TgiError – If parent handle invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.address_space.getAliasOfAddressSpaceRefByName(addressSpaceID)

Get the name of the referenced addressSpace when this one is an alias.

Section: F.7.11.12.

Note

The 2022 generated schema currently exposes no aliasOf element for addressSpace; this function therefore returns None (stub).

Parameters:

addressSpaceID (str) – Address space handle (validated for existence only).

Returns:

Referenced addressSpace name or None (schema gap).

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.address_space.getAliasOfAddressSpaceRefID(addressSpaceID)

Get the handle of the alias reference element.

Section: F.7.11.13.

Note

Not present in current schema; always returns None (stub).

Parameters:

addressSpaceID (str) – Address space handle (validated for existence).

Returns:

Always None until schema models aliasOf.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.address_space.getLocalMemoryMapAddressBlockIDs(localMemoryMapID)

List addressBlock handles in a localMemoryMap.

Section: F.7.11.14.

Parameters:

localMemoryMapID (str) – Handle referencing a localMemoryMap.

Returns:

Handles of contained addressBlock elements (empty if none).

Return type:

list[str]

Raises:

TgiError – If handle invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.address_space.getLocalMemoryMapBankIDs(localMemoryMapID)

List bank handles within a localMemoryMap.

Section: F.7.11.15.

Parameters:

localMemoryMapID (str) – Handle referencing a localMemoryMap.

Returns:

Bank handles (empty list if none present).

Return type:

list[str]

Raises:

TgiError – If handle invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.address_space.getRegionAddressOffset(segmentID)

Get numeric value of a region (segment) addressOffset.

Section: F.7.11.16.

Parameters:

segmentID (str) – Handle referencing a segment.

Returns:

Evaluated offset or None if absent or not evaluable.

Return type:

int | None

Raises:

TgiError – If segment handle invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.address_space.getRegionAddressOffsetExpression(segmentID)

Get expression string of a segment addressOffset.

Section: F.7.11.17.

Parameters:

segmentID (str) – Segment handle.

Returns:

Expression string or None if missing.

Return type:

str | None

Raises:

TgiError – If handle invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.address_space.getRegionAddressOffsetID(segmentID)

Get handle of the segment addressOffset element.

Section: F.7.11.18.

Parameters:

segmentID (str) – Segment handle.

Returns:

Child handle or None when element absent.

Return type:

str | None

Raises:

TgiError – If handle invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.address_space.getRegionRange(segmentID)

Get numeric value of a segment range.

Section: F.7.11.19.

Parameters:

segmentID (str) – Segment handle.

Returns:

Numeric range value or None if absent/not evaluable.

Return type:

int | None

Raises:

TgiError – If handle invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.address_space.getRegionRangeExpression(segmentID)

Get expression string for a segment range.

Section: F.7.11.20.

Parameters:

segmentID (str) – Segment handle.

Returns:

Expression or None if element absent.

Return type:

str | None

Raises:

TgiError – If handle invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.address_space.getRegionRangeID(segmentID)

Get handle of the segment range element.

Section: F.7.11.21.

Parameters:

segmentID (str) – Segment handle.

Returns:

Child handle or None when element absent.

Return type:

str | None

Raises:

TgiError – If handle invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.address_space.removeAddressSpaceAddressUnitBits(addressSpaceID)

Remove the addressUnitBits element if present.

Section: F.7.12.4.

Parameters:

addressSpaceID (str) – Address space handle.

Returns:

True if removed, False if it was absent.

Return type:

bool

Raises:

TgiError – If handle invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.address_space.removeAddressSpaceLocalMemoryMap(addressSpaceID)

Remove the localMemoryMap element if present.

Section: F.7.12.5.

Parameters:

addressSpaceID (str) – Address space handle.

Returns:

True if removed, else False.

Return type:

bool

Raises:

TgiError – If handle invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.address_space.removeAddressSpaceSegment(segmentID)

Remove a segment element.

Section: F.7.12.6.

Parameters:

segmentID (str) – Segment handle.

Returns:

True if removed, False if not found.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.address_space.removeExecutableImageFileSetRef(fileSetRefID)

Remove an executableImage fileSetRef (stub).

Section: F.7.12.7.

Returns:

Always False (schema gap).

Return type:

bool

Parameters:

fileSetRefID (str)

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.address_space.removeLinkerCommandFileGenerator(generatorID)

Remove a linkerCommandFile generator (stub).

Section: F.7.12.8.

Returns:

Always False (schema gap).

Return type:

bool

Parameters:

generatorID (str)

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.address_space.removeLocalMemoryMapAddressBlock(addressBlockID)

Remove an addressBlock.

Section: F.7.12.9.

Parameters:

addressBlockID (str) – AddressBlock handle.

Returns:

True if removed, False otherwise.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.address_space.removeLocalMemoryMapBank(bankID)

Remove a bank element.

Section: F.7.12.10.

Parameters:

bankID (str) – Bank handle.

Returns:

True if removed, False otherwise.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.address_space.setAddressSpaceAddressUnitBits(addressSpaceID, value)

Set or create addressUnitBits.

Section: F.7.12.11.

Parameters:

• addressSpaceID (str) – Address space handle.

• value (int | str) – Integer or expression string.

Returns:

True on success.

Return type:

bool

Raises:

TgiError – If handle invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.address_space.setAddressSpaceLocalMemoryMap(addressSpaceID, name=None)

Create or replace the localMemoryMap element.

Section: F.7.12.12.

Parameters:

• addressSpaceID (str) – Parent addressSpace handle.

• name (str | None) – Optional name for the new localMemoryMap.

Returns:

True on success.

Return type:

bool

Raises:

TgiError – If handle invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.address_space.setAddressSpaceRange(addressSpaceID, value)

Set or create the range element.

Section: F.7.12.13.

Parameters:

• addressSpaceID (str) – Address space handle.

• value (int | str) – Integer or expression string.

Returns:

True on success.

Return type:

bool

Raises:

TgiError – If handle invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.address_space.setAddressSpaceWidth(addressSpaceID, value)

Set or create the width element.

Section: F.7.12.14.

Parameters:

• addressSpaceID (str) – Address space handle.

• value (int | str) – Integer or expression string.

Returns:

True on success.

Return type:

bool

Raises:

TgiError – If handle invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.address_space.setSegmentAddressOffset(segmentID, value)

Set or create a segment’s addressOffset.

Section: F.7.12.15.

Parameters:

• segmentID (str) – Segment handle.

• value (int | str) – Integer or expression string.

Returns:

True on success.

Return type:

bool

Raises:

TgiError – If handle invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.address_space.setSegmentRange(segmentID, value)

Set or create a segment’s range element.

Section: F.7.12.16.

Parameters:

• segmentID (str) – Segment handle.

• value (int | str) – Integer or expression string.

Returns:

True on success.

Return type:

bool

Raises:

TgiError – If handle invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.array module

Array category TGI functions (IEEE 1685-2022).

Implements BASE (F.7.13) and EXTENDED (F.7.14) Array functions. The schema represents arrayable constructs (e.g. register arrays, field arrays, generic array helper types) with a container having:

• dim: list of dimension elements (each with value expression and optional indexVar attribute in EXTENDED mode)

• Optional left/right bound elements (left, right) for some array forms

• Optional range element (unsigned expression)

• Optional stride element named either stride (generic), bit_stride or bitStride depending on the generated dataclass; we normalise access via stride accessors.

Not all array forms carry every sub-element; getters return None when a sub-element is absent. Numeric getters attempt integer conversion of the underlying value field, otherwise return None.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.array.addArray(parentID)

Add a new generic array element under a parent.

Section: F.7.14.1.

This is a generic implementation; creation only succeeds if the parent has an attribute suitable for receiving arrays: array (single) or arrays (list). If both exist and arrays is a list, we append there.

Parameters:

parentID (str) – Handle of the parent object.

Returns:

Handle of the created array.

Return type:

str

Raises:

TgiError – If the parent handle is invalid or no array slot exists.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.array.addArrayDim(arrayID, expression)

Append a new dim element to an array.

Section: F.7.14.2.

Parameters:

• arrayID (str) – Array handle.

• expression (str) – Value/expression string.

Returns:

Handle of created dimension.

Return type:

str

Raises:

TgiError – If array handle invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.array.getArrayDimIDs(arrayID)

List handles of dimension (dim) elements.

Section: F.7.13.1.

Parameters:

arrayID (str) – Handle referencing an array container.

Returns:

Handles (possibly empty) of dim elements.

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.array.getArrayIDs(parentID)

Return handles of child array containers under a parent.

Section: F.7.13.2.

The spec enumerates retrieval of arrays contained in a parent object. We treat any attributes named array or arrays (list) as array containers. Missing attributes produce an empty list.

Parameters:

parentID (str) – Parent handle (any object).

Returns:

Handles of arrays (empty if none).

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.array.getArrayLeftID(arrayID)

Return handle of left bound element if present.

Section: F.7.13.3.

Parameters:

arrayID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.array.getArrayRange(arrayID)

Return numeric range value.

Section: F.7.13.4.

Parameters:

arrayID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.array.getArrayRangeExpression(arrayID)

Return range expression string.

Section: F.7.13.5.

Parameters:

arrayID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.array.getArrayRightID(arrayID)

Return handle of right bound element if present.

Section: F.7.13.6.

Parameters:

arrayID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.array.getArrayStride(arrayID)

Return numeric stride value (bit/part stride).

Section: F.7.13.7.

Parameters:

arrayID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.array.getArrayStrideExpression(arrayID)

Return stride expression string.

Section: F.7.13.8.

Parameters:

arrayID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.array.getArrayStrideID(arrayID)

Return handle of stride element.

Section: F.7.13.9.

Parameters:

arrayID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.array.getDimExpression(dimID)

Return dimension expression string.

Section: F.7.13.10.

Parameters:

dimID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.array.getDimIndexVar(dimID)

Return the indexVar attribute of a dimension.

Section: F.7.13.11.

Parameters:

dimID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.array.getDimValue(dimID)

Return evaluated integer value of a dimension expression.

Section: F.7.13.12.

Parameters:

dimID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.array.getRegisterArrayID(registerID)

Return array handle for a register element if it has one.

Section: F.7.13.13.

Parameters:

registerID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.array.getRegisterFieldArrayID(fieldID)

Return array handle for a register field element if present.

Section: F.7.13.14.

Parameters:

fieldID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.array.removeArray(arrayID)

Remove an array element.

Section: F.7.14.3.

Parameters:

arrayID (str) – Array handle.

Returns:

True if removed, else False.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.array.removeArrayDim(dimID)

Remove a dim element.

Section: F.7.14.4.

Parameters:

dimID (str) – Dimension handle.

Returns:

True if removed, else False.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.array.removeArrayStride(arrayID)

Remove stride element if present.

Section: F.7.14.5.

Parameters:

arrayID (str) – Array handle.

Returns:

True if present and removed, else False.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.array.removeIndexVarAttribute(dimID)

Remove the indexVar attribute from a dimension.

Section: F.7.14.6.

Parameters:

dimID (str) – Dimension handle.

Returns:

True if removed, False if not set.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.array.setArrayStride(arrayID, value)

Set or create the stride element.

Section: F.7.14.7.

Parameters:

• arrayID (str) – Array handle.

• value (int | str) – Integer or expression string.

Returns:

True on success.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.array.setDimIndexVar(dimID, name)

Set (or create) indexVar attribute of a dimension.

Section: F.7.14.8.

Parameters:

• dimID (str) – Dimension handle.

• name (str) – Index variable name.

Returns:

True on success.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.assertion module

Assertion category TGI functions (IEEE 1685-2022).

Implements BASE (F.7.15) and EXTENDED (F.7.16) Assertion functions.

Assertions appear inside several schema elements (component, abstraction definition, bus definition, design, design configuration, abstractor, type definitions, generator chain). Each such container MAY include an assertions element containing one or more assertion child elements.

The BASE API provides enumeration and value/expression retrieval. The EXTENDED API allows adding, removing and setting textual metadata and the assert expression itself. Where the underlying schema does not model a feature mentioned in the spec (e.g. a dedicated failure message separate from description), a setter will either map to the closest schema field or raise TgiError with TgiFaultCode.UNSUPPORTED_OPERATION.

All getters return None when the requested value is absent. Mutators create intermediate containers on demand (e.g. the assertions wrapper) consistent with other category implementations.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.assertion.addAssertion(parentID, name, expression)

Create and append a new assertion element.

Section: F.7.16.1.

The parent must support an assertions.assertion list. The container will be created if absent.

Parameters:

• parentID (str) – Parent element handle.

• name (str) – Assertion name.

• expression (str) – Expression string for the assert condition.

Returns:

Handle of created assertion.

Return type:

str

Raises:

TgiError – If parent handle invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.assertion.getAssertionDescription(assertionID)

Return description value.

Section: F.7.15.5.

Parameters:

assertionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.assertion.getAssertionDisplayName(assertionID)

Return displayName value.

Section: F.7.15.3.

Parameters:

assertionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.assertion.getAssertionExpression(assertionID)

Return the assert expression string value.

Section: F.7.15.6. Maps to assert_value.value in the schema.

Parameters:

assertionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.assertion.getAssertionExpressionID(assertionID)

Return handle of the underlying expression object.

Section: F.7.15.7.

Parameters:

assertionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.assertion.getAssertionIDs(parentID)

Return handles of assertion children under a parent.

Section: F.7.15.1.

Parameters:

parentID (str) – Handle referencing any object which MAY own an assertions container.

Returns:

Handles (possibly empty) of assertion elements.

Return type:

list[str]

Raises:

TgiError – If the parent handle is invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.assertion.getAssertionName(assertionID)

Return the assertion name.

Section: F.7.15.2.

Parameters:

assertionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.assertion.getAssertionShortDescription(assertionID)

Return shortDescription value.

Section: F.7.15.4.

Parameters:

assertionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.assertion.removeAssertion(assertionID)

Remove an assertion element.

Section: F.7.16.2.

Parameters:

assertionID (str) – Assertion handle.

Returns:

True if removed else False.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.assertion.setAssertionDescription(assertionID, value)

Set or create description.

Section: F.7.16.6.

Parameters:

• assertionID (str)

• value (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.assertion.setAssertionDisplayName(assertionID, value)

Set or create displayName.

Section: F.7.16.4.

Parameters:

• assertionID (str)

• value (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.assertion.setAssertionExpression(assertionID, expression)

Set the assert expression string.

Section: F.7.16.7. Creates the expression container if absent.

Parameters:

• assertionID (str)

• expression (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.assertion.setAssertionName(assertionID, name)

Set assertion name.

Section: F.7.16.3.

Parameters:

• assertionID (str)

• name (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.assertion.setAssertionShortDescription(assertionID, value)

Set or create shortDescription.

Section: F.7.16.5.

Parameters:

• assertionID (str)

• value (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_definition module

Bus definition category TGI functions (IEEE 1685-2022).

Implements BASE (F.7.17) and EXTENDED (F.7.18) Bus Definition functions.

The schema class BusDefinition models VLNV metadata, reference to an optional base bus (extends), maximum initiator/target counts (unsigned expressions), system group names, choices, parameters, assertions and optional boolean capabilities (directConnection, broadcast, isAddressable).

BASE functions provide traversal and value retrieval. EXTENDED functions add, remove and modify child elements and scalar/expression values. Where the spec mentions removal of optional elements, corresponding remove* functions set the underlying field to None and return True if a change occurred, else False.

Assumptions: * The full list of F.7.17/F.7.18 function names is inferred; if additional or

differently named functions are required by the spec they can be added in a follow-up revision.

• Parameter / assertion category specific operations remain available via

  their dedicated category modules; minimal add/remove helpers are exposed here for completeness per F.7 classification symmetry.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_definition.addBusDefinitionAssertion(busDefinitionID, name, expression)

Add an assertion element (name + expression).

Parameters:

• busDefinitionID (str)

• name (str)

• expression (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_definition.addBusDefinitionChoice(busDefinitionID, name)

Append a choice element with given name.

Parameters:

• busDefinitionID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_definition.addBusDefinitionParameterInteger(busDefinitionID, name, value)

Add a simple integer parameter (name/value only).

Parameters:

• busDefinitionID (str) – Bus definition handle.

• name (str) – Parameter name.

• value (int) – Integer value (stored as string expression).

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_definition.addBusDefinitionSystemGroupName(busDefinitionID, name)

Append a new systemGroupName element.

Parameters:

• busDefinitionID (str) – Bus definition handle.

• name (str) – Group name string.

Returns:

Handle of created element.

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_definition.getBusDefinitionAssertionIDs(busDefinitionID)

Return handles of assertion children (if any).

Parameters:

busDefinitionID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_definition.getBusDefinitionBroadcast(busDefinitionID)

Return boolean broadcast flag.

Parameters:

busDefinitionID (str)

Return type:

bool | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_definition.getBusDefinitionChoiceIDs(busDefinitionID)

Return handles of choice children (if any).

Parameters:

busDefinitionID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_definition.getBusDefinitionDescription(busDefinitionID)

Return description value.

Parameters:

busDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_definition.getBusDefinitionDirectConnection(busDefinitionID)

Return boolean directConnection flag.

Parameters:

busDefinitionID (str)

Return type:

bool | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_definition.getBusDefinitionDisplayName(busDefinitionID)

Return displayName value.

Parameters:

busDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_definition.getBusDefinitionExtendsLibrary(busDefinitionID)

Parameters:

busDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_definition.getBusDefinitionExtendsName(busDefinitionID)

Parameters:

busDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_definition.getBusDefinitionExtendsVLNV(busDefinitionID)

Return concatenated VLNV string for extends (vendor:library:name:version).

Parameters:

busDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_definition.getBusDefinitionExtendsVendor(busDefinitionID)

Parameters:

busDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_definition.getBusDefinitionExtendsVersion(busDefinitionID)

Parameters:

busDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_definition.getBusDefinitionIsAddressable(busDefinitionID)

Return boolean isAddressable flag.

Parameters:

busDefinitionID (str)

Return type:

bool | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_definition.getBusDefinitionLibrary(busDefinitionID)

Return library value.

Parameters:

busDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_definition.getBusDefinitionMaxInitiators(busDefinitionID)

Return integer value of maxInitiators if convertible.

Parameters:

busDefinitionID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_definition.getBusDefinitionMaxInitiatorsExpression(busDefinitionID)

Return expression string for maxInitiators.

Parameters:

busDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_definition.getBusDefinitionMaxInitiatorsID(busDefinitionID)

Parameters:

busDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_definition.getBusDefinitionMaxTargets(busDefinitionID)

Return integer value of maxTargets if convertible.

Parameters:

busDefinitionID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_definition.getBusDefinitionMaxTargetsExpression(busDefinitionID)

Return expression string for maxTargets.

Parameters:

busDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_definition.getBusDefinitionMaxTargetsID(busDefinitionID)

Parameters:

busDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_definition.getBusDefinitionName(busDefinitionID)

Return name value.

Parameters:

busDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_definition.getBusDefinitionParameterIDs(busDefinitionID)

Return handles of parameter children (if any).

Parameters:

busDefinitionID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_definition.getBusDefinitionShortDescription(busDefinitionID)

Return shortDescription value.

Parameters:

busDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_definition.getBusDefinitionSystemGroupNameIDs(busDefinitionID)

Return handles of systemGroupName elements.

Parameters:

busDefinitionID (str) – Bus definition handle.

Returns:

Handles (possibly empty) of system group names.

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_definition.getBusDefinitionSystemGroupNameValue(systemGroupNameID)

Return the value of a systemGroupName element.

Parameters:

systemGroupNameID (str) – Handle of a systemGroupName element.

Returns:

String value.

Return type:

str | None

Raises:

TgiError – If the handle is invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_definition.getBusDefinitionVendor(busDefinitionID)

Return vendor value.

Parameters:

busDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_definition.getBusDefinitionVersion(busDefinitionID)

Return version value.

Parameters:

busDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_definition.removeBusDefinitionAssertion(assertionID)

Remove an assertion element by handle.

Parameters:

assertionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_definition.removeBusDefinitionBroadcast(busDefinitionID)

Remove broadcast flag if present.

Parameters:

busDefinitionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_definition.removeBusDefinitionChoice(choiceID)

Remove a choice element by handle.

Parameters:

choiceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_definition.removeBusDefinitionDirectConnection(busDefinitionID)

Remove (clear) directConnection if set.

Parameters:

busDefinitionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_definition.removeBusDefinitionExtends(busDefinitionID)

Remove extends reference if present.

Parameters:

busDefinitionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_definition.removeBusDefinitionIsAddressable(busDefinitionID)

Remove isAddressable flag if present.

Parameters:

busDefinitionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_definition.removeBusDefinitionMaxInitiators(busDefinitionID)

Remove maxInitiators element.

Parameters:

busDefinitionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_definition.removeBusDefinitionMaxTargets(busDefinitionID)

Remove maxTargets element.

Parameters:

busDefinitionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_definition.removeBusDefinitionParameter(parameterID)

Remove a parameter element by handle.

Parameters:

parameterID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_definition.removeBusDefinitionSystemGroupName(systemGroupNameID)

Remove a systemGroupName element by handle.

Parameters:

systemGroupNameID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_definition.setBusDefinitionBroadcast(busDefinitionID, flag)

Set broadcast flag.

Parameters:

• busDefinitionID (str)

• flag (bool)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_definition.setBusDefinitionDescription(busDefinitionID, value)

Set or create the description element.

Parameters:

• busDefinitionID (str)

• value (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_definition.setBusDefinitionDirectConnection(busDefinitionID, flag)

Set directConnection boolean.

Parameters:

• busDefinitionID (str)

• flag (bool)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_definition.setBusDefinitionDisplayName(busDefinitionID, value)

Set or create the displayName element.

Parameters:

• busDefinitionID (str)

• value (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_definition.setBusDefinitionExtends(busDefinitionID, vendor, library, name, version)

Set or create the extends reference (VLNV).

Parameters:

• busDefinitionID (str)

• vendor (str)

• library (str)

• name (str)

• version (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_definition.setBusDefinitionIsAddressable(busDefinitionID, flag)

Set isAddressable flag.

Parameters:

• busDefinitionID (str)

• flag (bool)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_definition.setBusDefinitionMaxInitiators(busDefinitionID, value)

Set (or create) maxInitiators expression.

Parameters:

• busDefinitionID (str)

• value (int | str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_definition.setBusDefinitionMaxTargets(busDefinitionID, value)

Set (or create) maxTargets expression.

Parameters:

• busDefinitionID (str)

• value (int | str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_definition.setBusDefinitionShortDescription(busDefinitionID, value)

Set or create the shortDescription element.

Parameters:

• busDefinitionID (str)

• value (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_interface module

Bus interface category TGI functions (IEEE 1685-2022).

Implements BASE (F.7.19) and EXTENDED (F.7.20) Bus Interface functions.

Bus interfaces expose VLNV references to busType and abstractionTypes, a connectionRequired attribute, optional textual metadata (name, displayName, description) and port mapping sub-structures. The BASE API covers enumeration of busInterface children, retrieval of VLNV tuples for busType and associated abstractionType view references, and metadata getters. The EXTENDED API supports adding/removing busInterface elements, adjusting references and setting/clearing the connectionRequired flag.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_interface.addBusInterface(componentID, name, busTypeVLNV)

Create and append a new busInterface under a component.

Parameters:

• componentID (str) – Parent component handle.

• name (str) – Interface name.

• busTypeVLNV (tuple[str, str, str, str]) – (vendor, library, name, version) tuple for busType ref.

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_interface.addBusInterfaceAbstractionTypeBusTypeViewRef(busInterfaceID, viewVLNV)

Append an abstractionType element referencing a view (name only stored).

Parameters:

• busInterfaceID (str)

• viewVLNV (tuple[str, str, str, str])

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_interface.getBusInterfaceAbstractionTypeBusTypeViewRefsByVLNV(busInterfaceID)

Return list of abstractionType view VLNV tuples.

The 2022 schema models viewRef as name only; vendor/library/version will normally be None.

Parameters:

busInterfaceID (str)

Return type:

list[tuple[str | None, str | None, str | None, str | None]]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_interface.getBusInterfaceBusTypeRefByVLNV(busInterfaceID)

Return the busType VLNV tuple (vendor, library, name, version).

Returns a tuple of Nones if the reference is absent.

Parameters:

busInterfaceID (str)

Return type:

tuple[str | None, str | None, str | None, str | None]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_interface.getBusInterfaceConnectionRequired(busInterfaceID)

Return connectionRequired attribute value (or None).

Parameters:

busInterfaceID (str)

Return type:

bool | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_interface.getBusInterfaceDescription(busInterfaceID)

Return description value.

Parameters:

busInterfaceID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_interface.getBusInterfaceDisplayName(busInterfaceID)

Return displayName value.

Parameters:

busInterfaceID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_interface.getBusInterfaceName(busInterfaceID)

Return the busInterface name attribute.

Parameters:

busInterfaceID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_interface.getComponentBusInterfaceIDs(busInterfacesID)

Return handles of all busInterface children.

Parameters:

busInterfacesID (str) – Handle referencing a busInterfaces container.

Returns:

Handles (possibly empty).

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_interface.removeBusInterface(busInterfaceID)

Remove a busInterface by handle.

Returns True if removed, False otherwise.

Parameters:

busInterfaceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_interface.setBusInterfaceBusTypeRefByVLNV(busInterfaceID, busTypeVLNV)

Set or clear the busType reference of a busInterface.

Parameters:

• busInterfaceID (str)

• busTypeVLNV (tuple[str, str, str, str] | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.bus_interface.setBusInterfaceConnectionRequired(busInterfaceID, required)

Set or clear the connectionRequired flag.

Parameters:

• busInterfaceID (str)

• required (bool | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.catalog module

Catalog category TGI functions (IEEE 1685-2022).

Implements BASE (F.7.23) and EXTENDED (F.7.24) Catalog functions.

Catalogs provide traversal and manipulation of ipxactFile entries for all major schema categories (abstractionDef, abstractors, busDefinitions, catalogs, components, designConfigurations, designs, generatorChains, typeDefinitions). BASE functions enumerate ipxactFile handles for each category and retrieve element metadata. EXTENDED functions add/remove ipxactFile entries and set element properties (name, VLNV reference).

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.catalog.addCatalogAbstractionDefIpxactFile(catalog, abstractionDefVLNV, fileName)

Add an abstractionDefinition ipxactFile entry to the catalog.

Parameters:

• catalog (Catalog) – Catalog handle object.

• abstractionDefVLNV (Sequence[str]) – Sequence [vendor, library, name, version].

• fileName (str) – Relative or absolute XML file name.

Returns:

Handle string of the created ipxactFile element.

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.catalog.addCatalogAbstractorsIpxactFile(catalog, abstractorVLNV, fileName)

Add an abstractors ipxactFile entry to the catalog.

Parameters:

• catalog (Catalog)

• abstractorVLNV (Sequence[str])

• fileName (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.catalog.addCatalogBusDefinitionsIpxactFile(catalog, busDefVLNV, fileName)

Add a busDefinitions ipxactFile entry to the catalog.

Parameters:

• catalog (Catalog)

• busDefVLNV (Sequence[str])

• fileName (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.catalog.addCatalogCatalogsIpxactFile(catalog, catalogVLNV, fileName)

Add a catalogs ipxactFile entry to the catalog.

Parameters:

• catalog (Catalog)

• catalogVLNV (Sequence[str])

• fileName (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.catalog.addCatalogComponentsIpxactFile(catalog, componentVLNV, fileName)

Add a components ipxactFile entry to the catalog.

Parameters:

• catalog (Catalog)

• componentVLNV (Sequence[str])

• fileName (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.catalog.addCatalogDesignConfigurationsIpxactFile(catalog, designConfigurationVLNV, fileName)

Add a designConfigurations ipxactFile entry to the catalog.

Parameters:

• catalog (Catalog)

• designConfigurationVLNV (Sequence[str])

• fileName (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.catalog.addCatalogDesignsIpxactFile(catalog, designVLNV, fileName)

Add a designs ipxactFile entry to the catalog.

Parameters:

• catalog (Catalog)

• designVLNV (Sequence[str])

• fileName (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.catalog.addCatalogGeneratorChainsIpxactFile(catalog, generatorChainVLNV, fileName)

Add a generatorChains ipxactFile entry to the catalog.

Parameters:

• catalog (Catalog)

• generatorChainVLNV (Sequence[str])

• fileName (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.catalog.addCatalogTypeDefinitionsIpxactFile(catalog, typeDefinitionVLNV, fileName)

Add a typeDefinitions ipxactFile entry to the catalog.

Parameters:

• catalog (Catalog)

• typeDefinitionVLNV (Sequence[str])

• fileName (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.catalog.getCatalogAbstractionDefIpxactFileIDs(catalog)

Return handles of abstractionDefinition ipxactFile entries.

Parameters:

catalog (Catalog)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.catalog.getCatalogAbstractorsIpxactFileIDs(catalog)

Return handles of abstractors ipxactFile entries.

Parameters:

catalog (Catalog)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.catalog.getCatalogBusDefinitionsIpxactFileIDs(catalog)

Return handles of busDefinitions ipxactFile entries.

Parameters:

catalog (Catalog)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.catalog.getCatalogCatalogsIpxactFileIDs(catalog)

Return handles of catalogs ipxactFile entries.

Parameters:

catalog (Catalog)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.catalog.getCatalogComponentsIpxactFileIDs(catalog)

Return handles of components ipxactFile entries.

Parameters:

catalog (Catalog)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.catalog.getCatalogDesignConfigurationsIpxactFileIDs(catalog)

Return handles of designConfigurations ipxactFile entries.

Parameters:

catalog (Catalog)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.catalog.getCatalogDesignsIpxactFileIDs(catalog)

Return handles of designs ipxactFile entries.

Parameters:

catalog (Catalog)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.catalog.getCatalogGeneratorChainsIpxactFileIDs(catalog)

Return handles of generatorChains ipxactFile entries.

Parameters:

catalog (Catalog)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.catalog.getCatalogTypeDefinitionsIpxactFileIDs(catalog)

Return handles of typeDefinitions ipxactFile entries.

Parameters:

catalog (Catalog)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.catalog.getIpxactFileName(ipxact_file)

Return the file name of an ipxactFile entry.

Parameters:

ipxact_file (IpxactFileType)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.catalog.getIpxactFileVlnvRefByVLNV(ipxact_file)

Return the VLNV string (vendor:library:name:version) for an ipxactFile.

Parameters:

ipxact_file (IpxactFileType)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.catalog.removeCatalogAbstractionDefIpxactFile(catalog, ipxactFileID)

Remove an abstractionDefinition ipxactFile entry by handle.

Parameters:

• catalog (Catalog)

• ipxactFileID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.catalog.removeCatalogAbstractorsIpxactFile(catalog, ipxactFileID)

Remove an abstractors ipxactFile entry by handle.

Parameters:

• catalog (Catalog)

• ipxactFileID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.catalog.removeCatalogBusDefinitionsIpxactFile(catalog, ipxactFileID)

Remove a busDefinitions ipxactFile entry by handle.

Parameters:

• catalog (Catalog)

• ipxactFileID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.catalog.removeCatalogCatalogsIpxactFile(catalog, ipxactFileID)

Remove a catalogs ipxactFile entry by handle.

Parameters:

• catalog (Catalog)

• ipxactFileID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.catalog.removeCatalogComponentsIpxactFile(catalog, ipxactFileID)

Remove a components ipxactFile entry by handle.

Parameters:

• catalog (Catalog)

• ipxactFileID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.catalog.removeCatalogDesignConfigurationsIpxactFile(catalog, ipxactFileID)

Remove a designConfigurations ipxactFile entry by handle.

Parameters:

• catalog (Catalog)

• ipxactFileID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.catalog.removeCatalogDesignsIpxactFile(catalog, ipxactFileID)

Remove a designs ipxactFile entry by handle.

Parameters:

• catalog (Catalog)

• ipxactFileID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.catalog.removeCatalogGeneratorChainsIpxactFile(catalog, ipxactFileID)

Remove a generatorChains ipxactFile entry by handle.

Parameters:

• catalog (Catalog)

• ipxactFileID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.catalog.removeCatalogTypeDefinitionsIpxactFile(catalog, ipxactFileID)

Remove a typeDefinitions ipxactFile entry by handle.

Parameters:

• catalog (Catalog)

• ipxactFileID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.catalog.setIpxactFileName(ipxact_file, name)

Set the file name of an ipxactFile entry.

Parameters:

• ipxact_file (IpxactFileType)

• name (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.catalog.setIpxactFileVlnv(ipxact_file, vlnv)

Set the VLNV reference of an ipxactFile entry.

Parameters:

• ipxact_file (IpxactFileType)

• vlnv (Sequence[str])

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.choice module

Choice category TGI functions (IEEE 1685-2022).

Implements BASE (F.7.25) and EXTENDED (F.7.26) Choice functions.

Provides traversal and manipulation of enumerations for Choices.Choice objects. All functions raise TgiError with TgiFaultCode.INVALID_ID for invalid handles.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.choice.addChoiceEnumeration(choiceID, name)

Add a new enumeration with the given name to the choice.

Section: F.7.26.1

Parameters:

• choiceID (str) – Handle to a Choices.Choice element.

• name (str) – Name for the new enumeration.

Returns:

Handle to the new Choices.Choice.Enumeration element.

Raises:

TgiError – If the handle is invalid.

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.choice.getChoiceEnumerationIDs(choiceID)

Return handles to all choiceEnumeration elements of a choice.

Section: F.7.25.1

Parameters:

choiceID (str) – Handle to a Choices.Choice element.

Returns:

List of handles to Choices.Choice.Enumeration elements.

Raises:

TgiError – If the handle is invalid.

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.choice.getEnumerationValue(choiceEnumerationID)

Return the enumerationValue defined on the given enumeration element.

Section: F.7.25.2

Parameters:

choiceEnumerationID (str) – Handle to a Choices.Choice.Enumeration element.

Returns:

The enumeration value string, or None if not set.

Raises:

TgiError – If the handle is invalid.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.choice.getEnumerationValueExpression(choiceEnumerationID)

Return the expression defined on the given enumeration element.

Section: F.7.25.3

Parameters:

choiceEnumerationID (str) – Handle to a Choices.Choice.Enumeration element.

Returns:

The enumeration expression string, or None if not set.

Raises:

TgiError – If the handle is invalid.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.choice.removeChoiceEnumeration(choiceEnumerationID)

Remove the given choiceEnumeration from its parent choice.

Section: F.7.26.2

Parameters:

choiceEnumerationID (str) – Handle to a Choices.Choice.Enumeration element.

Returns:

True if removed, False if not found.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.choice.setEnumerationValue(choiceEnumerationID, value)

Set the value on the given enumeration element.

Section: F.7.26.3

Parameters:

• choiceEnumerationID (str) – Handle to a Choices.Choice.Enumeration element.

• value (str) – New value expression.

Returns:

True if set, False if not found.

Raises:

TgiError – If the handle is invalid.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.clearbox module

Clearbox category TGI functions (IEEE 1685-2022).

Implements BASE (F.7.27) and EXTENDED (F.7.28) Clearbox functions.

Provides traversal and manipulation utilities for clearbox elements, clearboxElementRef and clearboxElementRefLocation structures. Functions raise TgiError with TgiFaultCode.INVALID_ID when a supplied handle does not reference the expected schema object.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.clearbox.addClearboxElementRefLocation(clearboxElementRefID, value)

Add a clearboxElementRefLocation to a clearboxElementRef.

Section: F.7.28.1

Parameters:

• clearboxElementRefID (str) – Handle to a clearboxElementRef element.

• value (str) – Path segment value.

Returns:

Handle of the newly added clearboxElementRefLocation.

Raises:

TgiError – If the ref handle is invalid.

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.clearbox.addLocationSlice(locationID, value)

Add a slice to a Location element.

Section: F.7.28.2

Parameters:

• locationID (str) – Handle to a location element.

• value (str) – Slice value (path segment).

Returns:

Handle to the new slice element.

Raises:

TgiError – If the location handle is invalid.

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.clearbox.getClearboxElementClearboxType(clearboxElementID)

Return the clearboxType value for a clearboxElement.

Section: F.7.27.1

Parameters:

clearboxElementID (str) – Handle to a clearboxElement element.

Returns:

The clearboxType enumeration value as string, or None if not set.

Raises:

TgiError – If the handle is invalid.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.clearbox.getClearboxElementDriveable(clearboxElementID)

Return the driveable value for a clearboxElement.

Section: F.7.27.2

Parameters:

clearboxElementID (str) – Handle to a clearboxElement element.

Returns:

Boolean driveable value or None if not present.

Raises:

TgiError – If the handle is invalid.

Return type:

bool | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.clearbox.getClearboxElementRefByID(clearboxElementRefID)

Return handle to the clearboxElement referenced by a clearboxElementRef.

Section: F.7.27.3

Parameters:

clearboxElementRefID (str) – Handle to a clearboxElementRef element.

Returns:

Handle to referenced clearboxElement or None if resolution fails.

Raises:

TgiError – If the ref handle is invalid.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.clearbox.getClearboxElementRefLocationIDs(clearboxElementRefID)

Return handles to all clearboxElementRefLocation elements.

Section: F.7.27.4

Parameters:

clearboxElementRefID (str) – Handle to a clearboxElementRef element.

Returns:

List of handles for each clearboxElementRefLocation.

Raises:

TgiError – If the ref handle is invalid.

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.clearbox.removeClearboxElementDriveable(clearboxElementID)

Remove the driveable element from a clearboxElement.

Section: F.7.28.3

Parameters:

clearboxElementID (str) – Handle to a clearboxElement element.

Returns:

True if removed, False if not present or invalid.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.clearbox.removeClearboxElementRefLocation(clearboxElementRefLocationID)

Remove a clearboxElementRefLocation element.

Section: F.7.28.4

Parameters:

clearboxElementRefLocationID (str) – Handle to a clearboxElementRefLocation element.

Returns:

True if removed, False otherwise.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.clearbox.setClearboxElementClearboxType(clearboxID, clearboxType)

Set the clearbox type of a clearbox element.

Section: F.7.28.5

Parameters:

• clearboxID (str) – Handle to a clearboxElement element.

• clearboxType (str) – New clearbox type string.

Returns:

True if set, False if not found.

Raises:

TgiError – If the handle is invalid.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.clearbox.setClearboxElementDriveable(clearboxElementID, value)

Set the driveable value for a clearboxElement.

Section: F.7.28.6

Parameters:

• clearboxElementID (str) – Handle to a clearboxElement element.

• value (bool) – Boolean driveable state.

Returns:

True if set, False if not found.

Raises:

TgiError – If the handle is invalid.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component module

Component category TGI functions (IEEE 1685-2022).

Implements BASE (F.7.29) and EXTENDED (F.7.30) Component functions. Only the public TGI functions defined by those sections are exported (no convenience helpers). All functions take opaque handles referencing unconfigured componentType object graphs (schema: ComponentType) previously registered via the core handle manager. Invalid handles raise TgiError with TgiFaultCode.INVALID_ID. Mutating functions create the minimal schema objects necessary to satisfy the call semantics; callers may further refine created sub-elements through other category APIs.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.addComponentAddressSpace(componentID, name)

Add an addressSpace element.

Section: F.7.30.1.

Parameters:

• componentID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.addComponentChannel(componentID, name)

Add a channel element.

Section: F.7.30.2.

Parameters:

• componentID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.addComponentChoice(componentID, name)

Add a choice element (no enumerations yet).

Section: F.7.30.3.

Parameters:

• componentID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.addComponentClearboxElement(componentID, name=None)

Add a clearboxElement.

Section: F.7.30.4. Name is optional (schema may not define one).

Parameters:

• componentID (str)

• name (str | None)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.addComponentComponentGenerator(componentID, name)

Add a componentGenerator element.

Section: F.7.30.5.

Parameters:

• componentID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.addComponentComponentInstantiation(componentID, name)

Add a componentInstantiation (model.instantiations).

Section: F.7.30.6.

Parameters:

• componentID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.addComponentCpu(componentID, name)

Add a cpu element.

Section: F.7.30.7.

Parameters:

• componentID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.addComponentDesignConfigurationInstantiation(componentID, name)

Add a designConfigurationInstantiation.

Section: F.7.30.8.

Parameters:

• componentID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.addComponentDesignInstantiation(componentID, name)

Add a designInstantiation.

Section: F.7.30.9.

Parameters:

• componentID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.addComponentFileSet(componentID, name)

Add a fileSet element.

Section: F.7.30.10.

Parameters:

• componentID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.addComponentIndirectInterface(componentID, name)

Add an indirectInterface element.

Section: F.7.30.11.

Parameters:

• componentID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.addComponentInitiatorBusInterface(componentID, name)

Add an initiator busInterface.

Section: F.7.30.12.

Parameters:

• componentID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.addComponentMemoryMap(componentID, name)

Add a memoryMap element.

Section: F.7.30.13.

Parameters:

• componentID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.addComponentMirroredInitiatorBusInterface(componentID, name)

Add a mirrored initiator busInterface.

Section: F.7.30.14.

Parameters:

• componentID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.addComponentMirroredSystemBusInterface(componentID, name)

Add a mirrored system busInterface.

Section: F.7.30.15.

Parameters:

• componentID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.addComponentMirroredTargetBusInterface(componentID, name)

Add a mirrored target busInterface.

Section: F.7.30.16.

Parameters:

• componentID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.addComponentMode(componentID, name)

Add a mode element.

Section: F.7.30.17.

Parameters:

• componentID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.addComponentMonitorBusInterface(componentID, name)

Add a monitor busInterface.

Section: F.7.30.18.

Parameters:

• componentID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.addComponentOtherClockDriver(componentID, name)

Add an otherClockDriver element.

Section: F.7.30.19.

Parameters:

• componentID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.addComponentResetType(componentID, name)

Add a resetType element.

Section: F.7.30.20.

Parameters:

• componentID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.addComponentStructuredInterfacePort(componentID, name, subPortName, structPortTypeDefTypeName)

Add a structured interface port.

Section: F.7.30.21.

Parameters:

• componentID (str)

• name (str)

• subPortName (str)

• structPortTypeDefTypeName (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.addComponentStructuredStructPort(componentID, name, subPortName, structPortTypeDefTypeName)

Add a structured struct port.

Section: F.7.30.22.

Parameters:

• componentID (str)

• name (str)

• subPortName (str)

• structPortTypeDefTypeName (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.addComponentStructuredUnionPort(componentID, name, structPortTypeDefTypeName, subPortName)

Add a structured union port.

Section: F.7.30.23.

Parameters:

• componentID (str)

• name (str)

• structPortTypeDefTypeName (str)

• subPortName (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.addComponentSystemBusInterface(componentID, name)

Add a system busInterface.

Section: F.7.30.24.

Parameters:

• componentID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.addComponentTargetBusInterface(componentID, name)

Add a target busInterface.

Section: F.7.30.25.

Parameters:

• componentID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.addComponentTransactionalPort(componentID, name)

Add a transactional port.

Section: F.7.30.26.

Parameters:

• componentID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.addComponentView(componentID, name)

Add a view element.

Section: F.7.30.27.

Parameters:

• componentID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.addComponentWirePort(componentID, name, direction=None)

Add a wire port.

Section: F.7.30.28.

Parameters:

• componentID (str)

• name (str)

• direction (str | None)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.getComponentAddressSpaceIDs(componentID)

Return handles of all addressSpace elements.

Section: F.7.29.1.

Parameters:

componentID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.getComponentBusInterfaceIDs(componentID)

Return handles of all busInterface elements.

Section: F.7.29.2.

Parameters:

componentID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.getComponentChannelIDs(componentID)

Return handles of all channel elements.

Section: F.7.29.3.

Parameters:

componentID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.getComponentChoiceIDs(componentID)

Return handles of all choice elements.

Section: F.7.29.4.

Parameters:

componentID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.getComponentClearboxElementIDs(componentID)

Return handles of clearboxElement children.

Section: F.7.29.5.

Parameters:

componentID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.getComponentComponentGeneratorIDs(componentID)

Return handles of componentGenerator children.

Section: F.7.29.6.

Parameters:

componentID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.getComponentComponentInstantiationIDs(componentID)

Return handles of componentInstantiation elements in model.

Section: F.7.29.7.

Parameters:

componentID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.getComponentCpuIDs(componentID)

Return handles of cpu elements.

Section: F.7.29.8.

Parameters:

componentID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.getComponentDesignConfigurationInstantiationIDs(componentID)

Return handles of designConfigurationInstantiation elements.

Section: F.7.29.9.

Parameters:

componentID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.getComponentDesignInstantiationIDs(componentID)

Return handles of designInstantiation elements.

Section: F.7.29.10.

Parameters:

componentID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.getComponentExternalTypeDefinitionsIDs(componentID)

Return handles of externalTypeDefinitions elements.

Section: F.7.29.11.

Parameters:

componentID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.getComponentFileSetIDs(componentID)

Return handles of fileSet elements.

Section: F.7.29.12.

Parameters:

componentID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.getComponentIndirectInterfaceIDs(componentID)

Return handles of indirectInterface elements.

Section: F.7.29.13.

Parameters:

componentID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.getComponentMemoryMapIDs(componentID)

Return handles of memoryMap elements.

Section: F.7.29.14.

Parameters:

componentID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.getComponentModeIDs(componentID)

Return handles of mode elements.

Section: F.7.29.15.

Parameters:

componentID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.getComponentOtherClockDriverIDs(componentID)

Return handles of otherClockDriver elements.

Section: F.7.29.16.

Parameters:

componentID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.getComponentPortIDs(componentID)

Return handles of model port elements (all styles).

Section: F.7.29.17.

Parameters:

componentID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.getComponentPowerDomainIDs(componentID)

Return handles of powerDomain elements.

Section: F.7.29.18.

Parameters:

componentID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.getComponentResetTypeIDs(componentID)

Return handles of resetType elements.

Section: F.7.29.19.

Parameters:

componentID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.getComponentSelectedViewIDs(componentID)

Return handles of selectedView elements.

Section: F.7.29.20.

Parameters:

componentID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.removeComponentAddressSpace(componentID, addressSpaceID)

Remove an addressSpace.

Section: F.7.30.29.

Parameters:

• componentID (str)

• addressSpaceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.removeComponentBusInterface(componentID, busInterfaceID)

Remove a busInterface (any role).

Section: F.7.30.30.

Parameters:

• componentID (str)

• busInterfaceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.removeComponentChannel(componentID, channelID)

Remove a channel.

Section: F.7.30.31.

Parameters:

• componentID (str)

• channelID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.removeComponentChoice(componentID, choiceID)

Remove a choice.

Section: F.7.30.32.

Parameters:

• componentID (str)

• choiceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.removeComponentClearboxElement(componentID, clearboxElementID)

Remove a clearboxElement.

Section: F.7.30.33.

Parameters:

• componentID (str)

• clearboxElementID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.removeComponentComponentGenerator(componentID, componentGeneratorID)

Remove a componentGenerator.

Section: F.7.30.34.

Parameters:

• componentID (str)

• componentGeneratorID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.removeComponentComponentInstantiation(componentID, componentInstantiationID)

Remove a componentInstantiation.

Section: F.7.30.35.

Parameters:

• componentID (str)

• componentInstantiationID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.removeComponentCpu(componentID, cpuID)

Remove a cpu element.

Section: F.7.30.36.

Parameters:

• componentID (str)

• cpuID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.removeComponentDesignConfigurationInstantiation(componentID, designConfigurationInstantiationID)

Remove a designConfigurationInstantiation.

Section: F.7.30.37.

Parameters:

• componentID (str)

• designConfigurationInstantiationID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.removeComponentDesignInstantiation(componentID, designInstantiationID)

Remove a designInstantiation.

Section: F.7.30.38.

Parameters:

• componentID (str)

• designInstantiationID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.removeComponentFileSet(componentID, fileSetID)

Remove a fileSet.

Section: F.7.30.39.

Parameters:

• componentID (str)

• fileSetID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.removeComponentIndirectInterface(componentID, indirectInterfaceID)

Remove an indirectInterface.

Section: F.7.30.40.

Parameters:

• componentID (str)

• indirectInterfaceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.removeComponentMemoryMap(componentID, memoryMapID)

Remove a memoryMap.

Section: F.7.30.41.

Parameters:

• componentID (str)

• memoryMapID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.removeComponentMode(componentID, modeID)

Remove a mode.

Section: F.7.30.42.

Parameters:

• componentID (str)

• modeID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.removeComponentOtherClockDriver(componentID, otherClockDriverID)

Remove an otherClockDriver.

Section: F.7.30.43.

Parameters:

• componentID (str)

• otherClockDriverID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.removeComponentPort(componentID, portID)

Remove a port (any style) from model.ports.

Section: F.7.30.44.

Parameters:

• componentID (str)

• portID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.removeComponentResetType(componentID, resetTypeID)

Remove a resetType element.

Section: F.7.30.45.

Parameters:

• componentID (str)

• resetTypeID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.component.removeComponentView(componentID, viewID)

Remove a view element.

Section: F.7.30.46.

Parameters:

• componentID (str)

• viewID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.configurable_element module

Configurable element category TGI functions (IEEE 1685-2022).

Implements BASE (F.7.31) and EXTENDED (F.7.32) configurable element functions. A configurable element in the 2022 schema is represented by configurableElementValue entries contained inside an optional configurableElementValues element under various parent objects (e.g. component, designConfiguration viewConfiguration, generator instances, abstractor instances, etc.). A configured element (in the wording of the standard) owns a collection of configurableElementValue children each of which carries a required referenceId attribute referencing the ID of a configurable (unconfigured) element plus an expression value (the textual content inherited from complexBaseExpression).

The mapping between unconfigured and configured IDs in this initial implementation is identity: the same object can act as both handle kinds because the project has not yet introduced distinct configured wrapper objects. Consequently getUnconfiguredID currently returns the provided handle (identity mapping). This can be revised transparently later without changing the public API.

Only the public TGI functions explicitly listed in sections F.7.31 and F.7.32 are exported—no convenience helpers. Invalid handles raise TgiError with TgiFaultCode.INVALID_ID. Semantic issues (e.g. attempting to mutate a non-owning parent) raise TgiError with TgiFaultCode.INVALID_ARGUMENT.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.configurable_element.addConfigurableElementValue(configuredElementID, referenceID, expression)

Add a configurable element value under a configured element.

Section: F.7.32.1.

Parameters:

• configuredElementID (str) – Parent handle.

• referenceID (str) – Referenced configurable element ID.

• expression (str) – Expression / value text.

Returns:

Handle of the newly created configurableElementValue.

Return type:

str

Raises:

TgiError – If the parent handle is invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.configurable_element.addViewConfigurationConfigurableElementValue(viewConfigurationID, referenceID, expression)

Add a configurable element value to a designConfiguration.viewConfiguration.view.

Section: F.7.32.2.

The viewConfigurationID is expected to reference a DesignConfiguration.ViewConfiguration whose view child contains (or will contain) a configurableElementValues container. Only minimal structure is created; the view element itself must already exist.

Parameters:

• viewConfigurationID (str)

• referenceID (str)

• expression (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.configurable_element.getConfigurableElementIDs(unconfiguredElementID)

Return handles of all configurable elements for an unconfigured element.

Section: F.7.31.1.

The standard conceptual model distinguishes between an unconfigured element (definition) and configurable elements (parameters) that can be bound with values when configuring instances. In this implementation configurable elements correspond directly to configurableElementValue children; thus this function returns their handles (identity mapping for now).

Parameters:

unconfiguredElementID (str) – Handle referencing an unconfigured element.

Returns:

Handles of all associated configurable elements.

Return type:

list[str]

Raises:

TgiError – If the handle is invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.configurable_element.getConfigurableElementValue(configurableElementID)

Return the default value of a configurable element.

Section: F.7.31.2.

Parameters:

configurableElementID (str) – Handle of the configurable element (value).

Returns:

Expression/value text or None if absent.

Return type:

str | None

Raises:

TgiError – If the handle is invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.configurable_element.getConfigurableElementValueExpression(configurableElementID)

Return the default expression of a configurable element.

Section: F.7.31.3.

Equivalent to getConfigurableElementValue() for the current schema where the stored textual value doubles as the expression.

Parameters:

configurableElementID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.configurable_element.getConfigurableElementValueIDs(configuredElementID)

Return handles of all configurableElementValue children of a configured element.

Section: F.7.31.4.

Parameters:

configuredElementID (str) – Handle referencing a configured element.

Returns:

Child handles (empty list if none).

Return type:

list[str]

Raises:

TgiError – If the handle is invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.configurable_element.getConfigurableElementValueReferenceID(configurableElementValueID)

Return the referenceId attribute of a configurable element value.

Section: F.7.31.5.

Parameters:

configurableElementValueID (str) – Handle of the child value.

Returns:

Reference ID string or None if unset.

Return type:

str | None

Raises:

TgiError – If the handle is invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.configurable_element.getConfigurableElementValueValueExpression(configurableElementValueID)

Return the expression text stored in a configurable element value.

Section: F.7.31.6.

Parameters:

configurableElementValueID (str) – Handle of the value element.

Returns:

Expression string or None.

Return type:

str | None

Raises:

TgiError – If the handle is invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.configurable_element.getUnconfiguredID(configuredElementID)

Return the unconfigured element ID for the given configured element.

Section: F.7.31.7.

Identity mapping placeholder (see module docstring). Always returns the provided ID after validating it resolves.

Parameters:

configuredElementID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.configurable_element.removeConfigurableElementValue(configurableElementValueID)

Remove the referenced configurable element value.

Section: F.7.32.3.

Parameters:

configurableElementValueID (str) – Handle of the value to remove.

Returns:

True if removed, False if not found / wrong type.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.configurable_element.setConfigurableElementValue(configurableElementID, expression)

Set the default value/expression of a configurable element.

Section: F.7.32.4.

Parameters:

• configurableElementID (str) – Handle of the value element.

• expression (str) – New expression text.

Returns:

True if updated, False if not.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.configurable_element.setConfigurableElementValueReferenceID(configurableElementValueID, referenceID)

Set the referenceId attribute of a configurable element value.

Section: F.7.32.5.

Parameters:

• configurableElementValueID (str) – Handle of the value element.

• referenceID (str) – New reference ID string.

Returns:

True if updated, False otherwise.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.configurable_element.setConfigurableElementValueValue(configurableElementValueID, expression)

Set the expression text of a configurable element value.

Section: F.7.32.6.

Parameters:

• configurableElementValueID (str) – Handle of the value element.

• expression (str) – New expression/value string.

Returns:

True if updated, False otherwise.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.constraint module

Constraint category TGI functions (IEEE 1685-2022).

Implements BASE (F.7.33) and EXTENDED (F.7.34) functions providing read and write access to constraint related schema elements: constraintSet, constraintSetRef, driveConstraint, loadConstraint and timingConstraint along with the nested cellSpecification and vector range expressions.

Only the public functions defined in sections F.7.33 and F.7.34 are exported; no convenience helpers. Invalid handles raise TgiError with TgiFaultCode.INVALID_ID. Operations that cannot be performed because of schema state raise TgiFaultCode.INVALID_ARGUMENT.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.constraint.getCellSpecificationCellClass(cellSpecificationID)

Return the cellClass enumeration value of a cellSpecification.

Section: F.7.33.1.

Parameters:

cellSpecificationID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.constraint.getCellSpecificationCellFunction(cellSpecificationID)

Return the cellFunction enumeration value of a cellSpecification.

Section: F.7.33.2.

Parameters:

cellSpecificationID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.constraint.getCellSpecificationCellFunctionID(cellSpecificationID)

Return handle of the cellFunction element of a cellSpecification.

Section: F.7.33.3.

Parameters:

cellSpecificationID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.constraint.getConstraintSetDriveConstraintCellSpecificationID(constraintSetID)

Return handle of cellSpecification inside the driveConstraint.

Section: F.7.33.4.

Parameters:

constraintSetID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.constraint.getConstraintSetLoadConstraintID(constraintSetID)

Return handle of the loadConstraint element.

Section: F.7.33.5.

Parameters:

constraintSetID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.constraint.getConstraintSetRefLocalName(constraintSetRefID)

Return the local name value of a constraintSetRef.

Section: F.7.33.6.

Parameters:

constraintSetRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.constraint.getConstraintSetReferenceName(constraintSetID)

Return the constraintSetId attribute of a constraintSet.

Section: F.7.33.7.

Parameters:

constraintSetID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.constraint.getConstraintSetTimingConstraintIDs(constraintSetID)

Return handles of all timingConstraint children of a constraintSet.

Section: F.7.33.8.

Parameters:

constraintSetID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.constraint.getConstraintSetVector(constraintSetID)

Return [left, right] evaluated integer values of constraintSet vector.

Section: F.7.33.9. Returns [None, None] if vector absent or expressions unevaluated.

Parameters:

constraintSetID (str)

Return type:

list[int | None]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.constraint.getConstraintSetVectorExpression(constraintSetID)

Return [leftExpr, rightExpr] textual expressions of vector bounds.

Section: F.7.33.10.

Parameters:

constraintSetID (str)

Return type:

list[str | None]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.constraint.getConstraintSetVectorLeftID(constraintSetID)

Return handle of left side expression element of vector.

Section: F.7.33.11.

Parameters:

constraintSetID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.constraint.getConstraintSetVectorRightID(constraintSetID)

Return handle of right side expression element of vector.

Section: F.7.33.12.

Parameters:

constraintSetID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.constraint.getDriveConstraintOther(driveConstraintID)

Return the other attribute of driveConstraint.cellSpecification.cellFunction.

Section: F.7.33.13.

Parameters:

driveConstraintID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.constraint.getDriveConstraintType(driveConstraintID)

Return type of driveConstraint (cellFunction value or cellClass value).

Section: F.7.33.14.

Parameters:

driveConstraintID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.constraint.getDriveConstraintValue(driveConstraintID)

Return the drive constraint strength value (cellStrength attribute).

Section: F.7.33.15.

Parameters:

driveConstraintID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.constraint.getLoadConstraintCellSpecificationID(loadConstraintID)

Return handle of the cellSpecification of a loadConstraint.

Section: F.7.33.16.

Parameters:

loadConstraintID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.constraint.getLoadConstraintCount(loadConstraintID)

Return numeric count of a loadConstraint.

Section: F.7.33.17.

Parameters:

loadConstraintID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.constraint.getLoadConstraintCountExpression(loadConstraintID)

Return textual count expression of a loadConstraint.

Section: F.7.33.18.

Parameters:

loadConstraintID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.constraint.getLoadConstraintCountID(loadConstraintID)

Return handle of the count expression element.

Section: F.7.33.19.

Parameters:

loadConstraintID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.constraint.getLoadConstraintOther(loadConstraintID)

Return the other attribute (cellFunction based specification only).

Section: F.7.33.20.

Parameters:

loadConstraintID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.constraint.getLoadConstraintType(loadConstraintID)

Return type of a loadConstraint (cellFunction value or cellClass value).

Section: F.7.33.21.

Parameters:

loadConstraintID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.constraint.getLoadConstraintValue(loadConstraintID)

Return the load constraint strength value (cellStrength attribute).

Section: F.7.33.22.

Parameters:

loadConstraintID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.constraint.getTimingConstraintValue(timingConstraintID)

Return numeric value of a timingConstraint.

Section: F.7.33.23.

Parameters:

timingConstraintID (str)

Return type:

float | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.constraint.removeConstraintSetDriveConstraint(constraintSetID)

Remove the driveConstraint child from a constraintSet.

Section: F.7.34.1.

Parameters:

constraintSetID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.constraint.removeConstraintSetLoadConstraint(constraintSetID)

Remove the loadConstraint child from a constraintSet.

Section: F.7.34.2.

Parameters:

constraintSetID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.constraint.removeConstraintSetTimingConstraint(timingConstraintID)

Remove a timingConstraint element.

Section: F.7.34.3.

Parameters:

timingConstraintID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.constraint.removeConstraintSetVector(constraintSetID)

Remove vector element from a constraintSet.

Section: F.7.34.4.

Parameters:

constraintSetID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.constraint.removeLoadConstraintCount(loadConstraintID)

Remove count element from a loadConstraint.

Section: F.7.34.5.

Parameters:

loadConstraintID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.constraint.setCellSpecificationCellClass(cellSpecificationID, cellClass)

Set cellClass enumeration of a cellSpecification (clears cellFunction).

Section: F.7.34.6.

Parameters:

• cellSpecificationID (str)

• cellClass (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.constraint.setCellSpecificationCellFunction(cellSpecificationID, cellFunction)

Set cellFunction enumeration of a cellSpecification (clears cellClass).

Section: F.7.34.7.

Parameters:

• cellSpecificationID (str)

• cellFunction (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.constraint.setConstraintSetDriveConstraint(constraintSetID, cellFunctionOrCellClass)

Create/replace driveConstraint with given type (function or class).

Section: F.7.34.8. Strength left unspecified (None) until separately set.

Parameters:

• constraintSetID (str)

• cellFunctionOrCellClass (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.constraint.setConstraintSetLoadConstraint(constraintSetID, cellFunctionOrCellClass)

Create/replace loadConstraint with given type (function or class).

Section: F.7.34.9.

Parameters:

• constraintSetID (str)

• cellFunctionOrCellClass (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.constraint.setConstraintSetReferenceName(constraintSetID, referenceName)

Set the constraintSetId attribute of a constraintSet.

Section: F.7.34.10.

Parameters:

• constraintSetID (str)

• referenceName (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.constraint.setConstraintSetVector(constraintSetID, vector)

Set vector left/right expression values for a constraintSet.

Section: F.7.34.11. Expects list/tuple of two strings.

Parameters:

• constraintSetID (str)

• vector (list[str])

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.constraint.setDriveConstraintOtherValue(driveConstraintID, other)

Set other attribute for driveConstraint cellFunction variant.

Section: F.7.34.12.

Parameters:

• driveConstraintID (str)

• other (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.constraint.setDriveConstraintValue(driveConstraintID, value)

Set cellStrength (value) for driveConstraint cellSpecification.

Section: F.7.34.13.

Parameters:

• driveConstraintID (str)

• value (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.constraint.setLoadConstraintCellSpecification(loadConstraintID, cellFunctionOrCellClass)

Replace loadConstraint cellSpecification definition.

Section: F.7.34.14.

Parameters:

• loadConstraintID (str)

• cellFunctionOrCellClass (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.constraint.setLoadConstraintCount(loadConstraintID, count)

Set numeric count (expression) of loadConstraint.

Section: F.7.34.15.

Parameters:

• loadConstraintID (str)

• count (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.constraint.setLoadConstraintOtherValue(loadConstraintID, other)

Set other attribute for loadConstraint cellFunction variant.

Section: F.7.34.16.

Parameters:

• loadConstraintID (str)

• other (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.constraint.setTimingConstraintValue(timingConstraintID, value)

Set value of a timingConstraint (stored as float).

Section: F.7.34.17.

Parameters:

• timingConstraintID (str)

• value (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.constraint_set module

Constraint Set category TGI functions (IEEE 1685-2022).

Implements only the public API defined in Annex F sections:

• F.7.35 Constraint Set (BASE)

• F.7.36 Constraint Set (EXTENDED)

Per the 2022 specification these sections currently define exactly two functions:

• getConstraintSetTimingConstraints (F.7.35.1)

• addConstraintSetTimingConstraint (F.7.36.1)

Previous convenience traversal/getter helpers have been removed to satisfy the requirement that this module expose no more and no less than the standard TGI functions. Historical comment section markers are preserved to conform to project guidelines about retaining comments.

Invalid handles raise TgiError with TgiFaultCode.INVALID_ID. Mutation routines return a Boolean status (true on success) unless the spec defines a different return (adding returns the new element handle).

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.constraint_set.addConstraintSetTimingConstraint(constraintSetID, value, clockName)

Add a new timingConstraint to the given constraintSet.

Section: F.7.36.1.

Parameters:

• constraintSetID (str) – Handle referencing a constraintSet element.

• value (float) – Timing constraint value (0.0 – 100.0 inclusive per schema range).

• clockName (str) – Name of the associated clock.

Returns:

Handle of the newly created timingConstraint element.

Return type:

str

Raises:

TgiError – If the parent handle is invalid or value cannot be applied.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.constraint_set.getConstraintSetTimingConstraints(constraintSetID)

Return all timingConstraint values for the given constraintSet.

Section: F.7.35.1.

Parameters:

constraintSetID (str) – Handle referencing a constraintSet element.

Returns:

The list of timing constraint numeric values (empty if none).

Return type:

list[float]

Raises:

TgiError – If the handle does not reference a ConstraintSet.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.core module

Core TGI in-memory infrastructure for IP-XACT 1685-2022.

Central utilities: handle allocation, handle resolution, VLNV registry, and minimal fault/exception scaffolding. This intentionally avoids dependencies outside the standard library.

class amal.eda.ipxact_de.tgi.ipxact.v1685_2022.core.HandleManager

Bases: object

Allocate & resolve opaque handles for Python objects.

detach_child_by_handle(child_handle)

Parameters:

child_handle (str)

Return type:

bool

forget(handle)

Parameters:

handle (str)

Return type:

bool

get(obj)

Parameters:

obj (Any)

Return type:

str

get_parent_info(child_handle)

Parameters:

child_handle (str)

Return type:

_ParentInfo | None

register_parent(child, parent, path, container)

Parameters:

• child (Any)

• parent (Any)

• path (tuple[str, ...])

• container (str)

Return type:

None

resolve(handle)

Parameters:

handle (str)

Return type:

Any | None

class amal.eda.ipxact_de.tgi.ipxact.v1685_2022.core.RegisteredElement(vlnv, root, file_name=None)

Bases: object

Metadata describing a registry entry.

Parameters:

• vlnv (tuple[str, str, str, str])

• root (Any)

• file_name (str | None)

file_name: str | None

root: Any

vlnv: tuple[str, str, str, str]

exception amal.eda.ipxact_de.tgi.ipxact.v1685_2022.core.TgiError(message, fault_code='INTERNAL_ERROR')

Bases: RuntimeError

Base exception with a TGI fault code.

Parameters:

• message (str)

• fault_code (str)

Return type:

None

add_note(object, /)

Exception.add_note(note) – add a note to the exception

args

with_traceback(object, /)

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

class amal.eda.ipxact_de.tgi.ipxact.v1685_2022.core.TgiFaultCode

Bases: str

Subset of TGI fault codes (expand as coverage grows).

ALREADY_EXISTS = 'ALREADY_EXISTS'

INTERNAL_ERROR = 'INTERNAL_ERROR'

INVALID_ARGUMENT = 'INVALID_ARGUMENT'

INVALID_ID = 'INVALID_ID'

NOT_FOUND = 'NOT_FOUND'

capitalize()

Return a capitalized version of the string.

More specifically, make the first character have upper case and the rest lower case.

casefold()

Return a version of the string suitable for caseless comparisons.

center(width, fillchar=' ', /)

Return a centered string of length width.

Padding is done using the specified fill character (default is a space).

count()

Return the number of non-overlapping occurrences of substring sub in string S[start:end].

Optional arguments start and end are interpreted as in slice notation.

encode(encoding='utf-8', errors='strict')

Encode the string using the codec registered for encoding.

encoding

The encoding in which to encode the string.

errors

The error handling scheme to use for encoding errors. The default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith()

Return True if the string ends with the specified suffix, False otherwise.

suffix

A string or a tuple of strings to try.

start

Optional start position. Default: start of the string.

end

Optional stop position. Default: end of the string.

expandtabs(tabsize=8)

Return a copy where all tab characters are expanded using spaces.

If tabsize is not given, a tab size of 8 characters is assumed.

find()

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end].

Optional arguments start and end are interpreted as in slice notation. Return -1 on failure.

format(*args, **kwargs)

Return a formatted version of the string, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map(mapping, /)

Return a formatted version of the string, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

index()

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end].

Optional arguments start and end are interpreted as in slice notation. Raises ValueError when the substring is not found.

isalnum()

Return True if the string is an alpha-numeric string, False otherwise.

A string is alpha-numeric if all characters in the string are alpha-numeric and there is at least one character in the string.

isalpha()

Return True if the string is an alphabetic string, False otherwise.

A string is alphabetic if all characters in the string are alphabetic and there is at least one character in the string.

isascii()

Return True if all characters in the string are ASCII, False otherwise.

ASCII characters have code points in the range U+0000-U+007F. Empty string is ASCII too.

isdecimal()

Return True if the string is a decimal string, False otherwise.

A string is a decimal string if all characters in the string are decimal and there is at least one character in the string.

isdigit()

Return True if the string is a digit string, False otherwise.

A string is a digit string if all characters in the string are digits and there is at least one character in the string.

isidentifier()

Return True if the string is a valid Python identifier, False otherwise.

Call keyword.iskeyword(s) to test whether string s is a reserved identifier, such as “def” or “class”.

islower()

Return True if the string is a lowercase string, False otherwise.

A string is lowercase if all cased characters in the string are lowercase and there is at least one cased character in the string.

isnumeric()

Return True if the string is a numeric string, False otherwise.

A string is numeric if all characters in the string are numeric and there is at least one character in the string.

isprintable()

Return True if all characters in the string are printable, False otherwise.

A character is printable if repr() may use it in its output.

isspace()

Return True if the string is a whitespace string, False otherwise.

A string is whitespace if all characters in the string are whitespace and there is at least one character in the string.

istitle()

Return True if the string is a title-cased string, False otherwise.

In a title-cased string, upper- and title-case characters may only follow uncased characters and lowercase characters only cased ones.

isupper()

Return True if the string is an uppercase string, False otherwise.

A string is uppercase if all cased characters in the string are uppercase and there is at least one cased character in the string.

join(iterable, /)

Concatenate any number of strings.

The string whose method is called is inserted in between each given string. The result is returned as a new string.

Example: ‘.’.join([‘ab’, ‘pq’, ‘rs’]) -> ‘ab.pq.rs’

ljust(width, fillchar=' ', /)

Return a left-justified string of length width.

Padding is done using the specified fill character (default is a space).

lower()

Return a copy of the string converted to lowercase.

lstrip(chars=None, /)

Return a copy of the string with leading whitespace removed.

If chars is given and not None, remove characters in chars instead.

static maketrans()

Return a translation table usable for str.translate().

If there is only one argument, it must be a dictionary mapping Unicode ordinals (integers) or characters to Unicode ordinals, strings or None. Character keys will be then converted to ordinals. If there are two arguments, they must be strings of equal length, and in the resulting dictionary, each character in x will be mapped to the character at the same position in y. If there is a third argument, it must be a string, whose characters will be mapped to None in the result.

partition(sep, /)

Partition the string into three parts using the given separator.

This will search for the separator in the string. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing the original string and two empty strings.

removeprefix(prefix, /)

Return a str with the given prefix string removed if present.

If the string starts with the prefix string, return string[len(prefix):]. Otherwise, return a copy of the original string.

removesuffix(suffix, /)

Return a str with the given suffix string removed if present.

If the string ends with the suffix string and that suffix is not empty, return string[:-len(suffix)]. Otherwise, return a copy of the original string.

replace(old, new, /, count=-1)

Return a copy with all occurrences of substring old replaced by new.

count

Maximum number of occurrences to replace. -1 (the default value) means replace all occurrences.

If the optional argument count is given, only the first count occurrences are replaced.

rfind()

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end].

Optional arguments start and end are interpreted as in slice notation. Return -1 on failure.

rindex()

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end].

Optional arguments start and end are interpreted as in slice notation. Raises ValueError when the substring is not found.

rjust(width, fillchar=' ', /)

Return a right-justified string of length width.

Padding is done using the specified fill character (default is a space).

rpartition(sep, /)

Partition the string into three parts using the given separator.

This will search for the separator in the string, starting at the end. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing two empty strings and the original string.

rsplit(sep=None, maxsplit=-1)

Return a list of the substrings in the string, using sep as the separator string.

sep

The separator used to split the string.

When set to None (the default value), will split on any whitespace character (including n r t f and spaces) and will discard empty strings from the result.

maxsplit

Maximum number of splits. -1 (the default value) means no limit.

Splitting starts at the end of the string and works to the front.

rstrip(chars=None, /)

Return a copy of the string with trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

split(sep=None, maxsplit=-1)

Return a list of the substrings in the string, using sep as the separator string.

sep

The separator used to split the string.

When set to None (the default value), will split on any whitespace character (including n r t f and spaces) and will discard empty strings from the result.

maxsplit

Maximum number of splits. -1 (the default value) means no limit.

Splitting starts at the front of the string and works to the end.

Note, str.split() is mainly useful for data that has been intentionally delimited. With natural text that includes punctuation, consider using the regular expression module.

splitlines(keepends=False)

Return a list of the lines in the string, breaking at line boundaries.

Line breaks are not included in the resulting list unless keepends is given and true.

startswith()

Return True if the string starts with the specified prefix, False otherwise.

prefix

A string or a tuple of strings to try.

start

Optional start position. Default: start of the string.

end

Optional stop position. Default: end of the string.

strip(chars=None, /)

Return a copy of the string with leading and trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

swapcase()

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title()

Return a version of the string where each word is titlecased.

More specifically, words start with uppercased characters and all remaining cased characters have lower case.

translate(table, /)

Replace each character in the string using the given translation table.

table

Translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, strings, or None.

The table must implement lookup/indexing via __getitem__, for instance a dictionary or list. If this operation raises LookupError, the character is left untouched. Characters mapped to None are deleted.

upper()

Return a copy of the string converted to uppercase.

zfill(width, /)

Pad a numeric string with zeros on the left, to fill a field of the given width.

The string is never truncated.

class amal.eda.ipxact_de.tgi.ipxact.v1685_2022.core.VlnvRegistry

Bases: object

In-memory VLNV <-> object registry.

get_id(vlnv_like)

Return handle for VLNV if registered else None.

Parameters:

vlnv_like (Sequence[str] | str)

Return type:

str | None

get_vlnv(handle)

Return VLNV tuple for a registered handle else None.

Parameters:

handle (str)

Return type:

tuple[str, str, str, str] | None

iter_by_predicate(predicate)

Yield handles whose root object satisfies predicate.

Parameters:

predicate – Callable taking the root object and returning bool.

Yields:

Handles for each matching element.

Return type:

Iterable[str]

register(element, vlnv_like, file_name=None, replace=False)

Register (or optionally replace) the VLNV mapping for an element.

Parameters:

• element (Any) – Root model object.

• vlnv_like (Sequence[str] | str) – VLNV as a sequence of (vendor, library, name, version) or a single string delimited by ‘;’ or ‘:’.

• file_name (str | None) – Optional file name the object originated from.

• replace (bool) – If True, replace existing entry silently.

Returns:

True on success.

Return type:

bool

unregister(vlnv_like)

Remove an existing VLNV mapping.

Parameters:

vlnv_like (Sequence[str] | str) – (vendor, library, name, version)

Returns:

True if an entry was removed, else False.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.core.detach_child_by_handle(child_handle)

Parameters:

child_handle (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.core.get_handle(obj)

Return (and allocate if new) handle for obj.

Parameters:

obj (Any)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.core.get_parent_info(child_handle)

Parameters:

child_handle (str)

Return type:

_ParentInfo | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.core.register_parent(child, parent, path, container)

Public helper to register parent relationship (thin wrapper).

Parameters:

• child (Any)

• parent (Any)

• path (tuple[str, ...])

• container (str)

Return type:

None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.core.resolve_handle(handle)

Return underlying object or None if unknown.

Parameters:

handle (str)

Return type:

Any | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.core.vlnv_to_tuple(vlnv_like)

Normalize input to a 4-item VLNV tuple.

Accepts either: - A sequence of four strings: (vendor, library, name, version) - A single string delimited by ‘;’ or ‘:’ (e.g. “vendor;library;name;version”

or “vendor:library:name:version”)

Raises:

TgiError – If the input cannot be parsed as exactly four parts.

Parameters:

vlnv_like (Sequence[str] | str)

Return type:

tuple[str, str, str, str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.cpu module

CPU category TGI functions (IEEE 1685-2022).

Implements BASE (F.7.21) and EXTENDED (F.7.22) CPU functions.

The schema exposes CPUs via component.cpus.cpu[*] each with required name, range, width and memoryMapRef elements plus optional addressUnitBits (expression), regions list, executableImage list and parameter list. Regions have required name, addressOffset and range.

BASE functions provide traversal of CPUs and their regions plus getters for scalar/textual values and numeric/expression/ID triplets where the underlying schema uses an expression type. EXTENDED functions support adding/removing CPUs and regions, setting/clearing optional scalars and assigning expression values.

Assumptions: * Function set aligns with patterns used in bus_definition, assertion, etc. * Numeric getters attempt int() conversion; on failure they return None. * Removal of optional scalar/expression attributes returns True if a change

occurred else False (idempotent semantics).

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.cpu.addComponentCpu(componentID, name, memoryMapRef, rangeValue, widthValue)

Add a cpu to a component.

Parameters:

• componentID (str) – Component handle.

• name (str) – CPU name.

• memoryMapRef (str) – Referenced memory map name.

• rangeValue (int | str) – Integer or expression for range.

• widthValue (int | str) – Integer or expression for width.

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.cpu.addCpuRegion(cpuID, name, addressOffset, rangeValue)

Append a region to a CPU.

Parameters:

• cpuID (str) – CPU handle.

• name (str) – Region name.

• addressOffset (int | str) – Numeric/expression for addressOffset.

• rangeValue (int | str) – Numeric/expression for range.

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.cpu.getComponentCpuIDs(componentID)

Return handles of cpu elements of a component.

Parameters:

componentID (str) – Component handle.

Returns:

Handles list (empty if none).

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.cpu.getCpuAddressUnitBits(cpuID)

Parameters:

cpuID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.cpu.getCpuAddressUnitBitsExpression(cpuID)

Parameters:

cpuID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.cpu.getCpuAddressUnitBitsID(cpuID)

Parameters:

cpuID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.cpu.getCpuDescription(cpuID)

Parameters:

cpuID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.cpu.getCpuDisplayName(cpuID)

Parameters:

cpuID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.cpu.getCpuMemoryMapRef(cpuID)

Parameters:

cpuID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.cpu.getCpuName(cpuID)

Parameters:

cpuID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.cpu.getCpuRange(cpuID)

Parameters:

cpuID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.cpu.getCpuRangeExpression(cpuID)

Parameters:

cpuID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.cpu.getCpuRangeID(cpuID)

Parameters:

cpuID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.cpu.getCpuRegionAddressOffset(regionID)

Parameters:

regionID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.cpu.getCpuRegionAddressOffsetExpression(regionID)

Parameters:

regionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.cpu.getCpuRegionAddressOffsetID(regionID)

Parameters:

regionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.cpu.getCpuRegionDescription(regionID)

Parameters:

regionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.cpu.getCpuRegionDisplayName(regionID)

Parameters:

regionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.cpu.getCpuRegionIDs(cpuID)

Parameters:

cpuID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.cpu.getCpuRegionName(regionID)

Parameters:

regionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.cpu.getCpuRegionRange(regionID)

Parameters:

regionID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.cpu.getCpuRegionRangeExpression(regionID)

Parameters:

regionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.cpu.getCpuRegionRangeID(regionID)

Parameters:

regionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.cpu.getCpuRegionShortDescription(regionID)

Parameters:

regionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.cpu.getCpuShortDescription(cpuID)

Parameters:

cpuID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.cpu.getCpuWidth(cpuID)

Parameters:

cpuID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.cpu.getCpuWidthExpression(cpuID)

Parameters:

cpuID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.cpu.getCpuWidthID(cpuID)

Parameters:

cpuID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.cpu.removeComponentCpu(cpuID)

Remove a cpu element.

Returns True if removed.

Parameters:

cpuID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.cpu.removeCpuAddressUnitBits(cpuID)

Remove addressUnitBits (alias for set with None).

Parameters:

cpuID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.cpu.removeCpuRegion(regionID)

Remove a CPU region by handle.

Parameters:

regionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.cpu.setCpuAddressUnitBits(cpuID, value)

Set or clear addressUnitBits.

Value is stored as an AddressUnitBits expression. Clearing occurs when value is None.

Parameters:

• cpuID (str)

• value (int | str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.cpu.setCpuMemoryMapRef(cpuID, memoryMapRef)

Set or clear the memoryMapRef value.

Parameters:

• cpuID (str)

• memoryMapRef (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.cpu.setCpuRange(cpuID, value)

Set or clear the range expression of a CPU.

Parameters:

• cpuID (str)

• value (int | str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.cpu.setCpuRegionAddressOffset(regionID, value)

Set or clear a region addressOffset expression.

Parameters:

• regionID (str)

• value (int | str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.cpu.setCpuRegionRange(regionID, value)

Set or clear a region range expression.

Parameters:

• regionID (str)

• value (int | str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.cpu.setCpuWidth(cpuID, value)

Set or clear the width expression of a CPU.

Parameters:

• cpuID (str)

• value (int | str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.create module

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design module

Design category TGI functions (IEEE 1685-2022).

Implements BASE (F.7.37) and EXTENDED (F.7.38) Design functions. Only standard public TGI APIs are exposed – no convenience helpers beyond the spec list (“no more, no less”).

Each getter follows the error model used across the TGI layer: * Invalid handle -> TgiError with TgiFaultCode.INVALID_ID where the

spec implies the input must be a valid handle. Where the spec permits an empty result, invalid child collections yield empty lists / None instead.

• Mutators return True on success, False on semantic no-op (e.g. element absent for remove*) and raise INVALID_ID for bad handles.

Created child elements are registered with parent relationships so that handle lifecycle & reverse traversal remain coherent inside the DE.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.addActiveInterfaceExcludePort(activeInterfaceID, excludePort)

Add an excludePort to an activeInterface.

Section: F.7.38.1.

Parameters:

• activeInterfaceID (str)

• excludePort (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.addAdHocConnectionExternalPortReference(adHocConnectionID, portRef)

Add externalPortReference with portRef to adHocConnection.

Section: F.7.38.2.

Parameters:

• adHocConnectionID (str)

• portRef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.addAdHocConnectionInternalPortReference(adHocConnectionID, componentInstanceRef, portRef)

Add internalPortReference.

Section: F.7.38.3.

Parameters:

• adHocConnectionID (str)

• componentInstanceRef (str)

• portRef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.addDesignAdHocConnection(designID, name, componentInstanceRef, portRef)

Add adHocConnection with one internalPortReference.

Section: F.7.38.4.

Parameters:

• designID (str)

• name (str)

• componentInstanceRef (str)

• portRef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.addDesignChoice(designID, name, enumerations=None)

Add choice with name and enumerations.

Section: F.7.38.5.

Parameters:

• designID (str)

• name (str)

• enumerations (list[str] | None)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.addDesignComponentInstance(designID, componentVLNV, componentInstanceName)

Add componentInstance referencing component VLNV.

Section: F.7.38.6.

Parameters:

• designID (str)

• componentVLNV (tuple[str, str, str, str])

• componentInstanceName (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.addDesignExternalAdHocConnection(designID, name, portRef)

Add adHocConnection with single externalPortReference.

Section: F.7.38.7.

Parameters:

• designID (str)

• name (str)

• portRef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.addDesignInterconnection(designID, name, componentInstanceRef1, busInterfaceRef1, componentInstanceRef2, busInterfaceRef2)

Add interconnection with two activeInterface endpoints.

Section: F.7.38.8.

Parameters:

• designID (str)

• name (str)

• componentInstanceRef1 (str)

• busInterfaceRef1 (str)

• componentInstanceRef2 (str)

• busInterfaceRef2 (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.addDesignMonitorInterconnection(designID, name, componentInstanceRef1, activeInterfaceBusInterfaceRef, componentInstanceRef2, interfaceBusInterfaceRef)

Add monitorInterconnection with monitoredActiveInterface + monitorInterface.

Section: F.7.38.9.

Parameters:

• designID (str)

• name (str)

• componentInstanceRef1 (str)

• activeInterfaceBusInterfaceRef (str)

• componentInstanceRef2 (str)

• interfaceBusInterfaceRef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.addInterconnectionActiveInterface(interconnectionID, componentInstanceRef, busInterfaceRef)

Add an activeInterface to an interconnection.

Section: F.7.38.10.

Parameters:

• interconnectionID (str)

• componentInstanceRef (str)

• busInterfaceRef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.addInterconnectionHierInterface(interconnectionID, busInterfaceRef)

Add a hierInterface to an interconnection.

Section: F.7.38.11.

Parameters:

• interconnectionID (str)

• busInterfaceRef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.addMonitorInterconnectionMonitorInterface(monitorInterconnectionID, componentInstanceRef, busInterfaceRef)

Add monitorInterface to a monitorInterconnection.

Section: F.7.38.12.

Parameters:

• monitorInterconnectionID (str)

• componentInstanceRef (str)

• busInterfaceRef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.getActiveinterfaceExcludePortIDs(activeInterfaceID)

Return handles of excludePort elements of an activeInterface.

Section: F.7.37.1.

Parameters:

activeInterfaceID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.getAdHocConnectionExternalPortReferenceIDs(adHocConnectionID)

Return handles of externalPortReference children.

Section: F.7.37.2.

Parameters:

adHocConnectionID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.getAdHocConnectionInternalPortReferenceIDs(adHocConnectionID)

Return handles of internalPortReference children.

Section: F.7.37.3.

Parameters:

adHocConnectionID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.getAdHocConnectionTiedValue(adHocConnectionID)

Return tiedValue value if present.

Section: F.7.37.4.

Parameters:

adHocConnectionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.getAdHocConnectionTiedValueExpression(adHocConnectionID)

Return tiedValue expression string.

Section: F.7.37.5.

Parameters:

adHocConnectionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.getAdHocConnectionTiedValueID(adHocConnectionID)

Return handle of tiedValue element.

Section: F.7.37.6.

Parameters:

adHocConnectionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.getComponentInstanceComponentRefByID(componentInstanceID)

Return handle of referenced component (componentRef).

Section: F.7.37.8. (Design currently does not resolve to actual component object – placeholder None)

Parameters:

componentInstanceID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.getComponentInstanceComponentRefByVLNV(componentInstanceID)

Return (vendor, library, name, version) VLNV referenced.

Section: F.7.37.9.

Parameters:

componentInstanceID (str)

Return type:

tuple[str | None, str | None, str | None, str | None]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.getComponentInstanceName(componentInstanceID)

Return componentInstance name.

Section: F.7.37.10.

Parameters:

componentInstanceID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.getComponentInstancePowerDomainLinkIDs(componentInstanceID)

Parameters:

componentInstanceID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.getDesignAdHocConnectionIDs(designID)

Return handles of adHocConnection children.

Section: F.7.37.12.

Parameters:

designID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.getDesignChoiceIDs(designID)

Return handles of choice elements.

Section: F.7.37.13.

Parameters:

designID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.getDesignComponentInstanceIDs(designID)

Return handles of componentInstance elements.

Section: F.7.37.14.

Parameters:

designID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.getDesignID(top)

Return handle to current or top design.

Section: F.7.37.15. (Current DE context not tracked; return None.)

Parameters:

top (bool)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.getDesignInterconnectionIDs(designID)

Return handles of interconnection elements.

Section: F.7.37.16.

Parameters:

designID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.getDesignMonitorInterconnectionIDs(designID)

Return handles of monitorInterconnection elements.

Section: F.7.37.17.

Parameters:

designID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.getExternalPortReferencePartSelectID(externalPortReferenceID)

Return handle of partSelect element of externalPortReference.

Section: F.7.37.18.

Parameters:

externalPortReferenceID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.getExternalPortReferencePortRefByName(externalPortReferenceID)

Return portRef attribute of externalPortReference.

Section: F.7.37.19.

Parameters:

externalPortReferenceID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.getExternalPortReferenceSubPortReferenceIDs(externalPortReferenceID)

Return handles of subPortReference elements for externalPortReference.

Section: F.7.37.20.

Parameters:

externalPortReferenceID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.getInterconnectionActiveInterfaceIDs(interconnectionID)

Return handles of activeInterface children.

Section: F.7.37.21.

Parameters:

interconnectionID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.getInterconnectionHierInterfaceIDs(interconnectionID)

Return handles of hierInterface children.

Section: F.7.37.22.

Parameters:

interconnectionID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.getInternalPortReferenceComponentInstanceRefByName(internalPortReferenceID)

Return componentInstanceRef attribute value.

Section: F.7.37.7.

Parameters:

internalPortReferenceID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.getInternalPortReferencePartSelectID(internalPortReferenceID)

Return handle of partSelect element for internalPortReference.

Section: F.7.37.23.

Parameters:

internalPortReferenceID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.getInternalPortReferencePortRefByName(internalPortReferenceID)

Return portRef attribute from internalPortReference.

Section: F.7.37.24.

Parameters:

internalPortReferenceID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.getInternalPortReferenceSubPortReferenceIDs(internalPortReferenceID)

Return handles of subPortReference elements of internalPortReference.

Section: F.7.37.25.

Parameters:

internalPortReferenceID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.getMonitorInterconnectionMonitorInterfaceIDs(monitorInterconnectionID)

Return handles of monitorInterface elements.

Section: F.7.37.26.

Parameters:

monitorInterconnectionID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.getMonitorInterconnectionMonitoredActiveInterfaceID(monitorInterconnectionID)

Return handle of monitoredActiveInterface element.

Section: F.7.37.27.

Parameters:

monitorInterconnectionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.getPowerDomainLinkExternalPowerDomainRef(powerDomainLinkID)

Return external power domain value from powerDomainLink.

Section: F.7.37.28.

Parameters:

powerDomainLinkID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.getPowerDomainLinkExternalPowerDomainRefByID(powerDomainLinkID)

Return handle to referenced external power domain (not resolved).

Section: F.7.37.29. (Not resolvable without external library; returns None.)

Parameters:

powerDomainLinkID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.getPowerDomainLinkExternalPowerDomainRefByName(powerDomainLinkID)

Return external power domain referenced (string).

Section: F.7.37.30.

Parameters:

powerDomainLinkID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.getPowerDomainLinkExternalPowerDomainRefID(powerDomainLinkID)

Return handle of external power domain expression element.

Section: F.7.37.32.

Parameters:

powerDomainLinkID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.getPowerDomainLinkInternalPowerDomainRefs(powerDomainLinkID)

Return internal power domain reference expressions (strings).

Section: F.7.37.33.

Parameters:

powerDomainLinkID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.removeActiveInterfaceExcludePort(excludePortID)

Remove excludePort element.

Section: F.7.38.13.

Parameters:

excludePortID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.removeAdHocConnectionExternalPortReference(externalPortReferenceID)

Remove externalPortReference element.

Section: F.7.38.14.

Parameters:

externalPortReferenceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.removeAdHocConnectionInternalPortReference(internalPortReferenceID)

Remove internalPortReference element.

Section: F.7.38.15.

Parameters:

internalPortReferenceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.removeAdHocConnectionTiedValue(adHocConnectionID)

Remove tiedValue element from adHocConnection.

Section: F.7.38.16.

Parameters:

adHocConnectionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.removeDesignAdHocConnection(adHocConnectionID)

Remove adHocConnection element.

Section: F.7.38.17.

Parameters:

adHocConnectionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.removeDesignChoice(choiceID)

Remove choice element.

Section: F.7.38.18.

Parameters:

choiceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.removeDesignComponentInstance(componentInstanceID)

Remove componentInstance element.

Section: F.7.38.19.

Parameters:

componentInstanceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.removeDesignInterconnection(interconnectionID)

Remove interconnection element.

Section: F.7.38.20.

Parameters:

interconnectionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.removeDesignMonitorConnection(monitorInterconnectionID)

Remove monitorInterconnection element.

Section: F.7.38.21.

Parameters:

monitorInterconnectionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.removeExternalPortReferencePartSelect(externalPortReferenceID)

Remove partSelect from externalPortReference.

Section: F.7.38.22.

Parameters:

externalPortReferenceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.removeExternalPortReferenceSubPortReference(subPortRefID)

Remove a subPortReference element (external).

Section: F.7.38.23.

Parameters:

subPortRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.removeInterconnectionActiveInterface(activeInterfaceID)

Remove activeInterface element.

Section: F.7.38.24.

Parameters:

activeInterfaceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.removeInterconnectionHierInterface(hierInterfaceID)

Remove hierInterface element.

Section: F.7.38.25.

Parameters:

hierInterfaceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.removeInternalPortReferencePartSelect(internalPortReferenceID)

Remove partSelect from internalPortReference.

Section: F.7.38.26.

Parameters:

internalPortReferenceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.removeInternalPortReferenceSubPortReference(subPortRefID)

Remove subPortReference element (internal).

Section: F.7.38.27.

Parameters:

subPortRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.removeMonitorInterconnectionMonitorInterface(monitorInterfaceID)

Remove monitorInterface element.

Section: F.7.38.28.

Parameters:

monitorInterfaceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.setAdHocConnectionTiedValue(adHocConnectionID, tiedValue)

Set tiedValue value (creates element if absent).

Section: F.7.38.29.

Parameters:

• adHocConnectionID (str)

• tiedValue (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.setComponentInstanceComponentRef(componentInstanceID, componentVLNV)

Set componentRef VLNV on componentInstance.

Section: F.7.38.30.

Parameters:

• componentInstanceID (str)

• componentVLNV (tuple[str, str, str, str])

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.setExternalPortReferencePartSelect(externalPortReferenceID, range, indices)

Set partSelect on externalPortReference (replaces existing).

Section: F.7.38.31.

Parameters:

• externalPortReferenceID (str)

• range (tuple[str, str] | None)

• indices (list[str] | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.setInterconnectionActiveInterface(interconnectionID, componentInstanceRef, busRef)

Set (replace) first activeInterface of interconnection.

Section: F.7.38.33.

Parameters:

• interconnectionID (str)

• componentInstanceRef (str)

• busRef (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.setInterconnectionHierInterface(interconnectionID, busRef)

Set (replace) first hierInterface entry.

Section: F.7.38.34.

Parameters:

• interconnectionID (str)

• busRef (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.setInternalPortReferencePartSelect(internalPortReferenceID, range, indices)

Set partSelect on internalPortReference.

Section: F.7.38.32.

Parameters:

• internalPortReferenceID (str)

• range (tuple[str, str] | None)

• indices (list[str] | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.setMonitorInterconnectionMonitoredActiveInterface(monitorInterconnectionID, componentInstanceRef, busRef)

Set monitoredActiveInterface element.

Section: F.7.38.35.

Parameters:

• monitorInterconnectionID (str)

• componentInstanceRef (str)

• busRef (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.setMonitoredActiveInterfacePath(monitoredActiveInterfaceID, path)

Set path attribute on monitoredActiveInterface.

Section: F.7.38.36.

Parameters:

• monitoredActiveInterfaceID (str)

• path (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design.setPowerDomainLinkExternalPowerDomainRef(powerDomainLinkID, expression)

Set external power domain reference expression.

Section: F.7.38.37.

Parameters:

• powerDomainLinkID (str)

• expression (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design_configuration module

Design configuration category TGI functions (IEEE 1685-2022).

Implements BASE (F.7.39) and EXTENDED (F.7.40) functions for designConfiguration. Only the public TGI API (“no more, no less”) is exported. Mutators return True on success and raise TgiError with TgiFaultCode.INVALID_ID for invalid handles. If an element to remove is not found the function returns False without raising.

Helper functions are prefixed with _ and intentionally excluded from the public API surface.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design_configuration.addAbstractorInstancesAbstractorInstance(abstractorInstancesID, instanceName, viewName, abstractorRefVLNV)

Create and append an abstractorInstance.

Section: F.7.40.1.

Parameters:

• abstractorInstancesID (str)

• instanceName (str)

• viewName (str)

• abstractorRefVLNV (tuple[str, str, str, str])

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design_configuration.addAbstractorInstancesInterfaceRef(abstractorInstancesID, componentRef, busRef)

Add an interfaceRef to an abstractorInstances container.

Section: F.7.40.2.

Parameters:

• abstractorInstancesID (str)

• componentRef (str)

• busRef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design_configuration.addDesignConfChoice(designConfigurationID, name)

Add a choice element to the designConfiguration.

Section: F.7.40.3.

Parameters:

• designConfigurationID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design_configuration.addDesignConfigurationGeneratorChainConfiguration(designConfigurationID, vlnv)

Append a generatorChainConfiguration reference.

Section: F.7.40.4.

Parameters:

• designConfigurationID (str)

• vlnv (tuple[str, str, str, str])

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design_configuration.addDesignConfigurationInterconnectionConfiguration(designConfigurationID, interconnectionRef)

Create and append an interconnectionConfiguration with the given ref.

Section: F.7.40.5.

Parameters:

• designConfigurationID (str)

• interconnectionRef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design_configuration.addDesignConfigurationViewConfiguration(designConfigurationID, instanceName, viewRef)

Add a viewConfiguration selecting a viewRef for an instance.

Section: F.7.40.6.

Parameters:

• designConfigurationID (str)

• instanceName (str)

• viewRef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design_configuration.addInterconnectionConfigurationAbstractorInstances(interconnectionConfigurationID)

Append an empty abstractorInstances grouping.

Section: F.7.40.7.

Parameters:

interconnectionConfigurationID (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design_configuration.getAbstractorInstanceAbstractorRefByID(abstractorInstanceID)

Return handle of the abstractorRef element of an abstractorInstance.

Section: F.7.39.1. Returns None if not present (schema requires it though).

Parameters:

abstractorInstanceID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design_configuration.getAbstractorInstanceAbstractorRefByVLNV(abstractorInstanceID)

Return (vendor, library, name, version) of the abstractorRef.

Section: F.7.39.2.

Parameters:

abstractorInstanceID (str)

Return type:

tuple[str | None, str | None, str | None, str | None]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design_configuration.getAbstractorInstanceInstanceName(abstractorInstanceID)

Return instanceName of an abstractorInstance.

Section: F.7.39.3.

Parameters:

abstractorInstanceID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design_configuration.getAbstractorInstanceViewName(abstractorInstanceID)

Return viewName of an abstractorInstance.

Section: F.7.39.4.

Parameters:

abstractorInstanceID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design_configuration.getAbstractorInstancesAbstractorInstanceIDs(abstractorInstancesID)

Return handles of abstractorInstance children within an abstractorInstances container.

Section: F.7.39.5.

Parameters:

abstractorInstancesID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design_configuration.getAbstractorInstancesInterfaceRefIDs(abstractorInstancesID)

Return handles of interfaceRef elements under an abstractorInstances.

Section: F.7.39.6.

Parameters:

abstractorInstancesID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design_configuration.getDesignConfigurationChoiceIDs(designConfigurationID)

Return handles of choice elements.

Section: F.7.39.7.

Parameters:

designConfigurationID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design_configuration.getDesignConfigurationDesignRefByID(designConfigurationID)

Return handle of the designRef element.

Section: F.7.39.8.

Parameters:

designConfigurationID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design_configuration.getDesignConfigurationDesignRefByVLNV(designConfigurationID)

Return designRef VLNV tuple.

Section: F.7.39.9.

Parameters:

designConfigurationID (str)

Return type:

tuple[str | None, str | None, str | None, str | None]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design_configuration.getDesignConfigurationGeneratorChainConfigurationIDs(designConfigurationID)

Return handles of generatorChainConfiguration entries.

Section: F.7.39.10.

Parameters:

designConfigurationID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design_configuration.getDesignConfigurationInterconnectionConfigurationIDs(designConfigurationID)

Return handles of interconnectionConfiguration entries.

Section: F.7.39.11.

Parameters:

designConfigurationID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design_configuration.getDesignConfigurationViewConfigurationIDs(designConfigurationID)

Return handles of viewConfiguration entries.

Section: F.7.39.12.

Parameters:

designConfigurationID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design_configuration.getGeneratorChainConfigurationRefByID(generatorChainConfigurationID)

Return handle of a generatorChainConfiguration element (identity pass-through).

Section: F.7.39.13. Provided for spec completeness – the handle is the object itself.

Parameters:

generatorChainConfigurationID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design_configuration.getGeneratorChainConfigurationRefByVLNV(generatorChainConfigurationID)

Return VLNV of a generatorChainConfiguration reference.

Section: F.7.39.14.

Parameters:

generatorChainConfigurationID (str)

Return type:

tuple[str | None, str | None, str | None, str | None]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design_configuration.getInterconnectionConfigurationAbstractorsInstancesIDs(interconnectionConfigurationID)

Return handles of abstractorInstances groups under an interconnectionConfiguration.

Section: F.7.39.15.

Parameters:

interconnectionConfigurationID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design_configuration.getInterconnectionConfigurationInterconnectionRefByID(interconnectionConfigurationID)

Return the interconnectionRef as a string (ID form).

Section: F.7.39.16. The reference is a name string, so we return it directly.

Parameters:

interconnectionConfigurationID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design_configuration.getInterconnectionConfigurationInterconnectionRefByName(interconnectionConfigurationID)

Alias of F.7.39.16 per spec naming – returns the interconnectionRef name.

Section: F.7.39.17.

Parameters:

interconnectionConfigurationID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design_configuration.getViewConfigurationConfigurableElementValueIDs(viewConfigurationID)

Return handles of configurableElementValue children within a viewConfiguration’s view.

Section: F.7.39.18.

Parameters:

viewConfigurationID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design_configuration.getViewConfigurationInstanceName(viewConfigurationID)

Return instanceName for a viewConfiguration.

Section: F.7.39.19.

Parameters:

viewConfigurationID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design_configuration.getViewConfigurationViewID(viewConfigurationID)

Return handle of the view element of a viewConfiguration.

Section: F.7.39.20.

Parameters:

viewConfigurationID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design_configuration.removeAbstractorInstancesAbstractorInstance(abstractorInstanceID)

Remove an abstractorInstance.

Section: F.7.40.8. Returns False if handle invalid or not found under its parent.

Parameters:

abstractorInstanceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design_configuration.removeAbstractorInstancesInterfaceRef(interfaceRefID)

Remove an interfaceRef.

Section: F.7.40.9.

Parameters:

interfaceRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design_configuration.removeDesignConfChoice(choiceID)

Remove a design configuration choice.

Section: F.7.40.10.

Parameters:

choiceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design_configuration.removeDesignConfigurationDesignRef(designConfigurationID)

Remove the designRef element.

Section: F.7.40.11.

Parameters:

designConfigurationID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design_configuration.removeDesignConfigurationGeneratorChainConfiguration(generatorChainConfigurationID)

Remove a generatorChainConfiguration reference.

Section: F.7.40.12.

Parameters:

generatorChainConfigurationID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design_configuration.removeDesignConfigurationInterconnectionConfiguration(interconnectionConfigurationID)

Remove an interconnectionConfiguration element.

Section: F.7.40.13.

Parameters:

interconnectionConfigurationID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design_configuration.removeDesignConfigurationViewConfiguration(viewConfigurationID)

Remove a viewConfiguration element.

Section: F.7.40.14.

Parameters:

viewConfigurationID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design_configuration.removeInterconnectionConfigurationAbstractorInstances(abstractorInstancesID)

Remove an abstractorInstances grouping.

Section: F.7.40.15.

Parameters:

abstractorInstancesID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design_configuration.removeViewConfigurationConfigurableElementValue(configurableElementValueID)

Remove a configurableElementValue.

Section: F.7.40.16.

Parameters:

configurableElementValueID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design_configuration.setAbstractorInstanceAbstractorRef(abstractorInstanceID, vlnv)

Set (replace) the abstractorRef of an abstractorInstance.

Section: F.7.40.17.

Parameters:

• abstractorInstanceID (str)

• vlnv (tuple[str, str, str, str])

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design_configuration.setAbstractorInstanceInstanceName(abstractorInstanceID, instanceName)

Set instanceName of an abstractorInstance.

Section: F.7.40.18.

Parameters:

• abstractorInstanceID (str)

• instanceName (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design_configuration.setAbstractorInstanceViewName(abstractorInstanceID, viewName)

Set viewName of an abstractorInstance.

Section: F.7.40.19.

Parameters:

• abstractorInstanceID (str)

• viewName (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.design_configuration.setDesignConfigurationDesignRef(designConfigurationID, vlnv)

Set (or create) the designRef reference.

Section: F.7.40.20.

Parameters:

• designConfigurationID (str)

• vlnv (tuple[str, str, str, str])

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.driver module

Driver category TGI functions (IEEE 1685-2022).

Implements BASE (F.7.41) and EXTENDED (F.7.42) public TGI functions for driver elements. A driver represents value-driving semantics for wire ports – clock drivers, single-shot drivers, default values and optional range and viewRef associations. Only the API defined in Annex F is exported (no more, no less).

Mutator functions return True on success; remove* functions return False when the target element/attribute was absent. All functions raise TgiError with TgiFaultCode.INVALID_ID for invalid handles. Value/ expression getters return None when the element does not exist.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.driver.addDriverSingleShotDriver(driverID)

Create singleShotDriver (empty skeleton) if absent and return handle.

Section: F.7.42.1.

Parameters:

driverID (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.driver.addDriverViewRef(driverID, viewRef)

Append a viewRef value reference and return its handle.

Section: F.7.42.2.

Parameters:

• driverID (str)

• viewRef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.driver.getClockDriverClockPeriod(clockDriverID)

Return numeric value of clockPeriod.

Section: F.7.41.1.

Parameters:

clockDriverID (str)

Return type:

float | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.driver.getClockDriverClockPeriodExpression(clockDriverID)

Return expression string of clockPeriod if present.

Section: F.7.41.2.

Parameters:

clockDriverID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.driver.getClockDriverClockPeriodID(clockDriverID)

Return handle of clockPeriod element.

Section: F.7.41.3.

Parameters:

clockDriverID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.driver.getClockDriverClockPulseDuration(clockDriverID)

Return numeric value of clockPulseDuration.

Section: F.7.41.4.

Parameters:

clockDriverID (str)

Return type:

float | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.driver.getClockDriverClockPulseDurationExpression(clockDriverID)

Return expression for clockPulseDuration.

Section: F.7.41.5.

Parameters:

clockDriverID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.driver.getClockDriverClockPulseDurationID(clockDriverID)

Return handle of clockPulseDuration.

Section: F.7.41.6.

Parameters:

clockDriverID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.driver.getClockDriverClockPulseOffset(clockDriverID)

Return numeric value of clockPulseOffset.

Section: F.7.41.7.

Parameters:

clockDriverID (str)

Return type:

float | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.driver.getClockDriverClockPulseOffsetExpression(clockDriverID)

Return expression of clockPulseOffset.

Section: F.7.41.8.

Parameters:

clockDriverID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.driver.getClockDriverClockPulseOffsetID(clockDriverID)

Return handle of clockPulseOffset.

Section: F.7.41.9.

Parameters:

clockDriverID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.driver.getClockDriverClockPulseValue(clockDriverID)

Return numeric bit value of clockPulseValue.

Section: F.7.41.10.

Parameters:

clockDriverID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.driver.getClockDriverClockPulseValueExpression(clockDriverID)

Return expression of clockPulseValue.

Section: F.7.41.11.

Parameters:

clockDriverID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.driver.getClockDriverClockPulseValueID(clockDriverID)

Return handle of clockPulseValue element.

Section: F.7.41.12.

Parameters:

clockDriverID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.driver.getDriverClockDriverID(driverID)

Return handle of clockDriver child of a driver.

Section: F.7.41.13.

Parameters:

driverID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.driver.getDriverDefaultValue(driverID)

Return defaultValue numeric or string value.

Section: F.7.41.14.

Parameters:

driverID (str)

Return type:

int | str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.driver.getDriverDefaultValueExpression(driverID)

Return expression of defaultValue.

Section: F.7.41.15.

Parameters:

driverID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.driver.getDriverDefaultValueID(driverID)

Return handle of defaultValue element.

Section: F.7.41.16.

Parameters:

driverID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.driver.getDriverLeftID(driverID)

Return handle of range.left.

Section: F.7.41.17.

Parameters:

driverID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.driver.getDriverRange(driverID)

Return (leftValue, rightValue) of range.

Section: F.7.41.18.

Parameters:

driverID (str)

Return type:

tuple[int | None, int | None]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.driver.getDriverRangeExpression(driverID)

Return (leftExpression, rightExpression) of range.

Section: F.7.41.19.

Parameters:

driverID (str)

Return type:

tuple[str | None, str | None]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.driver.getDriverRightID(driverID)

Return handle of range.right.

Section: F.7.41.20.

Parameters:

driverID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.driver.removeDriverClockDriver(clockDriverID)

Remove the clockDriver element.

Section: F.7.42.3.

Parameters:

clockDriverID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.driver.removeDriverRange(driverID)

Remove the range child of a driver.

Section: F.7.42.4.

Parameters:

driverID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.driver.removeDriverSingleShotDriver(singleShotDriverID)

Remove the singleShotDriver element.

Section: F.7.42.5.

Parameters:

singleShotDriverID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.driver.removeDriverViewRef(viewRefID)

Remove a viewRef entry.

Section: F.7.42.6.

Parameters:

viewRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.driver.setClockDriverClockPeriod(clockDriverID, value, expression=None)

Set clockPeriod value/expression of an existing clockDriver.

Section: F.7.42.7.

Parameters:

• clockDriverID (str)

• value (float)

• expression (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.driver.setClockDriverClockPulseDuration(clockDriverID, value, expression=None)

Set clockPulseDuration fields.

Section: F.7.42.8.

Parameters:

• clockDriverID (str)

• value (float)

• expression (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.driver.setClockDriverClockPulseOffset(clockDriverID, value, expression=None)

Set clockPulseOffset fields.

Section: F.7.42.9.

Parameters:

• clockDriverID (str)

• value (float)

• expression (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.driver.setClockDriverClockPulseValue(clockDriverID, value, expression=None)

Set clockPulseValue fields.

Section: F.7.42.10.

Parameters:

• clockDriverID (str)

• value (int)

• expression (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.driver.setDriverClockDriver(driverID)

Ensure clockDriver exists (creating if necessary) and return its handle.

Section: F.7.42.11.

Parameters:

driverID (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.driver.setDriverDefaultValue(driverID, value, expression=None)

Set defaultValue contents (creating element if missing).

Section: F.7.42.13.

Parameters:

• driverID (str)

• value (int | str)

• expression (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.driver.setDriverRange(driverID, leftValue, rightValue, leftExpression=None, rightExpression=None)

Set range bounds creating range if required.

Section: F.7.42.14.

Parameters:

• driverID (str)

• leftValue (int)

• rightValue (int)

• leftExpression (str | None)

• rightExpression (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.driver.setDriverSingleShotDriver(driverID)

Ensure singleShotDriver exists and return its handle.

Section: F.7.42.12.

Parameters:

driverID (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.driver.setOtherClockDriverClockPeriod(driverID, value, expression=None)

Create/ensure clockDriver then set clockPeriod.

Section: F.7.42.15.

Parameters:

• driverID (str)

• value (float)

• expression (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.driver.setOtherClockDriverClockPulseDuration(driverID, value, expression=None)

Ensure clockDriver then set clockPulseDuration.

Section: F.7.42.16.

Parameters:

• driverID (str)

• value (float)

• expression (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.driver.setOtherClockDriverClockPulseOffset(driverID, value, expression=None)

Ensure clockDriver then set clockPulseOffset.

Section: F.7.42.17.

Parameters:

• driverID (str)

• value (float)

• expression (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.driver.setOtherClockDriverClockPulseValue(driverID, value, expression=None)

Ensure clockDriver then set clockPulseValue.

Section: F.7.42.18.

Parameters:

• driverID (str)

• value (int)

• expression (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.driver.setSingleShotDriverSingleShotDuration(singleShotDriverID, value, expression=None)

Set duration field of an existing singleShotDriver.

Section: F.7.42.19.

Parameters:

• singleShotDriverID (str)

• value (float)

• expression (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.driver.setSingleShotDriverSingleShotOffset(singleShotDriverID, value, expression=None)

Set offset field of an existing singleShotDriver.

Section: F.7.42.20.

Parameters:

• singleShotDriverID (str)

• value (float)

• expression (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute module

Element attribute category TGI functions (IEEE 1685-2022).

Implements BASE (F.7.43) and EXTENDED (F.7.44) Element attribute functions.

Design goals: * Provide exact public API surface mandated by Annex F – no extra helpers. * Keep implementation data-driven to avoid hand-maintaining ~280 functions. * Maintain uniform error semantics (invalid handles => INVALID_ID, coercion

failures => INVALID_ARGUMENT) matching other rewritten category modules.

Previous generic helper functions (getElementVendor, getElementLibrary, …) have been superseded by the exhaustive spec-defined function set and were removed intentionally to honor the “no more, no less” requirement. Their removal is recorded here to retain historical context (project rule: do not remove comments / commented code) – see version control for prior content.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.addConstrainedAttribute(elementID, constrained)

Add or replace the ‘constrained’ attribute.

Section: F.7.44.1.

Parameters:

• elementID (str) – Element handle.

• constrained (str) – Attribute value string.

Returns:

True on success.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getAddressBlockRefAttribute(elementID, *, _attr='addressBlockRef', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getAddressBlockRefAttributeByID(elementID, *, _attr='addressBlockRef', _rtype='ref', _kind='ref')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getAddressSpaceRefAttribute(elementID, *, _attr='addressSpaceRef', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getAddressSpaceRefAttributeByID(elementID, *, _attr='addressSpaceRef', _rtype='ref', _kind='ref')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getAllBitsBooleanAttribute(elementID, *, _attr='allBits', _rtype='bool', _kind='bool')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getAllLogicalDirectionsAllowedBooleanAttribute(elementID, *, _attr='allLogicalDirectionsAllowed', _rtype='bool', _kind='bool')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getAllLogicalInitiativesAllowedBooleanAttribute(elementID, *, _attr='allLogicalInitiativesAllowed', _rtype='bool', _kind='bool')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getAlternateRegisterRefAttribute(elementID, *, _attr='alternateRegisterRef', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getAlternateRegisterRefAttributeByID(elementID, *, _attr='alternateRegisterRef', _rtype='ref', _kind='ref')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getAppendBooleanAttribute(elementID, *, _attr='append', _rtype='bool', _kind='bool')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getArrayIdAttribute(elementID, *, _attr='arrayId', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getBankAlignmentAttribute(elementID, *, _attr='bankAlignment', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getBankRefAttribute(elementID, *, _attr='bankRef', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getBankRefAttributeByID(elementID, *, _attr='bankRef', _rtype='ref', _kind='ref')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getBusRefAttribute(elementID, *, _attr='busRef', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getBusRefAttributeByID(elementID, *, _attr='busRef', _rtype='ref', _kind='ref')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getCellStrengthAttribute(elementID, *, _attr='cellStrength', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getChoiceRefAttribute(elementID, *, _attr='choiceRef', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getChoiceRefAttributeByID(elementID, *, _attr='choiceRef', _rtype='ref', _kind='ref')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getClockEdgeAttribute(elementID, *, _attr='clockEdge', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getClockNameAttribute(elementID, *, _attr='clockName', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getClockSourceAttribute(elementID, *, _attr='clockSource', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getComponentInstanceRefAttribute(elementID, *, _attr='componentInstanceRef', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getComponentInstanceRefAttributeByID(elementID, *, _attr='componentInstanceRef', _rtype='ref', _kind='ref')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getComponentRefAttribute(elementID, *, _attr='componentRef', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getComponentRefAttributeByID(elementID, *, _attr='componentRef', _rtype='ref', _kind='ref')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getConfigGroupsAttribute(elementID, *, _attr='configGroups', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getConstrainedAttributeValues(elementID, *, _attr='constrained', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getConstraintSetIdAttribute(elementID, *, _attr='constraintSetId', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getCustomAttribute(elementID, *, _attr='custom', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getDataTypeAttribute(elementID, *, _attr='dataType', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getDataTypeDefinitionAttribute(elementID, *, _attr='dataTypeDefinition', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getDefaultBooleanAttribute(elementID, *, _attr='default', _rtype='bool', _kind='bool')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getDelayTypeAttribute(elementID, *, _attr='delayType', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getDirectionAttribute(elementID, *, _attr='direction', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getDriverTypeAttribute(elementID, *, _attr='driverType', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getExactBooleanAttribute(elementID, *, _attr='exact', _rtype='bool', _kind='bool')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getExternalDeclarationsBooleanAttribute(elementID, *, _attr='externalDeclarations', _rtype='bool', _kind='bool')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getFieldRefAttribute(elementID, *, _attr='fieldRef', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getFieldRefAttributeByID(elementID, *, _attr='fieldRef', _rtype='ref', _kind='ref')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getFileIdAttribute(elementID, *, _attr='fileId', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getFlowTypeAttribute(elementID, *, _attr='flowType', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getForceBooleanAttribute(elementID, *, _attr='force', _rtype='bool', _kind='bool')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getGroupAttribute(elementID, *, _attr='group', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getHelpAttribute(elementID, *, _attr='help', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getHiddenBooleanAttribute(elementID, *, _attr='hidden', _rtype='bool', _kind='bool')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getIdAttribute(elementID, *, _attr='id', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getImageIdAttribute(elementID, *, _attr='imageId', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getImageTypeAttribute(elementID, *, _attr='imageType', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getImplicitBooleanAttribute(elementID, *, _attr='implicit', _rtype='bool', _kind='bool')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getIndexVarAttribute(elementID, *, _attr='indexVar', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getInitiatorRefAttribute(elementID, *, _attr='initiatorRef', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getInitiatorRefAttributeByID(elementID, *, _attr='initiatorRef', _rtype='ref', _kind='ref')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getInterfaceModeAttribute(elementID, *, _attr='interfaceMode', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getInvertAttribute(elementID, *, _attr='invert', _rtype='bool', _kind='bool')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getIsIOBooleanAttribute(elementID, *, _attr='isIO', _rtype='bool', _kind='bool')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getLevelAttribute(elementID, *, _attr='level', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getLibextAttribute(elementID, *, _attr='libext', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getLibraryAttribute(elementID, *, _attr='library', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getMandatoryBooleanAttribute(elementID, *, _attr='mandatory', _rtype='bool', _kind='bool')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getMaximumAttribute(elementID, *, _attr='maximum', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getMaximumDoubleAttribute(elementID, *, _attr='maximum', _rtype='float', _kind='float')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getMaximumIntAttribute(elementID, *, _attr='maximum', _rtype='int', _kind='int')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getMemoryMapRefAttribute(elementID, *, _attr='memoryMapRef', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getMemoryMapRefAttributeByID(elementID, *, _attr='memoryMapRef', _rtype='ref', _kind='ref')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getMemoryReMapRefAttributeByID(elementID, *, _attr='memoryReMapRef', _rtype='ref', _kind='ref')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getMemoryRemapRefAttribute(elementID, *, _attr='memoryRemapRef', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getMinimumAttribute(elementID, *, _attr='minimum', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getMinimumDoubleAttribute(elementID, *, _attr='minimum', _rtype='float', _kind='float')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getMinimumIntAttribute(elementID, *, _attr='minimum', _rtype='int', _kind='int')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getMisalignmentAllowedBooleanAttribute(elementID, *, _attr='misalignmentAllowed', _rtype='bool', _kind='bool')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getModeRefAttribute(elementID, *, _attr='modeRef', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getModifyAttribute(elementID, *, _attr='modify', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getMultipleGroupSelectionOperatorAttribute(elementID, *, _attr='multipleGroupSelectionOperator', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getNameAttribute(elementID, *, _attr='name', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getOrderFloatAttribute(elementID, *, _attr='order', _rtype='float', _kind='float')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getOtherAnyAttribute(elementID, *, _attr='otherAny', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getOtherAttribute(elementID, *, _attr='other', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getOtherAttributes(elementID, *, _attr='others', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getPackedBooleanAttribute(elementID, *, _attr='packed', _rtype='bool', _kind='bool')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getParameterIdAttribute(elementID, *, _attr='parameterId', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getPathAttribute(elementID, *, _attr='path', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getPhantomBooleanAttribute(elementID, *, _attr='phantom', _rtype='bool', _kind='bool')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getPortRefAttribute(elementID, *, _attr='portRef', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getPortRefAttributeByID(elementID, *, _attr='portRef', _rtype='ref', _kind='ref')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getPowerDomainRefAttribute(elementID, *, _attr='powerDomainRef', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getPowerDomainRefAttributeByID(elementID, *, _attr='powerDomainRef', _rtype='ref', _kind='ref')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getPrefixAttribute(elementID, *, _attr='prefix', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getPriorityIntAttribute(elementID, *, _attr='priority', _rtype='int', _kind='int')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getPromptAttribute(elementID, *, _attr='prompt', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getReferenceIdAttribute(elementID, *, _attr='referenceId', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getRegisterFileRefAttribute(elementID, *, _attr='registerFileRef', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getRegisterFileRefAttributeByID(elementID, *, _attr='registerFileRef', _rtype='ref', _kind='ref')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getRegisterRefAttribute(elementID, *, _attr='registerRef', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getReplicateBooleanAttribute(elementID, *, _attr='replicate', _rtype='bool', _kind='bool')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getResetTypeRefAttribute(elementID, *, _attr='resetTypeRef', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getResetTypeRefAttributeByID(elementID, *, _attr='resetTypeRef', _rtype='ref', _kind='ref')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getResolveAttribute(elementID, *, _attr='resolve', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getScopeAttribute(elementID, *, _attr='scope', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getSegmentRefAttribute(elementID, *, _attr='segmentRef', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getSegmentRefAttributeByID(elementID, *, _attr='segmentRef', _rtype='ref', _kind='ref')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getSignAttribute(elementID, *, _attr='sign', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getStrictBooleanAttribute(elementID, *, _attr='strict', _rtype='bool', _kind='bool')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getSubPortRefAttribute(elementID, *, _attr='subPortRef', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getSubPortRefAttributeByID(elementID, *, _attr='subPortRef', _rtype='ref', _kind='ref')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getTestConstraintAttribute(elementID, *, _attr='testConstraint', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getTextAttribute(elementID, *, _attr='text', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getTypeAttribute(elementID, *, _attr='type', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getTypeDefinitionsAttribute(elementID, *, _attr='typeDefinitions', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getUniqueBooleanAttribute(elementID, *, _attr='unique', _rtype='bool', _kind='bool')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getUnitAttribute(elementID, *, _attr='unit', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getUnitsAttribute(elementID, *, _attr='units', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getUsageAttribute(elementID, *, _attr='usage', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getUsageTypeAttribute(elementID, *, _attr='usageType', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getUserAttribute(elementID, *, _attr='user', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getVectorIdAttribute(elementID, *, _attr='vectorId', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getVendorAttribute(elementID, *, _attr='vendor', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getVersionAttribute(elementID, *, _attr='version', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getViewRefAttribute(elementID, *, _attr='viewRef', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.getViewRefAttributeByID(elementID, *, _attr='viewRef', _rtype='ref', _kind='ref')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.isSetAttribute(elementID, attributeName)

Return True if a named attribute exists and is not None.

Section: F.7.44.2.

Parameters:

• elementID (str) – Element handle.

• attributeName (str) – Raw attribute field name in data model.

Returns:

True if set, else False.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeAllBitsAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeAppendAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeArrayIdAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeAttribute(elementID, attributeName)

Remove (clear) an arbitrary attribute by name.

Parameters:

• elementID (str) – Element handle.

• attributeName (str) – Attribute field name to clear.

Returns:

True if removed; False if it was not set.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeCellStrengthAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeChoiceRefAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeClockEdgeAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeClockNameAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeClockSourceAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeConstrainedAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeConstraintSetIdAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeDataTypeAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeDataTypeDefinitionAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeDefaultAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeDelayTypeAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeDirectionAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeDriverTypeAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeExternalDeclarationsAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeFileIdAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeFlowTypeAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeForceAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeGroupAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeHelpAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeHiddenAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeIdAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeImageTypeAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeImplicitAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeInvertAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeIsIOAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeLevelAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeLibextAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeMaximumAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeMinimumAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeMisalignmentAllowedAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeModeAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeModifyAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeMultipleGroupSelectionOperatorAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeOrderAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeOtherAnyAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeOtherAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removePackedAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeParameterIdAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removePathAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removePhantomAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removePowerDomainRefAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removePrefixAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removePromptAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeReplicateAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeResetTypeRefAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeResolveAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeScopeAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeSegmentRefAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeSignAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeStrictAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeTestConstraintAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeTextAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeTypeAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeTypeDefinitionsAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeUniqueAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeUnitAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeUnitsAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeUsageTypeAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeUserAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.removeVectorIdAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setAddressBlockRefAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setAddressSpaceRefAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setAllBitsBooleanAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setAllLogicalDirectionsAllowedBooleanAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setAllLogicalInitiativesAllowedBooleanAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setAlternateRegisterRefAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setAppendBooleanAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setArrayIdAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setBankAlignmentAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setBankRefAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setBusRefAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setCellStrengthAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setChoiceRefAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setClockEdgeAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setClockNameAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setClockSourceAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setComponentInstanceRefAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setComponentRefAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setConfigGroupsAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setConstraintSetIdAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setCustomAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setDataTypeAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setDataTypeDefinitionAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setDefaultBooleanAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setDelayTypeAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setDirectionAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setDriverTypeAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setExactBooleanAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setExternalDeclarationsBooleanAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setFieldRefAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setFileIdAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setFlowTypeAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setForceBooleanAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setGroupAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setHelpAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setHiddenBooleanAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setIdAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setImageIdAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setImageTypeAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setImplicitBooleanAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setIndexVarAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setInitiatorRefAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setInterfaceModeAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setInvertAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setIsIOBooleanAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setLevelAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setLibextAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setLibraryAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setMandatoryBooleanAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setMaximumAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setMaximumDoubleAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setMaximumIntAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setMemoryMapRefAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setMemoryRemapRefAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setMinimumAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setMinimumDoubleAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setMinimumIntAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setMisalignmentAllowedBooleanAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setModeRefAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setModifyAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setMultipleGroupSelectionOperatorAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setNameAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setOrderFloatAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setOtherAnyAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setOtherAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setPackedBooleanAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setParameterIdAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setPathAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setPhantomBooleanAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setPortRefAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setPowerDomainRefAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setPrefixAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setPriorityIntAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setPromptAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setReferenceIdAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setRegisterFileRefAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setRegisterRefAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setReplicateBooleanAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setResetTypeRefAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setResolveAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setScopeAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setSegmentRefAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setSignAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setStrictBooleanAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setSubPortRefAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setTestConstraintAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setTextAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setTypeAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setTypeDefinitionsAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setUniqueBooleanAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setUnitAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setUnitsAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setUsageAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setUsageTypeAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setUserAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setVectorIdAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setVendorAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setVersionAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.element_attribute.setViewRefAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder module

File builder category TGI functions (IEEE 1685-2022).

Implements BASE (F.7.45) and EXTENDED (F.7.46) File builder functions. Only the exact public API defined by Annex F is exported (no legacy helper aliases). The functions provide access to buildCommand and fileBuilder structures contained within higher-level elements (e.g., executableImage, languageTools, fileSet entries). Where an element (command/flags/…) is not present, getters return None (or empty lists) consistent with other categories.

NOTE: The underlying 2022 schema classes are imported from org.accellera.ipxact.v1685_2022. We interact with them via attribute access and simple container list manipulations. We purposefully keep the implementation conservative—if an expected container is missing we raise INVALID_ID for invalid handles; absence of a specific optional child just returns None / False.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.addExecutableImageFileBuilderID(executableImageID, fileType)

Create a new fileBuilder under executableImage.languageTools.

Section: F.7.46.1.

Parameters:

• executableImageID (str)

• fileType (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.addExecutableImageLinkerCommandFile(executableImageID, enable=None)

Append a new linkerCommandFile (optionally setting enable flag).

Section: F.7.46.2.

Parameters:

• executableImageID (str)

• enable (bool | None)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.addLanguageToolsFileBuilder(languageToolsID, fileType)

Add fileBuilder to existing languageTools element.

Section: F.7.46.3.

Parameters:

• languageToolsID (str)

• fileType (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.addLinkerCommandFileGeneratorRef(linkerCommandFileID, generatorRef)

Append a generatorRef to a linkerCommandFile.

Section: F.7.46.4.

Parameters:

• linkerCommandFileID (str)

• generatorRef (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.getBuildCommandCommand(fileID)

Return textual build command value.

Section: F.7.45.1.

Parameters:

fileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.getBuildCommandCommandExpression(fileID)

Return expression (if any) for build command.

Section: F.7.45.2.

Parameters:

fileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.getBuildCommandCommandID(fileID)

Return handle of build command value element.

Section: F.7.45.3.

Parameters:

fileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.getBuildCommandFlags(fileID)

Return textual flags value.

Section: F.7.45.4.

Parameters:

fileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.getBuildCommandFlagsExpression(fileID)

Return expression (if any) for flags.

Section: F.7.45.5.

Parameters:

fileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.getBuildCommandFlagsID(fileID)

Return handle of flags element.

Section: F.7.45.6.

Parameters:

fileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.getBuildCommandReplaceDefaultFlags(fileID)

Return boolean value of replaceDefaultFlags (converted to bool).

Section: F.7.45.7.

Parameters:

fileID (str)

Return type:

bool | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.getBuildCommandReplaceDefaultFlagsID(fileID)

Return handle of replaceDefaultFlags element.

Section: F.7.45.8.

Parameters:

fileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.getBuildCommandTargetName(fileID)

Return targetName value (derived file path).

Section: F.7.45.9.

Parameters:

fileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.getBuildCommandTargetNameExpression(fileID)

Return expression for targetName.

Section: F.7.45.10.

Parameters:

fileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.getExecutableImageFileBuilderIDs(executableImageID)

Return handles of all fileBuilder children of languageTools.

Section: F.7.45.11.

Parameters:

executableImageID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.getExecutableImageFileSetRefIDs(executableImageID)

Return handles of all fileSetRef children.

Section: F.7.45.12.

Parameters:

executableImageID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.getExecutableImageLanguageToolsID(executableImageID)

Return handle of languageTools or None.

Section: F.7.45.13.

Parameters:

executableImageID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.getExecutableImageLinker(executableImageID)

Return linker command text.

Section: F.7.45.14.

Parameters:

executableImageID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.getExecutableImageLinkerCommandFileID(executableImageID)

Return handle of first linkerCommandFile (if any).

Section: F.7.45.15.

Parameters:

executableImageID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.getExecutableImageLinkerExpression(executableImageID)

Return expression for linker element.

Section: F.7.45.16.

Parameters:

executableImageID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.getExecutableImageLinkerFlags(executableImageID)

Return textual linker flags.

Section: F.7.45.17.

Parameters:

executableImageID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.getExecutableImageLinkerFlagsExpression(executableImageID)

Return expression for linker flags.

Section: F.7.45.18.

Parameters:

executableImageID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.getFileBuildCommandID(fileID)

Return handle of buildCommand element for a File.

Section: F.7.45.19.

Parameters:

fileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.getFileBuilderCommand(fileBuilderID)

Return command text of a fileBuilder.

Section: F.7.45.20.

Parameters:

fileBuilderID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.removeBuildCommandCommand(fileID)

Remove buildCommand.command element.

Section: F.7.46.5.

Parameters:

fileID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.removeBuildCommandFlags(fileID)

Remove buildCommand.flags element.

Section: F.7.46.6.

Parameters:

fileID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.removeBuildCommandReplaceDefaultFlags(fileID)

Remove replaceDefaultFlags element.

Section: F.7.46.7.

Parameters:

fileID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.removeBuildCommandTargetName(fileID)

Remove targetName element.

Section: F.7.46.8.

Parameters:

fileID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.removeDefaultFileBuilderCommand(fileBuilderID)

Remove command child from fileBuilder.

Section: F.7.46.9.

Parameters:

fileBuilderID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.removeExecutableImageFileBuilderID(fileBuilderID)

Detach a fileBuilder from its parent list.

Section: F.7.46.10.

Parameters:

fileBuilderID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.removeExecutableImageLanguageTools(executableImageID)

Remove the entire languageTools element.

Section: F.7.46.11.

Parameters:

executableImageID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.removeExecutableImageLinkerCommandFile(executableImageID)

Remove first linkerCommandFile under languageTools.

Section: F.7.46.12.

Parameters:

executableImageID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.removeFileBuilderCommand(fileBuilderID)

Remove command element of fileBuilder.

Section: F.7.46.13.

Parameters:

fileBuilderID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.removeFileBuilderFlags(fileBuilderID)

Remove flags element of fileBuilder.

Section: F.7.46.14.

Parameters:

fileBuilderID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.removeFileBuilderReplaceDefaultFlags(fileBuilderID)

Remove replaceDefaultFlags element of fileBuilder.

Section: F.7.46.15.

Parameters:

fileBuilderID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.removeLanguageToolsFileBuilder(fileBuilderID)

Remove fileBuilder from languageTools (alias context).

Section: F.7.46.16.

Parameters:

fileBuilderID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.removeLanguageToolsLinkerCommandFile(languageToolsID)

Remove first linkerCommandFile of languageTools.

Section: F.7.46.17.

Parameters:

languageToolsID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.removeLanguageToolsLinkerFlags(languageToolsID)

Remove linkerFlags element.

Section: F.7.46.18.

Parameters:

languageToolsID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.removeLinkerCommandFileGeneratorRef(linkerCommandFileID)

Clear all generatorRef entries from linkerCommandFile.

Section: F.7.46.19.

Parameters:

linkerCommandFileID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.setBuildCommandCommand(fileID, command)

Set buildCommand.command value (creates buildCommand if absent).

Section: F.7.46.20.

Parameters:

• fileID (str)

• command (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.setBuildCommandFlags(fileID, flags)

Set buildCommand.flags value.

Section: F.7.46.21.

Parameters:

• fileID (str)

• flags (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.setBuildCommandReplaceDefaultFlags(fileID, replace)

Set replaceDefaultFlags boolean.

Section: F.7.46.22.

Parameters:

• fileID (str)

• replace (bool)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.setBuildCommandTargetName(fileID, targetName)

Set targetName value.

Section: F.7.46.23.

Parameters:

• fileID (str)

• targetName (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.setExecutableImageLanguageTools(executableImageID)

Create (if absent) and return handle of languageTools.

Section: F.7.46.24.

Parameters:

executableImageID (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.setExecutableImageLinker(executableImageID, linker)

Set linker text inside languageTools.

Section: F.7.46.25.

Parameters:

• executableImageID (str)

• linker (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.setExecutableImageLinkerFlags(executableImageID, flags)

Set linkerFlags text inside languageTools.

Section: F.7.46.26.

Parameters:

• executableImageID (str)

• flags (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.setFileBuildCommand(fileID)

Ensure buildCommand exists and return its handle.

Section: F.7.46.27.

Parameters:

fileID (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.setFileBuilderCommand(fileBuilderID, command)

Set fileBuilder.command.

Section: F.7.46.28.

Parameters:

• fileBuilderID (str)

• command (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.setFileBuilderFileType(fileBuilderID, fileType)

Set fileBuilder.fileType.

Section: F.7.46.29.

Parameters:

• fileBuilderID (str)

• fileType (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.setFileBuilderFlags(fileBuilderID, flags)

Set fileBuilder.flags.

Section: F.7.46.30.

Parameters:

• fileBuilderID (str)

• flags (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.setFileBuilderReplaceDefaultFlags(fileBuilderID, replace)

Set fileBuilder.replaceDefaultFlags.

Section: F.7.46.31.

Parameters:

• fileBuilderID (str)

• replace (bool)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.setLanguageToolsLinker(languageToolsID, linker)

Set linker value under languageTools.

Section: F.7.46.32.

Parameters:

• languageToolsID (str)

• linker (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.setLanguageToolsLinkerCommandFile(languageToolsID)

Append new linkerCommandFile under languageTools.

Section: F.7.46.33.

Parameters:

languageToolsID (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.setLanguageToolsLinkerFlags(languageToolsID, flags)

Set linkerFlags for languageTools.

Section: F.7.46.34.

Parameters:

• languageToolsID (str)

• flags (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.setLinkerCommandFileCommandLineSwitch(linkerCommandFileID, switch)

Set commandLineSwitch of linkerCommandFile.

Section: F.7.46.35.

Parameters:

• linkerCommandFileID (str)

• switch (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_builder.setLinkerCommandFileEnable(linkerCommandFileID, enable)

Set enable flag of linkerCommandFile.

Section: F.7.46.36.

Parameters:

• linkerCommandFileID (str)

• enable (bool)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set module

File set category TGI functions (IEEE 1685-2022).

Implements BASE (F.7.47) and EXTENDED (F.7.48) File set functions. Only the exact public API defined by Annex F is exported. These functions cover traversal of fileSets, files, default file builders, functions (SW functions inside a fileSet), and their subordinate argument / sourceFile elements; plus mutation helpers for the EXTENDED section.

Design notes: * Absent optional children return None (or empty list) – invalid handles

raise TgiError with INVALID_ID.

• Newly created child objects are registered with their parent via register_parent allowing later detach via remove* functions.

• The 2022 schema expresses many list-valued fields as Iterable but uses list factories; we treat them as mutable lists (adding a # type: ignore where static checkers complain).

• Some spec functions reference fileSetRef / fileSetRefGroup elements that are not present in the 2022 FileSet schema. They are stubbed to return empty results (BASE) or raise INVALID_ARGUMENT (EXTENDED) so callers can detect unsupported constructs. This is documented in each affected docstring.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.addFileDefine(fileID, name, value)

Add a define symbol (Section: F.7.48.1).

The schema’s NameValuePairType may expect wrapped value object; we assign plain string which aligns with other usage sites in the codebase.

Parameters:

• fileID (str)

• name (str)

• value (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.addFileDependency(fileID, dependency)

Add a dependency string (Section: F.7.48.2).

Parameters:

• fileID (str)

• dependency (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.addFileExportedName(fileID, value)

Add exportedName (Section: F.7.48.3).

Parameters:

• fileID (str)

• value (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.addFileFileType(fileID, fileType)

Add an additional fileType (Section: F.7.48.4).

Parameters:

• fileID (str)

• fileType (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.addFileImageType(fileID, value)

Add imageType (Section: F.7.48.5).

Parameters:

• fileID (str)

• value (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.addFileSetDefaultFileBuilder(fileSetID, fileType)

Add defaultFileBuilder to fileSet (Section: F.7.48.6).

Note: Spec text lists fileID; schema associates defaultFileBuilder with fileSet. We adopt fileSetID here.

Parameters:

• fileSetID (str)

• fileType (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.addFileSetDependency(fileSetID, dependency)

Add dependency to fileSet (Section: F.7.48.7).

Parameters:

• fileSetID (str)

• dependency (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.addFileSetFile(fileSetID, name, fileTypes)

Add file to fileSet (Section: F.7.48.8).

Parameters:

• fileSetID (str)

• name (str)

• fileTypes (list[str])

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.addFileSetFunction(fileSetID, fileRef)

Add function referencing fileRef (Section: F.7.48.9).

Parameters:

• fileSetID (str)

• fileRef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.addFileSetGroup(fileSetID, group)

Add group value (Section: F.7.48.10).

Parameters:

• fileSetID (str)

• group (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.addFileSetRefGroupFileSetRef(fileSetRefGroupID, localName)

Add fileSetRef (Section: F.7.48.11 – unsupported).

Raises INVALID_ARGUMENT because schema lacks fileSetRefGroup.

Parameters:

• fileSetRefGroupID (str)

• localName (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.addFunctionArgument(functionID, name, value, dataType)

Add function argument (Section: F.7.48.12).

Parameters:

• functionID (str)

• name (str)

• value (str)

• dataType (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.addFunctionSourceFile(functionID, sourceFileName, fileType)

Add sourceFile (Section: F.7.48.13).

Parameters:

• functionID (str)

• sourceFileName (str)

• fileType (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.getBuildCommandReplaceDefaultFlagsExpression(fileID)

Return replaceDefaultFlags expression (Section: F.7.47.1).

Parameters:

fileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.getFileDefineIDs(fileID)

Return handles of define symbols (Section: F.7.47.2).

Parameters:

fileID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.getFileDefineSymbolValue(fileDefineID)

Return value of a fileDefine (Section: F.7.47.3).

Parameters:

fileDefineID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.getFileDependencyIDs(fileID)

Return dependency handles for a file (Section: F.7.47.4).

Parameters:

fileID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.getFileExportedNameIDs(fileID)

Return exportedName handles (Section: F.7.47.5).

Parameters:

fileID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.getFileExportedNames(fileID)

Return exported names (Section: F.7.47.6).

Parameters:

fileID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.getFileFileTypeIDs(fileID)

Return fileType handles (Section: F.7.47.7).

Parameters:

fileID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.getFileFileTypes(fileID)

Return fileType enumeration literals (Section: F.7.47.8).

Parameters:

fileID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.getFileImageTypeIDs(fileID)

Return imageType handles (Section: F.7.47.9).

Parameters:

fileID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.getFileImageTypes(fileID)

Return image type values (Section: F.7.47.10).

Parameters:

fileID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.getFileIsIncludeFile(fileID)

Return isIncludeFile boolean (Section: F.7.47.11).

Parameters:

fileID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.getFileIsIncludeFileID(fileID)

Return handle to isIncludeFile element (Section: F.7.47.12).

Parameters:

fileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.getFileIsStructural(fileID)

Return isStructural value (Section: F.7.47.13).

Parameters:

fileID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.getFileLogicalName(fileID)

Return logicalName value (Section: F.7.47.14).

Parameters:

fileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.getFileLogicalNameID(fileID)

Return handle to logicalName element (Section: F.7.47.15).

Parameters:

fileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.getFileName(fileID)

Return file name path value (Section: F.7.47.16).

Parameters:

fileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.getFileSetDefaultFileBuilderIDs(fileSetID)

Return handles of defaultFileBuilder elements (Section: F.7.47.17).

Parameters:

fileSetID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.getFileSetDependencyIDs(fileSetID)

Return fileSet dependency handles (Section: F.7.47.18).

Parameters:

fileSetID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.getFileSetFileIDs(fileSetID)

Return file handles (Section: F.7.47.19).

Parameters:

fileSetID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.getFileSetFunctionIDs(fileSetID)

Return function handles (Section: F.7.47.20).

Parameters:

fileSetID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.getFileSetGroupFileSetRefIDs(fileSetGroupID)

Return fileSetRef handles (Section: F.7.47.21).

Not supported by current schema – returns empty list if group exists else raises INVALID_ID.

Parameters:

fileSetGroupID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.getFileSetGroupIDs(fileSetID)

Return group handles (Section: F.7.47.22).

Parameters:

fileSetID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.getFileSetGroups(fileSetID)

Return group string values (Section: F.7.47.23).

Parameters:

fileSetID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.getFileSetRefByID(fileSetRefID)

Return referenced fileSet handle (Section: F.7.47.24).

Unsupported (no fileSetRef element in schema) – always returns None or raises INVALID_ID if handle does not refer to a placeholder type.

Parameters:

fileSetRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.getFileSetRefGroupFileSetRefIDs(fileSetRefGroupID)

Return fileSetRef handles (Section: F.7.47.25 – unsupported).

Parameters:

fileSetRefGroupID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.getFileSetRefLocalNameRefByID(fileSetRefID)

Return referenced fileSet handle (Section: F.7.47.26 – unsupported).

Parameters:

fileSetRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.getFunctionArgumentDataType(argumentID)

Return argument dataType (Section: F.7.47.27).

Parameters:

argumentID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.getFunctionArgumentIDs(functionID)

Return function argument handles (Section: F.7.47.28).

Parameters:

functionID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.getFunctionDisabled(functionID)

Return disabled boolean (Section: F.7.47.29).

Parameters:

functionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.getFunctionDisabledExpression(functionID)

Return disabled expression (Section: F.7.47.30).

Parameters:

functionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.getFunctionDisabledID(functionID)

Return disabled element handle (Section: F.7.47.31).

Parameters:

functionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.getFunctionEntryPoint(functionID)

Return entryPoint (Section: F.7.47.32).

Parameters:

functionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.getFunctionFileID(functionID)

Return file handle referenced by function (Section: F.7.47.33).

Parameters:

functionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.getFunctionFileRefByID(functionID)

Alias of getFunctionFileID (Section: F.7.47.34).

Parameters:

functionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.getFunctionFileRefByName(functionID)

Return fileRef name (Section: F.7.47.35).

The schema encodes fileRef as string (the referenced fileId); no separate local name – we return the same value.

Parameters:

functionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.getFunctionReplicate(functionID)

Return replicate boolean (Section: F.7.47.36).

Parameters:

functionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.getFunctionReturnType(functionID)

Return returnType literal (Section: F.7.47.37).

Parameters:

functionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.getFunctionSourceFileIDs(functionID)

Return sourceFile handles (Section: F.7.47.38).

Parameters:

functionID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.getFunctionSourceFileName(functionSourceFileID)

Return sourceFile sourceName (Section: F.7.47.39).

Parameters:

functionSourceFileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.getFunctionSourceFileType(functionSourceFileID)

Return sourceFile fileType literal (Section: F.7.47.40).

Parameters:

functionSourceFileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.getSourceFileFileType(sourceFileID)

Return fileType value (Section: F.7.47.41).

Parameters:

sourceFileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.getSourceFileFileTypeID(sourceFileID)

Return fileType element handle (Section: F.7.47.42).

Parameters:

sourceFileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.getSourceFileSourceName(sourceFileID)

Return sourceName value (Section: F.7.47.43).

Parameters:

sourceFileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.removeFileBuildCommand(fileID)

Remove buildCommand (Section: F.7.48.14).

Parameters:

fileID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.removeFileDefine(defineID)

Remove define (Section: F.7.48.15).

Parameters:

defineID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.removeFileDependency(dependencyID)

Remove dependency (Section: F.7.48.16).

Parameters:

dependencyID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.removeFileExportedName(exportedNameID)

Remove exportedName (Section: F.7.48.17).

Parameters:

exportedNameID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.removeFileFileType(fileTypeID)

Remove fileType (Section: F.7.48.18).

Parameters:

fileTypeID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.removeFileImageType(imageTypeID)

Remove imageType (Section: F.7.48.19).

Parameters:

imageTypeID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.removeFileIsIncludeFile(fileID)

Remove isIncludeFile (Section: F.7.48.20).

Parameters:

fileID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.removeFileIsStructural(fileID)

Remove isStructural (Section: F.7.48.21).

Parameters:

fileID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.removeFileLogicalName(fileID)

Remove logicalName (Section: F.7.48.22).

Parameters:

fileID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.removeFileSetDefaultFileBuilder(fileBuilderID)

Remove defaultFileBuilder (Section: F.7.48.23).

Parameters:

fileBuilderID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.removeFileSetDependency(dependencyID)

Remove fileSet dependency (Section: F.7.48.24).

Parameters:

dependencyID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.removeFileSetFile(fileID)

Remove file from fileSet (Section: F.7.48.25).

Parameters:

fileID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.removeFileSetFunction(functionID)

Remove function (Section: F.7.48.26).

Parameters:

functionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.removeFileSetGroup(groupID)

Remove group (Section: F.7.48.27).

Parameters:

groupID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.removeFunctionArgument(argumentID)

Remove function argument (Section: F.7.48.28).

Parameters:

argumentID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.removeFunctionDisabled(functionID)

Remove disabled element (Section: F.7.48.29).

Parameters:

functionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.removeFunctionEntryPoint(functionID)

Remove entryPoint (Section: F.7.48.30).

Parameters:

functionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.removeFunctionReturnType(functionID)

Remove returnType (Section: F.7.48.31).

Parameters:

functionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.removeFunctionSourceFile(functionSourceFileID)

Remove sourceFile (Section: F.7.48.32).

Parameters:

functionSourceFileID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.setFileIsIncludeFile(fileID, value)

Set isIncludeFile (Section: F.7.48.33).

Parameters:

• fileID (str)

• value (bool)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.setFileIsStructural(fileID, value)

Set isStructural (Section: F.7.48.34).

Parameters:

• fileID (str)

• value (bool)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.setFileLogicalName(fileID, logicalName)

Set logicalName (Section: F.7.48.35).

Parameters:

• fileID (str)

• logicalName (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.setFileName(fileID, name)

Set file name path (Section: F.7.48.36).

Parameters:

• fileID (str)

• name (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.setFunctionArgumentDataType(argumentID, dataType)

Set argument dataType (Section: F.7.48.37).

Parameters:

• argumentID (str)

• dataType (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.setFunctionDisabled(functionID, disabledExpression)

Set disabled expression (Section: F.7.48.38).

Parameters:

• functionID (str)

• disabledExpression (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.setFunctionEntryPoint(functionID, entryPoint)

Set entryPoint (Section: F.7.48.39).

Parameters:

• functionID (str)

• entryPoint (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.setFunctionFileRef(functionID, fileRef)

Set fileRef (Section: F.7.48.40).

Parameters:

• functionID (str)

• fileRef (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.setFunctionReplicate(functionID, replicate)

Set replicate (Section: F.7.48.41).

Parameters:

• functionID (str)

• replicate (bool)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.setFunctionReturnType(functionID, returnType)

Set returnType (Section: F.7.48.42).

Parameters:

• functionID (str)

• returnType (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.setFunctionSourceFileName(functionID, value)

Set first sourceFile’s sourceName (Section: F.7.48.43).

If no sourceFile exists a new one (without fileType) is created.

Parameters:

• functionID (str)

• value (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.setSourceFileFileType(sourceFileID, value)

Set sourceFile fileType (Section: F.7.48.44).

Parameters:

• sourceFileID (str)

• value (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.file_set.setSourceFileSourceName(sourceFileID, sourceName)

Set sourceName (Section: F.7.48.45).

Parameters:

• sourceFileID (str)

• sourceName (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator module

Generator category TGI functions (IEEE 1685-2022).

Implements exactly the BASE (F.7.49) and EXTENDED (F.7.50) Generator functions. These operate on generator objects (Generator) and the instance generators (AbstractorGenerator and ComponentGenerator) which extend InstanceGeneratorType.

Error semantics follow the common TGI model: * INVALID_ID for unknown / wrong-type handles * INVALID_ARGUMENT for semantic misuse (e.g. applying a group add to a

non-instance generator, enum literal mismatch, etc.).

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator.addAbstractorGeneratorGroup(abstractorGeneratorID, groupName)

Append a group element to an AbstractorGenerator.

Section: F.7.50.1.

Parameters:

• abstractorGeneratorID (str)

• groupName (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator.addComponentGeneratorGroup(componentGeneratorID, groupName)

Append a group element to a ComponentGenerator.

Section: F.7.50.2.

Parameters:

• componentGeneratorID (str)

• groupName (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator.getAbstractorGeneratorGroup(abstractorGeneratorID)

Return the first group value of an AbstractorGenerator.

Section: F.7.49.1. If no group elements exist, returns None.

Parameters:

abstractorGeneratorID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator.getAbstractorGeneratorGroupIDs(abstractorGeneratorID)

Return handles of all group elements of an AbstractorGenerator.

Section: F.7.49.2.

Parameters:

abstractorGeneratorID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator.getComponentGeneratorGroupIDs(componentGeneratorID)

Return handles of group elements of a ComponentGenerator.

Section: F.7.49.3.

Parameters:

componentGeneratorID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator.getGeneratorApiService(generatorID)

Return API service (SOAP/REST).

Section: F.7.49.4.

Parameters:

generatorID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator.getGeneratorApiTypeID(generatorID)

Return handle of the apiType element (not its value).

Section: F.7.49.5.

Parameters:

generatorID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator.getGeneratorExecutable(generatorID)

Return the path string of generatorExe.

Section: F.7.49.6.

Parameters:

generatorID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator.getGeneratorGeneratorExe(generatorID)

Return the ID (handle) of the generatorExe element.

Section: F.7.49.7. Returns None if absent.

Parameters:

generatorID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator.getGeneratorGroups(generatorID)

Return list of group values (works for instance generators only).

Section: F.7.49.8. Non-instance generators return empty list.

Parameters:

generatorID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator.getGeneratorPhase(generatorID)

Return numeric/string phase value or None.

Section: F.7.49.9.

Parameters:

generatorID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator.getGeneratorPhaseExpression(generatorID)

Return expression string of phase (same as value for this schema).

Section: F.7.49.10.

Parameters:

generatorID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator.getGeneratorPhaseID(generatorID)

Return handle of phase element.

Section: F.7.49.11.

Parameters:

generatorID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator.getGeneratorScope(generatorID)

Return scope attribute (INSTANCE or DESIGN) for instance generators.

Section: F.7.49.12. Returns None for plain Generator objects.

Parameters:

generatorID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator.getGeneratorTransportMethodsID(generatorID)

Return handle of transportMethods element.

Section: F.7.49.13.

Parameters:

generatorID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator.getTransportMethodsTransportMethodID(transportMethodsID)

Return handle of the transportMethod child.

Section: F.7.49.14.

Parameters:

transportMethodsID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator.removeAbstractorGeneratorGroup(groupID)

Remove a group element from an AbstractorGenerator.

Section: F.7.50.3.

Parameters:

groupID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator.removeComponentGeneratorGroup(groupID)

Remove a group element from a ComponentGenerator.

Section: F.7.50.4.

Parameters:

groupID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator.removeGeneratorApiService(generatorID)

Remove the apiService element.

Section: F.7.50.5.

Parameters:

generatorID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator.removeGeneratorApiType(generatorID)

Remove the apiType element.

Section: F.7.50.6.

Parameters:

generatorID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator.removeGeneratorPhase(generatorID)

Remove the phase element.

Section: F.7.50.7.

Parameters:

generatorID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator.removeGeneratorTransportMethods(generatorID)

Remove the transportMethods container.

Section: F.7.50.8.

Parameters:

generatorID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator.removeTransportMethodsTransportMethod(transportMethodsID)

Remove the transportMethod child from a container.

Section: F.7.50.9. Container itself remains.

Parameters:

transportMethodsID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator.setGeneratorApiService(generatorID, apiService)

Set or clear the apiService element.

Section: F.7.50.10.

Parameters:

• generatorID (str)

• apiService (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator.setGeneratorApiType(generatorID, apiType)

Set or clear the apiType element.

Section: F.7.50.11.

Parameters:

• generatorID (str)

• apiType (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator.setGeneratorGeneratorExe(generatorID, path)

Set the path of generatorExe (creates element if absent).

Section: F.7.50.12.

Parameters:

• generatorID (str)

• path (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator.setGeneratorPhase(generatorID, phaseValue)

Set (or create) the phase element value.

Section: F.7.50.13. The value is stored as the expression string.

Parameters:

• generatorID (str)

• phaseValue (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator.setGeneratorScope(generatorID, scope)

Set scope attribute of an instance generator (INSTANCE/DESIGN).

Section: F.7.50.14.

Parameters:

• generatorID (str)

• scope (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator.setGeneratorTransportMethods(generatorID)

Ensure a transportMethods container exists; return its handle.

Section: F.7.50.15. Does not create a transportMethod child.

Parameters:

generatorID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator.setTransportMethodsTransportMethod(transportMethodsID, method)

Set/clear the transportMethod child (currently only ‘file’).

Section: F.7.50.16.

Parameters:

• transportMethodsID (str)

• method (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator_chain module

Generator chain category TGI functions (IEEE 1685-2022).

Implements exactly BASE (F.7.51) and EXTENDED (F.7.52) Generator chain functions. These cover traversal of chain groups, selectors, choices, and mutation of chain group, selector, generator and choice elements. Error handling: INVALID_ID for bad handles; INVALID_ARGUMENT for semantic violations.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator_chain.addGeneratorChainChainGroup(generatorChainID, group)

Add a chainGroup value to a generatorChain.

Section: F.7.52.1.

Parameters:

• generatorChainID (str)

• group (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator_chain.addGeneratorChainChoice(generatorChainID, name, enumerations)

Add a choice with enumerations to a generatorChain.

Section: F.7.52.2.

Parameters:

• generatorChainID (str)

• name (str)

• enumerations (list[str])

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator_chain.addGeneratorChainComponentGeneratorSelector(generatorChainID, name)

Add a componentGeneratorSelector (with groupSelector names) to chain.

Section: F.7.52.3.

Parameters:

• generatorChainID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator_chain.addGeneratorChainGenerator(generatorChainID, name, generatorExecutable)

Add a generator (name + executable path) to chain.

Section: F.7.52.4.

Parameters:

• generatorChainID (str)

• name (str)

• generatorExecutable (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator_chain.addGeneratorChainGeneratorChainSelector(generatorChainID, name)

Add a generatorChainSelector with groupSelector name placeholder.

Section: F.7.52.5.

Parameters:

• generatorChainID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator_chain.addGroupSelectorName(groupSelectorID, name)

Append a Name to groupSelector.

Section: F.7.52.6.

Parameters:

• groupSelectorID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator_chain.getComponentGeneratorSelectorGroupSelectorID(componentGeneratorSelectorID)

Return handle of groupSelector of a componentGeneratorSelector.

Section: F.7.51.1.

Parameters:

componentGeneratorSelectorID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator_chain.getGeneratorChainChainGroupIDs(generatorChainID)

Return handles of all chainGroup elements.

Section: F.7.51.2.

Parameters:

generatorChainID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator_chain.getGeneratorChainChoiceIDs(generatorChainID)

Return handles of all choice elements.

Section: F.7.51.3.

Parameters:

generatorChainID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator_chain.getGeneratorChainComponentGeneratorSelectorIDs(generatorChainID)

Return handles of componentGeneratorSelector elements.

Section: F.7.51.4.

Parameters:

generatorChainID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator_chain.getGeneratorChainGeneratorChainSelectorIDs(generatorChainID)

Return handles of generatorChainSelector elements.

Section: F.7.51.5.

Parameters:

generatorChainID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator_chain.getGeneratorChainGeneratorIDs(generatorChainID)

Return handles of generator child elements.

Section: F.7.51.6.

Parameters:

generatorChainID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator_chain.getGeneratorChainSelectorGeneratorChainRefByID(generatorChainSelectorID)

Return handle of referenced generatorChain (generatorChainRef).

Section: F.7.51.7.

Parameters:

generatorChainSelectorID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator_chain.getGeneratorChainSelectorGeneratorChainRefByVLNV(generatorChainSelectorID)

Return VLNV tuple of referenced generatorChain.

Section: F.7.51.8.

Parameters:

generatorChainSelectorID (str)

Return type:

tuple[str | None, str | None, str | None, str | None]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator_chain.getGeneratorChainSelectorGroupSelectorID(generatorChainSelectorID)

Return handle of groupSelector element on a generatorChainSelector.

Section: F.7.51.9.

Parameters:

generatorChainSelectorID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator_chain.getGroupSelectorNameIDs(groupSelectorID)

Return handles of all Name elements within a groupSelector.

Section: F.7.51.10.

Parameters:

groupSelectorID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator_chain.getGroupSelectorSelectionNames(groupSelectorID)

Return list of name values in a groupSelector.

Section: F.7.51.11.

Parameters:

groupSelectorID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator_chain.getGroupSelectorSelectionOperator(groupSelectorID)

Return multipleGroupSelectionOperator value.

Section: F.7.51.12.

Parameters:

groupSelectorID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator_chain.removeGeneratorChainChainGroup(chainGroupID)

Remove a chainGroup element.

Section: F.7.52.7.

Parameters:

chainGroupID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator_chain.removeGeneratorChainChoice(choiceID)

Remove a choice element.

Section: F.7.52.8.

Parameters:

choiceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator_chain.removeGeneratorChainComponentGeneratorSelector(componentGeneratorSelectorID)

Remove a componentGeneratorSelector element.

Section: F.7.52.9.

Parameters:

componentGeneratorSelectorID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator_chain.removeGeneratorChainGenerator(generatorID)

Remove a generator element.

Section: F.7.52.10.

Parameters:

generatorID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator_chain.removeGeneratorChainGeneratorChainSelector(generatorChainSelectorID)

Remove a generatorChainSelector element.

Section: F.7.52.11.

Parameters:

generatorChainSelectorID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator_chain.removeGroupSelectorName(groupSelectorNameID)

Remove a Name element from a groupSelector.

Section: F.7.52.12.

Parameters:

groupSelectorNameID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator_chain.setComponentGeneratorSelectorGroupSelector(componentGeneratorSelectorID, names)

Set groupSelector (names list) on componentGeneratorSelector.

Section: F.7.52.13. Replaces any existing groupSelector.

Parameters:

• componentGeneratorSelectorID (str)

• names (list[str])

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator_chain.setGeneratorChainSelectorGeneratorChainRef(generatorChainSelectorID, generatorChainVLNV)

Set generatorChainRef VLNV on a generatorChainSelector.

Section: F.7.52.14.

Parameters:

• generatorChainSelectorID (str)

• generatorChainVLNV (tuple[str, str, str, str])

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.generator_chain.setGeneratorChainSelectorGroupSelector(generatorChainSelectorID, names, operator=None)

Set groupSelector (names + optional operator) on generatorChainSelector.

Section: F.7.52.15.

Parameters:

• generatorChainSelectorID (str)

• names (list[str])

• operator (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface module

Indirect interface category TGI functions (IEEE 1685-2022).

Implements exactly the BASE (F.7.53) and EXTENDED (F.7.54) indirect interface functions for manipulating and querying the indirectAddressRef and indirectDataRef structures of an IndirectInterface.

Error handling: invalid handles raise TgiError with TgiFaultCode.INVALID_ID; semantic violations return TgiFaultCode.INVALID_ARGUMENT.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.addIndirectAddressRefBankRef(indirectAddressRefID, bankRef)

Append a bankRef to indirectAddressRef.

Section: F.7.54.1.

Parameters:

• indirectAddressRefID (str)

• bankRef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.addIndirectAddressRefRegisterFileRef(indirectAddressRefID, registerFileRef)

Append a registerFileRef to indirectAddressRef.

Section: F.7.54.2.

Parameters:

• indirectAddressRefID (str)

• registerFileRef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.addIndirectDataRefBankRef(indirectDataRefID, bankRef)

Append a bankRef to indirectDataRef.

Section: F.7.54.3.

Parameters:

• indirectDataRefID (str)

• bankRef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.addIndirectDataRefRegisterFileRef(indirectDataRefID, registerFileRef)

Append a registerFileRef to indirectDataRef.

Section: F.7.54.4.

Parameters:

• indirectDataRefID (str)

• registerFileRef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.addIndirectInterfaceTransparentBridge(indirectInterfaceID, initiatorRef)

Add a transparentBridge element to indirectInterface.

Section: F.7.54.5.

Parameters:

• indirectInterfaceID (str)

• initiatorRef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.getIndirectAddressRefAddressBlockRefByName(indirectAddressRefID)

Return addressBlockRef attribute value.

Section: F.7.53.1.

Parameters:

indirectAddressRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.getIndirectAddressRefAddressBlockRefID(indirectAddressRefID)

Return handle of addressBlockRef element.

Section: F.7.53.2.

Parameters:

indirectAddressRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.getIndirectAddressRefAddressSpaceRefByName(indirectAddressRefID)

Return addressSpaceRef attribute value.

Section: F.7.53.3.

Parameters:

indirectAddressRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.getIndirectAddressRefAddressSpaceRefID(indirectAddressRefID)

Return handle of addressSpaceRef element.

Section: F.7.53.4.

Parameters:

indirectAddressRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.getIndirectAddressRefAlternateRegisterRefByName(indirectAddressRefID)

Return alternateRegisterRef attribute value.

Section: F.7.53.5.

Parameters:

indirectAddressRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.getIndirectAddressRefAlternateRegisterRefID(indirectAddressRefID)

Return handle of alternateRegisterRef element.

Section: F.7.53.6.

Parameters:

indirectAddressRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.getIndirectAddressRefBankRefByNames(indirectAddressRefID)

Return list of bankRef attribute values.

Section: F.7.53.7.

Parameters:

indirectAddressRefID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.getIndirectAddressRefBankRefIDs(indirectAddressRefID)

Return handles of bankRef elements.

Section: F.7.53.8.

Parameters:

indirectAddressRefID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.getIndirectAddressRefFieldRefByName(indirectAddressRefID)

Return fieldRef attribute value.

Section: F.7.53.9.

Parameters:

indirectAddressRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.getIndirectAddressRefFieldRefID(indirectAddressRefID)

Return handle of fieldRef element.

Section: F.7.53.10.

Parameters:

indirectAddressRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.getIndirectAddressRefMemoryMapRefByName(indirectAddressRefID)

Return memoryMapRef attribute value.

Section: F.7.53.11.

Parameters:

indirectAddressRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.getIndirectAddressRefMemoryMapRefID(indirectAddressRefID)

Return handle of memoryMapRef element.

Section: F.7.53.12.

Parameters:

indirectAddressRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.getIndirectAddressRefMemoryRemapRefByID(indirectAddressRefID)

Return memoryRemapRef attribute value (same as ByName for attribute form).

Section: F.7.53.13.

Parameters:

indirectAddressRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.getIndirectAddressRefMemoryRemapRefByName(indirectAddressRefID)

Alias returning memoryRemapRef attribute value.

Section: F.7.53.14.

Parameters:

indirectAddressRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.getIndirectAddressRefMemoryRemapRefID(indirectAddressRefID)

Return handle of memoryRemapRef element.

Section: F.7.53.15.

Parameters:

indirectAddressRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.getIndirectAddressRefRegisterFileRefByNames(indirectAddressRefID)

Return registerFileRef attribute values.

Section: F.7.53.16.

Parameters:

indirectAddressRefID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.getIndirectAddressRefRegisterFileRefIDs(indirectAddressRefID)

Return handles of registerFileRef elements.

Section: F.7.53.17.

Parameters:

indirectAddressRefID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.getIndirectAddressRefRegisterRefByName(indirectAddressRefID)

Return registerRef attribute value.

Section: F.7.53.18.

Parameters:

indirectAddressRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.getIndirectAddressRefRegisterRefID(indirectAddressRefID)

Return handle of registerRef element.

Section: F.7.53.19.

Parameters:

indirectAddressRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.getIndirectDataRefAddressBlockRefByName(indirectDataRefID)

Return addressBlockRef attribute value for data ref.

Section: F.7.53.20.

Parameters:

indirectDataRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.getIndirectDataRefAddressBlockRefID(indirectDataRefID)

Return handle of addressBlockRef element (data).

Section: F.7.53.21.

Parameters:

indirectDataRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.getIndirectDataRefAddressSpaceRefByName(indirectDataRefID)

Return addressSpaceRef attribute value (data).

Section: F.7.53.22.

Parameters:

indirectDataRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.getIndirectDataRefAddressSpaceRefID(indirectDataRefID)

Return handle of addressSpaceRef element (data).

Section: F.7.53.23.

Parameters:

indirectDataRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.getIndirectDataRefAlternateRegisterRefByName(indirectDataRefID)

Return alternateRegisterRef attribute value (data).

Section: F.7.53.24.

Parameters:

indirectDataRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.getIndirectDataRefAlternateRegisterRefID(indirectDataRefID)

Return handle of alternateRegisterRef element (data).

Section: F.7.53.25.

Parameters:

indirectDataRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.getIndirectDataRefBankRefByNames(indirectDataRefID)

Return bankRef attribute values (data).

Section: F.7.53.26.

Parameters:

indirectDataRefID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.getIndirectDataRefBankRefIDs(indirectDataRefID)

Return handles of bankRef elements (data).

Section: F.7.53.27.

Parameters:

indirectDataRefID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.getIndirectDataRefFieldRefByName(indirectDataRefID)

Return fieldRef attribute value (data).

Section: F.7.53.28.

Parameters:

indirectDataRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.getIndirectDataRefFieldRefID(indirectDataRefID)

Return handle of fieldRef element (data).

Section: F.7.53.29.

Parameters:

indirectDataRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.getIndirectDataRefMemoryMapRefByName(indirectDataRefID)

Return memoryMapRef attribute value (data).

Section: F.7.53.30.

Parameters:

indirectDataRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.getIndirectDataRefMemoryMapRefID(indirectDataRefID)

Return handle of memoryMapRef element (data).

Section: F.7.53.31.

Parameters:

indirectDataRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.getIndirectDataRefMemoryRemapRefByID(indirectDataRefID)

Return memoryRemapRef attribute value (data).

Section: F.7.53.32.

Parameters:

indirectDataRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.getIndirectDataRefMemoryRemapRefByName(indirectDataRefID)

Alias returning memoryRemapRef attribute value (data).

Section: F.7.53.33.

Parameters:

indirectDataRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.getIndirectDataRefMemoryRemapRefID(indirectDataRefID)

Return handle of memoryRemapRef element (data).

Section: F.7.53.34.

Parameters:

indirectDataRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.getIndirectDataRefRegisterFileRefByNames(indirectDataRefID)

Return registerFileRef attribute values (data).

Section: F.7.53.35.

Parameters:

indirectDataRefID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.getIndirectDataRefRegisterFileRefIDs(indirectDataRefID)

Return handles of registerFileRef elements (data).

Section: F.7.53.36.

Parameters:

indirectDataRefID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.getIndirectDataRefRegisterRefByName(indirectDataRefID)

Return registerRef attribute value (data).

Section: F.7.53.37.

Parameters:

indirectDataRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.getIndirectDataRefRegisterRefID(indirectDataRefID)

Return handle of registerRef element (data).

Section: F.7.53.38.

Parameters:

indirectDataRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.removeAliasOfMemoryRemapRef(aliasOfMemoryRemapRefID)

Remove aliasOfMemoryRemapRef (global element reference removal).

Section: F.7.54.6.

Parameters:

aliasOfMemoryRemapRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.removeBroadcastToAddressSpaceRef(broadcastToAddressSpaceRefID)

Remove broadcastToAddressSpaceRef.

Section: F.7.54.7.

Parameters:

broadcastToAddressSpaceRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.removeIndirectAddressRefAddressBlockRef(indirectAddressRefID)

Remove addressBlockRef from indirectAddressRef.

Section: F.7.54.8.

Parameters:

indirectAddressRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.removeIndirectAddressRefAddressSpaceRef(indirectAddressRefID)

Remove addressSpaceRef from indirectAddressRef.

Section: F.7.54.9.

Parameters:

indirectAddressRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.removeIndirectAddressRefAlternateRegisterRef(indirectAddressRefID)

Remove alternateRegisterRef from indirectAddressRef.

Section: F.7.54.10.

Parameters:

indirectAddressRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.removeIndirectAddressRefBankRef(bankRefID)

Remove a bankRef element (by handle).

Section: F.7.54.11.

Parameters:

bankRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.removeIndirectAddressRefMemoryMapRef(indirectAddressRefID)

Remove memoryMapRef from indirectAddressRef.

Section: F.7.54.12.

Parameters:

indirectAddressRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.removeIndirectAddressRefMemoryRemapRef(indirectAddressRefID)

Remove memoryRemapRef from indirectAddressRef.

Section: F.7.54.13.

Parameters:

indirectAddressRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.removeIndirectAddressRefRegisterFileRef(registerFileRefID)

Remove a registerFileRef element (by handle) from indirectAddressRef.

Section: F.7.54.14.

Parameters:

registerFileRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.removeIndirectAddressRefRegisterRef(indirectAddressRefID)

Remove registerRef from indirectAddressRef.

Section: F.7.54.15.

Parameters:

indirectAddressRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.removeIndirectDataRefAddressBlockRef(indirectDataRefID)

Remove addressBlockRef from indirectDataRef.

Section: F.7.54.16.

Parameters:

indirectDataRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.removeIndirectDataRefAddressSpaceRef(indirectDataRefID)

Remove addressSpaceRef from indirectDataRef.

Section: F.7.54.17.

Parameters:

indirectDataRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.removeIndirectDataRefAlternateRegisterRef(indirectDataRefID)

Remove alternateRegisterRef from indirectDataRef.

Section: F.7.54.18.

Parameters:

indirectDataRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.removeIndirectDataRefBankRef(bankRefID)

Remove a bankRef (data) by handle.

Section: F.7.54.19.

Parameters:

bankRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.removeIndirectDataRefMemoryMapRef(indirectDataRefID)

Remove memoryMapRef from indirectDataRef.

Section: F.7.54.20.

Parameters:

indirectDataRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.removeIndirectDataRefMemoryRemapRef(indirectDataRefID)

Remove memoryRemapRef from indirectDataRef.

Section: F.7.54.21.

Parameters:

indirectDataRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.removeIndirectDataRefRegisterFileRef(registerFileRefID)

Remove registerFileRef element (data) by handle.

Section: F.7.54.22.

Parameters:

registerFileRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.indirect_interface.removeIndirectDataRefRegisterRef(indirectDataRefID)

Remove registerRef from indirectDataRef.

Section: F.7.54.23.

Parameters:

indirectDataRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.instantiation module

Instantiation category TGI functions (IEEE 1685-2022).

Implements BASE (F.7.55) and EXTENDED (F.7.56) Instantiation functions. These cover getter, add, remove and set operations for:

• componentInstantiation (attributes, nested refs and lists)

• designConfigurationInstantiation (language + designConfigurationRef)

• abstractionType / abstractorInstance / componentInstance reference helper getters used elsewhere in traversal APIs

Error handling matches the common TGI pattern: invalid handles raise TgiError with TgiFaultCode.INVALID_ID; semantic violations (e.g. wrong handle kind for an operation) raise INVALID_ARGUMENT. Absent optional elements simply return None or an empty list as appropriate per Annex F. All functions implemented here are ONLY those enumerated in sections F.7.55 and F.7.56 (no more, no less).

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.instantiation.addComponentInstantiationClearboxElementRef(componentInstantiationID, name, pathSegmentValue)

Add a clearboxElementRef element.

Section: F.7.56.1.

Parameters:

• componentInstantiationID (str)

• name (str)

• pathSegmentValue (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.instantiation.addComponentInstantiationConstraintSetRef(componentInstantiationID, localName)

Add a constraintSetRef.

Section: F.7.56.2.

Parameters:

• componentInstantiationID (str)

• localName (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.instantiation.addComponentInstantiationDefaultFileBuilder(componentInstantiationID, fileType)

Add a defaultFileBuilder element.

Section: F.7.56.3.

Parameters:

• componentInstantiationID (str)

• fileType (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.instantiation.addComponentInstantiationFileSetRef(componentInstantiationID, localName)

Add a fileSetRef element.

Section: F.7.56.4.

Parameters:

• componentInstantiationID (str)

• localName (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.instantiation.getAbstractionTypeAbstractionRefID(abstractionTypeID)

Return handle of abstractionRef inside an abstractionType.

Section: F.7.55.1. Returns None if absent.

Parameters:

abstractionTypeID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.instantiation.getAbstractorInstanceAbstractorRefID(abstractorInstanceID)

Return handle of the abstractorRef of an abstractorInstance.

Section: F.7.55.2.

Parameters:

abstractorInstanceID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.instantiation.getComponentInstanceComponentRefID(componentInstanceID)

Return handle of the componentRef inside a componentInstance.

Section: F.7.55.3.

Parameters:

componentInstanceID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.instantiation.getComponentInstantiationArchitectureName(componentInstantiationID)

Return architectureName value.

Section: F.7.55.4.

Parameters:

componentInstantiationID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.instantiation.getComponentInstantiationClearboxElementRefIDs(componentInstantiationID)

Return handles of all clearboxElementRef elements.

Section: F.7.55.5.

Parameters:

componentInstantiationID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.instantiation.getComponentInstantiationConfigurationName(componentInstantiationID)

Return configurationName value.

Section: F.7.55.6.

Parameters:

componentInstantiationID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.instantiation.getComponentInstantiationConstraintSetRefIDs(componentInstantiationID)

Return handles of constraintSetRef elements.

Section: F.7.55.7.

Parameters:

componentInstantiationID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.instantiation.getComponentInstantiationDefaultFileBuilderIDs(componentInstantiationID)

Return handles of defaultFileBuilder elements.

Section: F.7.55.8.

Parameters:

componentInstantiationID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.instantiation.getComponentInstantiationFileSetRefIDs(componentInstantiationID)

Return handles of fileSetRef elements.

Section: F.7.55.9.

Parameters:

componentInstantiationID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.instantiation.getComponentInstantiationIsVirtual(componentInstantiationID)

Return value of isVirtual.

Section: F.7.55.10.

Parameters:

componentInstantiationID (str)

Return type:

bool | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.instantiation.getComponentInstantiationLanguage(componentInstantiationID)

Return language value (string) if present.

Section: F.7.55.11.

Parameters:

componentInstantiationID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.instantiation.getComponentInstantiationLanguageID(componentInstantiationID)

Return handle of the language element.

Section: F.7.55.12.

Parameters:

componentInstantiationID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.instantiation.getComponentInstantiationLibraryName(componentInstantiationID)

Return libraryName value.

Section: F.7.55.13.

Parameters:

componentInstantiationID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.instantiation.getComponentInstantiationModuleName(componentInstantiationID)

Return moduleName value.

Section: F.7.55.14.

Parameters:

componentInstantiationID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.instantiation.getComponentInstantiationPackageName(componentInstantiationID)

Return packageName value.

Section: F.7.55.15.

Parameters:

componentInstantiationID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.instantiation.getDesignConfigurationInstantiationDesignConfigurationRefByID(designConfigurationInstantiationID)

Return designConfigurationRef handle for a designConfigurationInstantiation.

Section: F.7.55.16.

Parameters:

designConfigurationInstantiationID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.instantiation.getDesignConfigurationInstantiationDesignConfigurationRefByVLNV(designConfigurationInstantiationID)

Return VLNV tuple of the designConfigurationRef.

Section: F.7.55.17. Returns (None, None, None, None) if absent.

Parameters:

designConfigurationInstantiationID (str)

Return type:

tuple[str | None, str | None, str | None, str | None]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.instantiation.getDesignConfigurationInstantiationDesignConfigurationRefID(designConfigurationInstantiationID)

Alias of F.7.55.16 (explicit naming per spec).

Parameters:

designConfigurationInstantiationID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.instantiation.getDesignConfigurationInstantiationLanguage(designConfigurationInstantiationID)

Return language value of a designConfigurationInstantiation.

Section: F.7.55.19.

Parameters:

designConfigurationInstantiationID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.instantiation.getDesignConfigurationInstantiationLanguageID(designConfigurationInstantiationID)

Return handle of the language element.

Section: F.7.55.20.

Parameters:

designConfigurationInstantiationID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.instantiation.removeComponentInstantiationArchitectureName(componentInstantiationID)

Remove (clear) architectureName.

Section: F.7.56.5.

Parameters:

componentInstantiationID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.instantiation.removeComponentInstantiationClearboxElementRef(clearboxElementRefID)

Remove a specific clearboxElementRef by handle.

Section: F.7.56.6.

Parameters:

clearboxElementRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.instantiation.removeComponentInstantiationConfigurationName(componentInstantiationID)

Clear configurationName.

Section: F.7.56.7.

Parameters:

componentInstantiationID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.instantiation.removeComponentInstantiationConstraintSetRef(constraintSetRefID)

Remove a constraintSetRef by handle.

Section: F.7.56.8.

Parameters:

constraintSetRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.instantiation.removeComponentInstantiationDefaultFileBuilder(fileBuilderID)

Remove a defaultFileBuilder by handle.

Section: F.7.56.9.

Parameters:

fileBuilderID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.instantiation.removeComponentInstantiationFileSetRef(fileSetRefID)

Remove a fileSetRef.

Section: F.7.56.10.

Parameters:

fileSetRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.instantiation.removeComponentInstantiationIsVirtual(componentInstantiationID)

Clear isVirtual element.

Section: F.7.56.11.

Parameters:

componentInstantiationID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.instantiation.removeComponentInstantiationLanguage(componentInstantiationID)

Remove language element.

Section: F.7.56.12.

Parameters:

componentInstantiationID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.instantiation.removeComponentInstantiationLibraryName(componentInstantiationID)

Clear libraryName.

Section: F.7.56.13.

Parameters:

componentInstantiationID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.instantiation.removeComponentInstantiationModuleName(componentInstantiationID)

Clear moduleName.

Section: F.7.56.14.

Parameters:

componentInstantiationID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.instantiation.removeComponentInstantiationPackageName(componentInstantiationID)

Clear packageName.

Section: F.7.56.15.

Parameters:

componentInstantiationID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.instantiation.removeDesignConfigurationInstantiationLanguage(designConfigurationInstantiationID)

Remove language element from designConfigurationInstantiation.

Section: F.7.56.16.

Parameters:

designConfigurationInstantiationID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.instantiation.setComponentInstantiationArchitectureName(componentInstantiationID, architectureName)

Set architectureName.

Section: F.7.56.17.

Parameters:

• componentInstantiationID (str)

• architectureName (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.instantiation.setComponentInstantiationConfigurationName(componentInstantiationID, configurationName)

Set configurationName.

Section: F.7.56.18.

Parameters:

• componentInstantiationID (str)

• configurationName (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.instantiation.setComponentInstantiationIsVirtual(componentInstantiationID, value)

Set isVirtual element value.

Section: F.7.56.19.

Parameters:

• componentInstantiationID (str)

• value (bool)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.instantiation.setComponentInstantiationLanguage(componentInstantiationID, language)

Set language element (creates if absent).

Section: F.7.56.20.

Parameters:

• componentInstantiationID (str)

• language (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.instantiation.setComponentInstantiationLibraryName(componentInstantiationID, libraryName)

Set libraryName.

Section: F.7.56.21.

Parameters:

• componentInstantiationID (str)

• libraryName (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.instantiation.setComponentInstantiationModuleName(componentInstantiationID, moduleName)

Set moduleName.

Section: F.7.56.22.

Parameters:

• componentInstantiationID (str)

• moduleName (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.instantiation.setComponentInstantiationPackageName(componentInstantiationID, packageName)

Set packageName.

Section: F.7.56.23.

Parameters:

• componentInstantiationID (str)

• packageName (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.instantiation.setDesignConfigurationInstantiationDesignConfigurationRef(designConfigurationInstantiationID, designConfigurationVLNV)

Set the designConfigurationRef (creates if absent).

Section: F.7.56.24.

Parameters:

• designConfigurationInstantiationID (str)

• designConfigurationVLNV (tuple[str, str, str, str])

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.instantiation.setDesignConfigurationInstantiationLanguage(designConfigurationInstantiationID, language)

Set language element for designConfigurationInstantiation.

Section: F.7.56.25.

Parameters:

• designConfigurationInstantiationID (str)

• language (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.memory_map module

Memory map category TGI functions (IEEE 1685-2022).

Implements the full BASE (F.7.57) and EXTENDED (F.7.58) API surface for the Memory map category. ONLY the functions specified in those sections are exported (no more, no less). Functions provide read (get) and mutation operations across memory maps, banks, addressBlocks, subspaceMaps, memoryRemaps and associated aliasing / definition references. Missing optional elements return None (or empty lists) per TGI semantics. Invalid handles raise TgiError with TgiFaultCode.INVALID_ID; bad arguments raise with TgiFaultCode.INVALID_ARGUMENT.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.memory_map.addMemoryMapAddressBlock(memoryMapID, name)

Create a new addressBlock under a memory map.

Section: F.7.58.11 (core portion). Only name is required here; additional properties can be assigned via dedicated setters (range, width, baseAddress, etc.).

Parameters:

• memoryMapID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.memory_map.addMemoryMapBank(memoryMapID, name)

Add a bank to the memory map.

Section: F.7.58.12.

Parameters:

• memoryMapID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.memory_map.addMemoryMapMemoryRemap(memoryMapID, name)

Add a memoryRemap element.

Section: F.7.58.13.

Parameters:

• memoryMapID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.memory_map.addMemoryMapSubspaceMap(memoryMapID, name, addressOffset=None)

Add a subspaceMap to the memory map.

Section: F.7.58.14. Supports optional base address offset.

Parameters:

• memoryMapID (str)

• name (str)

• addressOffset (int | None)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.memory_map.getMemoryMapAddressBlockIDs(memoryMapID)

Return handles of all addressBlock children.

Section: F.7.57.44.

Parameters:

memoryMapID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.memory_map.getMemoryMapAddressUnitBits(memoryMapID)

Return the numeric value of addressUnitBits.

Section: F.7.57.45. Returns None if element absent or not numeric.

Parameters:

memoryMapID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.memory_map.getMemoryMapAddressUnitBitsExpression(memoryMapID)

Return expression text of addressUnitBits if present.

Section: F.7.57.46. Returns None if no element.

Parameters:

memoryMapID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.memory_map.getMemoryMapAddressUnitBitsID(memoryMapID)

Return handle of addressUnitBits element.

Section: F.7.57.47. Returns None if absent.

Parameters:

memoryMapID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.memory_map.getMemoryMapBankIDs(memoryMapID)

Return handles of bank children.

Section: F.7.57.48.

Parameters:

memoryMapID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.memory_map.getMemoryMapElementIDs(memoryMapID)

Return handles of all direct memory map elements (addressBlocks, banks, subspaceMaps, memoryRemaps).

Section: F.7.57.49.

Parameters:

memoryMapID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.memory_map.getMemoryMapElementType(elementID)

Return the element type name for a memory map child handle.

Section: F.7.57.50. Returns the local element type string or None if the handle does not reference a known memory map element type.

Parameters:

elementID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.memory_map.getMemoryMapMemoryMapDefinitionRefByExternalTypeDefID(memoryMapID)

Return the referenced memoryMapDefinition name.

Section: F.7.57.51. Returns None if absent.

Parameters:

memoryMapID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.memory_map.getMemoryMapMemoryMapDefinitionRefByID(memoryMapID)

Return memoryMapDefinition name via element handle.

Section: F.7.57.52.

Parameters:

memoryMapID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.memory_map.getMemoryMapMemoryMapDefinitionRefByName(memoryMapID)

Return memoryMapDefinition name by its name lookup.

Section: F.7.57.53.

Parameters:

memoryMapID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.memory_map.getMemoryMapMemoryMapDefinitionRefID(memoryMapID)

Return handle of memoryMapDefinitionRef element.

Section: F.7.57.54.

Parameters:

memoryMapID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.memory_map.getMemoryMapMemoryRemapIDs(memoryMapID)

Return handles of memoryRemap children.

Section: F.7.57.55.

Parameters:

memoryMapID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.memory_map.getMemoryMapRemapIDs(memoryMapID)

Alias for memory remap IDs (compat name per spec F.7.57.56).

Parameters:

memoryMapID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.memory_map.getMemoryMapShared(memoryMapID)

Return shared attribute value (if present).

Section: F.7.57 (paired with setter F.7.58.68). Returns None if not set.

Parameters:

memoryMapID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.memory_map.removeMemoryMapMemoryRemap(memoryRemapID)

Remove a memoryRemap element.

Section: F.7.58.40.

Parameters:

memoryRemapID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.memory_map.removeMemoryMapSubspaceMap(subspaceMapID)

Remove a subspaceMap element.

Section: F.7.58.42.

Parameters:

subspaceMapID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.memory_map.setMemoryMapMemoryMapDefinitionRef(memoryMapID, name)

Set or clear memoryMapDefinitionRef (named reference).

Section: F.7.58.67. Name corresponds to a memoryMapDefinition in typeDefinitions. Passing None removes the element.

Parameters:

• memoryMapID (str)

• name (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.memory_map.setMemoryMapShared(memoryMapID, shared)

Set or clear shared attribute value (string form).

Section: F.7.58.68. Accepts None to remove the element.

Parameters:

• memoryMapID (str)

• shared (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.miscellaneous module

Miscellaneous category TGI functions (IEEE 1685-2022).

Implements BASE (F.7.59) and EXTENDED (F.7.60) miscellaneous helper functions. These cover generic value/expression access, part-select index manipulation, argument/define/expression setters, VLNV registry operations and administrative calls (init/end/message/save). Only the standard 2022 API surface (no more, no less) is exported.

Where the underlying schema objects are not explicitly typed in this layer (e.g. argumentValue wrappers), generic duck-typing against value / expression / group attributes is used. This mirrors patterns from other categories while keeping strict fault code semantics.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.miscellaneous.addPartSelectIndex(partSelectID, expression)

Add a new index entry to partSelect returning its handle.

Section: F.7.60.1.

Parameters:

• partSelectID (str)

• expression (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.miscellaneous.end()

Terminate the active TGI administrative session.

Implements the End administrative command defined in section F.3.2. According to the specification this shall be the final message sent from the generator to the DE and conveys that the generator no longer requires the DE to listen for further TGI calls. The IEEE text also notes that a generator is not strictly required to terminate after sending End; therefore we model this as an idempotent state change.

Ordering rules enforced:

• init() must have been called successfully first; otherwise a

  TgiError is raised with INVALID_ARGUMENT.

• Multiple end() calls after the first succeed and simply

  return True (idempotent) so that defensive double-shutdown logic in callers does not produce faults.

Side effects:

• Marks the session as ended. Additional TGI calls that depend on

  an open session (currently only message) will raise.

Returns:

True when the session is (now or already) ended.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.miscellaneous.getArgumentValue(argumentID)

Return argument value (simple numeric str/int) or None.

Section: F.7.59.1.

Parameters:

argumentID (str)

Return type:

int | str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.miscellaneous.getArgumentValueExpression(argumentID)

Return associated expression string for an argument if present.

Section: F.7.59.2.

Parameters:

argumentID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.miscellaneous.getArgumentValueID(argumentID)

Return handle to the value element (argument itself).

Section: F.7.59.3.

Parameters:

argumentID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.miscellaneous.getBooleanValue(booleanID)

Return boolean simple content value.

Section: F.7.59.4.

Parameters:

booleanID (str)

Return type:

bool | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.miscellaneous.getDefineValue(defineID)

Return define value string.

Section: F.7.59.5.

Parameters:

defineID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.miscellaneous.getDefineValueExpression(defineID)

Return expression for define value.

Section: F.7.59.6.

Parameters:

defineID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.miscellaneous.getDefineValueID(defineID)

Return handle to define value (self handle).

Section: F.7.59.7.

Parameters:

defineID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.miscellaneous.getExpression(expressionID)

Return raw expression text.

Section: F.7.59.8.

Parameters:

expressionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.miscellaneous.getExpressionIntValue(expressionID)

Attempt to parse the evaluated integer value of an expression.

Section: F.7.59.9. Simple heuristic: if expression or value parses as int base 0.

Parameters:

expressionID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.miscellaneous.getExpressionValue(expressionID)

Return evaluated value (returns value or expression text fallback).

Section: F.7.59.10.

Parameters:

expressionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.miscellaneous.getGroup(elementID)

Return group attribute from element if any.

Section: F.7.59.11.

Parameters:

elementID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.miscellaneous.getPartSelectIndexIDs(partSelectID)

Return handles of each index element in a partSelect.

Section: F.7.59.12. Assumes attribute index list on object.

Parameters:

partSelectID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.miscellaneous.getPartSelectIndices(partSelectID)

Return concrete integer indices for part select (best-effort).

Section: F.7.59.13.

Parameters:

partSelectID (str)

Return type:

list[int]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.miscellaneous.getPartSelectIndicesExpression(partSelectID)

Return raw expressions/values for each index.

Section: F.7.59.14.

Parameters:

partSelectID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.miscellaneous.getPartSelectRange(partSelectID)

Return (left,right) numeric range if can be parsed.

Section: F.7.59.15.

Parameters:

partSelectID (str)

Return type:

tuple[int | None, int | None]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.miscellaneous.getPartSelectRangeExpression(partSelectID)

Return (leftExpr,rightExpr) raw expression/value strings.

Section: F.7.59.16.

Parameters:

partSelectID (str)

Return type:

tuple[str | None, str | None]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.miscellaneous.getPartSelectRangeLeftID(partSelectID)

Return handle of left expression element if present.

Section: F.7.59.17.

Parameters:

partSelectID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.miscellaneous.getPartSelectRangeRightID(partSelectID)

Return handle of right expression element if present.

Section: F.7.59.18.

Parameters:

partSelectID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.miscellaneous.getValue(elementID)

Return generic simple content value.

Section: F.7.59.19.

Parameters:

elementID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.miscellaneous.getXML(elementID)

Serialize an element to XML using xsdata’s XmlSerializer.

Section: F.7.59.20. Uses the project-wide serializer configuration (indentation two spaces). If the element cannot be resolved, None is returned. Errors during serialization raise TgiError with INVALID_ARGUMENT.

Parameters:

elementID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.miscellaneous.init(apiVersion, failureMode, init_message=None)

Initialize a new TGI administrative session (Init command).

Section F.3.2 specifies Init as the required first administrative message from the generator to the DE. While the standard only mandates a boolean return status, practical service front-ends provide contextual arguments (API version negotiated, desired failure/reporting mode, and an optional initial status message).

Parameters:

• apiVersion (str) – API version string requested/advertised by the generator (e.g. “1685-2022”). Stored for later inspection.

• failureMode (str) – Strategy for fault handling (implementation defined – e.g. “strict”, “permissive”, “continue”). The value is stored verbatim; no enumeration enforcement is applied here.

• init_message (str | None)

Return type:

bool

init_message: Optional initial status line to record (equivalent to a

first Message command with informational severity).

Raises:

TgiError – If a session is already active (no intervening End), fault code ALREADY_EXISTS.

Returns:

True when initialization succeeds.

Parameters:

• apiVersion (str)

• failureMode (str)

• init_message (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.miscellaneous.isSetElement(elementID)

Return True if element handle resolves to an object.

Section: F.7.60.4.

Parameters:

elementID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.miscellaneous.message(severity, text)

Record a status message (Message command) for the active session.

Section F.3.2 defines Message as a way for a generator to convey status to the user. This implementation captures both a required severity tag and the message text, storing them in the session log.

Parameters:

• severity (str) – Free-form severity level (e.g. INFO, WARN, ERROR). No validation is enforced; callers may adopt any taxonomy.

• text (str) – Message body. Empty strings are ignored (treated as no-op) but still return True.

Raises:

TgiError – If called before init or after end with fault code INVALID_ARGUMENT.

Returns:

True if accepted / ignored (empty text).

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.miscellaneous.registerCatalogVLNVs(vlnvEntries)

Register multiple catalog VLNV entries (no roots known yet).

Section: F.7.60.6. Each entry is a 4-tuple; returns success flags. Root object association is undefined here so a lightweight placeholder object is used.

Parameters:

vlnvEntries (Iterable[Sequence[str] | str])

Return type:

list[bool]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.miscellaneous.registerVLNV(elementID, vlnv)

Register a single VLNV for an element.

Section: F.7.60.7. Accepts either a handle string or the object itself (tests pass objects directly). Raises TgiError if duplicate.

Parameters:

• elementID (Any)

• vlnv (Sequence[str] | str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.miscellaneous.removePartSelectIndex(indexID)

Remove an index element from its parent partSelect list.

Section: F.7.60.8.

Parameters:

indexID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.miscellaneous.removePartSelectRange(partSelectID)

Remove range (left/right) elements.

Section: F.7.60.17.

Parameters:

partSelectID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.miscellaneous.resolveExpression(expression)

Resolve expression (stub returns input).

Parameters:

expression (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.miscellaneous.save()

Persist current model state (no-op True).

Section: F.7.60.10.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.miscellaneous.setArgumentValue(argumentID, value)

Set or clear argument value.

Section: F.7.60.11.

Parameters:

• argumentID (str)

• value (str | int | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.miscellaneous.setBooleanValue(booleanID, value)

Set or clear boolean value.

Section: F.7.60.12.

Parameters:

• booleanID (str)

• value (bool | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.miscellaneous.setDefineValue(defineID, value)

Set or clear define value.

Section: F.7.60.13.

Parameters:

• defineID (str)

• value (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.miscellaneous.setExpressionValue(expressionID, expression)

Set or clear expression text.

Section: F.7.60.14.

Parameters:

• expressionID (str)

• expression (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.miscellaneous.setPartSelectRange(partSelectID, left, right)

Set (left,right) range expressions or clear when None.

Section: F.7.60.15.

Parameters:

• partSelectID (str)

• left (str | None)

• right (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.miscellaneous.setValue(elementID, value)

Set generic value simple content.

Section: F.7.60.16.

Parameters:

• elementID (str)

• value (str | int | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.miscellaneous.unregisterCatalogVLNVs(vlnvEntries)

Unregister multiple VLNVs returning success flags.

Section: F.7.60.18.

Parameters:

vlnvEntries (Iterable[Sequence[str] | str])

Return type:

list[bool]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.miscellaneous.unregisterVLNV(vlnv)

Unregister a single VLNV mapping.

Section: F.7.60.19.

Parameters:

vlnv (Sequence[str] | str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.module_parameter module

Module parameter category TGI functions (IEEE 1685-2022).

Implements BASE (F.7.61) and EXTENDED (F.7.62) functions for accessing and modifying moduleParameter elements under a componentInstantiation or any container exposing a module_parameter list. This mirrors the style and error semantics of other category modules (e.g. abstraction_definition).

Rules applied: * Get functions never raise for missing elements; they return None or an

empty list.

• Traversal enumerations return handles (opaque IDs) for contained module parameters.

• Extended add/remove/set operations raise TgiError with TgiFaultCode.INVALID_ID for unknown handles and TgiFaultCode.INVALID_ARGUMENT for invalid arguments; otherwise return True/new handle.

• Expressions are not distinguished from values in the current simplified in- memory model, so the expression getter mirrors value retrieval.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.module_parameter.addModuleParameter(moduleParameterContainerElementID, name, value=None)

Add a new moduleParameter below the container, returning its handle.

Section: F.7.62.1. :param moduleParameterContainerElementID: Handle to container (componentInstantiation

or object with module_parameter list attribute).

Parameters:

• name (str) – Parameter name.

• value (str | None) – Optional initial value string.

• moduleParameterContainerElementID (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.module_parameter.getModuleParameterIDs(moduleParameterContainerElementID)

Return handles of all moduleParameter elements in the container.

Section: F.7.61.1.

Parameters:

moduleParameterContainerElementID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.module_parameter.getModuleParameterValue(moduleParameterID)

Return the parameter value simple string (None if absent).

Section: F.7.61.2.

Parameters:

moduleParameterID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.module_parameter.getModuleParameterValueExpression(moduleParameterID)

Return the value expression (mirrors value in this model).

Section: F.7.61.3.

Parameters:

moduleParameterID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.module_parameter.removeModuleParameter(moduleParameterID)

Remove a moduleParameter by handle.

Section: F.7.62.2.

Parameters:

moduleParameterID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.module_parameter.setModuleParameterValue(moduleParameterID, newValue)

Set parameter value, creating value element if needed.

Section: F.7.62.3.

Parameters:

• moduleParameterID (str)

• newValue (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.name_group module

Name group category TGI functions (IEEE 1685-2022).

Implements BASE (F.7.63) and EXTENDED (F.7.64) functions operating on the standard IP-XACT NameGroup (name, displayName, description, shortDescription) which is reused across many schema elements. Handles refer to any object possessing the corresponding attributes.

Design decisions: * Getters never raise for missing handles; they return None. * Set/remove calls raise TgiError with INVALID_ID for unknown handles. * Removal sets the attribute to None and returns True if the element

existed before removal else False.

• Setting creates/overwrites simple string content; empty string is allowed.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.name_group.getDescription(elementID)

Return description text.

Section: F.7.63.1.

Parameters:

elementID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.name_group.getDisplayName(elementID)

Return displayName text.

Section: F.7.63.2.

Parameters:

elementID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.name_group.getName(elementID)

Return name text.

Section: F.7.63.3.

Parameters:

elementID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.name_group.getShortDescription(elementID)

Return shortDescription text.

Section: F.7.63.4.

Parameters:

elementID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.name_group.removeDescription(elementID)

Remove description element.

Section: F.7.64.1.

Parameters:

elementID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.name_group.removeDisplayName(elementID)

Remove displayName element.

Section: F.7.64.2.

Parameters:

elementID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.name_group.removeName(elementID)

Remove name element.

Section: F.7.64.3.

Parameters:

elementID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.name_group.removeShortDescription(elementID)

Remove shortDescription element.

Section: F.7.64.4.

Parameters:

elementID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.name_group.setDescription(elementID, value)

Set description text (None clears).

Section: F.7.64.5.

Parameters:

• elementID (str)

• value (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.name_group.setDisplayName(elementID, value)

Set displayName text (None clears). Handles both naming variants.

Section: F.7.64.6.

Parameters:

• elementID (str)

• value (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.name_group.setName(elementID, value)

Set name text (None clears).

Section: F.7.64.7.

Parameters:

• elementID (str)

• value (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.name_group.setShortDescription(elementID, value)

Set shortDescription text (None clears). Supports both variants.

Section: F.7.64.8.

Parameters:

• elementID (str)

• value (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.parameter module

Parameter category TGI functions (IEEE 1685-2022).

Implements BASE (F.7.65) and EXTENDED (F.7.66) functions for the parameter elements used widely across IP-XACT. Provides enumeration, choice & reference helpers, value/expression accessors, and creation/removal/set operations.

Conventions: * Getters return None/[] rather than raising for missing handles or fields. * Set/remove operations raise TgiError with INVALID_ID for unknown

handles, INVALID_ARGUMENT for illegal arguments.

• Expression handling mirrors simple value (model currently stores value only).

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.parameter.addParameter(parameterContainerElementID, name, value=None)

Create a new parameter and append to container.

Section: F.7.66.1. :param parameterContainerElementID: Handle of container with parameter list. :param name: Parameter name (must be unique within container). :param value: Optional initial value string.

Raises:

TgiError – On invalid container handle or duplicate name.

Parameters:

• parameterContainerElementID (str)

• name (str)

• value (str | None)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.parameter.getModuleParameterDataTypeDefinitionRefByID(parameterID)

Return the data type definition reference ID (handle) if present.

Section: F.7.65.1. Current model: return None (placeholder) pending full type definitions integration.

Parameters:

parameterID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.parameter.getParameterChoiceRefByName(parameterContainerElementID, parameterName)

Return handle of the choice referenced by parameter name.

Section: F.7.65.2. Placeholder returns None until choices are attached to parameters in the model.

Parameters:

• parameterContainerElementID (str)

• parameterName (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.parameter.getParameterIDFromReferenceID(parameterContainerElementID, referenceParameterID)

Map a reference parameter ID to the actual parameter ID (identity).

Section: F.7.65.3. With no separate reference indirection layer yet, returns the input if it resolves to a Parameter.

Parameters:

• parameterContainerElementID (str)

• referenceParameterID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.parameter.getParameterIDs(parameterContainerElementID)

Return handles of all parameter elements under the container.

Section: F.7.65.4.

Parameters:

parameterContainerElementID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.parameter.getParameterNameFromReferenceID(parameterContainerElementID, referenceParameterID)

Return parameter name given a (possibly reference) parameter ID.

Section: F.7.65.5.

Parameters:

• parameterContainerElementID (str)

• referenceParameterID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.parameter.getParameterValue(parameterID)

Return parameter value simple text.

Section: F.7.65.6.

Parameters:

parameterID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.parameter.getParameterValueExpression(parameterID)

Return expression for parameter value (mirrors value currently).

Section: F.7.65.7.

Parameters:

parameterID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.parameter.getParameterValueID(parameterID)

Return handle to the value element (parameter itself here).

Section: F.7.65.8.

Parameters:

parameterID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.parameter.removeConfigGroupsAttribute(parameterID)

Remove configGroups attribute from parameter (placeholder).

Section: F.7.66.2. Current model: if attribute exists set to None. Returns True if removed, False if not present or parameter invalid.

Parameters:

parameterID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.parameter.removeParameter(parameterID)

Remove a parameter by handle.

Section: F.7.66.3. Uses parent registry for structural detach.

Parameters:

parameterID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.parameter.setParameterValue(parameterID, newValue)

Set (or clear if None) parameter value.

Section: F.7.66.4.

Parameters:

• parameterID (str)

• newValue (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port module

Port category TGI functions (IEEE 1685-2022).

Implements BASE (F.7.67) and EXTENDED (F.7.68) Port functions.

Notes

The 2022 schema introduces rich structure for wire / transactional / structured ports plus field maps and domain type definitions. Only elements represented in the generated Python schema are manipulated. Where the spec references semantics not yet modeled (e.g. specific driver or constraint details) the function returns None or an empty list instead of raising – consistent with earlier categories.

Error model:

Functions that take a handle to a Port or nested object return graceful empty values if the handle is invalid (None, empty list, empty string) – mirroring other BASE getter implementations. EXTENDED add/remove/set operations raise TgiError with TgiFaultCode.INVALID_ID for an invalid handle and TgiFaultCode.INVALID_ARGUMENT for semantic problems (e.g. duplicates). All add* return a handle (string) of the new element.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port.addDomainTypeDefTypeDefinition(portID, domainTypeDefID, value)

Append a typeDefinition string to the given domainTypeDef.

Section: F.7.68.1.

Parameters:

• portID (str)

• domainTypeDefID (str)

• value (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port.addDomainTypeDefViewRef(portID, domainTypeDefID, viewRef)

Add a viewRef to a domainTypeDef.

Section: F.7.68.2.

Parameters:

• portID (str)

• domainTypeDefID (str)

• viewRef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port.addExternalPortReferenceSubPortReference(portID, fieldMapID, subPortRef)

Add subPortReference for an external reference (treated same as internal here).

Section: F.7.68.3. Implementation merges external/internal semantics.

Parameters:

• portID (str)

• fieldMapID (str)

• subPortRef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port.addFieldMapIndex(portID, fieldMapID, index)

Set/replace the partSelect of a FieldMap with a single index.

Section: F.7.68.4. Returns handle of partSelect.

Parameters:

• portID (str)

• fieldMapID (str)

• index (int)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port.addFieldMapModeRef(portID, fieldMapID, modeName, priority)

Append a modeRef to a FieldMap.

Section: F.7.68.5.

Parameters:

• portID (str)

• fieldMapID (str)

• modeName (str)

• priority (int)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port.addFieldMapSubPortReference(portID, fieldMapID, subPortRef)

Add a subPortReference to a FieldMap.

Section: F.7.68.6.

Parameters:

• portID (str)

• fieldMapID (str)

• subPortRef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port.addInternalPortReferenceSubPortReference(portID, fieldMapID, subPortRef)

Add subPortReference for an internal reference (same as external here).

Section: F.7.68.7.

Parameters:

• portID (str)

• fieldMapID (str)

• subPortRef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port.addPortClockDriver(portID, value)

Add a clock driver to port (placeholder – not modeled).

Section: F.7.68.8. Returns synthetic handle.

Parameters:

• portID (str)

• value (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port.addPortClockDriverExpresion(portID, expression)

Add clock driver expression (placeholder). Section: F.7.68.9.

Parameters:

• portID (str)

• expression (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port.addPortDefaultDriver(portID, value)

Add default driver (placeholder). Section: F.7.68.10.

Parameters:

• portID (str)

• value (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port.addPortDefaultDriverExpression(portID, expression)

Add default driver expression (placeholder). Section: F.7.68.11.

Parameters:

• portID (str)

• expression (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port.addPortDomainTypeDef(portID, typeName)

Create and append a DomainTypeDef under wire.domainTypeDefs.

Section: F.7.68.12.

Parameters:

• portID (str)

• typeName (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port.addPortFieldMap(portID)

Create a new FieldMap on the port.

Section: F.7.68.13.

Parameters:

portID (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port.addPortSignalTypeDef(portID, typeDef)

Add a signalTypeDef to wire.signalTypeDefs (placeholder).

Section: F.7.68.14. Returns synthetic handle.

Parameters:

• portID (str)

• typeDef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port.addPortSingleShotDriver(portID, value)

Add single-shot driver (placeholder). Section: F.7.68.15.

Parameters:

• portID (str)

• value (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port.addPortSingleShotDriverExpression(portID, expression)

Add single-shot driver expression (placeholder). Section: F.7.68.16.

Parameters:

• portID (str)

• expression (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port.addPortStructuredStructPortTypeDef(portID, typeDef)

Add structPortTypeDef (placeholder). Section: F.7.68.17.

Parameters:

• portID (str)

• typeDef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port.addPortStructuredSubStructuredPort(portID, name)

Add sub structured port (placeholder). Section: F.7.68.18.

Parameters:

• portID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port.addPortStructuredSubWirePort(portID, name)

Add sub wire port (placeholder). Section: F.7.68.19.

Parameters:

• portID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port.addPortStructuredVector(portID, left, right)

Add structured vectors element (placeholder). Section: F.7.68.20.

Parameters:

• portID (str)

• left (int)

• right (int)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port.addPortTransactionalTransTypeDef(portID, language, text)

Add transactional transTypeDef (placeholder). Section: F.7.68.21.

Parameters:

• portID (str)

• language (str)

• text (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port.addPortWireConstraintSet(portID, name)

Add wire constraint set (placeholder). Section: F.7.68.22.

Parameters:

• portID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port.addPortWireDriver(portID, value)

Add wire driver (placeholder). Section: F.7.68.23.

Parameters:

• portID (str)

• value (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port.addPortWireTypeDef(portID, typeDef)

Add wire type definition (placeholder). Section: F.7.68.24.

Parameters:

• portID (str)

• typeDef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port.addServiceTypeDefServiceTypeDef(portID, typeDef)

Add service type definition (placeholder). Section: F.7.68.25.

Parameters:

• portID (str)

• typeDef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port.getAccessPortAccessType(portID)

Return the access type (wire/transactional/structured) of the port.

Section: F.7.67.1. Returns one of “wire”, “transactional”, “structured” or None.

Parameters:

portID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port.getDomainTypeDefTypeDefinitionIDs(portID, domainTypeDefID)

Return handles for typeDefinition children of a domainTypeDef.

Section: F.7.67.2.

Parameters:

• portID (str)

• domainTypeDefID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port.getDomainTypeDefTypeDefinitions(portID, domainTypeDefID)

Return string values of typeDefinition entries for a domainTypeDef.

Section: F.7.67.3.

Parameters:

• portID (str)

• domainTypeDefID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port.getDomainTypeDefTypeName(portID, domainTypeDefID)

Return the typeName value of a domainTypeDef.

Section: F.7.67.4.

Parameters:

• portID (str)

• domainTypeDefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port.getDomainTypeDefTypeNameID(portID, domainTypeDefID)

Return the handle of the typeName element of a domainTypeDef.

Section: F.7.67.5.

Parameters:

• portID (str)

• domainTypeDefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port.getDomainTypeDefViewIDs(portID, domainTypeDefID)

Return handles of viewRef elements of a domainTypeDef.

Section: F.7.67.6.

Parameters:

• portID (str)

• domainTypeDefID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port.getDomainTypeDefViewRefIDs(portID, domainTypeDefID)

Alias of getDomainTypeDefViewIDs (spec splits naming).

Section: F.7.67.7.

Parameters:

• portID (str)

• domainTypeDefID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port.getDomainTypeDefViewRefs(portID, domainTypeDefID)

Return string values of viewRef elements for a domainTypeDef.

Section: F.7.67.8.

Parameters:

• portID (str)

• domainTypeDefID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port.getFieldDefinitionAccessPoliciesIDs(portID)

Return handles of access policy elements associated with the port field maps.

Section: F.7.67.9. Implementation note: Access policies are not explicitly modeled on FieldMap in the generated schema; returns empty list until/if modeled.

Parameters:

portID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port.getFieldMapFieldSliceID(fieldMapID)

Return handle of fieldSlice child of a FieldMap.

Section: F.7.67.10.

Parameters:

fieldMapID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port.getFieldMapModeRefByID(fieldMapModeRefID)

Return (modeName, priority) for a modeRef handle.

Section: F.7.67.11.

Parameters:

fieldMapModeRefID (str)

Return type:

tuple[str | None, int | None]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port.getFieldMapModeRefByNames(portID, fieldMapID, modeName)

Return handle of a modeRef within a FieldMap by its mode name.

Section: F.7.67.12.

Parameters:

• portID (str)

• fieldMapID (str)

• modeName (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port.getFieldMapModeRefIDs(portID, fieldMapID)

Return handles of modeRef elements for a given FieldMap.

Section: F.7.67.13.

Parameters:

• portID (str)

• fieldMapID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port.getFieldMapModeRefs(portID, fieldMapID)

Return list of (modeName, priority) for modeRefs of a FieldMap.

Section: F.7.67.14.

Parameters:

• portID (str)

• fieldMapID (str)

Return type:

list[tuple[str | None, int | None]]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port.getFieldMapPartSelectID(fieldMapID)

Return handle of partSelect child of a FieldMap.

Section: F.7.67.15.

Parameters:

fieldMapID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port.getFieldMapSubPortReferenceIDs(fieldMapID)

Return handles of subPortReference children of a FieldMap.

Section: F.7.67.16.

Parameters:

fieldMapID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port.getPayloadExtension(portID)

Return payload extension string for a transactional port.

Section: F.7.67.17. Implementation note: Not modeled in schema; returns None.

Parameters:

portID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port.getPayloadExtensionID(portID)

Return handle for payload extension element.

Section: F.7.67.18. Not modeled; returns None.

Parameters:

portID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port.getPayloadType(portID)

Return payload type for a transactional port.

Section: F.7.67.19. Implementation note: Not modeled separately; returns None.

Parameters:

portID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port.getPortAccessID(portID)

Return handle of the access element of the port.

Section: F.7.67.20.

Parameters:

portID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port_map module

Port map category TGI functions.

Implements IEEE 1685-2022 Annex F Port map category:

• F.7.69 Port map (BASE)

• F.7.70 Port map (EXTENDED)

Only the functions defined by the standard are exported (no more, no less). BASE functions are tolerant (return None/[] on invalid handles). EXTENDED functions raise TgiError with an appropriate TgiFaultCode when arguments are invalid or an operation cannot be completed.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port_map.addPhysicalPortSubPort(physicalPortID, name)

Add a subPort to an existing physicalPort.

Section: F.7.70.1.

Parameters:

• physicalPortID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port_map.addPortMapPhysicalPortSubPort(portMapID, name)

Convenience: add subPort via portMap physicalPort.

Section: F.7.70.2.

Parameters:

• portMapID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port_map.getLogicalPortRange(portMapID)

Return handle of the logicalPort.range element.

Section: F.7.69.1.

Parameters:

portMapID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port_map.getLogicalPortRangeExpression(portMapID)

Return combined expression (“left:right”) for logicalPort.range.

Section: F.7.69.2.

Parameters:

portMapID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port_map.getLogicalPortRangeLeftID(portMapID)

Return handle to the left element of logicalPort.range.

Section: F.7.69.3.

Parameters:

portMapID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port_map.getLogicalPortRangeRightID(portMapID)

Return handle to the right element of logicalPort.range.

Section: F.7.69.4.

Parameters:

portMapID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port_map.getPhysicalPortPartSelectID(portMapID)

Return handle to physicalPort.partSelect.

Section: F.7.69.5.

Parameters:

portMapID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port_map.getPhysicalPortSubPortIDs(portMapID)

Return handles of physicalPort.subPort elements.

Section: F.7.69.6.

Parameters:

portMapID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port_map.getPortMapIsInformative(portMapID)

Return isInformative flag value.

Section: F.7.69.7.

Parameters:

portMapID (str)

Return type:

bool | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port_map.getPortMapLogicalPortID(portMapID)

Return handle of logicalPort element.

Section: F.7.69.8.

Parameters:

portMapID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port_map.getPortMapLogicalTieOff(portMapID)

Return handle of logicalTieOff element.

Section: F.7.69.9.

Parameters:

portMapID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port_map.getPortMapLogicalTieOffExpression(portMapID)

Return expression text of logicalTieOff.

Section: F.7.69.10.

Parameters:

portMapID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port_map.getPortMapLogicalTieOffID(portMapID)

Alias for getPortMapLogicalTieOff (both return handle).

Section: F.7.69.11.

Parameters:

portMapID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port_map.getPortMapPhysicalPortID(portMapID)

Return handle of physicalPort element.

Section: F.7.69.12.

Parameters:

portMapID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port_map.removePhysicalPortPartSelect(physicalPortID)

Remove partSelect from a physicalPort.

Section: F.7.70.3.

Parameters:

physicalPortID (str)

Return type:

None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port_map.removePhysicalPortSubPort(subPortID)

Remove a subPort from its parent physicalPort.

Section: F.7.70.4. Best-effort linear search over known port maps.

Parameters:

subPortID (str)

Return type:

None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port_map.removePortMapIsInformative(portMapID)

Clear the isInformative element.

Section: F.7.70.5.

Parameters:

portMapID (str)

Return type:

None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port_map.setAbstractionTypeAbstractionRef(abstractionTypeID, vlnv)

Set abstractionRef VLNV string (vendor:library:name:version).

Section: F.7.70.6.

Parameters:

• abstractionTypeID (str)

• vlnv (str)

Return type:

None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port_map.setLogicalPortRange(portMapID, left_expr, right_expr)

Create or update logicalPort.range with given left/right expressions.

Section: F.7.70.7.

Parameters:

• portMapID (str)

• left_expr (str)

• right_expr (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port_map.setPhysicalPortPartSelect(physicalPortID, left_expr, right_expr)

Set or update partSelect on a physicalPort.

Section: F.7.70.8.

Parameters:

• physicalPortID (str)

• left_expr (str)

• right_expr (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port_map.setPortMapIsInformative(portMapID, value)

Set the isInformative flag.

Section: F.7.70.9.

Parameters:

• portMapID (str)

• value (bool)

Return type:

None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port_map.setPortMapLogicalPort(portMapID, name)

Set the logicalPort name (create logicalPort if absent).

Section: F.7.70.10.

Parameters:

• portMapID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port_map.setPortMapLogicalTieOff(portMapID, expression)

Create/update logicalTieOff expression.

Section: F.7.70.11.

Parameters:

• portMapID (str)

• expression (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port_map.setPortMapPhysicalPort(portMapID, name)

Set or create physicalPort with provided name.

Section: F.7.70.12.

Parameters:

• portMapID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.port_map.setSubPortMapPartSelect(subPortID, left_expr, right_expr)

Set partSelect on a subPort.

Section: F.7.70.13.

Parameters:

• subPortID (str)

• left_expr (str)

• right_expr (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.power module

Power category TGI functions (IEEE 1685-2022).

Implements BASE (F.7.71) and EXTENDED (F.7.72) Power functions. Only the functions defined in Annex F are exported – no additional helpers. BASE getters return empty/None for invalid handles; EXTENDED mutators raise TgiError with appropriate TgiFaultCode.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.power.addComponentInstancePowerDomainLink(componentInstanceID, externalRefExpression=None)

Append powerDomainLink to component instance (F.7.72.1).

Parameters:

• componentInstanceID (str)

• externalRefExpression (str | None)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.power.addComponentPowerDomain(componentID, name)

Create powerDomain under component (F.7.72.2).

Parameters:

• componentID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.power.addPortTransactionalPowerConstraint(portID, powerDomainRef=None)

Add transactional powerConstraint (F.7.72.3).

Parameters:

• portID (str)

• powerDomainRef (str | None)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.power.addPortWirePowerConstraint(portID, powerDomainRef=None)

Add wire powerConstraint (F.7.72.4).

Parameters:

• portID (str)

• powerDomainRef (str | None)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.power.addPowerDomainLinkInternalPowerDomainReference(powerDomainLinkID, internalRefExpression)

Add internalPowerDomainReference (F.7.72.5).

Parameters:

• powerDomainLinkID (str)

• internalRefExpression (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.power.getPortTransactionalPowerConstraintIDs(portID)

Return IDs of transactional powerConstraint elements (F.7.71.1).

Parameters:

portID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.power.getPortWirePowerConstraintIDs(portID)

Return IDs of wire powerConstraint elements (F.7.71.2).

Parameters:

portID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.power.getPowerConstraintPowerDomainRefByID(powerConstraintID)

Return powerDomainRef value for constraint (F.7.71.3).

Parameters:

powerConstraintID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.power.getPowerConstraintPowerDomainRefByName(powerConstraintID)

Alias of getPowerConstraintPowerDomainRefByID (F.7.71.4).

Parameters:

powerConstraintID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.power.getPowerConstraintRange(powerConstraintID)

Return range handle if present (wire only) (F.7.71.5).

Parameters:

powerConstraintID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.power.getPowerConstraintRangeLeftID(powerConstraintID)

Return left bound handle of range (F.7.71.6).

Parameters:

powerConstraintID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.power.getPowerConstraintRangeRightID(powerConstraintID)

Return right bound handle of range (F.7.71.7).

Parameters:

powerConstraintID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.power.getPowerDomainAlwaysOn(powerDomainID)

Return boolean alwaysOn value (F.7.71.8).

Parameters:

powerDomainID (str)

Return type:

bool | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.power.getPowerDomainAlwaysOnExpression(powerDomainID)

Return expression string for alwaysOn (F.7.71.9).

Parameters:

powerDomainID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.power.getPowerDomainAlwaysOnID(powerDomainID)

Return handle of alwaysOn element (F.7.71.10).

Parameters:

powerDomainID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.power.getPowerDomainName(powerDomainID)

Return power domain name (F.7.71.11).

Parameters:

powerDomainID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.power.getPowerDomainSubDomainOf(powerDomainID)

Return subDomainOf value (F.7.71.12).

Parameters:

powerDomainID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.power.getPowerDomainSubDomainOfRefByID(powerDomainID)

Alias of getPowerDomainSubDomainOf (F.7.71.13).

Parameters:

powerDomainID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.power.removeComponentInstancePowerDomainLink(powerDomainLinkID)

Remove powerDomainLink (F.7.72.6).

Parameters:

powerDomainLinkID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.power.removeComponentPowerDomain(powerDomainID)

Remove component powerDomain (F.7.72.7).

Parameters:

powerDomainID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.power.removePowerConstraintRange(powerConstraintID)

Remove range from powerConstraint (F.7.72.8).

Parameters:

powerConstraintID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.power.removePowerDomainLinkInternalPowerDomainRef(powerDomainLinkID, internalRefExpression)

Remove an internalPowerDomainReference by expression or ID (F.7.72.9).

Parameters:

• powerDomainLinkID (str)

• internalRefExpression (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.power.removePowerDomainSubDomainOf(powerDomainID)

Clear subDomainOf (F.7.72.10).

Parameters:

powerDomainID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.power.setPowerConstraintPowerDomainRef(powerConstraintID, powerDomainName)

Set powerDomainRef (F.7.72.11).

Parameters:

• powerConstraintID (str)

• powerDomainName (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.power.setPowerConstraintRange(powerConstraintID, left_expr, right_expr)

Create or update range (wire only) (F.7.72.12).

Parameters:

• powerConstraintID (str)

• left_expr (str)

• right_expr (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.power.setPowerDomainAlwaysOn(powerDomainID, expression)

Set alwaysOn (boolean or expression) (F.7.72.13).

Parameters:

• powerDomainID (str)

• expression (str | bool)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.power.setPowerDomainSubDomainOf(powerDomainID, parentName)

Set subDomainOf (F.7.72.14).

Parameters:

• powerDomainID (str)

• parentName (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register module

Register category TGI functions (IEEE 1685-2022).

Implements BASE (F.7.73) and EXTENDED (F.7.74) Register functions. Only the functions defined in Annex F are exported. BASE getters return empty/None for invalid handles. EXTENDED mutators raise TgiError with appropriate :TgiFaultCode values. Schema coverage is partial; where underlying objects are absent the operations return graceful defaults or raise INVALID_ID.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.addAlternateRegisterField(alternateRegisterID, name, offset, width)

Add field to alternateRegister (F.7.74.1).

Parameters:

• alternateRegisterID (str)

• name (str)

• offset (str)

• width (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.addAlternaterRegisterModeRef(alternateRegisterID, modeRef, priority)

Add modeRef to alternateRegister (F.7.74.2).

Parameters:

• alternateRegisterID (str)

• modeRef (str)

• priority (int)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.addBroadcastToBankRef(broadcastToID, bankRef)

Add bankRef to broadcastTo (F.7.74.3).

Parameters:

• broadcastToID (str)

• bankRef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.addBroadcastToRegisterFileRef(broadcastToID, registerFileRef)

Add registerFileRef (F.7.74.4).

Parameters:

• broadcastToID (str)

• registerFileRef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.addEnumeratedValuesFieldEnumeratedValue(enumeratedValuesID, name, value)

Add enumeratedValue (F.7.74.5).

Parameters:

• enumeratedValuesID (str)

• name (str)

• value (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.addFieldRefIndex(fieldRefID, value)

Add index to fieldRef (F.7.74.6).

Parameters:

• fieldRefID (str)

• value (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.addRegisterAlternateRegister(registerID, name, modeRef, priority, fieldName, fieldOffset, fieldWidth)

Add alternateRegister (F.7.74.7).

Parameters:

• registerID (str)

• name (str)

• modeRef (str)

• priority (int)

• fieldName (str)

• fieldOffset (str)

• fieldWidth (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.addRegisterField(registerID, name, offset, width)

Add field to register (F.7.74.8).

Parameters:

• registerID (str)

• name (str)

• offset (str)

• width (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.addRegisterFieldReset(registerFieldID, value)

Add reset to register field (F.7.74.9).

Parameters:

• registerFieldID (str)

• value (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.addRegisterRefIndex(registerRefID, value)

Add index to registerRef (F.7.74.10).

Parameters:

• registerRefID (str)

• value (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getAliasOfAlternateRegisterRefByName(aliasOfID)

Return alternateRegisterRef value (F.7.73.1).

Parameters:

aliasOfID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getAliasOfAlternateRegisterRefID(aliasOfID)

Return handle of alternateRegisterRef (F.7.73.2).

Parameters:

aliasOfID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getAliasOfFieldRefByName(aliasOfID)

Return fieldRef value (F.7.73.3).

Parameters:

aliasOfID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getAliasOfFieldRefID(aliasOfID)

Return handle of fieldRef (F.7.73.4).

Parameters:

aliasOfID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getAliasOfRegisterRefByName(aliasOfID)

Return registerRef value (F.7.73.5).

Parameters:

aliasOfID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getAliasOfRegisterRefID(aliasOfID)

Return handle of registerRef (F.7.73.6).

Parameters:

aliasOfID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getAlternateRegisterFieldIDs(alternateRegisterID)

Return field handles of alternateRegister (F.7.73.7).

Parameters:

alternateRegisterID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getAlternateRegisterModeRefIDs(alternateRegisterID)

Return modeRef handles (F.7.73.8).

Parameters:

alternateRegisterID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getAlternateRegisterRefAlternateRegisterRefByName(alternateRegisterRefID)

Return alternateRegisterRef value (F.7.73.9).

Parameters:

alternateRegisterRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getAlternateRegisterTypeIdentifier(alternateRegisterID)

Return typeIdentifier value (F.7.73.10).

Parameters:

alternateRegisterID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getAlternateRegisterVolatility(alternateRegisterID)

Return volatility boolean (F.7.73.11).

Parameters:

alternateRegisterID (str)

Return type:

bool | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getBroadcastToAddressBlockRefByName(broadcastToID)

Return addressBlockRef value (F.7.73.12).

Parameters:

broadcastToID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getBroadcastToAddressBlockRefID(broadcastToID)

Return handle of addressBlockRef (F.7.73.13).

Parameters:

broadcastToID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getBroadcastToAddressSpaceRefByName(broadcastToID)

Return addressSpaceRef value (F.7.73.14).

Parameters:

broadcastToID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getBroadcastToAddressSpaceRefID(broadcastToID)

Return handle of addressSpaceRef (F.7.73.15).

Parameters:

broadcastToID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getBroadcastToAlternateRegisterRefByName(broadcastToID)

Return alternateRegisterRef value (F.7.73.16).

Parameters:

broadcastToID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getBroadcastToAlternateRegisterRefID(broadcastToID)

Return handle of alternateRegisterRef (F.7.73.17).

Parameters:

broadcastToID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getBroadcastToBankRefByNames(broadcastToID)

Return list of bankRef values (F.7.73.18).

Parameters:

broadcastToID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getBroadcastToBankRefIDs(broadcastToID)

Return handles of bankRef elements (F.7.73.19).

Parameters:

broadcastToID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getBroadcastToFieldRefByName(broadcastToID)

Return fieldRef value (F.7.73.20).

Parameters:

broadcastToID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getBroadcastToFieldRefID(broadcastToID)

Return handle of fieldRef (F.7.73.21).

Parameters:

broadcastToID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getBroadcastToMemoryMapRefByName(broadcastToID)

Return memoryMapRef value (F.7.73.22).

Parameters:

broadcastToID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getBroadcastToMemoryMapRefID(broadcastToID)

Return handle of memoryMapRef (F.7.73.23).

Parameters:

broadcastToID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getBroadcastToRegisterFileRefByNames(broadcastToID)

Return registerFileRef names (F.7.73.24).

Parameters:

broadcastToID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getBroadcastToRegisterFileRefIDs(broadcastToID)

Return handles of registerFileRef elements (F.7.73.25).

Parameters:

broadcastToID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getBroadcastToRegisterRefByName(broadcastToID)

Return registerRef value (F.7.73.26).

Parameters:

broadcastToID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getBroadcastToRegisterRefID(broadcastToID)

Return handle of registerRef (F.7.73.27).

Parameters:

broadcastToID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getEnumeratedValueExpression(enumeratedValueID)

Return expression (F.7.73.28).

Parameters:

enumeratedValueID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getEnumeratedValueUsage(enumeratedValueID)

Return usage (F.7.73.29).

Parameters:

enumeratedValueID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getEnumeratedValueValue(enumeratedValueID)

Return numeric value (F.7.73.30).

Parameters:

enumeratedValueID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getEnumeratedValueValueExpression(enumeratedValueID)

Return value expression (F.7.73.31).

Parameters:

enumeratedValueID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getEnumeratedValueValueID(enumeratedValueID)

Return handle of value element (F.7.73.32).

Parameters:

enumeratedValueID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getEnumeratedValuesEnumeratedValueIDs(enumeratedValuesID)

Return enumeratedValue handles (F.7.73.33).

Parameters:

enumeratedValuesID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getEnumeratedValuesEnumerationDefinitionRefByExternalTypeDefID(enumeratedValuesID)

Return externalTypeDefinitions handle (F.7.73.34).

Parameters:

enumeratedValuesID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getEnumeratedValuesEnumerationDefinitionRefByID(enumeratedValuesID)

Return enumerationDefinition handle (F.7.73.35).

Parameters:

enumeratedValuesID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getEnumeratedValuesEnumerationDefinitionRefByName(enumeratedValuesID)

Return enumerationDefinitionRef value (F.7.73.36).

Parameters:

enumeratedValuesID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getEnumeratedValuesEnumerationDefinitionRefID(enumeratedValuesID)

Return handle of enumerationDefinitionRef (F.7.73.37).

Parameters:

enumeratedValuesID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getFieldBitOffsetID(fieldID)

Return bitOffset handle (F.7.73.38).

Parameters:

fieldID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getFieldDefinitionBitWidthID(fieldDefinitionID)

Return bitWidth handle (F.7.73.39).

Parameters:

fieldDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getFieldDefinitionEnumeratedValueIDs(fieldDefinitionID)

Return enumeratedValue handles (F.7.73.40).

Parameters:

fieldDefinitionID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getFieldDefinitionTypeIdentifier(fieldDefinitionID)

Return typeIdentifier (F.7.73.41).

Parameters:

fieldDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getFieldDefinitionVolatile(fieldDefinitionID)

Return volatile flag (F.7.73.42).

Parameters:

fieldDefinitionID (str)

Return type:

bool | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getFieldRefFieldRefByName(fieldRefID)

Return fieldRef value (F.7.73.43).

Parameters:

fieldRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getFieldRefIndexIDs(fieldRefID)

Return index handles (F.7.73.44).

Parameters:

fieldRefID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getRegisterAddressOffset(registerID)

Return addressOffset value (F.7.73.45).

Parameters:

registerID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getRegisterAddressOffsetExpression(registerID)

Return addressOffset expression (F.7.73.46).

Parameters:

registerID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getRegisterAddressOffsetID(registerID)

Return handle of addressOffset (F.7.73.47).

Parameters:

registerID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getRegisterAlternateRegisterIDs(registerID)

Return alternateRegister handles (F.7.73.48).

Parameters:

registerID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getRegisterFieldAliasOfID(registerFieldID)

Return aliasOf handle (F.7.73.49).

Parameters:

registerFieldID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getRegisterFieldBitOffset(registerFieldID)

Return bitOffset value (F.7.73.50).

Parameters:

registerFieldID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getRegisterFieldBitOffsetExpression(registerFieldID)

Return bitOffset expression (F.7.73.51).

Parameters:

registerFieldID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getRegisterFieldBitOffsetID(registerFieldID)

Return handle of bitOffset (F.7.73.52).

Parameters:

registerFieldID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getRegisterFieldBitWidth(registerFieldID)

Return bitWidth numeric value (F.7.73.53).

Parameters:

registerFieldID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getRegisterFieldBitWidthExpression(registerFieldID)

Return bitWidth expression (F.7.73.54).

Parameters:

registerFieldID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getRegisterFieldBitWidthID(registerFieldID)

Return bitWidth handle (F.7.73.55).

Parameters:

registerFieldID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getRegisterFieldEnumeratedValuesID(registerFieldID)

Return enumeratedValues handle (F.7.73.56).

Parameters:

registerFieldID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getRegisterFieldFieldDefinitionRefByExternalTypeDefID(registerFieldID)

Return externalTypeDefinitions handle (F.7.73.57).

Parameters:

registerFieldID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getRegisterFieldFieldDefinitionRefByID(registerFieldID)

Return fieldDefinition handle (F.7.73.58).

Parameters:

registerFieldID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getRegisterFieldFieldDefinitionRefByName(registerFieldID)

Return fieldDefinitionRef value (F.7.73.59).

Parameters:

registerFieldID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getRegisterFieldFieldDefinitionRefID(registerFieldID)

Return fieldDefinitionRef handle (F.7.73.60).

Parameters:

registerFieldID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getRegisterFieldIDs(registerID)

Return register field handles (F.7.73.61).

Parameters:

registerID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getRegisterFieldResetIDs(registerFieldID)

Return reset handles (F.7.73.62).

Parameters:

registerFieldID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getRegisterFieldTypeIdentifier(registerFieldID)

Return typeIdentifier (F.7.73.63).

Parameters:

registerFieldID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getRegisterFieldVolatility(registerFieldID)

Return volatility flag (F.7.73.64).

Parameters:

registerFieldID (str)

Return type:

bool | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getRegisterFileAddressOffsetID(registerFileID)

Return addressOffset handle (F.7.73.65).

Parameters:

registerFileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getRegisterRefAttributeByID(registerRefID)

Return referenced register handle (F.7.73.66).

Parameters:

registerRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getRegisterRefIndexIDs(registerRefID)

Return index handles (F.7.73.67).

Parameters:

registerRefID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getRegisterRefRegisterRefByName(registerRefID)

Return registerRef value (F.7.73.68).

Parameters:

registerRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getRegisterRegisterDefinitionRefByExternalTypeDefID(registerID)

Return externalTypeDefinitions handle (F.7.73.69).

Parameters:

registerID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getRegisterRegisterDefinitionRefByID(registerID)

Return registerDefinition handle (F.7.73.70).

Parameters:

registerID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getRegisterRegisterDefinitionRefByName(registerID)

Return registerDefinitionRef value (F.7.73.71).

Parameters:

registerID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getRegisterRegisterDefinitionRefID(registerID)

Return registerDefinitionRef handle (F.7.73.72).

Parameters:

registerID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getRegisterSize(registerID)

Return size value (F.7.73.73).

Parameters:

registerID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getRegisterSizeExpression(registerID)

Return size expression (F.7.73.74).

Parameters:

registerID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getRegisterSizeID(registerID)

Return size handle (F.7.73.75).

Parameters:

registerID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getRegisterTypeIdentifier(registerID)

Return typeIdentifier (F.7.73.76).

Parameters:

registerID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getRegisterVolatility(registerID)

Return volatility boolean (F.7.73.77).

Parameters:

registerID (str)

Return type:

bool | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getResetMask(resetID)

Return reset mask resolved value (F.7.73.78).

Parameters:

resetID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getResetMaskExpression(resetID)

Return reset mask expression (F.7.73.79).

Parameters:

resetID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getResetMaskID(resetID)

Return mask handle (F.7.73.80).

Parameters:

resetID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getResetValue(resetID)

Return reset value (F.7.73.81).

Parameters:

resetID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getResetValueExpression(resetID)

Return reset value expression (F.7.73.82).

Parameters:

resetID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.getResetValueID(resetID)

Return reset value handle (F.7.73.83).

Parameters:

resetID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.removeAliasOfAlternateRegisterRef(aliasOfID)

Remove alternateRegisterRef (F.7.74.11).

Parameters:

aliasOfID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.removeAliasOfRegisterRef(aliasOfID)

Remove registerRef (F.7.74.12).

Parameters:

aliasOfID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.removeAlternateRegisterField(regFieldID)

Remove alternate register field (F.7.74.13).

Parameters:

regFieldID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.removeAlternateRegisterTypeIdentifier(alternateRegisterID)

Remove typeIdentifier (F.7.74.14).

Parameters:

alternateRegisterID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.removeAlternateRegisterVolatility(alternateRegisterID)

Remove volatility (F.7.74.15).

Parameters:

alternateRegisterID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.removeAlternaterRegisterModeRef(modeRefID)

Remove modeRef element (F.7.74.16).

Parameters:

modeRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.removeBroadcastToAddressBlockRef(broadcastToID)

Remove addressBlockRef (F.7.74.17).

Parameters:

broadcastToID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.removeBroadcastToAlternateRegisterRef(broadcastToID)

Remove alternateRegisterRef (F.7.74.18).

Parameters:

broadcastToID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.removeBroadcastToBankRef(bankRefID)

Remove bankRef by element handle (F.7.74.19).

Parameters:

bankRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.removeBroadcastToMemoryMapRef(broadcastToID)

Remove memoryMapRef (F.7.74.20).

Parameters:

broadcastToID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.removeBroadcastToRegisterFileRef(registerRefID)

Remove registerFileRef (F.7.74.21).

Parameters:

registerRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register.removeBroadcastToRegisterRef(registerRefID)

Remove registerRef (F.7.74.22).

Parameters:

registerRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register_file module

Register file category TGI functions (IEEE 1685-2022).

Implements BASE (F.7.75) and EXTENDED (F.7.76) Register file functions. Only 2022 standard APIs defined by Annex F are exported; no vendor extensions or legacy names are exposed. BASE getters follow the tolerant semantics used in other categories: invalid handles return neutral values (None / empty lists) instead of raising, enabling generators to probe. EXTENDED mutators raise TgiError with TgiFaultCode.INVALID_ID for invalid handles and TgiFaultCode.INVALID_ARGUMENT for semantic violations.

This module purposefully contains lightweight logic; deeper schema validation (e.g. uniqueness, overlapping address ranges) can be layered later once the core API surface is stable.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register_file.addAliasOfRegisterFileRef(registerFileID, vlnv)

Create/replace aliasOf registerFile reference. Section F.7.76.1.

Parameters:

• registerFileID (str)

• vlnv (tuple[str, str, str, str])

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register_file.addRegisterFileDefinitionRegisterFile(registerFileDefinitionRefID, name)

Add a contained registerFile to a registerFileDefinition ref target. F.7.76.2.

Because schema mapping for definition vs instance may differ, we treat the provided handle as pointing at a RegisterFile acting as definition root.

Parameters:

• registerFileDefinitionRefID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register_file.addRegisterFileRefIndex(registerFileID, value)

Parameters:

• registerFileID (str)

• value (int)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register_file.addRegisterFileRegister(registerFileID, name)

Parameters:

• registerFileID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register_file.getAliasOfRegisterFileRefByNames(registerFileID, vendor, library, name, version)

Return handle of aliasOf registerFile reference matching VLNV names.

Section: F.7.75.1. Returns None if not found or handle invalid.

Parameters:

• registerFileID (str)

• vendor (str)

• library (str)

• name (str)

• version (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register_file.getAliasOfRegisterFileRefIDs(registerFileID)

Return list of aliasOf register file reference handles (0 or 1). F.7.75.2.

Parameters:

registerFileID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register_file.getRegisterFileAccessHandleIDs(registerFileID)

Parameters:

registerFileID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register_file.getRegisterFileAccessPolicyIDs(registerFileID)

Parameters:

registerFileID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register_file.getRegisterFileAddressOffset(registerFileID)

Parameters:

registerFileID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register_file.getRegisterFileAddressOffsetExpression(registerFileID)

Parameters:

registerFileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register_file.getRegisterFileArrayID(registerFileID)

Parameters:

registerFileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register_file.getRegisterFileRange(registerFileID)

Parameters:

registerFileID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register_file.getRegisterFileRangeExpression(registerFileID)

Parameters:

registerFileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register_file.getRegisterFileRangeID(registerFileID)

Parameters:

registerFileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register_file.getRegisterFileRefIndexIDs(registerFileID)

Parameters:

registerFileID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register_file.getRegisterFileRegisterFileDefinitionRefByExternalTypeDefID(registerFileID, externalTypeDefID)

Parameters:

• registerFileID (str)

• externalTypeDefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register_file.getRegisterFileRegisterFileDefinitionRefByID(registerFileID, byID)

Parameters:

• registerFileID (str)

• byID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register_file.getRegisterFileRegisterFileDefinitionRefByName(registerFileID, name)

Parameters:

• registerFileID (str)

• name (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register_file.getRegisterFileRegisterFileDefinitionRefID(registerFileID)

Parameters:

registerFileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register_file.getRegisterFileRegisterFileIDs(registerFileID)

Parameters:

registerFileID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register_file.getRegisterFileRegisterIDs(registerFileID)

Parameters:

registerFileID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register_file.getRegisterFileTypeIdentifier(registerFileID)

Parameters:

registerFileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register_file.removeAliasOfRegisterFileRef(aliasOfRegisterFileRefID)

Parameters:

aliasOfRegisterFileRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register_file.removeRegisterFileAccessHandle(registerFileAccessHandleID)

Parameters:

registerFileAccessHandleID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register_file.removeRegisterFileRefIndex(registerFileRefIndexID)

Parameters:

registerFileRefIndexID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register_file.removeRegisterFileRegister(registerFileRegisterID)

Parameters:

registerFileRegisterID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register_file.removeRegisterFileRegisterFile(registerFileRegisterFileID)

Parameters:

registerFileRegisterFileID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register_file.removeRegisterFileTypeIdentifier(registerFileID)

Parameters:

registerFileID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register_file.setRegisterFileAddressOffset(registerFileID, value=None, expression=None)

Parameters:

• registerFileID (str)

• value (int | None)

• expression (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register_file.setRegisterFileRange(registerFileID, value=None, expression=None)

Parameters:

• registerFileID (str)

• value (int | None)

• expression (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register_file.setRegisterFileRegisterFileDefinitionRef(registerFileID, name=None, vlnv=None)

Parameters:

• registerFileID (str)

• name (str | None)

• vlnv (tuple[str, str, str, str] | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.register_file.setRegisterFileTypeIdentifier(registerFileID, typeIdentifier)

Parameters:

• registerFileID (str)

• typeIdentifier (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_ module

Slice category TGI functions (IEEE 1685-2022).

Named slice_ to avoid clashing with Python’s built-in slice. Implements BASE (F.7.77) and EXTENDED (F.7.78) Slice functions. BASE getters are tolerant: invalid handles produce neutral results (None / empty list) rather than raising, consistent with other category modules. EXTENDED mutators raise TgiError with TgiFaultCode.INVALID_ID for invalid handles and TgiFaultCode.INVALID_ARGUMENT for semantic issues.

The underlying schema objects for slice relationships (e.g. fieldSlice, portSlice, memoryMapRef, etc.) are represented minimally using existing schema objects when available or lightweight namespaces when not yet present.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_.addFieldSliceBankRef(fieldSliceID, vlnv)

Parameters:

• fieldSliceID (str)

• vlnv (tuple[str, str, str, str])

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_.addFieldSliceRegisterFileRef(fieldSliceID, name)

Parameters:

• fieldSliceID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_.addModeFieldSlice(modeID, fieldSliceID)

Parameters:

• modeID (str)

• fieldSliceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_.addModePortSlice(modeID, portSliceID)

Parameters:

• modeID (str)

• portSliceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_.addPortSliceSubPortReference(portSliceID, subPortName)

Parameters:

• portSliceID (str)

• subPortName (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_.addSlicePathSegment(sliceID, segment)

Parameters:

• sliceID (str)

• segment (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_.getFieldSliceAddressBlockRefByID(fieldSliceID, addressBlockID)

Parameters:

• fieldSliceID (str)

• addressBlockID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_.getFieldSliceAddressBlockRefByName(fieldSliceID, name)

Parameters:

• fieldSliceID (str)

• name (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_.getFieldSliceAddressBlockRefID(fieldSliceID)

Parameters:

fieldSliceID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_.getFieldSliceAddressSpaceRefByID(fieldSliceID, addressSpaceID)

Parameters:

• fieldSliceID (str)

• addressSpaceID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_.getFieldSliceAddressSpaceRefByName(fieldSliceID, name)

Parameters:

• fieldSliceID (str)

• name (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_.getFieldSliceAddressSpaceRefID(fieldSliceID)

Parameters:

fieldSliceID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_.getFieldSliceAlternateRegisterRefByID(fieldSliceID, altRegisterID)

Parameters:

• fieldSliceID (str)

• altRegisterID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_.getFieldSliceAlternateRegisterRefByName(fieldSliceID, name)

Parameters:

• fieldSliceID (str)

• name (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_.getFieldSliceAlternateRegisterRefID(fieldSliceID)

Parameters:

fieldSliceID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_.getFieldSliceBankRefByNames(fieldSliceID, vendor, library, name, version)

Parameters:

• fieldSliceID (str)

• vendor (str)

• library (str)

• name (str)

• version (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_.getFieldSliceBankRefIDs(fieldSliceID)

Parameters:

fieldSliceID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_.getFieldSliceFieldRefByName(fieldSliceID, name)

Parameters:

• fieldSliceID (str)

• name (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_.getFieldSliceFieldRefID(fieldSliceID)

Parameters:

fieldSliceID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_.getFieldSliceMemoryMapRefByID(fieldSliceID, memoryMapID)

Parameters:

• fieldSliceID (str)

• memoryMapID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_.getFieldSliceMemoryMapRefByName(fieldSliceID, name)

Parameters:

• fieldSliceID (str)

• name (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_.getFieldSliceMemoryMapRefID(fieldSliceID)

Parameters:

fieldSliceID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_.getFieldSliceMemoryRemapRefByID(fieldSliceID, memoryRemapID)

Parameters:

• fieldSliceID (str)

• memoryRemapID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_.getFieldSliceMemoryRemapRefByName(fieldSliceID, name)

Parameters:

• fieldSliceID (str)

• name (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_.getFieldSliceMemoryRemapRefID(fieldSliceID)

Parameters:

fieldSliceID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_.getFieldSliceRange(fieldSliceID)

Parameters:

fieldSliceID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_.getFieldSliceRangeLeftID(fieldSliceID)

Parameters:

fieldSliceID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_.getFieldSliceRangeRightID(fieldSliceID)

Parameters:

fieldSliceID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_.removeFieldSliceAlternateRegisterRef(fieldSliceAlternateRegisterRefID)

Parameters:

fieldSliceAlternateRegisterRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_.removeFieldSliceBankRef(fieldSliceBankRefID)

Parameters:

fieldSliceBankRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_.removeFieldSliceMemoryRemapRef(fieldSliceMemoryRemapRefID)

Parameters:

fieldSliceMemoryRemapRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_.removeFieldSliceRange(fieldSliceRangeID)

Parameters:

fieldSliceRangeID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_.removeFieldSliceRegisterFileRef(fieldSliceRegisterFileRefID)

Parameters:

fieldSliceRegisterFileRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_.removeLocationSlice(locationSliceID)

Parameters:

locationSliceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_.removeModeFieldSlice(modeFieldSliceID)

Parameters:

modeFieldSliceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_.removeModePortSlice(modePortSliceID)

Parameters:

modePortSliceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_.removePortSlicePartSelect(portSlicePartSelectID)

Parameters:

portSlicePartSelectID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_.removePortSliceSubPortReference(portSliceSubPortReferenceID)

Parameters:

portSliceSubPortReferenceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_.removeSlicePathSegment(slicePathSegmentID)

Parameters:

slicePathSegmentID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_.removeSliceRange(sliceRangeID)

Parameters:

sliceRangeID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_.setFieldSliceAddressBlockRef(fieldSliceID, name)

Parameters:

• fieldSliceID (str)

• name (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_.setFieldSliceAddressSpaceRef(fieldSliceID, name)

Parameters:

• fieldSliceID (str)

• name (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_.setFieldSliceAlternateRegisterRef(fieldSliceID, name)

Parameters:

• fieldSliceID (str)

• name (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_.setFieldSliceFieldRef(fieldSliceID, name)

Parameters:

• fieldSliceID (str)

• name (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_.setFieldSliceMemoryMapRef(fieldSliceID, name)

Parameters:

• fieldSliceID (str)

• name (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_.setFieldSliceMemoryRemapRef(fieldSliceID, name)

Parameters:

• fieldSliceID (str)

• name (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_.setFieldSliceRange(fieldSliceID, value=None, expression=None)

Parameters:

• fieldSliceID (str)

• value (int | None)

• expression (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_.setFieldSliceRegisterRef(fieldSliceID, name)

Parameters:

• fieldSliceID (str)

• name (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_.setPortSlicePartSelect(portSliceID, leftExpression, rightExpression)

Parameters:

• portSliceID (str)

• leftExpression (str)

• rightExpression (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_.setPortSlicePortRef(portSliceID, name)

Parameters:

• portSliceID (str)

• name (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.slice_.setSliceRange(sliceID, leftExpression, rightExpression)

Parameters:

• sliceID (str)

• leftExpression (str)

• rightExpression (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.top_element module

Top element category TGI functions (IEEE 1685-2022).

Implements BASE (F.7.79) and EXTENDED (F.7.80) top element functions. The “top element” represents the container / repository scope from which all other IP-XACT elements (components, bus definitions, etc.) can be enumerated or created. BASE traversal getters return empty lists or neutral values when the provided handle is invalid (tolerant semantics). EXTENDED creation and edit operations raise TgiError with appropriate fault codes for invalid IDs or arguments.

Because this implementation operates without a backing persistent database, we treat a top handle as any object carrying collections named after the relevant categories (e.g. abstraction_definitions, components). If such collections are absent they are initialised on demand for creation operations. Created objects are minimal, leveraging generated schema classes when available or SimpleNamespace fallbacks otherwise.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.top_element.createAbstractionDef(topElementID, name)

Create an Abstraction Definition (EXTENDED).

Raises:

TgiError – If the top element handle is invalid.

Parameters:

• topElementID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.top_element.createAbstractor(topElementID, name)

Create an Abstractor (EXTENDED).

Parameters:

• topElementID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.top_element.createBusDefinition(topElementID, name)

Create a Bus Definition (EXTENDED).

Parameters:

• topElementID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.top_element.createCatalog(topElementID, name)

Create a Catalog under a top element (EXTENDED).

Spec F.7.80.4: Adds a new catalog child to the given top element and returns its handle. Only the top-element scoped creation is supported here (root VLNV catalog creation is handled by the Creation category).

Parameters:

• topElementID (str) – Handle of the top element.

• name (str) – Catalog name.

Returns:

Handle of the newly created Catalog.

Raises:

TgiError – If the top element handle is invalid.

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.top_element.createComponent(topElementID, name)

Create a Component (EXTENDED).

Parameters:

• topElementID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.top_element.createDesign(topElementID, name)

Create a Design (EXTENDED).

Parameters:

• topElementID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.top_element.createDesignConfiguration(topElementID, name)

Create a Design Configuration (EXTENDED).

Parameters:

• topElementID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.top_element.createGeneratorChain(topElementID, name)

Create a Generator Chain (EXTENDED).

Parameters:

• topElementID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.top_element.createTypeDefinitions(topElementID, name)

Create a TypeDefinitions element (EXTENDED).

Parameters:

• topElementID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.top_element.edit(elementID, attribute, value)

Set an arbitrary attribute on a model element (EXTENDED).

Raises:

TgiError – If the element handle is invalid or the update fails.

Parameters:

• elementID (str)

• attribute (str)

• value (Any)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.top_element.getAbstractionDefIDs(topElementID)

Return handles of Abstraction Definitions under a top element.

Tolerant BASE behavior: invalid topElementID returns [].

Parameters:

topElementID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.top_element.getAbstractorIDs(topElementID)

Return handles of Abstractors under a top element (BASE).

Parameters:

topElementID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.top_element.getBusDefIDs(topElementID)

Return handles of Bus Definitions (BASE).

Parameters:

topElementID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.top_element.getCatalogIDs(*args, **kwargs)

Hybrid traversal.

Dev-phase convenience: with no arguments enumerate globally registered root Catalog handles. With an argument delegate to the spec-conformant top-element scoped enumeration.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.top_element.getComponentIDs(topElementID)

Return handles of Components (BASE).

Parameters:

topElementID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.top_element.getDesignConfigurationIDs(topElementID)

Return handles of Design Configurations (BASE).

Parameters:

topElementID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.top_element.getDesignIDs(topElementID)

Return handles of Designs (BASE).

Parameters:

topElementID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.top_element.getGeneratorChainIDs(topElementID)

Return handles of Generator Chains (BASE).

Parameters:

topElementID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.top_element.getID(elementID)

Return element handle (overloaded for VLNV sequences).

Spec (Top element BASE) defines getID(elementID) returning the handle if valid else None. The Administrative category defines getID(vlnvSequence) resolving a VLNV to a handle. To avoid one overshadowing the other in the aggregated namespace we implement a tolerant polymorphic version here: if elementID looks like a 4-length string sequence treat it as a VLNV, else treat it as an element handle.

Parameters:

elementID – Either a candidate handle string or a 4-sequence (vendor, library, name, version).

Returns:

Handle string or None if resolution fails.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.top_element.getTypeDefinitionsIDs(topElementID)

Return handles of Type Definitions (BASE).

Parameters:

topElementID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.top_element.getVLNV(elementID)

Return VLNV quadruple of an element (BASE).

If the handle refers to a root registered in the global registry we delegate to that (ensuring unregistered elements return None after removal). Otherwise we fall back to extracting vendor/library/name/ version attributes directly and returning a 4-tuple with None in missing positions. Invalid handles return (None, None, None, None).

Parameters:

elementID (str)

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.top_element.getXMLPath(elementID)

Return XML path for an element or synthesize one from VLNV.

Synthesis produces /vendor:library:name:version skipping missing parts. Invalid handle returns None.

Parameters:

elementID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.top_element.setXMLPath(elementID, path)

Associate an XML path with an element (EXTENDED).

Parameters:

• elementID (str)

• path (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions module

Type Definitions category TGI functions (IEEE 1685-2022).

Implements BASE (F.7.81) and EXTENDED (F.7.82) functions for the typeDefinitions document describing reusable type definition collections.

BASE getters are tolerant: invalid handles return neutral values (empty list, None) instead of raising unless the spec semantics depend on explicit fault signaling. EXTENDED mutators raise TgiError using TgiFaultCode.INVALID_ID for unknown handles and TgiFaultCode.INVALID_ARGUMENT for semantic issues.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.addComponentExternalTypeDefinitions(componentID)

Parameters:

componentID (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.addEnumerationDefinition(typeDefinitionsID, name)

Parameters:

• typeDefinitionsID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.addEnumerationDefinitionEnumeratedValue(enumerationDefinitionID, name, value)

Parameters:

• enumerationDefinitionID (str)

• name (str)

• value (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.addExternalTypeDefinitionsModeLink(externalTypeDefinitionsID, name)

Parameters:

• externalTypeDefinitionsID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.addExternalTypeDefinitionsViewLink(externalTypeDefinitionsID, name)

Parameters:

• externalTypeDefinitionsID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.addFieldDefinitionsEnumeratedValue(fieldDefinitionsID, name, value)

Parameters:

• fieldDefinitionsID (str)

• name (str)

• value (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.addTypeDefinitionsAddressBlockDefinition(typeDefinitionsID, name)

Parameters:

• typeDefinitionsID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.addTypeDefinitionsBankDefinition(typeDefinitionsID, name)

Parameters:

• typeDefinitionsID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.addTypeDefinitionsChoice(typeDefinitionsID, name)

Parameters:

• typeDefinitionsID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.addTypeDefinitionsEnumerationDefinition(typeDefinitionsID, name)

Parameters:

• typeDefinitionsID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.addTypeDefinitionsExternalTypeDefinitions(typeDefinitionsID, name)

Parameters:

• typeDefinitionsID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.addTypeDefinitionsFieldAccessPolicyDefinition(typeDefinitionsID, name)

Parameters:

• typeDefinitionsID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.addTypeDefinitionsFieldDefinition(typeDefinitionsID, name)

Parameters:

• typeDefinitionsID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.addTypeDefinitionsMemoryMapDefinition(typeDefinitionsID, name)

Parameters:

• typeDefinitionsID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.addTypeDefinitionsMemoryRemapDefinition(typeDefinitionsID, name)

Parameters:

• typeDefinitionsID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.addTypeDefinitionsMode(typeDefinitionsID, name)

Parameters:

• typeDefinitionsID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.addTypeDefinitionsRegisterDefinition(typeDefinitionsID, name)

Parameters:

• typeDefinitionsID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.addTypeDefinitionsRegisterFileDefinition(typeDefinitionsID, name)

Parameters:

• typeDefinitionsID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.addTypeDefinitionsResetType(typeDefinitionsID, name)

Parameters:

• typeDefinitionsID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.addTypeDefinitionsView(typeDefinitionsID, name)

Parameters:

• typeDefinitionsID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.getAddressBlockDefinitionAddressUnitBits(addressBlockDefinitionID)

Parameters:

addressBlockDefinitionID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.getAddressBlockDefinitionAddressUnitBitsExpression(addressBlockDefinitionID)

Parameters:

addressBlockDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.getAddressBlockDefinitionAddressUnitBitsID(addressBlockDefinitionID)

Parameters:

addressBlockDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.getBankDefinitionAddressUnitBits(bankDefinitionID)

Parameters:

bankDefinitionID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.getBankDefinitionAddressUnitBitsExpression(bankDefinitionID)

Parameters:

bankDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.getBankDefinitionAddressUnitBitsID(bankDefinitionID)

Parameters:

bankDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.getEnumerationDefinitionEnumeratedValueIDs(enumerationDefinitionID)

Parameters:

enumerationDefinitionID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.getEnumerationDefinitionWidth(enumerationDefinitionID)

Parameters:

enumerationDefinitionID (str)

Return type:

Any | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.getEnumerationDefinitionWidthExpression(enumerationDefinitionID)

Parameters:

enumerationDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.getEnumerationDefinitionWidthID(enumerationDefinitionID)

Parameters:

enumerationDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.getExternalTypeDefinitionsModeLinksIDs(externalTypeDefinitionsID)

Parameters:

externalTypeDefinitionsID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.getExternalTypeDefinitionsResetTypeLinkIDs(externalTypeDefinitionsID)

Parameters:

externalTypeDefinitionsID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.getExternalTypeDefinitionsTypeDefinitionsRefByID(externalTypeDefinitionsID)

Parameters:

externalTypeDefinitionsID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.getExternalTypeDefinitionsTypeDefinitionsRefByVLNV(externalTypeDefinitionsID)

Parameters:

externalTypeDefinitionsID (str)

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.getExternalTypeDefinitionsViewLinkIDs(externalTypeDefinitionsID)

Parameters:

externalTypeDefinitionsID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.getMemoryRemapDefinitionAddressUnitBits(memoryRemapDefinitionID)

Parameters:

memoryRemapDefinitionID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.getMemoryRemapDefinitionAddressUnitBitsExpression(memoryRemapDefinitionID)

Parameters:

memoryRemapDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.getMemoryRemapDefinitionAddressUnitBitsID(memoryRemapDefinitionID)

Parameters:

memoryRemapDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.getModeLinkExternalModeReferenceID(modeLinkID)

Parameters:

modeLinkID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.getModeLinkExternalModeReferenceRefByName(modeLinkID)

Parameters:

modeLinkID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.getModeLinkModeReferenceID(modeLinkID)

Parameters:

modeLinkID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.getModeLinkModeReferenceRefByName(modeLinkID)

Parameters:

modeLinkID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.getRegisterFileDefinitionAddressUnitBits(registerFileDefinitionID)

Parameters:

registerFileDefinitionID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.getRegisterFileDefinitionAddressUnitBitsExpression(registerFileDefinitionID)

Parameters:

registerFileDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.getRegisterFileDefinitionAddressUnitBitsID(registerFileDefinitionID)

Parameters:

registerFileDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.getResetTypeLinkExternalResetTypeRefByName(resetTypeLinkID)

Parameters:

resetTypeLinkID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.getResetTypeLinkExternalResetTypeReferenceID(resetTypeLinkID)

Parameters:

resetTypeLinkID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.getResetTypeLinkResetTypeReferenceID(resetTypeLinkID)

Parameters:

resetTypeLinkID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.getResetTypeLinkResetTypeReferenceRefByName(resetTypeLinkID)

Parameters:

resetTypeLinkID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.getTypeDefinitionsAddressBlockDefinitionIDs(typeDefinitionsID)

Parameters:

typeDefinitionsID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.getTypeDefinitionsBankDefinitionIDs(typeDefinitionsID)

Parameters:

typeDefinitionsID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.getTypeDefinitionsChoiceIDs(typeDefinitionsID)

Parameters:

typeDefinitionsID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.getTypeDefinitionsEnumerationDefinitionIDs(typeDefinitionsID)

Parameters:

typeDefinitionsID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.getTypeDefinitionsExternalTypeDefinitionsIDs(typeDefinitionsID)

Parameters:

typeDefinitionsID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.getTypeDefinitionsFieldDefinitionIDs(typeDefinitionsID)

Parameters:

typeDefinitionsID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.getTypeDefinitionsMemoryMapDefinitionIDs(typeDefinitionsID)

Parameters:

typeDefinitionsID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.getTypeDefinitionsMemoryRemapDefinitionIDs(typeDefinitionsID)

Parameters:

typeDefinitionsID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.getTypeDefinitionsModeIDs(typeDefinitionsID)

Parameters:

typeDefinitionsID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.getTypeDefinitionsRegisterDefinitionIDs(typeDefinitionsID)

Parameters:

typeDefinitionsID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.getTypeDefinitionsRegisterFileDefinitionIDs(typeDefinitionsID)

Parameters:

typeDefinitionsID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.getTypeDefinitionsResetTypeIDs(typeDefinitionsID)

Parameters:

typeDefinitionsID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.getTypeDefinitionsViewIDs(typeDefinitionsID)

Parameters:

typeDefinitionsID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.getViewLinkExternalViewReferenceID(viewLinkID)

Parameters:

viewLinkID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.getViewLinkExternalViewReferenceRefByName(viewLinkID)

Parameters:

viewLinkID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.getViewLinkViewReferenceID(viewLinkID)

Parameters:

viewLinkID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.getViewLinkViewReferenceRefByID(viewLinkID)

Parameters:

viewLinkID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.getViewLinkViewReferenceRefByName(viewLinkID)

Parameters:

viewLinkID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.removeAddressBlockDefinitionAddressUnitBits(addressBlockDefinitionID)

Parameters:

addressBlockDefinitionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.removeBankDefinitionAddressUnitBits(bankDefinitionID)

Parameters:

bankDefinitionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.removeComponentExternalTypeDefinitions(componentID)

Parameters:

componentID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.removeEnumerationDefinitionEnumeratedValue(enumeratedValueID)

Parameters:

enumeratedValueID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.removeExternalTypeDefinitionsModeLink(modeLinkID)

Parameters:

modeLinkID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.removeExternalTypeDefinitionsResetTypeLink(resetTypeLinkID)

Parameters:

resetTypeLinkID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.removeExternalTypeDefinitionsViewLink(viewLinkID)

Parameters:

viewLinkID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.removeFieldDefinitionEnumerationDefinitionRef(fieldDefinitionID)

Parameters:

fieldDefinitionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.removeFieldDefinitionsEnumeratedValue(enumeratedValueID)

Parameters:

enumeratedValueID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.removeMemoryRemapDefinitionAddressUnitBits(memoryRemapDefinitionID)

Parameters:

memoryRemapDefinitionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.removeRegisterFileDefinitionAddressUnitBits(registerFileDefinitionID)

Parameters:

registerFileDefinitionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.removeTypeDefinitionsAddressBlockDefinition(addressBlockDefinitionID)

Parameters:

addressBlockDefinitionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.removeTypeDefinitionsBankDefinition(bankDefinitionID)

Parameters:

bankDefinitionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.removeTypeDefinitionsChoice(choiceID)

Parameters:

choiceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.removeTypeDefinitionsEnumerationDefinition(enumerationDefinitionID)

Parameters:

enumerationDefinitionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.removeTypeDefinitionsExternalTypeDefinitions(externalTypeDefinitionsID)

Parameters:

externalTypeDefinitionsID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.removeTypeDefinitionsFieldAccessPolicyDefinition(fieldAccessPolicyDefinitionID)

Parameters:

fieldAccessPolicyDefinitionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.removeTypeDefinitionsFieldDefinition(fieldDefinitionID)

Parameters:

fieldDefinitionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.removeTypeDefinitionsMemoryMapDefinition(memoryMapDefinitionID)

Parameters:

memoryMapDefinitionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.removeTypeDefinitionsMemoryRemapDefinition(memoryRemapDefinitionID)

Parameters:

memoryRemapDefinitionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.removeTypeDefinitionsMode(modeID)

Parameters:

modeID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.removeTypeDefinitionsRegisterDefinition(registerDefinitionID)

Parameters:

registerDefinitionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.removeTypeDefinitionsRegisterFileDefinition(registerFileDefinitionID)

Parameters:

registerFileDefinitionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.removeTypeDefinitionsResetType(resetTypeID)

Parameters:

resetTypeID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.removeTypeDefinitionsView(viewID)

Parameters:

viewID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.setAddressBlockDefinitionAddressUnitBits(addressBlockDefinitionID, value)

Parameters:

• addressBlockDefinitionID (str)

• value (int | str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.setBankDefinitionAddressUnitBits(bankDefinitionID, value)

Parameters:

• bankDefinitionID (str)

• value (int | str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.setEnumerationDefinitionWidth(enumerationDefinitionID, value)

Parameters:

• enumerationDefinitionID (str)

• value (int | str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.setExternalTypeDefinitionsTypeDefinitionsRef(externalTypeDefinitionsID, vlnv)

Parameters:

• externalTypeDefinitionsID (str)

• vlnv (tuple[str, str, str, str])

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.setMemoryRemapDefinitionAddressUnitBits(memoryRemapDefinitionID, value)

Parameters:

• memoryRemapDefinitionID (str)

• value (int | str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.setModeLinkExternalModeReference(modeLinkID, name)

Parameters:

• modeLinkID (str)

• name (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.setModeLinkModeReference(modeLinkID, name)

Parameters:

• modeLinkID (str)

• name (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.setRegisterFileDefinitionAddressUnitBits(registerFileDefinitionID, value)

Parameters:

• registerFileDefinitionID (str)

• value (int | str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.setResetTypeLinkExternalResetTypeReference(resetTypeLinkID, name)

Parameters:

• resetTypeLinkID (str)

• name (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.setResetTypeLinkResetTypeReference(resetTypeLinkID, name)

Parameters:

• resetTypeLinkID (str)

• name (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.setViewLinkExternalViewReference(viewLinkID, name)

Parameters:

• viewLinkID (str)

• name (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.type_definitions.setViewLinkViewReference(viewLinkID, name)

Parameters:

• viewLinkID (str)

• name (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.vector module

Vector category TGI functions (IEEE 1685-2022).

Implements BASE (F.7.83) and EXTENDED (F.7.84) vector functions. A vector is any element with left/right sub-elements representing integer or expression endpoints. The spec defines an API that allows traversal of vector endpoints and mutation (setting / removing ends) in EXTENDED mode.

Design notes: * BASE getters are tolerant: invalid handles yield neutral values (None

or empty list) rather than faults, consistent with other category modules.

• EXTENDED functions raise TgiError with TgiFaultCode.INVALID_ID for unknown handles and TgiFaultCode.INVALID_ARGUMENT for semantic issues.

• Some schema objects embed a nested object (e.g. vector) containing left and right; we transparently descend if necessary.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.vector.getVectorIDs(vectorContainerID)

Parameters:

vectorContainerID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.vector.getVectorIdAttribute(elementID)

Parameters:

elementID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.vector.getVectorLeftID(vectorID)

Parameters:

vectorID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.vector.getVectorRange(vectorID)

Parameters:

vectorID (str)

Return type:

list[int | None] | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.vector.getVectorRangeExpression(vectorID)

Parameters:

vectorID (str)

Return type:

list[str | None] | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.vector.getVectorRightID(vectorID)

Parameters:

vectorID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.vector.removeVectorLeft(vectorID)

Parameters:

vectorID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.vector.removeVectorRight(vectorID)

Parameters:

vectorID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.vector.setVector(vectorID, left, right)

Parameters:

• vectorID (str)

• left (str | int | None)

• right (str | int | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.vector.setVectorIdAttribute(elementID, vectorId)

Parameters:

• elementID (str)

• vectorId (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.vector.setVectorLeft(vectorID, left)

Parameters:

• vectorID (str)

• left (str | int | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.vector.setVectorRight(vectorID, right)

Parameters:

• vectorID (str)

• right (str | int | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.vendor_extensions module

Vendor extensions category TGI functions (IEEE 1685-2022).

Implements the public TGI functions for Vendor Extensions: * BASE (F.7.85) – traversal and retrieval of vendor extension elements. * EXTENDED (F.7.86) – addition and removal of vendor extension fragments.

The IP-XACT schema models vendor extensions as a container element (usually named vendorExtensions) holding an arbitrary sequence of XML extension elements (wildcards). In generated bindings this frequently appears as a structure with an any or similarly named list of generic objects (often lxml.etree._Element or simple namespace objects).

Design choices: * BASE getters are tolerant: invalid IDs yield neutral values (None or

empty lists) rather than raising faults.

• EXTENDED mutators raise TgiError with

  TgiFaultCode.INVALID_ID for unknown handles and TgiFaultCode.INVALID_ARGUMENT for malformed XML fragments.

• Added fragments are stored as lightweight objects. If an lxml parser is

  available the fragment is parsed and the element stored; otherwise a fallback simple object capturing tag/text/attributes is produced.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.vendor_extensions.addVendorExtensions(vendorExtensionsContainerElementID, vendorExtensions)

Parameters:

• vendorExtensionsContainerElementID (str)

• vendorExtensions (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.vendor_extensions.getVendorExtensionElementAttributeNames(parentID, elementName)

Parameters:

• parentID (str)

• elementName (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.vendor_extensions.getVendorExtensionElementAttributeValue(parentID, elementName, attributeName)

Parameters:

• parentID (str)

• elementName (str)

• attributeName (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.vendor_extensions.getVendorExtensionElementNames(parentID)

Parameters:

parentID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.vendor_extensions.getVendorExtensionElementText(parentID, elementName)

Parameters:

• parentID (str)

• elementName (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.vendor_extensions.getVendorExtensionElementsRaw(parentID)

Parameters:

parentID (str)

Return type:

list[Any]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.vendor_extensions.getVendorExtensionsIDs(parentID)

Parameters:

parentID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.vendor_extensions.removeVendorExtensionsElement(extensionID)

Parameters:

extensionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.view module

View category TGI functions (IEEE 1685-2022).

Implements BASE (F.7.87) and EXTENDED (F.7.88) API for view elements. A view in IP-XACT names a particular representation of a component and references component instantiations, bus interfaces, filesets, env identifiers, etc. This module exposes only the standard public TGI functions – no more, no less – following the tolerant BASE / strict EXTENDED convention used across the codebase.

Notes / assumptions: * We treat any object whose type name ends with View or which has

characteristic attributes (env_identifiers, file_set_refs) as a view for tolerant getters.

• Underlying generated schema classes are imported lazily where needed (kept minimal to avoid touching schema packages not required by tests).

• BASE getters return neutral values (None / empty lists) when a handle is invalid instead of raising.

• EXTENDED mutators raise TgiError with TgiFaultCode.INVALID_ID (unknown handle) or TgiFaultCode.INVALID_ARGUMENT (semantic issues).

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.view.addViewEnvIdentifier(viewID, value)

Parameters:

• viewID (str)

• value (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.view.getViewBusInterfaceRefIDs(viewID)

Parameters:

viewID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.view.getViewComponentInstantiationRefByID(viewID)

Parameters:

viewID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.view.getViewComponentInstantiationRefByName(viewID)

Parameters:

viewID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.view.getViewEnvIdentifierIDs(viewID)

Parameters:

viewID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.view.getViewEnvIdentifiers(viewID)

Parameters:

viewID (str)

Return type:

list[str | None]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.view.getViewFileSetRefIDs(viewID)

Parameters:

viewID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.view.getViewModelName(viewID)

Parameters:

viewID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.view.getViewModelParametersID(viewID)

Parameters:

viewID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.view.getViewName(viewID)

Parameters:

viewID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.view.getViewOtherClockDriverRefIDs(viewID)

Parameters:

viewID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.view.getViewParametersID(viewID)

Parameters:

viewID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.view.getViewPortWireRefIDs(viewID)

Parameters:

viewID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.view.getViewVendorExtensionsID(viewID)

Parameters:

viewID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.view.removeViewBusInterfaceRef(refID)

Parameters:

refID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.view.removeViewComponentInstantiationRef(refID)

Parameters:

refID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.view.removeViewEnvIdentifier(envIdentifierID)

Parameters:

envIdentifierID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.view.removeViewFileSetRef(refID)

Parameters:

refID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.view.removeViewOtherClockDriverRef(refID)

Parameters:

refID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.view.removeViewPortWireRef(refID)

Parameters:

refID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.view.setViewComponentInstantiationRef(viewID, name)

Parameters:

• viewID (str)

• name (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.view.setViewModelName(viewID, modelName)

Parameters:

• viewID (str)

• modelName (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.view.setViewName(viewID, name)

Parameters:

• viewID (str)

• name (str)

Return type:

bool

Module contents

TGI function namespace for IP-XACT 1685-2022 (category-structured).

exception amal.eda.ipxact_de.tgi.ipxact.v1685_2022.TgiError(message, fault_code='INTERNAL_ERROR')

Bases: RuntimeError

Base exception with a TGI fault code.

Parameters:

• message (str)

• fault_code (str)

Return type:

None

add_note(object, /)

Exception.add_note(note) – add a note to the exception

args

with_traceback(object, /)

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addAbstractionDefChoice(abstractionDefinitionID, name)

Add a choice element.

Section: F.7.3.1.

A minimal enumeration entry is created automatically using name as the enumeration value to satisfy schema requirements.

Parameters:

• abstractionDefinitionID (str) – Handle of the parent abstractionDefinition.

• name (str) – Choice name.

Returns:

Handle of the created choice element.

Raises:

TgiError – If the abstractionDefinition handle is invalid.

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addAbstractionDefPort(abstractionDefinitionID, logicalName, type)

Add an abstractionDefPort.

Section: F.7.3.2.

Creates a new port with the requested style. Supported type values: wire, transactional and packet. For packet an empty packets container is created; packet content must be added separately via addAbstractionDefPortPacket().

Parameters:

• abstractionDefinitionID (str) – Parent abstractionDefinition handle.

• logicalName (str) – Logical port name.

• type (str) – Port style (‘wire’, ‘transactional’, ‘packet’).

Returns:

Handle of the created port.

Raises:

TgiError – If the abstractionDefinition handle is invalid or the type is unsupported.

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addAbstractionDefPortMode(abstractionDefPortID, mode)

Add a mode (initiator/target) to a port.

Section: F.7.3.3.

This helper creates onInitiator or onTarget entries for wire and transactional styles. System entries use dedicated onSystem add functions.

Parameters:

• abstractionDefPortID (str) – Port handle.

• mode (str) – ‘initiator’ or ‘target’.

Returns:

Handle of the created element (existing one reused if already present).

Raises:

TgiError – If the port handle is invalid or mode unsupported.

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addAbstractionDefPortPacket(absDefPortID, packetName, packetFieldName, packetFieldWidth)

Add a port packet with one field.

Section: F.7.3.4.

Creates (if necessary) the packets container and adds a new packet with a single field.

Parameters:

• absDefPortID (str) – Port handle.

• packetName (str) – Packet name.

• packetFieldName (str) – Field name.

• packetFieldWidth (str) – Width expression string.

Returns:

Handle of the created packet element.

Raises:

TgiError – If the port handle is invalid.

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addAbstractionDefPortTransactionalOnSystem(portID, group)

Add a transactional onSystem element.

Section: F.7.3.5.

Parameters:

• portID (str) – Transactional port handle.

• group (str) – Group name.

Returns:

Handle of the created onSystem element.

Raises:

TgiError – If the port is invalid or not transactional.

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addAbstractionDefPortWireOnSystem(portID, group)

Add a wire onSystem element.

Section: F.7.3.6.

Parameters:

• portID (str) – Wire port handle.

• group (str) – Group name.

Returns:

Handle of the created onSystem element.

Raises:

TgiError – If the port is invalid or not wire style.

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addAbstractorAbstractorGenerator(abstractorID, name, generatorExecutable)

Create and append an abstractorGenerator.

Section: F.7.5.1.

Parameters:

• abstractorID (str)

• name (str)

• generatorExecutable (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addAbstractorChoice(abstractorID, name)

Add a choice element with the given name (no enumerations yet).

Section: F.7.5.2.

Parameters:

• abstractorID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addAbstractorComponentInstantiation(abstractorID, name)

Add a componentInstantiation under model.instantiations.

Section: F.7.5.3.

Parameters:

• abstractorID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addAbstractorFileSet(abstractorID, name)

Add a new fileSet under the abstractor.

Section: F.7.5.4.

Parameters:

• abstractorID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addAbstractorGeneratorGroup(abstractorGeneratorID, groupName)

Append a group element to an AbstractorGenerator.

Section: F.7.50.1.

Parameters:

• abstractorGeneratorID (str)

• groupName (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addAbstractorInstancesAbstractorInstance(abstractorInstancesID, instanceName, viewName, abstractorRefVLNV)

Create and append an abstractorInstance.

Section: F.7.40.1.

Parameters:

• abstractorInstancesID (str)

• instanceName (str)

• viewName (str)

• abstractorRefVLNV (tuple[str, str, str, str])

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addAbstractorInstancesInterfaceRef(abstractorInstancesID, componentRef, busRef)

Add an interfaceRef to an abstractorInstances container.

Section: F.7.40.2.

Parameters:

• abstractorInstancesID (str)

• componentRef (str)

• busRef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addAbstractorInterfaceAbstractionType(abstractorID, interfaceIndex, abstractionRefVLNV)

Add an abstractionType to one of the two abstractorInterfaces.

Section: F.7.5.5. :param interfaceIndex: 0 or 1 selecting which of the two interfaces. :param abstractionRefVLNV: (vendor, library, name, version) of abstractionDef.

Parameters:

• abstractorID (str)

• interfaceIndex (int)

• abstractionRefVLNV (tuple[str, str, str, str])

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addAbstractorStructuredInterfacePort(abstractorID, name, subPortName, structPortTypeDefTypeName)

Add a structured interface port (adds a subPort reference).

Section: F.7.5.8.

Parameters:

• abstractorID (str)

• name (str)

• subPortName (str)

• structPortTypeDefTypeName (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addAbstractorStructuredStructPort(abstractorID, name, subPortName, structPortTypeDefTypeName, direction=None)

Add a structured structPort with direction.

Section: F.7.5.9.

Parameters:

• abstractorID (str)

• name (str)

• subPortName (str)

• structPortTypeDefTypeName (str)

• direction (str | None)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addAbstractorStructuredUnionPort(abstractorID, name, structPortTypeDefTypeName, subPortName, direction=None)

Add a structured unionPort with direction.

Section: F.7.5.10.

Parameters:

• abstractorID (str)

• name (str)

• structPortTypeDefTypeName (str)

• subPortName (str)

• direction (str | None)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addAbstractorTransactionalPort(abstractorID, name, initiative=None)

Add a transactional model port.

Section: F.7.5.6.

Parameters:

• abstractorID (str)

• name (str)

• initiative (str | None)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addAbstractorView(abstractorID, name)

Add a view element under model.views.

Section: F.7.5.11.

Parameters:

• abstractorID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addAbstractorWirePort(abstractorID, name, direction=None)

Add a wire model port.

Section: F.7.5.7.

Parameters:

• abstractorID (str)

• name (str)

• direction (str | None)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addAccessHandle(parentID, type)

Add an accessHandle of the requested type.

Section: F.7.8.1.

Supported type strings: simple, sliced, port.

Parameters:

• parentID (str) – Handle of element that can own accessHandles.

• type (str) – Variant to create.

Returns:

Handle of the created accessHandle.

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addAccessHandleIndex(accessHandleID, value)

Add an index element to a portAccessHandle.

Section: F.7.8.2.

Parameters:

• accessHandleID (str)

• value (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addAccessHandlePathSegment(accessHandleID, value)

Add a pathSegment to a simpleAccessHandle.

Section: F.7.8.3.

Parameters:

• accessHandleID (str)

• value (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addAccessHandleSlice(accessHandleID, value)

Add a slice element to a port or sliced accessHandle.

Section: F.7.8.4.

Parameters:

• accessHandleID (str)

• value (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addAccessHandleViewRef(accessHandleID, viewName)

Add a viewRef child to any accessHandle variant.

Section: F.7.8.5.

Parameters:

• accessHandleID (str)

• viewName (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addAccessRestrictionModeRef(accessRestrictionID, modeRef, priority=None)

Section: F.7.10.1 Add a modeRef to an accessRestriction.

Parameters:

• accessRestrictionID (str)

• modeRef (str)

• priority (int | None)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addActiveInterfaceExcludePort(activeInterfaceID, excludePort)

Add an excludePort to an activeInterface.

Section: F.7.38.1.

Parameters:

• activeInterfaceID (str)

• excludePort (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addAdHocConnectionExternalPortReference(adHocConnectionID, portRef)

Add externalPortReference with portRef to adHocConnection.

Section: F.7.38.2.

Parameters:

• adHocConnectionID (str)

• portRef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addAdHocConnectionInternalPortReference(adHocConnectionID, componentInstanceRef, portRef)

Add internalPortReference.

Section: F.7.38.3.

Parameters:

• adHocConnectionID (str)

• componentInstanceRef (str)

• portRef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addAddressBlockAccessPolicy(addressBlockID)

Section: F.7.10.2 Add accessPolicy to addressBlock.

Parameters:

addressBlockID (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addAddressSpaceSegment(addressSpaceID, name, addressOffsetExpr, rangeExpr)

Create and append a segment to an addressSpace.

Section: F.7.12.1.

Parameters:

• addressSpaceID (str) – Parent addressSpace handle.

• name (str) – New segment name.

• addressOffsetExpr (str) – Expression for addressOffset.

• rangeExpr (str) – Expression for range.

Returns:

Handle of the newly created segment.

Return type:

str

Raises:

TgiError – If the parent handle is invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addAliasOfRegisterFileRef(registerFileID, vlnv)

Create/replace aliasOf registerFile reference. Section F.7.76.1.

Parameters:

• registerFileID (str)

• vlnv (tuple[str, str, str, str])

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addAlternateRegisterAccessPolicy(registerID)

Section: F.7.10.3 Add accessPolicy to alternateRegister.

Parameters:

registerID (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addAlternateRegisterField(alternateRegisterID, name, offset, width)

Add field to alternateRegister (F.7.74.1).

Parameters:

• alternateRegisterID (str)

• name (str)

• offset (str)

• width (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addAlternaterRegisterModeRef(alternateRegisterID, modeRef, priority)

Add modeRef to alternateRegister (F.7.74.2).

Parameters:

• alternateRegisterID (str)

• modeRef (str)

• priority (int)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addArray(parentID)

Add a new generic array element under a parent.

Section: F.7.14.1.

This is a generic implementation; creation only succeeds if the parent has an attribute suitable for receiving arrays: array (single) or arrays (list). If both exist and arrays is a list, we append there.

Parameters:

parentID (str) – Handle of the parent object.

Returns:

Handle of the created array.

Return type:

str

Raises:

TgiError – If the parent handle is invalid or no array slot exists.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addArrayDim(arrayID, expression)

Append a new dim element to an array.

Section: F.7.14.2.

Parameters:

• arrayID (str) – Array handle.

• expression (str) – Value/expression string.

Returns:

Handle of created dimension.

Return type:

str

Raises:

TgiError – If array handle invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addAssertion(parentID, name, expression)

Create and append a new assertion element.

Section: F.7.16.1.

The parent must support an assertions.assertion list. The container will be created if absent.

Parameters:

• parentID (str) – Parent element handle.

• name (str) – Assertion name.

• expression (str) – Expression string for the assert condition.

Returns:

Handle of created assertion.

Return type:

str

Raises:

TgiError – If parent handle invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addBroadcastToBankRef(broadcastToID, bankRef)

Add bankRef to broadcastTo (F.7.74.3).

Parameters:

• broadcastToID (str)

• bankRef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addBroadcastToRegisterFileRef(broadcastToID, registerFileRef)

Add registerFileRef (F.7.74.4).

Parameters:

• broadcastToID (str)

• registerFileRef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addBusDefinitionAssertion(busDefinitionID, name, expression)

Add an assertion element (name + expression).

Parameters:

• busDefinitionID (str)

• name (str)

• expression (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addBusDefinitionChoice(busDefinitionID, name)

Append a choice element with given name.

Parameters:

• busDefinitionID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addBusDefinitionParameterInteger(busDefinitionID, name, value)

Add a simple integer parameter (name/value only).

Parameters:

• busDefinitionID (str) – Bus definition handle.

• name (str) – Parameter name.

• value (int) – Integer value (stored as string expression).

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addBusDefinitionSystemGroupName(busDefinitionID, name)

Append a new systemGroupName element.

Parameters:

• busDefinitionID (str) – Bus definition handle.

• name (str) – Group name string.

Returns:

Handle of created element.

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addBusInterface(componentID, name, busTypeVLNV)

Create and append a new busInterface under a component.

Parameters:

• componentID (str) – Parent component handle.

• name (str) – Interface name.

• busTypeVLNV (tuple[str, str, str, str]) – (vendor, library, name, version) tuple for busType ref.

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addBusInterfaceAbstractionTypeBusTypeViewRef(busInterfaceID, viewVLNV)

Append an abstractionType element referencing a view (name only stored).

Parameters:

• busInterfaceID (str)

• viewVLNV (tuple[str, str, str, str])

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addCatalogAbstractionDefIpxactFile(catalog, abstractionDefVLNV, fileName)

Add an abstractionDefinition ipxactFile entry to the catalog.

Parameters:

• catalog (Catalog) – Catalog handle object.

• abstractionDefVLNV (Sequence[str]) – Sequence [vendor, library, name, version].

• fileName (str) – Relative or absolute XML file name.

Returns:

Handle string of the created ipxactFile element.

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addCatalogAbstractorsIpxactFile(catalog, abstractorVLNV, fileName)

Add an abstractors ipxactFile entry to the catalog.

Parameters:

• catalog (Catalog)

• abstractorVLNV (Sequence[str])

• fileName (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addCatalogBusDefinitionsIpxactFile(catalog, busDefVLNV, fileName)

Add a busDefinitions ipxactFile entry to the catalog.

Parameters:

• catalog (Catalog)

• busDefVLNV (Sequence[str])

• fileName (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addCatalogCatalogsIpxactFile(catalog, catalogVLNV, fileName)

Add a catalogs ipxactFile entry to the catalog.

Parameters:

• catalog (Catalog)

• catalogVLNV (Sequence[str])

• fileName (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addCatalogComponentsIpxactFile(catalog, componentVLNV, fileName)

Add a components ipxactFile entry to the catalog.

Parameters:

• catalog (Catalog)

• componentVLNV (Sequence[str])

• fileName (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addCatalogDesignConfigurationsIpxactFile(catalog, designConfigurationVLNV, fileName)

Add a designConfigurations ipxactFile entry to the catalog.

Parameters:

• catalog (Catalog)

• designConfigurationVLNV (Sequence[str])

• fileName (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addCatalogDesignsIpxactFile(catalog, designVLNV, fileName)

Add a designs ipxactFile entry to the catalog.

Parameters:

• catalog (Catalog)

• designVLNV (Sequence[str])

• fileName (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addCatalogGeneratorChainsIpxactFile(catalog, generatorChainVLNV, fileName)

Add a generatorChains ipxactFile entry to the catalog.

Parameters:

• catalog (Catalog)

• generatorChainVLNV (Sequence[str])

• fileName (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addCatalogTypeDefinitionsIpxactFile(catalog, typeDefinitionVLNV, fileName)

Add a typeDefinitions ipxactFile entry to the catalog.

Parameters:

• catalog (Catalog)

• typeDefinitionVLNV (Sequence[str])

• fileName (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addChoiceEnumeration(choiceID, name)

Add a new enumeration with the given name to the choice.

Section: F.7.26.1

Parameters:

• choiceID (str) – Handle to a Choices.Choice element.

• name (str) – Name for the new enumeration.

Returns:

Handle to the new Choices.Choice.Enumeration element.

Raises:

TgiError – If the handle is invalid.

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addClearboxElementRefLocation(clearboxElementRefID, value)

Add a clearboxElementRefLocation to a clearboxElementRef.

Section: F.7.28.1

Parameters:

• clearboxElementRefID (str) – Handle to a clearboxElementRef element.

• value (str) – Path segment value.

Returns:

Handle of the newly added clearboxElementRefLocation.

Raises:

TgiError – If the ref handle is invalid.

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addComponentAddressSpace(componentID, name)

Add an addressSpace element.

Section: F.7.30.1.

Parameters:

• componentID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addComponentChannel(componentID, name)

Add a channel element.

Section: F.7.30.2.

Parameters:

• componentID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addComponentChoice(componentID, name)

Add a choice element (no enumerations yet).

Section: F.7.30.3.

Parameters:

• componentID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addComponentClearboxElement(componentID, name=None)

Add a clearboxElement.

Section: F.7.30.4. Name is optional (schema may not define one).

Parameters:

• componentID (str)

• name (str | None)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addComponentComponentGenerator(componentID, name)

Add a componentGenerator element.

Section: F.7.30.5.

Parameters:

• componentID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addComponentComponentInstantiation(componentID, name)

Add a componentInstantiation (model.instantiations).

Section: F.7.30.6.

Parameters:

• componentID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addComponentCpu(componentID, name, memoryMapRef, rangeValue, widthValue)

Add a cpu to a component.

Parameters:

• componentID (str) – Component handle.

• name (str) – CPU name.

• memoryMapRef (str) – Referenced memory map name.

• rangeValue (int | str) – Integer or expression for range.

• widthValue (int | str) – Integer or expression for width.

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addComponentDesignConfigurationInstantiation(componentID, name)

Add a designConfigurationInstantiation.

Section: F.7.30.8.

Parameters:

• componentID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addComponentDesignInstantiation(componentID, name)

Add a designInstantiation.

Section: F.7.30.9.

Parameters:

• componentID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addComponentExternalTypeDefinitions(componentID)

Parameters:

componentID (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addComponentFileSet(componentID, name)

Add a fileSet element.

Section: F.7.30.10.

Parameters:

• componentID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addComponentGeneratorGroup(componentGeneratorID, groupName)

Append a group element to a ComponentGenerator.

Section: F.7.50.2.

Parameters:

• componentGeneratorID (str)

• groupName (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addComponentIndirectInterface(componentID, name)

Add an indirectInterface element.

Section: F.7.30.11.

Parameters:

• componentID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addComponentInitiatorBusInterface(componentID, name)

Add an initiator busInterface.

Section: F.7.30.12.

Parameters:

• componentID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addComponentInstancePowerDomainLink(componentInstanceID, externalRefExpression=None)

Append powerDomainLink to component instance (F.7.72.1).

Parameters:

• componentInstanceID (str)

• externalRefExpression (str | None)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addComponentInstantiationClearboxElementRef(componentInstantiationID, name, pathSegmentValue)

Add a clearboxElementRef element.

Section: F.7.56.1.

Parameters:

• componentInstantiationID (str)

• name (str)

• pathSegmentValue (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addComponentInstantiationConstraintSetRef(componentInstantiationID, localName)

Add a constraintSetRef.

Section: F.7.56.2.

Parameters:

• componentInstantiationID (str)

• localName (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addComponentInstantiationDefaultFileBuilder(componentInstantiationID, fileType)

Add a defaultFileBuilder element.

Section: F.7.56.3.

Parameters:

• componentInstantiationID (str)

• fileType (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addComponentInstantiationFileSetRef(componentInstantiationID, localName)

Add a fileSetRef element.

Section: F.7.56.4.

Parameters:

• componentInstantiationID (str)

• localName (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addComponentMemoryMap(componentID, name)

Add a memoryMap element.

Section: F.7.30.13.

Parameters:

• componentID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addComponentMirroredInitiatorBusInterface(componentID, name)

Add a mirrored initiator busInterface.

Section: F.7.30.14.

Parameters:

• componentID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addComponentMirroredSystemBusInterface(componentID, name)

Add a mirrored system busInterface.

Section: F.7.30.15.

Parameters:

• componentID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addComponentMirroredTargetBusInterface(componentID, name)

Add a mirrored target busInterface.

Section: F.7.30.16.

Parameters:

• componentID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addComponentMode(componentID, name)

Add a mode element.

Section: F.7.30.17.

Parameters:

• componentID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addComponentMonitorBusInterface(componentID, name)

Add a monitor busInterface.

Section: F.7.30.18.

Parameters:

• componentID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addComponentOtherClockDriver(componentID, name)

Add an otherClockDriver element.

Section: F.7.30.19.

Parameters:

• componentID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addComponentPowerDomain(componentID, name)

Create powerDomain under component (F.7.72.2).

Parameters:

• componentID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addComponentResetType(componentID, name)

Add a resetType element.

Section: F.7.30.20.

Parameters:

• componentID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addComponentStructuredInterfacePort(componentID, name, subPortName, structPortTypeDefTypeName)

Add a structured interface port.

Section: F.7.30.21.

Parameters:

• componentID (str)

• name (str)

• subPortName (str)

• structPortTypeDefTypeName (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addComponentStructuredStructPort(componentID, name, subPortName, structPortTypeDefTypeName)

Add a structured struct port.

Section: F.7.30.22.

Parameters:

• componentID (str)

• name (str)

• subPortName (str)

• structPortTypeDefTypeName (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addComponentStructuredUnionPort(componentID, name, structPortTypeDefTypeName, subPortName)

Add a structured union port.

Section: F.7.30.23.

Parameters:

• componentID (str)

• name (str)

• structPortTypeDefTypeName (str)

• subPortName (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addComponentSystemBusInterface(componentID, name)

Add a system busInterface.

Section: F.7.30.24.

Parameters:

• componentID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addComponentTargetBusInterface(componentID, name)

Add a target busInterface.

Section: F.7.30.25.

Parameters:

• componentID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addComponentTransactionalPort(componentID, name)

Add a transactional port.

Section: F.7.30.26.

Parameters:

• componentID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addComponentView(componentID, name)

Add a view element.

Section: F.7.30.27.

Parameters:

• componentID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addComponentWirePort(componentID, name, direction=None)

Add a wire port.

Section: F.7.30.28.

Parameters:

• componentID (str)

• name (str)

• direction (str | None)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addConfigurableElementValue(configuredElementID, referenceID, expression)

Add a configurable element value under a configured element.

Section: F.7.32.1.

Parameters:

• configuredElementID (str) – Parent handle.

• referenceID (str) – Referenced configurable element ID.

• expression (str) – Expression / value text.

Returns:

Handle of the newly created configurableElementValue.

Return type:

str

Raises:

TgiError – If the parent handle is invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addConstrainedAttribute(elementID, constrained)

Add or replace the ‘constrained’ attribute.

Section: F.7.44.1.

Parameters:

• elementID (str) – Element handle.

• constrained (str) – Attribute value string.

Returns:

True on success.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addConstraintSetTimingConstraint(constraintSetID, value, clockName)

Add a new timingConstraint to the given constraintSet.

Section: F.7.36.1.

Parameters:

• constraintSetID (str) – Handle referencing a constraintSet element.

• value (float) – Timing constraint value (0.0 – 100.0 inclusive per schema range).

• clockName (str) – Name of the associated clock.

Returns:

Handle of the newly created timingConstraint element.

Return type:

str

Raises:

TgiError – If the parent handle is invalid or value cannot be applied.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addCpuRegion(cpuID, name, addressOffset, rangeValue)

Append a region to a CPU.

Parameters:

• cpuID (str) – CPU handle.

• name (str) – Region name.

• addressOffset (int | str) – Numeric/expression for addressOffset.

• rangeValue (int | str) – Numeric/expression for range.

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addDesignAdHocConnection(designID, name, componentInstanceRef, portRef)

Add adHocConnection with one internalPortReference.

Section: F.7.38.4.

Parameters:

• designID (str)

• name (str)

• componentInstanceRef (str)

• portRef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addDesignChoice(designID, name, enumerations=None)

Add choice with name and enumerations.

Section: F.7.38.5.

Parameters:

• designID (str)

• name (str)

• enumerations (list[str] | None)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addDesignComponentInstance(designID, componentVLNV, componentInstanceName)

Add componentInstance referencing component VLNV.

Section: F.7.38.6.

Parameters:

• designID (str)

• componentVLNV (tuple[str, str, str, str])

• componentInstanceName (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addDesignConfChoice(designConfigurationID, name)

Add a choice element to the designConfiguration.

Section: F.7.40.3.

Parameters:

• designConfigurationID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addDesignConfigurationGeneratorChainConfiguration(designConfigurationID, vlnv)

Append a generatorChainConfiguration reference.

Section: F.7.40.4.

Parameters:

• designConfigurationID (str)

• vlnv (tuple[str, str, str, str])

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addDesignConfigurationInterconnectionConfiguration(designConfigurationID, interconnectionRef)

Create and append an interconnectionConfiguration with the given ref.

Section: F.7.40.5.

Parameters:

• designConfigurationID (str)

• interconnectionRef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addDesignConfigurationViewConfiguration(designConfigurationID, instanceName, viewRef)

Add a viewConfiguration selecting a viewRef for an instance.

Section: F.7.40.6.

Parameters:

• designConfigurationID (str)

• instanceName (str)

• viewRef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addDesignExternalAdHocConnection(designID, name, portRef)

Add adHocConnection with single externalPortReference.

Section: F.7.38.7.

Parameters:

• designID (str)

• name (str)

• portRef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addDesignInterconnection(designID, name, componentInstanceRef1, busInterfaceRef1, componentInstanceRef2, busInterfaceRef2)

Add interconnection with two activeInterface endpoints.

Section: F.7.38.8.

Parameters:

• designID (str)

• name (str)

• componentInstanceRef1 (str)

• busInterfaceRef1 (str)

• componentInstanceRef2 (str)

• busInterfaceRef2 (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addDesignMonitorInterconnection(designID, name, componentInstanceRef1, activeInterfaceBusInterfaceRef, componentInstanceRef2, interfaceBusInterfaceRef)

Add monitorInterconnection with monitoredActiveInterface + monitorInterface.

Section: F.7.38.9.

Parameters:

• designID (str)

• name (str)

• componentInstanceRef1 (str)

• activeInterfaceBusInterfaceRef (str)

• componentInstanceRef2 (str)

• interfaceBusInterfaceRef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addDomainTypeDefTypeDefinition(portID, domainTypeDefID, value)

Append a typeDefinition string to the given domainTypeDef.

Section: F.7.68.1.

Parameters:

• portID (str)

• domainTypeDefID (str)

• value (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addDomainTypeDefViewRef(portID, domainTypeDefID, viewRef)

Add a viewRef to a domainTypeDef.

Section: F.7.68.2.

Parameters:

• portID (str)

• domainTypeDefID (str)

• viewRef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addDriverSingleShotDriver(driverID)

Create singleShotDriver (empty skeleton) if absent and return handle.

Section: F.7.42.1.

Parameters:

driverID (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addDriverViewRef(driverID, viewRef)

Append a viewRef value reference and return its handle.

Section: F.7.42.2.

Parameters:

• driverID (str)

• viewRef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addEnumeratedValuesFieldEnumeratedValue(enumeratedValuesID, name, value)

Add enumeratedValue (F.7.74.5).

Parameters:

• enumeratedValuesID (str)

• name (str)

• value (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addEnumerationDefinition(typeDefinitionsID, name)

Parameters:

• typeDefinitionsID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addEnumerationDefinitionEnumeratedValue(enumerationDefinitionID, name, value)

Parameters:

• enumerationDefinitionID (str)

• name (str)

• value (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addExecutableImageFileBuilderID(executableImageID, fileType)

Create a new fileBuilder under executableImage.languageTools.

Section: F.7.46.1.

Parameters:

• executableImageID (str)

• fileType (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addExecutableImageFileSetRef(addressSpaceID, fileSetName)

Add an executableImage fileSetRef (stub).

Section: F.7.12.2.

The 2022 generated schema in this project does not include the executable image container; this function therefore validates the parent handle and returns None.

Parameters:

• addressSpaceID (str) – Address space handle.

• fileSetName (str) – Name of the fileSet to reference (unused in stub).

Returns:

Always None until schema support is added.

Return type:

None

Raises:

TgiError – If the addressSpace handle is invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addExecutableImageLinkerCommandFile(executableImageID, enable=None)

Append a new linkerCommandFile (optionally setting enable flag).

Section: F.7.46.2.

Parameters:

• executableImageID (str)

• enable (bool | None)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addExternalPortReferenceSubPortReference(portID, fieldMapID, subPortRef)

Add subPortReference for an external reference (treated same as internal here).

Section: F.7.68.3. Implementation merges external/internal semantics.

Parameters:

• portID (str)

• fieldMapID (str)

• subPortRef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addExternalTypeDefinitionsModeLink(externalTypeDefinitionsID, name)

Parameters:

• externalTypeDefinitionsID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addExternalTypeDefinitionsResetTypeLink(*_args, **_kwargs)

Section: F.7.10.4 Not supported by generated schema (externalTypeDefinitions).

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addExternalTypeDefinitionsViewLink(externalTypeDefinitionsID, name)

Parameters:

• externalTypeDefinitionsID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addFieldAccessPoliciesFieldAccessPolicy(fieldAccessPoliciesID)

Section: F.7.10.5 Add fieldAccessPolicy to fieldAccessPolicies.

Parameters:

fieldAccessPoliciesID (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addFieldAccessPolicyAccessRestriction(fieldAccessPolicyID)

Section: F.7.10.6 Add accessRestriction to fieldAccessPolicy.

Parameters:

fieldAccessPolicyID (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addFieldAccessPolicyBroadcastTo(fieldAccessPolicyID, memoryMapRef=None, addressBlockRef=None, registerRef=None, fieldRef=None)

Section: F.7.10.7 Add broadcastTo element to fieldAccessPolicy (subset of refs).

Parameters:

• fieldAccessPolicyID (str)

• memoryMapRef (str | None)

• addressBlockRef (str | None)

• registerRef (str | None)

• fieldRef (str | None)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addFieldAccessPolicyModeRef(fieldAccessPolicyID, modeRef, priority=None)

Section: F.7.10.8 Add modeRef to fieldAccessPolicy.

Parameters:

• fieldAccessPolicyID (str)

• modeRef (str)

• priority (int | None)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addFieldDefinitionFieldAccessPolicy(fieldDefinitionID)

Section: F.7.10.9 Add fieldAccessPolicy to a fieldDefinition (create container if absent).

Parameters:

fieldDefinitionID (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addFieldDefinitionsEnumeratedValue(fieldDefinitionsID, name, value)

Parameters:

• fieldDefinitionsID (str)

• name (str)

• value (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addFieldMapIndex(portID, fieldMapID, index)

Set/replace the partSelect of a FieldMap with a single index.

Section: F.7.68.4. Returns handle of partSelect.

Parameters:

• portID (str)

• fieldMapID (str)

• index (int)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addFieldMapModeRef(portID, fieldMapID, modeName, priority)

Append a modeRef to a FieldMap.

Section: F.7.68.5.

Parameters:

• portID (str)

• fieldMapID (str)

• modeName (str)

• priority (int)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addFieldMapSubPortReference(portID, fieldMapID, subPortRef)

Add a subPortReference to a FieldMap.

Section: F.7.68.6.

Parameters:

• portID (str)

• fieldMapID (str)

• subPortRef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addFieldRefIndex(fieldRefID, value)

Add index to fieldRef (F.7.74.6).

Parameters:

• fieldRefID (str)

• value (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addFieldSliceBankRef(fieldSliceID, vlnv)

Parameters:

• fieldSliceID (str)

• vlnv (tuple[str, str, str, str])

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addFieldSliceRegisterFileRef(fieldSliceID, name)

Parameters:

• fieldSliceID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addFileDefine(fileID, name, value)

Add a define symbol (Section: F.7.48.1).

The schema’s NameValuePairType may expect wrapped value object; we assign plain string which aligns with other usage sites in the codebase.

Parameters:

• fileID (str)

• name (str)

• value (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addFileDependency(fileID, dependency)

Add a dependency string (Section: F.7.48.2).

Parameters:

• fileID (str)

• dependency (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addFileExportedName(fileID, value)

Add exportedName (Section: F.7.48.3).

Parameters:

• fileID (str)

• value (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addFileFileType(fileID, fileType)

Add an additional fileType (Section: F.7.48.4).

Parameters:

• fileID (str)

• fileType (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addFileImageType(fileID, value)

Add imageType (Section: F.7.48.5).

Parameters:

• fileID (str)

• value (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addFileSetDefaultFileBuilder(fileSetID, fileType)

Add defaultFileBuilder to fileSet (Section: F.7.48.6).

Note: Spec text lists fileID; schema associates defaultFileBuilder with fileSet. We adopt fileSetID here.

Parameters:

• fileSetID (str)

• fileType (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addFileSetDependency(fileSetID, dependency)

Add dependency to fileSet (Section: F.7.48.7).

Parameters:

• fileSetID (str)

• dependency (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addFileSetFile(fileSetID, name, fileTypes)

Add file to fileSet (Section: F.7.48.8).

Parameters:

• fileSetID (str)

• name (str)

• fileTypes (list[str])

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addFileSetFunction(fileSetID, fileRef)

Add function referencing fileRef (Section: F.7.48.9).

Parameters:

• fileSetID (str)

• fileRef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addFileSetGroup(fileSetID, group)

Add group value (Section: F.7.48.10).

Parameters:

• fileSetID (str)

• group (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addFileSetRefGroupFileSetRef(fileSetRefGroupID, localName)

Add fileSetRef (Section: F.7.48.11 – unsupported).

Raises INVALID_ARGUMENT because schema lacks fileSetRefGroup.

Parameters:

• fileSetRefGroupID (str)

• localName (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addFunctionArgument(functionID, name, value, dataType)

Add function argument (Section: F.7.48.12).

Parameters:

• functionID (str)

• name (str)

• value (str)

• dataType (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addFunctionSourceFile(functionID, sourceFileName, fileType)

Add sourceFile (Section: F.7.48.13).

Parameters:

• functionID (str)

• sourceFileName (str)

• fileType (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addGeneratorChainChainGroup(generatorChainID, group)

Add a chainGroup value to a generatorChain.

Section: F.7.52.1.

Parameters:

• generatorChainID (str)

• group (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addGeneratorChainChoice(generatorChainID, name, enumerations)

Add a choice with enumerations to a generatorChain.

Section: F.7.52.2.

Parameters:

• generatorChainID (str)

• name (str)

• enumerations (list[str])

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addGeneratorChainComponentGeneratorSelector(generatorChainID, name)

Add a componentGeneratorSelector (with groupSelector names) to chain.

Section: F.7.52.3.

Parameters:

• generatorChainID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addGeneratorChainGenerator(generatorChainID, name, generatorExecutable)

Add a generator (name + executable path) to chain.

Section: F.7.52.4.

Parameters:

• generatorChainID (str)

• name (str)

• generatorExecutable (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addGeneratorChainGeneratorChainSelector(generatorChainID, name)

Add a generatorChainSelector with groupSelector name placeholder.

Section: F.7.52.5.

Parameters:

• generatorChainID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addGroupSelectorName(groupSelectorID, name)

Append a Name to groupSelector.

Section: F.7.52.6.

Parameters:

• groupSelectorID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addIndirectAddressRefBankRef(indirectAddressRefID, bankRef)

Append a bankRef to indirectAddressRef.

Section: F.7.54.1.

Parameters:

• indirectAddressRefID (str)

• bankRef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addIndirectAddressRefRegisterFileRef(indirectAddressRefID, registerFileRef)

Append a registerFileRef to indirectAddressRef.

Section: F.7.54.2.

Parameters:

• indirectAddressRefID (str)

• registerFileRef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addIndirectDataRefBankRef(indirectDataRefID, bankRef)

Append a bankRef to indirectDataRef.

Section: F.7.54.3.

Parameters:

• indirectDataRefID (str)

• bankRef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addIndirectDataRefRegisterFileRef(indirectDataRefID, registerFileRef)

Append a registerFileRef to indirectDataRef.

Section: F.7.54.4.

Parameters:

• indirectDataRefID (str)

• registerFileRef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addIndirectInterfaceTransparentBridge(indirectInterfaceID, initiatorRef)

Add a transparentBridge element to indirectInterface.

Section: F.7.54.5.

Parameters:

• indirectInterfaceID (str)

• initiatorRef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addInterconnectionActiveInterface(interconnectionID, componentInstanceRef, busInterfaceRef)

Add an activeInterface to an interconnection.

Section: F.7.38.10.

Parameters:

• interconnectionID (str)

• componentInstanceRef (str)

• busInterfaceRef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addInterconnectionConfigurationAbstractorInstances(interconnectionConfigurationID)

Append an empty abstractorInstances grouping.

Section: F.7.40.7.

Parameters:

interconnectionConfigurationID (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addInterconnectionHierInterface(interconnectionID, busInterfaceRef)

Add a hierInterface to an interconnection.

Section: F.7.38.11.

Parameters:

• interconnectionID (str)

• busInterfaceRef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addInternalPortReferenceSubPortReference(portID, fieldMapID, subPortRef)

Add subPortReference for an internal reference (same as external here).

Section: F.7.68.7.

Parameters:

• portID (str)

• fieldMapID (str)

• subPortRef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addLanguageToolsFileBuilder(languageToolsID, fileType)

Add fileBuilder to existing languageTools element.

Section: F.7.46.3.

Parameters:

• languageToolsID (str)

• fileType (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addLinkerCommandFileGeneratorRef(linkerCommandFileID, generatorRef)

Append a generatorRef to a linkerCommandFile.

Section: F.7.46.4.

Parameters:

• linkerCommandFileID (str)

• generatorRef (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addLocalMemoryMapAddressBlock(localMemoryMapID, name, baseAddressExpr, rangeExpr, widthExpr)

Create and append an addressBlock to a localMemoryMap.

Section: F.7.12.3.

Parameters:

• localMemoryMapID (str) – Parent localMemoryMap handle.

• name (str) – New addressBlock name.

• baseAddressExpr (str) – Expression for baseAddress.

• rangeExpr (str) – Expression for range.

• widthExpr (str) – Expression for width.

Returns:

Handle of the newly created addressBlock.

Return type:

str

Raises:

TgiError – If the localMemoryMap handle is invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addLocationSlice(locationID, value)

Add a slice to a Location element.

Section: F.7.28.2

Parameters:

• locationID (str) – Handle to a location element.

• value (str) – Slice value (path segment).

Returns:

Handle to the new slice element.

Raises:

TgiError – If the location handle is invalid.

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addMemoryMapAddressBlock(memoryMapID, name)

Create a new addressBlock under a memory map.

Section: F.7.58.11 (core portion). Only name is required here; additional properties can be assigned via dedicated setters (range, width, baseAddress, etc.).

Parameters:

• memoryMapID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addMemoryMapBank(memoryMapID, name)

Add a bank to the memory map.

Section: F.7.58.12.

Parameters:

• memoryMapID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addMemoryMapMemoryRemap(memoryMapID, name)

Add a memoryRemap element.

Section: F.7.58.13.

Parameters:

• memoryMapID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addMemoryMapSubspaceMap(memoryMapID, name, addressOffset=None)

Add a subspaceMap to the memory map.

Section: F.7.58.14. Supports optional base address offset.

Parameters:

• memoryMapID (str)

• name (str)

• addressOffset (int | None)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addModeFieldSlice(modeID, fieldSliceID)

Parameters:

• modeID (str)

• fieldSliceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addModePortSlice(modeID, portSliceID)

Parameters:

• modeID (str)

• portSliceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addModuleParameter(moduleParameterContainerElementID, name, value=None)

Add a new moduleParameter below the container, returning its handle.

Section: F.7.62.1. :param moduleParameterContainerElementID: Handle to container (componentInstantiation

or object with module_parameter list attribute).

Parameters:

• name (str) – Parameter name.

• value (str | None) – Optional initial value string.

• moduleParameterContainerElementID (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addMonitorInterconnectionMonitorInterface(monitorInterconnectionID, componentInstanceRef, busInterfaceRef)

Add monitorInterface to a monitorInterconnection.

Section: F.7.38.12.

Parameters:

• monitorInterconnectionID (str)

• componentInstanceRef (str)

• busInterfaceRef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addParameter(parameterContainerElementID, name, value=None)

Create a new parameter and append to container.

Section: F.7.66.1. :param parameterContainerElementID: Handle of container with parameter list. :param name: Parameter name (must be unique within container). :param value: Optional initial value string.

Raises:

TgiError – On invalid container handle or duplicate name.

Parameters:

• parameterContainerElementID (str)

• name (str)

• value (str | None)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addPartSelectIndex(partSelectID, expression)

Add a new index entry to partSelect returning its handle.

Section: F.7.60.1.

Parameters:

• partSelectID (str)

• expression (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addPhysicalPortSubPort(physicalPortID, name)

Add a subPort to an existing physicalPort.

Section: F.7.70.1.

Parameters:

• physicalPortID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addPortClockDriver(portID, value)

Add a clock driver to port (placeholder – not modeled).

Section: F.7.68.8. Returns synthetic handle.

Parameters:

• portID (str)

• value (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addPortClockDriverExpresion(portID, expression)

Add clock driver expression (placeholder). Section: F.7.68.9.

Parameters:

• portID (str)

• expression (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addPortDefaultDriver(portID, value)

Add default driver (placeholder). Section: F.7.68.10.

Parameters:

• portID (str)

• value (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addPortDefaultDriverExpression(portID, expression)

Add default driver expression (placeholder). Section: F.7.68.11.

Parameters:

• portID (str)

• expression (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addPortDomainTypeDef(portID, typeName)

Create and append a DomainTypeDef under wire.domainTypeDefs.

Section: F.7.68.12.

Parameters:

• portID (str)

• typeName (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addPortFieldMap(portID)

Create a new FieldMap on the port.

Section: F.7.68.13.

Parameters:

portID (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addPortMapPhysicalPortSubPort(portMapID, name)

Convenience: add subPort via portMap physicalPort.

Section: F.7.70.2.

Parameters:

• portMapID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addPortSignalTypeDef(portID, typeDef)

Add a signalTypeDef to wire.signalTypeDefs (placeholder).

Section: F.7.68.14. Returns synthetic handle.

Parameters:

• portID (str)

• typeDef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addPortSingleShotDriver(portID, value)

Add single-shot driver (placeholder). Section: F.7.68.15.

Parameters:

• portID (str)

• value (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addPortSingleShotDriverExpression(portID, expression)

Add single-shot driver expression (placeholder). Section: F.7.68.16.

Parameters:

• portID (str)

• expression (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addPortSliceSubPortReference(portSliceID, subPortName)

Parameters:

• portSliceID (str)

• subPortName (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addPortStructuredStructPortTypeDef(portID, typeDef)

Add structPortTypeDef (placeholder). Section: F.7.68.17.

Parameters:

• portID (str)

• typeDef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addPortStructuredSubStructuredPort(portID, name)

Add sub structured port (placeholder). Section: F.7.68.18.

Parameters:

• portID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addPortStructuredSubWirePort(portID, name)

Add sub wire port (placeholder). Section: F.7.68.19.

Parameters:

• portID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addPortStructuredVector(portID, left, right)

Add structured vectors element (placeholder). Section: F.7.68.20.

Parameters:

• portID (str)

• left (int)

• right (int)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addPortTransactionalPowerConstraint(portID, powerDomainRef=None)

Add transactional powerConstraint (F.7.72.3).

Parameters:

• portID (str)

• powerDomainRef (str | None)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addPortTransactionalTransTypeDef(portID, language, text)

Add transactional transTypeDef (placeholder). Section: F.7.68.21.

Parameters:

• portID (str)

• language (str)

• text (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addPortWireConstraintSet(portID, name)

Add wire constraint set (placeholder). Section: F.7.68.22.

Parameters:

• portID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addPortWireDriver(portID, value)

Add wire driver (placeholder). Section: F.7.68.23.

Parameters:

• portID (str)

• value (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addPortWirePowerConstraint(portID, powerDomainRef=None)

Add wire powerConstraint (F.7.72.4).

Parameters:

• portID (str)

• powerDomainRef (str | None)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addPortWireTypeDef(portID, typeDef)

Add wire type definition (placeholder). Section: F.7.68.24.

Parameters:

• portID (str)

• typeDef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addPowerDomainLinkInternalPowerDomainReference(powerDomainLinkID, internalRefExpression)

Add internalPowerDomainReference (F.7.72.5).

Parameters:

• powerDomainLinkID (str)

• internalRefExpression (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addRegisterAccessPolicy(registerID)

Section: F.7.10.10 Add accessPolicy to register.

Parameters:

registerID (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addRegisterAlternateRegister(registerID, name, modeRef, priority, fieldName, fieldOffset, fieldWidth)

Add alternateRegister (F.7.74.7).

Parameters:

• registerID (str)

• name (str)

• modeRef (str)

• priority (int)

• fieldName (str)

• fieldOffset (str)

• fieldWidth (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addRegisterField(registerID, name, offset, width)

Add field to register (F.7.74.8).

Parameters:

• registerID (str)

• name (str)

• offset (str)

• width (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addRegisterFieldReset(registerFieldID, value)

Add reset to register field (F.7.74.9).

Parameters:

• registerFieldID (str)

• value (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addRegisterFileAccessPolicy(registerFileID)

Section: F.7.10.11 Add accessPolicy to registerFile.

Parameters:

registerFileID (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addRegisterFileDefinitionRegisterFile(registerFileDefinitionRefID, name)

Add a contained registerFile to a registerFileDefinition ref target. F.7.76.2.

Because schema mapping for definition vs instance may differ, we treat the provided handle as pointing at a RegisterFile acting as definition root.

Parameters:

• registerFileDefinitionRefID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addRegisterFileRefIndex(registerFileID, value)

Parameters:

• registerFileID (str)

• value (int)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addRegisterFileRegister(registerFileID, name)

Parameters:

• registerFileID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addRegisterRefIndex(registerRefID, value)

Add index to registerRef (F.7.74.10).

Parameters:

• registerRefID (str)

• value (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addServiceTypeDefServiceTypeDef(portID, typeDef)

Add service type definition (placeholder). Section: F.7.68.25.

Parameters:

• portID (str)

• typeDef (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addSlicePathSegment(sliceID, segment)

Parameters:

• sliceID (str)

• segment (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addTypeDefinitionsAddressBlockDefinition(typeDefinitionsID, name)

Parameters:

• typeDefinitionsID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addTypeDefinitionsBankDefinition(typeDefinitionsID, name)

Parameters:

• typeDefinitionsID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addTypeDefinitionsChoice(typeDefinitionsID, name)

Parameters:

• typeDefinitionsID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addTypeDefinitionsEnumerationDefinition(typeDefinitionsID, name)

Parameters:

• typeDefinitionsID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addTypeDefinitionsExternalTypeDefinitions(typeDefinitionsID, name)

Parameters:

• typeDefinitionsID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addTypeDefinitionsFieldAccessPolicyDefinition(typeDefinitionsID, name)

Parameters:

• typeDefinitionsID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addTypeDefinitionsFieldDefinition(typeDefinitionsID, name)

Parameters:

• typeDefinitionsID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addTypeDefinitionsMemoryMapDefinition(typeDefinitionsID, name)

Parameters:

• typeDefinitionsID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addTypeDefinitionsMemoryRemapDefinition(typeDefinitionsID, name)

Parameters:

• typeDefinitionsID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addTypeDefinitionsMode(typeDefinitionsID, name)

Parameters:

• typeDefinitionsID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addTypeDefinitionsRegisterDefinition(typeDefinitionsID, name)

Parameters:

• typeDefinitionsID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addTypeDefinitionsRegisterFileDefinition(typeDefinitionsID, name)

Parameters:

• typeDefinitionsID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addTypeDefinitionsResetType(typeDefinitionsID, name)

Parameters:

• typeDefinitionsID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addTypeDefinitionsView(typeDefinitionsID, name)

Parameters:

• typeDefinitionsID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addVendorExtensions(vendorExtensionsContainerElementID, vendorExtensions)

Parameters:

• vendorExtensionsContainerElementID (str)

• vendorExtensions (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addViewConfigurationConfigurableElementValue(viewConfigurationID, referenceID, expression)

Add a configurable element value to a designConfiguration.viewConfiguration.view.

Section: F.7.32.2.

The viewConfigurationID is expected to reference a DesignConfiguration.ViewConfiguration whose view child contains (or will contain) a configurableElementValues container. Only minimal structure is created; the view element itself must already exist.

Parameters:

• viewConfigurationID (str)

• referenceID (str)

• expression (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.addViewEnvIdentifier(viewID, value)

Parameters:

• viewID (str)

• value (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.createAbstractionDef(topElementID, name)

Create an Abstraction Definition (EXTENDED).

Raises:

TgiError – If the top element handle is invalid.

Parameters:

• topElementID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.createAbstractor(topElementID, name)

Create an Abstractor (EXTENDED).

Parameters:

• topElementID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.createBusDefinition(topElementID, name)

Create a Bus Definition (EXTENDED).

Parameters:

• topElementID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.createCatalog(topElementID, name)

Create a Catalog under a top element (EXTENDED).

Spec F.7.80.4: Adds a new catalog child to the given top element and returns its handle. Only the top-element scoped creation is supported here (root VLNV catalog creation is handled by the Creation category).

Parameters:

• topElementID (str) – Handle of the top element.

• name (str) – Catalog name.

Returns:

Handle of the newly created Catalog.

Raises:

TgiError – If the top element handle is invalid.

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.createComponent(topElementID, name)

Create a Component (EXTENDED).

Parameters:

• topElementID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.createDesign(topElementID, name)

Create a Design (EXTENDED).

Parameters:

• topElementID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.createDesignConfiguration(topElementID, name)

Create a Design Configuration (EXTENDED).

Parameters:

• topElementID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.createGeneratorChain(topElementID, name)

Create a Generator Chain (EXTENDED).

Parameters:

• topElementID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.createTypeDefinitions(topElementID, name)

Create a TypeDefinitions element (EXTENDED).

Parameters:

• topElementID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.edit(elementID, attribute, value)

Set an arbitrary attribute on a model element (EXTENDED).

Raises:

TgiError – If the element handle is invalid or the update fails.

Parameters:

• elementID (str)

• attribute (str)

• value (Any)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.end()

Terminate the active TGI administrative session.

Implements the End administrative command defined in section F.3.2. According to the specification this shall be the final message sent from the generator to the DE and conveys that the generator no longer requires the DE to listen for further TGI calls. The IEEE text also notes that a generator is not strictly required to terminate after sending End; therefore we model this as an idempotent state change.

Ordering rules enforced:

• init() must have been called successfully first; otherwise a

  TgiError is raised with INVALID_ARGUMENT.

• Multiple end() calls after the first succeed and simply

  return True (idempotent) so that defensive double-shutdown logic in callers does not produce faults.

Side effects:

• Marks the session as ended. Additional TGI calls that depend on

  an open session (currently only message) will raise.

Returns:

True when the session is (now or already) ended.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractionDefBusTypeRefByVLNV(abstractionDefinitionID)

Return busType VLNV tuple.

Section: F.7.2.1.

Parameters:

abstractionDefinitionID (str) – Handle to an abstractionDefinition (or instance) element.

Returns:

Tuple (vendor, library, name, version) with each item possibly None if the busType reference is absent.

Return type:

tuple[str | None, str | None, str | None, str | None]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractionDefChoiceIDs(abstractionDefinitionID)

Return handles of all choice children.

Section: F.7.2.2.

Parameters:

abstractionDefinitionID (str) – Handle to an abstractionDefinition element.

Returns:

List of choice element handles (empty if none defined).

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractionDefExtendsRefByVLNV(abstractionDefinitionID)

Return the extends VLNV tuple.

Section: F.7.2.3.

Parameters:

abstractionDefinitionID (str) – Handle to an abstractionDefinition element.

Returns:

Tuple (vendor, library, name, version) or all None if no extends present.

Return type:

tuple[str | None, str | None, str | None, str | None]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractionDefIDs(topElementID)

Return handles of Abstraction Definitions under a top element.

Tolerant BASE behavior: invalid topElementID returns [].

Parameters:

topElementID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractionDefPortIDs(abstractionDefinitionID)

Return handles of all logical ports.

Section: F.7.2.4.

Parameters:

abstractionDefinitionID (str) – Handle to an abstractionDefinition element.

Returns:

List of port handles (empty if no ports defined).

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractionDefPortLogicalName(abstractionDefPortID)

Return the logicalName of a port.

Section: F.7.2.5.

Parameters:

abstractionDefPortID (str) – Handle to an abstractionDefPort element.

Returns:

Logical name string or None if not present.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractionDefPortMatch(abstractionDefPortID)

Return the match flag of a port.

Section: F.7.2.6.

Parameters:

abstractionDefPortID (str) – Handle to an abstractionDefPort element.

Returns:

Boolean value or None if the element is absent.

Return type:

bool | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractionDefPortOnSystemIDs(abstractionDefPortID)

Return handles of transactional onSystem elements.

Section: F.7.2.7 (transactional port context).

Parameters:

abstractionDefPortID (str) – Handle to an abstractionDefPort element.

Returns:

List of onSystem handles (empty if none or port not transactional).

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractionDefPortPacketIDs(abstractionDefPortID)

Return handles of packet elements under the port.

Section: F.7.2.8.

Parameters:

abstractionDefPortID (str) – Handle to an abstractionDefPort element.

Returns:

List of packet handles (empty if none or not a packet style port).

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractionDefPortStyle(abstractionDefPortModeID)

Return the style of a port (wire, transactional, packet).

Section: F.7.2.9.

Parameters:

abstractionDefPortModeID (str) – Handle to an abstractionDefPort element.

Returns:

Style string or None if style cannot be determined.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractionDefPortTransactionalModeBusWidth(abstractionDefPortModeID)

Return transactional busWidth resolved value.

Section: F.7.2.10.

Parameters:

abstractionDefPortModeID (str) – Handle to a transactional abstractionDefPort element.

Returns:

Integer width or None if not specified / not transactional.

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractionDefPortTransactionalModeBusWidthExpression(abstractionDefPortModeID)

Return transactional busWidth expression.

Section: F.7.2.11.

Parameters:

abstractionDefPortModeID (str) – Handle to a transactional port element.

Returns:

Expression string or None if absent.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractionDefPortTransactionalModeBusWidthID(abstractionDefPortModeID)

Return handle to busWidth element.

Section: F.7.2.12.

Parameters:

abstractionDefPortModeID (str) – Handle to a transactional port element.

Returns:

Handle string or None if not present.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractionDefPortTransactionalModeInitiative(abstractionDefPortModeID)

Return initiative value across loci.

Section: F.7.2.13.

Parameters:

abstractionDefPortModeID (str) – Handle to a transactional port element.

Returns:

Initiative enumeration value or None.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractionDefPortTransactionalModeKindID(abstractionDefPortModeID)

Return handle to kind element.

Section: F.7.2.14.

Parameters:

abstractionDefPortModeID (str) – Handle to a transactional port element.

Returns:

Handle string or None if absent.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractionDefPortTransactionalModePresence(abstractionDefPortModeID)

Return presence value.

Section: F.7.2.15.

Parameters:

abstractionDefPortModeID (str) – Handle to a transactional port element.

Returns:

Presence enumeration value or None.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractionDefPortTransactionalModeProtocolID(abstractionDefPortModeID)

Return protocol handle.

Section: F.7.2.16.

Parameters:

abstractionDefPortModeID (str) – Handle to a transactional port element.

Returns:

Handle to protocol element or None.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractionDefPortTransactionalOnInitiatorID(abstractionDefPortID)

Return transactional onInitiator handle.

Section: F.7.2.17.

Parameters:

abstractionDefPortID (str) – Handle to a transactional port element.

Returns:

Handle string or None if absent.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractionDefPortTransactionalOnSystemIDs(abstractionDefPortID)

Return transactional onSystem handles.

Section: F.7.2.18.

Parameters:

abstractionDefPortID (str) – Handle to a transactional port element.

Returns:

List of handles (may be empty).

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractionDefPortTransactionalOnTargetID(abstractionDefPortID)

Return transactional onTarget handle.

Section: F.7.2.19.

Parameters:

abstractionDefPortID (str) – Handle to a transactional port element.

Returns:

Handle string or None.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractionDefPortTransactionalQualifierID(portID)

Return transactional qualifier handle.

Section: F.7.2.20.

Parameters:

portID (str) – Handle to a transactional port element.

Returns:

Handle string or None if absent.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractionDefPortWireDefaultValue(abstractionDefPortID)

Return wire defaultValue numeric value.

Section: F.7.2.21.

Parameters:

abstractionDefPortID (str) – Handle to a wire port element.

Returns:

Integer value or None if not present / not wire.

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractionDefPortWireDefaultValueExpression(abstractionDefPortID)

Return wire defaultValue expression.

Section: F.7.2.22.

Parameters:

abstractionDefPortID (str) – Handle to a wire port element.

Returns:

Expression string or None.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractionDefPortWireDefaultValueID(abstractionDefPortModeID)

Return handle to wire defaultValue element.

Section: F.7.2.23.

Parameters:

abstractionDefPortModeID (str) – Handle to a wire port element.

Returns:

Handle string or None if absent.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractionDefPortWireModeDirection(abstractionDefPortModeID)

Return wire direction.

Section: F.7.2.24.

Parameters:

abstractionDefPortModeID (str) – Handle to a wire port element.

Returns:

Direction enumeration or None.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractionDefPortWireModeMirroredModeConstraintsID(abstractionDefPortModeID)

Return handle to mirroredModeConstraints.

Section: F.7.2.25.

Parameters:

abstractionDefPortModeID (str) – Handle to a wire port element.

Returns:

Handle string or None if absent.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractionDefPortWireModeModeConstraintsID(abstractionDefPortModeID)

Return handle to modeConstraints.

Section: F.7.2.26.

Parameters:

abstractionDefPortModeID (str) – Handle to a wire port element.

Returns:

Handle string or None if not present.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractionDefPortWireModePresence(abstractionDefPortModeID)

Return wire presence enumeration.

Section: F.7.2.27.

Parameters:

abstractionDefPortModeID (str) – Handle to a wire port element.

Returns:

Presence value string or None.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractionDefPortWireModeWidth(abstractionDefPortModeID)

Return wire width numeric value.

Section: F.7.2.28.

Parameters:

abstractionDefPortModeID (str) – Handle to a wire port element.

Returns:

Integer width or None.

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractionDefPortWireModeWidthExpression(abstractionDefPortModeID)

Return wire width expression.

Section: F.7.2.29.

Parameters:

abstractionDefPortModeID (str) – Handle to a wire port element.

Returns:

Expression string or None.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractionDefPortWireModeWidthID(abstractionDefPortModeID)

Return handle of wire width element.

Section: F.7.2.30.

Parameters:

abstractionDefPortModeID (str) – Handle to a wire port element.

Returns:

Handle string or None if absent.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractionDefPortWireOnInitiatorID(abstractionDefPortID)

F.7.2.31 Return handle to the wire onInitiator element.

Parameters:

abstractionDefPortID (str) – Handle to a logical wire port element.

Returns:

Handle to the onInitiator element or None if absent / not wire style.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractionDefPortWireOnSystemIDs(portID)

F.7.2.32 Return handles to all wire onSystem elements.

Parameters:

portID (str) – Handle to a logical wire port element.

Returns:

List of onSystem element handles (may be empty).

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractionDefPortWireOnTargetID(abstractionDefPortID)

F.7.2.33 Return handle to the wire onTarget element.

Parameters:

abstractionDefPortID (str) – Handle to a logical wire port element.

Returns:

Handle to onTarget element or None if absent / not wire style.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractionDefPortWireQualifierID(portID)

F.7.2.34 Return handle to wire qualifier element.

Parameters:

portID (str) – Handle to a logical wire port element.

Returns:

Qualifier element handle or None if absent.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractionDefPortWireRequiresDriver(abstractionDefPortID)

Return wire requiresDriver boolean value.

Section: F.7.2.35.

Parameters:

abstractionDefPortID (str) – Handle to a wire style abstractionDefPort element.

Returns:

Boolean value if the requiresDriver element is present, otherwise None if absent or the port is not wire style.

Return type:

bool | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractionDefPortWireRequiresDriverID(abstractionDefPortModeID)

Return handle of wire requiresDriver element.

Section: F.7.2.36.

Parameters:

abstractionDefPortModeID (str) – Handle to a wire style abstractionDefPort element.

Returns:

Handle string if the requiresDriver element exists, otherwise None if absent or not a wire style port.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractionTypeAbstractionRefID(abstractionTypeID)

Return handle of abstractionRef inside an abstractionType.

Section: F.7.55.1. Returns None if absent.

Parameters:

abstractionTypeID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractorAbstractorGeneratorIDs(abstractorID)

Return handles of all abstractorGenerator children.

Section: F.7.4.1.

Parameters:

abstractorID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractorAbstractorInterfaceIDs(abstractorID)

Return handles of the exactly two abstractorInterface elements.

Section: F.7.4.2.

Parameters:

abstractorID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractorAbstractorMode(abstractorID)

Return (modeValue, group) for the abstractorMode element.

Section: F.7.4.3. Returns (None, None) if not present.

Parameters:

abstractorID (str)

Return type:

tuple[str | None, str | None]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractorAbstractorModeID(abstractorID)

Return handle of the abstractorMode element.

Section: F.7.4.4. Returns None if absent.

Parameters:

abstractorID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractorBusTypeRefByVLNV(abstractorID)

Return busType VLNV reference.

Section: F.7.4.5.

Parameters:

abstractorID (str)

Return type:

tuple[str | None, str | None, str | None, str | None]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractorChoiceIDs(abstractorID)

Return handles of choice children.

Section: F.7.4.6.

Parameters:

abstractorID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractorComponentInstantiationIDs(abstractorID)

Return handles of componentInstantiation elements in model.instantiations.

Section: F.7.4.7.

Parameters:

abstractorID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractorFileSetIDs(abstractorID)

Return handles of fileSet children.

Section: F.7.4.8.

Parameters:

abstractorID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractorGeneratorGroup(abstractorGeneratorID)

Return the first group value of an AbstractorGenerator.

Section: F.7.49.1. If no group elements exist, returns None.

Parameters:

abstractorGeneratorID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractorGeneratorGroupIDs(abstractorGeneratorID)

Return handles of all group elements of an AbstractorGenerator.

Section: F.7.49.2.

Parameters:

abstractorGeneratorID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractorIDs(topElementID)

Return handles of Abstractors under a top element (BASE).

Parameters:

topElementID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractorInstanceAbstractorRefByID(abstractorInstanceID)

Return handle of the abstractorRef element of an abstractorInstance.

Section: F.7.39.1. Returns None if not present (schema requires it though).

Parameters:

abstractorInstanceID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractorInstanceAbstractorRefByVLNV(abstractorInstanceID)

Return (vendor, library, name, version) of the abstractorRef.

Section: F.7.39.2.

Parameters:

abstractorInstanceID (str)

Return type:

tuple[str | None, str | None, str | None, str | None]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractorInstanceAbstractorRefID(abstractorInstanceID)

Return handle of the abstractorRef of an abstractorInstance.

Section: F.7.55.2.

Parameters:

abstractorInstanceID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractorInstanceInstanceName(abstractorInstanceID)

Return instanceName of an abstractorInstance.

Section: F.7.39.3.

Parameters:

abstractorInstanceID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractorInstanceViewName(abstractorInstanceID)

Return viewName of an abstractorInstance.

Section: F.7.39.4.

Parameters:

abstractorInstanceID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractorInstancesAbstractorInstanceIDs(abstractorInstancesID)

Return handles of abstractorInstance children within an abstractorInstances container.

Section: F.7.39.5.

Parameters:

abstractorInstancesID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractorInstancesInterfaceRefIDs(abstractorInstancesID)

Return handles of interfaceRef elements under an abstractorInstances.

Section: F.7.39.6.

Parameters:

abstractorInstancesID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractorInterfaceAbstractionTypeIDs(abstractorID)

Return handles of abstractionType elements of both abstractorInterfaces.

Section: F.7.4.9.

Parameters:

abstractorID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractorPortIDs(abstractorID)

Return handles of all abstractor model ports.

Section: F.7.4.10.

Parameters:

abstractorID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAbstractorViewIDs(abstractorID)

Return handles of view elements in model.views.

Section: F.7.4.11.

Parameters:

abstractorID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAccessHandleForce(accessHandleID)

Return the force attribute of a port/sliced handle.

Section: F.7.7.1.

Parameters:

accessHandleID (str) – Handle of a portAccessHandle or slicedAccessHandle.

Returns:

Boolean force value or None if the handle is simpleAccessHandle (which lacks the attribute) or the attribute is absent.

Return type:

bool | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAccessHandleIDs(parentID)

Return handles of accessHandle children of a parent.

Section: F.7.7.2.

Parameters:

parentID (str) – Handle to an element that may own an accessHandles container.

Returns:

List of accessHandle handles (possibly empty).

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAccessHandleIndicesIDs(accessHandleID)

Return index element handles of a portAccessHandle.

Section: F.7.7.3.

Parameters:

accessHandleID (str) – Handle referencing a portAccessHandle.

Returns:

List of index element handles (empty when none / wrong type).

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAccessHandlePathSegmentIDs(accessHandleID)

Return pathSegment handles of a simpleAccessHandle.

Section: F.7.7.4.

Parameters:

accessHandleID (str) – Handle referencing a simpleAccessHandle.

Returns:

List of pathSegment handles (empty when none / different type).

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAccessHandleSliceIDs(accessHandleID)

Return slice handles of a portAccessHandle or slicedAccessHandle.

Section: F.7.7.5.

Parameters:

accessHandleID (str) – Handle referencing a slicedAccessHandle or portAccessHandle.

Returns:

List of slice handles (empty when none or unsupported type).

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAccessHandleViewRefIDs(accessHandleID)

Return viewRef handles for any accessHandle variant.

Section: F.7.7.6.

Parameters:

accessHandleID (str) – Handle referencing a simple/sliced/port accessHandle.

Returns:

List of viewRef handles (empty if none / invalid type).

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAccessPolicyAccess(accessPolicyID)

Section: F.7.9.1 Return access value of an accessPolicy.

Parameters:

accessPolicyID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAccessPolicyModeRefByID(accessPolicyID, modeRef)

Section: F.7.9.2 Return handle of named modeRef in accessPolicy.

Parameters:

• accessPolicyID (str)

• modeRef (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAccessPolicyModeRefByNames(accessPolicyID)

Section: F.7.9.3 Return list of modeRef names in accessPolicy.

Parameters:

accessPolicyID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAccessPolicyModeRefIDs(accessPolicyID)

Section: F.7.9.4 Return handles of modeRef elements in accessPolicy.

Parameters:

accessPolicyID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAccessPortAccessType(portID)

Return the access type (wire/transactional/structured) of the port.

Section: F.7.67.1. Returns one of “wire”, “transactional”, “structured” or None.

Parameters:

portID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAccessRestrictionModeRefIDs(accessRestrictionID)

Section: F.7.9.5 Return modeRef handles of an accessRestriction.

Parameters:

accessRestrictionID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAccessRestrictionModeRefbyID(accessRestrictionID, modeRef)

Section: F.7.9.6 Return handle of named modeRef in accessRestriction.

Parameters:

• accessRestrictionID (str)

• modeRef (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAccessRestrictionModeRefbyNames(accessRestrictionID)

Section: F.7.9.7 Return list of modeRef names in accessRestriction.

Parameters:

accessRestrictionID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAccessRestrictionReadAccessMask(accessRestrictionID)

Section: F.7.9.8 Return numeric readAccessMask value (if simple expression).

Parameters:

accessRestrictionID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAccessRestrictionReadAccessMaskExpression(accessRestrictionID)

Section: F.7.9.9 Return readAccessMask expression string.

Parameters:

accessRestrictionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAccessRestrictionReadAccessMaskID(accessRestrictionID)

Section: F.7.9.10 Return handle of readAccessMask element.

Parameters:

accessRestrictionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAccessRestrictionWriteAccessMask(accessRestrictionID)

Section: F.7.9.11 Return numeric writeAccessMask value.

Parameters:

accessRestrictionID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAccessRestrictionWriteAccessMaskExpression(accessRestrictionID)

Section: F.7.9.12 Return writeAccessMask expression string.

Parameters:

accessRestrictionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAccessRestrictionWriteAccessMaskID(accessRestrictionID)

Section: F.7.9.13 Return handle of writeAccessMask element.

Parameters:

accessRestrictionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getActiveinterfaceExcludePortIDs(activeInterfaceID)

Return handles of excludePort elements of an activeInterface.

Section: F.7.37.1.

Parameters:

activeInterfaceID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAdHocConnectionExternalPortReferenceIDs(adHocConnectionID)

Return handles of externalPortReference children.

Section: F.7.37.2.

Parameters:

adHocConnectionID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAdHocConnectionInternalPortReferenceIDs(adHocConnectionID)

Return handles of internalPortReference children.

Section: F.7.37.3.

Parameters:

adHocConnectionID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAdHocConnectionTiedValue(adHocConnectionID)

Return tiedValue value if present.

Section: F.7.37.4.

Parameters:

adHocConnectionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAdHocConnectionTiedValueExpression(adHocConnectionID)

Return tiedValue expression string.

Section: F.7.37.5.

Parameters:

adHocConnectionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAdHocConnectionTiedValueID(adHocConnectionID)

Return handle of tiedValue element.

Section: F.7.37.6.

Parameters:

adHocConnectionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAddressBlockDefinitionAddressUnitBits(addressBlockDefinitionID)

Parameters:

addressBlockDefinitionID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAddressBlockDefinitionAddressUnitBitsExpression(addressBlockDefinitionID)

Parameters:

addressBlockDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAddressBlockDefinitionAddressUnitBitsID(addressBlockDefinitionID)

Parameters:

addressBlockDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAddressBlockRefAttribute(elementID, *, _attr='addressBlockRef', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAddressBlockRefAttributeByID(elementID, *, _attr='addressBlockRef', _rtype='ref', _kind='ref')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAddressSpaceAddressUnitBits(addressSpaceID)

Get the evaluated integer value of addressUnitBits.

Section: F.7.11.1.

Parameters:

addressSpaceID (str) – Handle referencing an addressSpace element.

Returns:

Evaluated numeric value, or None when the element is absent or not numerically evaluable.

Return type:

int | None

Raises:

TgiError – If addressSpaceID is invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAddressSpaceAddressUnitBitsExpression(addressSpaceID)

Get the (string) expression of addressUnitBits.

Section: F.7.11.2.

Parameters:

addressSpaceID (str) – Handle of the parent addressSpace.

Returns:

Original expression string (not evaluated) or None if absent.

Return type:

str | None

Raises:

TgiError – If addressSpaceID is invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAddressSpaceAddressUnitBitsID(addressSpaceID)

Get the handle of the addressUnitBits element.

Section: F.7.11.3.

Parameters:

addressSpaceID (str) – Handle referencing an addressSpace.

Returns:

Child handle or None if element absent.

Return type:

str | None

Raises:

TgiError – If the parent handle is invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAddressSpaceLocalMemoryMapID(addressSpaceID)

Get the handle of the localMemoryMap element.

Section: F.7.11.4.

Parameters:

addressSpaceID (str) – Handle referencing an addressSpace.

Returns:

Handle of the localMemoryMap child or None if absent.

Return type:

str | None

Raises:

TgiError – If the parent handle is invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAddressSpaceRange(addressSpaceID)

Get evaluated numeric value of range.

Section: F.7.11.5.

Parameters:

addressSpaceID (str) – Handle of the addressSpace.

Returns:

Numeric value or None if absent or not evaluable.

Return type:

int | None

Raises:

TgiError – If the addressSpace handle is invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAddressSpaceRangeExpression(addressSpaceID)

Get expression string for range.

Section: F.7.11.6.

Parameters:

addressSpaceID (str) – Address space handle.

Returns:

Expression or None if absent.

Return type:

str | None

Raises:

TgiError – If handle invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAddressSpaceRangeID(addressSpaceID)

Get handle of the range element.

Section: F.7.11.7.

Parameters:

addressSpaceID (str) – Handle referencing an addressSpace.

Returns:

Child handle or None when absent.

Return type:

str | None

Raises:

TgiError – If parent handle invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAddressSpaceRefAttribute(elementID, *, _attr='addressSpaceRef', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAddressSpaceRefAttributeByID(elementID, *, _attr='addressSpaceRef', _rtype='ref', _kind='ref')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAddressSpaceSegmentIDs(addressSpaceID)

List handles of segment children.

Section: F.7.11.8.

Parameters:

addressSpaceID (str) – Address space handle.

Returns:

List (possibly empty) of segment handles.

Return type:

list[str]

Raises:

TgiError – If parent handle invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAddressSpaceWidth(addressSpaceID)

Get evaluated numeric width value.

Section: F.7.11.9.

Parameters:

addressSpaceID (str) – Address space handle.

Returns:

Numeric width or None if absent or not evaluable.

Return type:

int | None

Raises:

TgiError – If handle invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAddressSpaceWidthExpression(addressSpaceID)

Get expression string for width.

Section: F.7.11.10.

Parameters:

addressSpaceID (str) – Address space handle.

Returns:

Expression or None when absent.

Return type:

str | None

Raises:

TgiError – If handle invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAddressSpaceWidthID(addressSpaceID)

Get handle of the width element.

Section: F.7.11.11.

Parameters:

addressSpaceID (str) – Address space handle.

Returns:

Child handle or None if absent.

Return type:

str | None

Raises:

TgiError – If parent handle invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAliasOfAddressSpaceRefByName(addressSpaceID)

Get the name of the referenced addressSpace when this one is an alias.

Section: F.7.11.12.

Note

The 2022 generated schema currently exposes no aliasOf element for addressSpace; this function therefore returns None (stub).

Parameters:

addressSpaceID (str) – Address space handle (validated for existence only).

Returns:

Referenced addressSpace name or None (schema gap).

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAliasOfAddressSpaceRefID(addressSpaceID)

Get the handle of the alias reference element.

Section: F.7.11.13.

Note

Not present in current schema; always returns None (stub).

Parameters:

addressSpaceID (str) – Address space handle (validated for existence).

Returns:

Always None until schema models aliasOf.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAliasOfAlternateRegisterRefByName(aliasOfID)

Return alternateRegisterRef value (F.7.73.1).

Parameters:

aliasOfID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAliasOfAlternateRegisterRefID(aliasOfID)

Return handle of alternateRegisterRef (F.7.73.2).

Parameters:

aliasOfID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAliasOfFieldRefByName(aliasOfID)

Return fieldRef value (F.7.73.3).

Parameters:

aliasOfID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAliasOfFieldRefID(aliasOfID)

Return handle of fieldRef (F.7.73.4).

Parameters:

aliasOfID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAliasOfRegisterFileRefByNames(registerFileID, vendor, library, name, version)

Return handle of aliasOf registerFile reference matching VLNV names.

Section: F.7.75.1. Returns None if not found or handle invalid.

Parameters:

• registerFileID (str)

• vendor (str)

• library (str)

• name (str)

• version (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAliasOfRegisterFileRefIDs(registerFileID)

Return list of aliasOf register file reference handles (0 or 1). F.7.75.2.

Parameters:

registerFileID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAliasOfRegisterRefByName(aliasOfID)

Return registerRef value (F.7.73.5).

Parameters:

aliasOfID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAliasOfRegisterRefID(aliasOfID)

Return handle of registerRef (F.7.73.6).

Parameters:

aliasOfID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAllBitsBooleanAttribute(elementID, *, _attr='allBits', _rtype='bool', _kind='bool')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAllLogicalDirectionsAllowedBooleanAttribute(elementID, *, _attr='allLogicalDirectionsAllowed', _rtype='bool', _kind='bool')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAllLogicalInitiativesAllowedBooleanAttribute(elementID, *, _attr='allLogicalInitiativesAllowed', _rtype='bool', _kind='bool')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAlternateRegisterAccessPolicyIDs(alternateRegisterID)

Section: F.7.9.14 Return accessPolicy handles of an alternateRegister.

Parameters:

alternateRegisterID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAlternateRegisterFieldIDs(alternateRegisterID)

Return field handles of alternateRegister (F.7.73.7).

Parameters:

alternateRegisterID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAlternateRegisterModeRefIDs(alternateRegisterID)

Return modeRef handles (F.7.73.8).

Parameters:

alternateRegisterID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAlternateRegisterRefAlternateRegisterRefByName(alternateRegisterRefID)

Return alternateRegisterRef value (F.7.73.9).

Parameters:

alternateRegisterRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAlternateRegisterRefAttribute(elementID, *, _attr='alternateRegisterRef', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAlternateRegisterRefAttributeByID(elementID, *, _attr='alternateRegisterRef', _rtype='ref', _kind='ref')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAlternateRegisterTypeIdentifier(alternateRegisterID)

Return typeIdentifier value (F.7.73.10).

Parameters:

alternateRegisterID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAlternateRegisterVolatility(alternateRegisterID)

Return volatility boolean (F.7.73.11).

Parameters:

alternateRegisterID (str)

Return type:

bool | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAppendBooleanAttribute(elementID, *, _attr='append', _rtype='bool', _kind='bool')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getArgumentValue(argumentID)

Return argument value (simple numeric str/int) or None.

Section: F.7.59.1.

Parameters:

argumentID (str)

Return type:

int | str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getArgumentValueExpression(argumentID)

Return associated expression string for an argument if present.

Section: F.7.59.2.

Parameters:

argumentID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getArgumentValueID(argumentID)

Return handle to the value element (argument itself).

Section: F.7.59.3.

Parameters:

argumentID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getArrayDimIDs(arrayID)

List handles of dimension (dim) elements.

Section: F.7.13.1.

Parameters:

arrayID (str) – Handle referencing an array container.

Returns:

Handles (possibly empty) of dim elements.

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getArrayIDs(parentID)

Return handles of child array containers under a parent.

Section: F.7.13.2.

The spec enumerates retrieval of arrays contained in a parent object. We treat any attributes named array or arrays (list) as array containers. Missing attributes produce an empty list.

Parameters:

parentID (str) – Parent handle (any object).

Returns:

Handles of arrays (empty if none).

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getArrayIdAttribute(elementID, *, _attr='arrayId', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getArrayLeftID(arrayID)

Return handle of left bound element if present.

Section: F.7.13.3.

Parameters:

arrayID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getArrayRange(arrayID)

Return numeric range value.

Section: F.7.13.4.

Parameters:

arrayID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getArrayRangeExpression(arrayID)

Return range expression string.

Section: F.7.13.5.

Parameters:

arrayID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getArrayRightID(arrayID)

Return handle of right bound element if present.

Section: F.7.13.6.

Parameters:

arrayID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getArrayStride(arrayID)

Return numeric stride value (bit/part stride).

Section: F.7.13.7.

Parameters:

arrayID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getArrayStrideExpression(arrayID)

Return stride expression string.

Section: F.7.13.8.

Parameters:

arrayID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getArrayStrideID(arrayID)

Return handle of stride element.

Section: F.7.13.9.

Parameters:

arrayID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAssertionDescription(assertionID)

Return description value.

Section: F.7.15.5.

Parameters:

assertionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAssertionDisplayName(assertionID)

Return displayName value.

Section: F.7.15.3.

Parameters:

assertionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAssertionExpression(assertionID)

Return the assert expression string value.

Section: F.7.15.6. Maps to assert_value.value in the schema.

Parameters:

assertionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAssertionExpressionID(assertionID)

Return handle of the underlying expression object.

Section: F.7.15.7.

Parameters:

assertionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAssertionIDs(parentID)

Return handles of assertion children under a parent.

Section: F.7.15.1.

Parameters:

parentID (str) – Handle referencing any object which MAY own an assertions container.

Returns:

Handles (possibly empty) of assertion elements.

Return type:

list[str]

Raises:

TgiError – If the parent handle is invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAssertionName(assertionID)

Return the assertion name.

Section: F.7.15.2.

Parameters:

assertionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getAssertionShortDescription(assertionID)

Return shortDescription value.

Section: F.7.15.4.

Parameters:

assertionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBankAccessPoliciesIDs(bankID)

Section: F.7.9.15 Return accessPolicy handles of a bank.

Parameters:

bankID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBankAlignmentAttribute(elementID, *, _attr='bankAlignment', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBankDefinitionAddressUnitBits(bankDefinitionID)

Parameters:

bankDefinitionID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBankDefinitionAddressUnitBitsExpression(bankDefinitionID)

Parameters:

bankDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBankDefinitionAddressUnitBitsID(bankDefinitionID)

Parameters:

bankDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBankRefAttribute(elementID, *, _attr='bankRef', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBankRefAttributeByID(elementID, *, _attr='bankRef', _rtype='ref', _kind='ref')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBooleanValue(booleanID)

Return boolean simple content value.

Section: F.7.59.4.

Parameters:

booleanID (str)

Return type:

bool | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBroadcastToAddressBlockRefByName(broadcastToID)

Return addressBlockRef value (F.7.73.12).

Parameters:

broadcastToID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBroadcastToAddressBlockRefID(broadcastToID)

Return handle of addressBlockRef (F.7.73.13).

Parameters:

broadcastToID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBroadcastToAddressSpaceRefByName(broadcastToID)

Return addressSpaceRef value (F.7.73.14).

Parameters:

broadcastToID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBroadcastToAddressSpaceRefID(broadcastToID)

Return handle of addressSpaceRef (F.7.73.15).

Parameters:

broadcastToID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBroadcastToAlternateRegisterRefByName(broadcastToID)

Return alternateRegisterRef value (F.7.73.16).

Parameters:

broadcastToID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBroadcastToAlternateRegisterRefID(broadcastToID)

Return handle of alternateRegisterRef (F.7.73.17).

Parameters:

broadcastToID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBroadcastToBankRefByNames(broadcastToID)

Return list of bankRef values (F.7.73.18).

Parameters:

broadcastToID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBroadcastToBankRefIDs(broadcastToID)

Return handles of bankRef elements (F.7.73.19).

Parameters:

broadcastToID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBroadcastToFieldRefByName(broadcastToID)

Return fieldRef value (F.7.73.20).

Parameters:

broadcastToID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBroadcastToFieldRefID(broadcastToID)

Return handle of fieldRef (F.7.73.21).

Parameters:

broadcastToID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBroadcastToMemoryMapRefByName(broadcastToID)

Return memoryMapRef value (F.7.73.22).

Parameters:

broadcastToID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBroadcastToMemoryMapRefID(broadcastToID)

Return handle of memoryMapRef (F.7.73.23).

Parameters:

broadcastToID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBroadcastToRegisterFileRefByNames(broadcastToID)

Return registerFileRef names (F.7.73.24).

Parameters:

broadcastToID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBroadcastToRegisterFileRefIDs(broadcastToID)

Return handles of registerFileRef elements (F.7.73.25).

Parameters:

broadcastToID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBroadcastToRegisterRefByName(broadcastToID)

Return registerRef value (F.7.73.26).

Parameters:

broadcastToID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBroadcastToRegisterRefID(broadcastToID)

Return handle of registerRef (F.7.73.27).

Parameters:

broadcastToID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBuildCommandCommand(fileID)

Return textual build command value.

Section: F.7.45.1.

Parameters:

fileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBuildCommandCommandExpression(fileID)

Return expression (if any) for build command.

Section: F.7.45.2.

Parameters:

fileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBuildCommandCommandID(fileID)

Return handle of build command value element.

Section: F.7.45.3.

Parameters:

fileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBuildCommandFlags(fileID)

Return textual flags value.

Section: F.7.45.4.

Parameters:

fileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBuildCommandFlagsExpression(fileID)

Return expression (if any) for flags.

Section: F.7.45.5.

Parameters:

fileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBuildCommandFlagsID(fileID)

Return handle of flags element.

Section: F.7.45.6.

Parameters:

fileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBuildCommandReplaceDefaultFlags(fileID)

Return boolean value of replaceDefaultFlags (converted to bool).

Section: F.7.45.7.

Parameters:

fileID (str)

Return type:

bool | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBuildCommandReplaceDefaultFlagsExpression(fileID)

Return replaceDefaultFlags expression (Section: F.7.47.1).

Parameters:

fileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBuildCommandReplaceDefaultFlagsID(fileID)

Return handle of replaceDefaultFlags element.

Section: F.7.45.8.

Parameters:

fileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBuildCommandTargetName(fileID)

Return targetName value (derived file path).

Section: F.7.45.9.

Parameters:

fileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBuildCommandTargetNameExpression(fileID)

Return expression for targetName.

Section: F.7.45.10.

Parameters:

fileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBusDefIDs(topElementID)

Return handles of Bus Definitions (BASE).

Parameters:

topElementID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBusDefinitionAssertionIDs(busDefinitionID)

Return handles of assertion children (if any).

Parameters:

busDefinitionID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBusDefinitionBroadcast(busDefinitionID)

Return boolean broadcast flag.

Parameters:

busDefinitionID (str)

Return type:

bool | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBusDefinitionChoiceIDs(busDefinitionID)

Return handles of choice children (if any).

Parameters:

busDefinitionID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBusDefinitionDescription(busDefinitionID)

Return description value.

Parameters:

busDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBusDefinitionDirectConnection(busDefinitionID)

Return boolean directConnection flag.

Parameters:

busDefinitionID (str)

Return type:

bool | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBusDefinitionDisplayName(busDefinitionID)

Return displayName value.

Parameters:

busDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBusDefinitionExtendsLibrary(busDefinitionID)

Parameters:

busDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBusDefinitionExtendsName(busDefinitionID)

Parameters:

busDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBusDefinitionExtendsVLNV(busDefinitionID)

Return concatenated VLNV string for extends (vendor:library:name:version).

Parameters:

busDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBusDefinitionExtendsVendor(busDefinitionID)

Parameters:

busDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBusDefinitionExtendsVersion(busDefinitionID)

Parameters:

busDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBusDefinitionIsAddressable(busDefinitionID)

Return boolean isAddressable flag.

Parameters:

busDefinitionID (str)

Return type:

bool | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBusDefinitionLibrary(busDefinitionID)

Return library value.

Parameters:

busDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBusDefinitionMaxInitiators(busDefinitionID)

Return integer value of maxInitiators if convertible.

Parameters:

busDefinitionID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBusDefinitionMaxInitiatorsExpression(busDefinitionID)

Return expression string for maxInitiators.

Parameters:

busDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBusDefinitionMaxInitiatorsID(busDefinitionID)

Parameters:

busDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBusDefinitionMaxTargets(busDefinitionID)

Return integer value of maxTargets if convertible.

Parameters:

busDefinitionID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBusDefinitionMaxTargetsExpression(busDefinitionID)

Return expression string for maxTargets.

Parameters:

busDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBusDefinitionMaxTargetsID(busDefinitionID)

Parameters:

busDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBusDefinitionName(busDefinitionID)

Return name value.

Parameters:

busDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBusDefinitionParameterIDs(busDefinitionID)

Return handles of parameter children (if any).

Parameters:

busDefinitionID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBusDefinitionShortDescription(busDefinitionID)

Return shortDescription value.

Parameters:

busDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBusDefinitionSystemGroupNameIDs(busDefinitionID)

Return handles of systemGroupName elements.

Parameters:

busDefinitionID (str) – Bus definition handle.

Returns:

Handles (possibly empty) of system group names.

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBusDefinitionSystemGroupNameValue(systemGroupNameID)

Return the value of a systemGroupName element.

Parameters:

systemGroupNameID (str) – Handle of a systemGroupName element.

Returns:

String value.

Return type:

str | None

Raises:

TgiError – If the handle is invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBusDefinitionVendor(busDefinitionID)

Return vendor value.

Parameters:

busDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBusDefinitionVersion(busDefinitionID)

Return version value.

Parameters:

busDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBusInterfaceAbstractionTypeBusTypeViewRefsByVLNV(busInterfaceID)

Return list of abstractionType view VLNV tuples.

The 2022 schema models viewRef as name only; vendor/library/version will normally be None.

Parameters:

busInterfaceID (str)

Return type:

list[tuple[str | None, str | None, str | None, str | None]]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBusInterfaceBusTypeRefByVLNV(busInterfaceID)

Return the busType VLNV tuple (vendor, library, name, version).

Returns a tuple of Nones if the reference is absent.

Parameters:

busInterfaceID (str)

Return type:

tuple[str | None, str | None, str | None, str | None]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBusInterfaceConnectionRequired(busInterfaceID)

Return connectionRequired attribute value (or None).

Parameters:

busInterfaceID (str)

Return type:

bool | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBusInterfaceDescription(busInterfaceID)

Return description value.

Parameters:

busInterfaceID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBusInterfaceDisplayName(busInterfaceID)

Return displayName value.

Parameters:

busInterfaceID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBusInterfaceName(busInterfaceID)

Return the busInterface name attribute.

Parameters:

busInterfaceID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBusRefAttribute(elementID, *, _attr='busRef', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getBusRefAttributeByID(elementID, *, _attr='busRef', _rtype='ref', _kind='ref')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getCatalogAbstractionDefIpxactFileIDs(catalog)

Return handles of abstractionDefinition ipxactFile entries.

Parameters:

catalog (Catalog)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getCatalogAbstractorsIpxactFileIDs(catalog)

Return handles of abstractors ipxactFile entries.

Parameters:

catalog (Catalog)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getCatalogBusDefinitionsIpxactFileIDs(catalog)

Return handles of busDefinitions ipxactFile entries.

Parameters:

catalog (Catalog)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getCatalogCatalogsIpxactFileIDs(catalog)

Return handles of catalogs ipxactFile entries.

Parameters:

catalog (Catalog)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getCatalogComponentsIpxactFileIDs(catalog)

Return handles of components ipxactFile entries.

Parameters:

catalog (Catalog)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getCatalogDesignConfigurationsIpxactFileIDs(catalog)

Return handles of designConfigurations ipxactFile entries.

Parameters:

catalog (Catalog)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getCatalogDesignsIpxactFileIDs(catalog)

Return handles of designs ipxactFile entries.

Parameters:

catalog (Catalog)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getCatalogGeneratorChainsIpxactFileIDs(catalog)

Return handles of generatorChains ipxactFile entries.

Parameters:

catalog (Catalog)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getCatalogIDs(*args, **kwargs)

Hybrid traversal.

Dev-phase convenience: with no arguments enumerate globally registered root Catalog handles. With an argument delegate to the spec-conformant top-element scoped enumeration.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getCatalogTypeDefinitionsIpxactFileIDs(catalog)

Return handles of typeDefinitions ipxactFile entries.

Parameters:

catalog (Catalog)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getCellSpecificationCellClass(cellSpecificationID)

Return the cellClass enumeration value of a cellSpecification.

Section: F.7.33.1.

Parameters:

cellSpecificationID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getCellSpecificationCellFunction(cellSpecificationID)

Return the cellFunction enumeration value of a cellSpecification.

Section: F.7.33.2.

Parameters:

cellSpecificationID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getCellSpecificationCellFunctionID(cellSpecificationID)

Return handle of the cellFunction element of a cellSpecification.

Section: F.7.33.3.

Parameters:

cellSpecificationID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getCellStrengthAttribute(elementID, *, _attr='cellStrength', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getChoiceEnumerationIDs(choiceID)

Return handles to all choiceEnumeration elements of a choice.

Section: F.7.25.1

Parameters:

choiceID (str) – Handle to a Choices.Choice element.

Returns:

List of handles to Choices.Choice.Enumeration elements.

Raises:

TgiError – If the handle is invalid.

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getChoiceRefAttribute(elementID, *, _attr='choiceRef', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getChoiceRefAttributeByID(elementID, *, _attr='choiceRef', _rtype='ref', _kind='ref')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getClearboxElementClearboxType(clearboxElementID)

Return the clearboxType value for a clearboxElement.

Section: F.7.27.1

Parameters:

clearboxElementID (str) – Handle to a clearboxElement element.

Returns:

The clearboxType enumeration value as string, or None if not set.

Raises:

TgiError – If the handle is invalid.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getClearboxElementDriveable(clearboxElementID)

Return the driveable value for a clearboxElement.

Section: F.7.27.2

Parameters:

clearboxElementID (str) – Handle to a clearboxElement element.

Returns:

Boolean driveable value or None if not present.

Raises:

TgiError – If the handle is invalid.

Return type:

bool | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getClearboxElementRefByID(clearboxElementRefID)

Return handle to the clearboxElement referenced by a clearboxElementRef.

Section: F.7.27.3

Parameters:

clearboxElementRefID (str) – Handle to a clearboxElementRef element.

Returns:

Handle to referenced clearboxElement or None if resolution fails.

Raises:

TgiError – If the ref handle is invalid.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getClearboxElementRefLocationIDs(clearboxElementRefID)

Return handles to all clearboxElementRefLocation elements.

Section: F.7.27.4

Parameters:

clearboxElementRefID (str) – Handle to a clearboxElementRef element.

Returns:

List of handles for each clearboxElementRefLocation.

Raises:

TgiError – If the ref handle is invalid.

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getClockDriverClockPeriod(clockDriverID)

Return numeric value of clockPeriod.

Section: F.7.41.1.

Parameters:

clockDriverID (str)

Return type:

float | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getClockDriverClockPeriodExpression(clockDriverID)

Return expression string of clockPeriod if present.

Section: F.7.41.2.

Parameters:

clockDriverID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getClockDriverClockPeriodID(clockDriverID)

Return handle of clockPeriod element.

Section: F.7.41.3.

Parameters:

clockDriverID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getClockDriverClockPulseDuration(clockDriverID)

Return numeric value of clockPulseDuration.

Section: F.7.41.4.

Parameters:

clockDriverID (str)

Return type:

float | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getClockDriverClockPulseDurationExpression(clockDriverID)

Return expression for clockPulseDuration.

Section: F.7.41.5.

Parameters:

clockDriverID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getClockDriverClockPulseDurationID(clockDriverID)

Return handle of clockPulseDuration.

Section: F.7.41.6.

Parameters:

clockDriverID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getClockDriverClockPulseOffset(clockDriverID)

Return numeric value of clockPulseOffset.

Section: F.7.41.7.

Parameters:

clockDriverID (str)

Return type:

float | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getClockDriverClockPulseOffsetExpression(clockDriverID)

Return expression of clockPulseOffset.

Section: F.7.41.8.

Parameters:

clockDriverID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getClockDriverClockPulseOffsetID(clockDriverID)

Return handle of clockPulseOffset.

Section: F.7.41.9.

Parameters:

clockDriverID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getClockDriverClockPulseValue(clockDriverID)

Return numeric bit value of clockPulseValue.

Section: F.7.41.10.

Parameters:

clockDriverID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getClockDriverClockPulseValueExpression(clockDriverID)

Return expression of clockPulseValue.

Section: F.7.41.11.

Parameters:

clockDriverID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getClockDriverClockPulseValueID(clockDriverID)

Return handle of clockPulseValue element.

Section: F.7.41.12.

Parameters:

clockDriverID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getClockEdgeAttribute(elementID, *, _attr='clockEdge', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getClockNameAttribute(elementID, *, _attr='clockName', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getClockSourceAttribute(elementID, *, _attr='clockSource', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getComponentAddressSpaceIDs(componentID)

Return handles of all addressSpace elements.

Section: F.7.29.1.

Parameters:

componentID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getComponentBusInterfaceIDs(componentID)

Return handles of all busInterface elements.

Section: F.7.29.2.

Parameters:

componentID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getComponentChannelIDs(componentID)

Return handles of all channel elements.

Section: F.7.29.3.

Parameters:

componentID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getComponentChoiceIDs(componentID)

Return handles of all choice elements.

Section: F.7.29.4.

Parameters:

componentID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getComponentClearboxElementIDs(componentID)

Return handles of clearboxElement children.

Section: F.7.29.5.

Parameters:

componentID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getComponentComponentGeneratorIDs(componentID)

Return handles of componentGenerator children.

Section: F.7.29.6.

Parameters:

componentID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getComponentComponentInstantiationIDs(componentID)

Return handles of componentInstantiation elements in model.

Section: F.7.29.7.

Parameters:

componentID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getComponentCpuIDs(componentID)

Return handles of cpu elements of a component.

Parameters:

componentID (str) – Component handle.

Returns:

Handles list (empty if none).

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getComponentDesignConfigurationInstantiationIDs(componentID)

Return handles of designConfigurationInstantiation elements.

Section: F.7.29.9.

Parameters:

componentID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getComponentDesignInstantiationIDs(componentID)

Return handles of designInstantiation elements.

Section: F.7.29.10.

Parameters:

componentID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getComponentExternalTypeDefinitionsIDs(componentID)

Return handles of externalTypeDefinitions elements.

Section: F.7.29.11.

Parameters:

componentID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getComponentFileSetIDs(componentID)

Return handles of fileSet elements.

Section: F.7.29.12.

Parameters:

componentID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getComponentGeneratorGroupIDs(componentGeneratorID)

Return handles of group elements of a ComponentGenerator.

Section: F.7.49.3.

Parameters:

componentGeneratorID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getComponentGeneratorSelectorGroupSelectorID(componentGeneratorSelectorID)

Return handle of groupSelector of a componentGeneratorSelector.

Section: F.7.51.1.

Parameters:

componentGeneratorSelectorID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getComponentIDs(topElementID)

Return handles of Components (BASE).

Parameters:

topElementID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getComponentIndirectInterfaceIDs(componentID)

Return handles of indirectInterface elements.

Section: F.7.29.13.

Parameters:

componentID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getComponentInstanceComponentRefByID(componentInstanceID)

Return handle of referenced component (componentRef).

Section: F.7.37.8. (Design currently does not resolve to actual component object – placeholder None)

Parameters:

componentInstanceID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getComponentInstanceComponentRefByVLNV(componentInstanceID)

Return (vendor, library, name, version) VLNV referenced.

Section: F.7.37.9.

Parameters:

componentInstanceID (str)

Return type:

tuple[str | None, str | None, str | None, str | None]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getComponentInstanceComponentRefID(componentInstanceID)

Return handle of the componentRef inside a componentInstance.

Section: F.7.55.3.

Parameters:

componentInstanceID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getComponentInstanceName(componentInstanceID)

Return componentInstance name.

Section: F.7.37.10.

Parameters:

componentInstanceID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getComponentInstancePowerDomainLinkIDs(componentInstanceID)

Parameters:

componentInstanceID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getComponentInstanceRefAttribute(elementID, *, _attr='componentInstanceRef', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getComponentInstanceRefAttributeByID(elementID, *, _attr='componentInstanceRef', _rtype='ref', _kind='ref')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getComponentInstantiationArchitectureName(componentInstantiationID)

Return architectureName value.

Section: F.7.55.4.

Parameters:

componentInstantiationID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getComponentInstantiationClearboxElementRefIDs(componentInstantiationID)

Return handles of all clearboxElementRef elements.

Section: F.7.55.5.

Parameters:

componentInstantiationID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getComponentInstantiationConfigurationName(componentInstantiationID)

Return configurationName value.

Section: F.7.55.6.

Parameters:

componentInstantiationID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getComponentInstantiationConstraintSetRefIDs(componentInstantiationID)

Return handles of constraintSetRef elements.

Section: F.7.55.7.

Parameters:

componentInstantiationID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getComponentInstantiationDefaultFileBuilderIDs(componentInstantiationID)

Return handles of defaultFileBuilder elements.

Section: F.7.55.8.

Parameters:

componentInstantiationID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getComponentInstantiationFileSetRefIDs(componentInstantiationID)

Return handles of fileSetRef elements.

Section: F.7.55.9.

Parameters:

componentInstantiationID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getComponentInstantiationIsVirtual(componentInstantiationID)

Return value of isVirtual.

Section: F.7.55.10.

Parameters:

componentInstantiationID (str)

Return type:

bool | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getComponentInstantiationLanguage(componentInstantiationID)

Return language value (string) if present.

Section: F.7.55.11.

Parameters:

componentInstantiationID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getComponentInstantiationLanguageID(componentInstantiationID)

Return handle of the language element.

Section: F.7.55.12.

Parameters:

componentInstantiationID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getComponentInstantiationLibraryName(componentInstantiationID)

Return libraryName value.

Section: F.7.55.13.

Parameters:

componentInstantiationID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getComponentInstantiationModuleName(componentInstantiationID)

Return moduleName value.

Section: F.7.55.14.

Parameters:

componentInstantiationID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getComponentInstantiationPackageName(componentInstantiationID)

Return packageName value.

Section: F.7.55.15.

Parameters:

componentInstantiationID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getComponentMemoryMapIDs(componentID)

Return handles of memoryMap elements.

Section: F.7.29.14.

Parameters:

componentID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getComponentModeIDs(componentID)

Return handles of mode elements.

Section: F.7.29.15.

Parameters:

componentID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getComponentOtherClockDriverIDs(componentID)

Return handles of otherClockDriver elements.

Section: F.7.29.16.

Parameters:

componentID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getComponentPortIDs(componentID)

Return handles of model port elements (all styles).

Section: F.7.29.17.

Parameters:

componentID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getComponentPowerDomainIDs(componentID)

Return handles of powerDomain elements.

Section: F.7.29.18.

Parameters:

componentID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getComponentRefAttribute(elementID, *, _attr='componentRef', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getComponentRefAttributeByID(elementID, *, _attr='componentRef', _rtype='ref', _kind='ref')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getComponentResetTypeIDs(componentID)

Return handles of resetType elements.

Section: F.7.29.19.

Parameters:

componentID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getComponentSelectedViewIDs(componentID)

Return handles of selectedView elements.

Section: F.7.29.20.

Parameters:

componentID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getConfigGroupsAttribute(elementID, *, _attr='configGroups', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getConfigurableElementIDs(unconfiguredElementID)

Return handles of all configurable elements for an unconfigured element.

Section: F.7.31.1.

The standard conceptual model distinguishes between an unconfigured element (definition) and configurable elements (parameters) that can be bound with values when configuring instances. In this implementation configurable elements correspond directly to configurableElementValue children; thus this function returns their handles (identity mapping for now).

Parameters:

unconfiguredElementID (str) – Handle referencing an unconfigured element.

Returns:

Handles of all associated configurable elements.

Return type:

list[str]

Raises:

TgiError – If the handle is invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getConfigurableElementValue(configurableElementID)

Return the default value of a configurable element.

Section: F.7.31.2.

Parameters:

configurableElementID (str) – Handle of the configurable element (value).

Returns:

Expression/value text or None if absent.

Return type:

str | None

Raises:

TgiError – If the handle is invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getConfigurableElementValueExpression(configurableElementID)

Return the default expression of a configurable element.

Section: F.7.31.3.

Equivalent to getConfigurableElementValue() for the current schema where the stored textual value doubles as the expression.

Parameters:

configurableElementID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getConfigurableElementValueIDs(configuredElementID)

Return handles of all configurableElementValue children of a configured element.

Section: F.7.31.4.

Parameters:

configuredElementID (str) – Handle referencing a configured element.

Returns:

Child handles (empty list if none).

Return type:

list[str]

Raises:

TgiError – If the handle is invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getConfigurableElementValueReferenceID(configurableElementValueID)

Return the referenceId attribute of a configurable element value.

Section: F.7.31.5.

Parameters:

configurableElementValueID (str) – Handle of the child value.

Returns:

Reference ID string or None if unset.

Return type:

str | None

Raises:

TgiError – If the handle is invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getConfigurableElementValueValueExpression(configurableElementValueID)

Return the expression text stored in a configurable element value.

Section: F.7.31.6.

Parameters:

configurableElementValueID (str) – Handle of the value element.

Returns:

Expression string or None.

Return type:

str | None

Raises:

TgiError – If the handle is invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getConstrainedAttributeValues(elementID, *, _attr='constrained', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getConstraintSetDriveConstraintCellSpecificationID(constraintSetID)

Return handle of cellSpecification inside the driveConstraint.

Section: F.7.33.4.

Parameters:

constraintSetID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getConstraintSetIdAttribute(elementID, *, _attr='constraintSetId', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getConstraintSetLoadConstraintID(constraintSetID)

Return handle of the loadConstraint element.

Section: F.7.33.5.

Parameters:

constraintSetID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getConstraintSetRefLocalName(constraintSetRefID)

Return the local name value of a constraintSetRef.

Section: F.7.33.6.

Parameters:

constraintSetRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getConstraintSetReferenceName(constraintSetID)

Return the constraintSetId attribute of a constraintSet.

Section: F.7.33.7.

Parameters:

constraintSetID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getConstraintSetTimingConstraintIDs(constraintSetID)

Return handles of all timingConstraint children of a constraintSet.

Section: F.7.33.8.

Parameters:

constraintSetID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getConstraintSetTimingConstraints(constraintSetID)

Return all timingConstraint values for the given constraintSet.

Section: F.7.35.1.

Parameters:

constraintSetID (str) – Handle referencing a constraintSet element.

Returns:

The list of timing constraint numeric values (empty if none).

Return type:

list[float]

Raises:

TgiError – If the handle does not reference a ConstraintSet.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getConstraintSetVector(constraintSetID)

Return [left, right] evaluated integer values of constraintSet vector.

Section: F.7.33.9. Returns [None, None] if vector absent or expressions unevaluated.

Parameters:

constraintSetID (str)

Return type:

list[int | None]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getConstraintSetVectorExpression(constraintSetID)

Return [leftExpr, rightExpr] textual expressions of vector bounds.

Section: F.7.33.10.

Parameters:

constraintSetID (str)

Return type:

list[str | None]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getConstraintSetVectorLeftID(constraintSetID)

Return handle of left side expression element of vector.

Section: F.7.33.11.

Parameters:

constraintSetID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getConstraintSetVectorRightID(constraintSetID)

Return handle of right side expression element of vector.

Section: F.7.33.12.

Parameters:

constraintSetID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getCpuAddressUnitBits(cpuID)

Parameters:

cpuID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getCpuAddressUnitBitsExpression(cpuID)

Parameters:

cpuID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getCpuAddressUnitBitsID(cpuID)

Parameters:

cpuID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getCpuDescription(cpuID)

Parameters:

cpuID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getCpuDisplayName(cpuID)

Parameters:

cpuID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getCpuMemoryMapRef(cpuID)

Parameters:

cpuID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getCpuName(cpuID)

Parameters:

cpuID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getCpuRange(cpuID)

Parameters:

cpuID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getCpuRangeExpression(cpuID)

Parameters:

cpuID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getCpuRangeID(cpuID)

Parameters:

cpuID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getCpuRegionAddressOffset(regionID)

Parameters:

regionID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getCpuRegionAddressOffsetExpression(regionID)

Parameters:

regionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getCpuRegionAddressOffsetID(regionID)

Parameters:

regionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getCpuRegionDescription(regionID)

Parameters:

regionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getCpuRegionDisplayName(regionID)

Parameters:

regionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getCpuRegionIDs(cpuID)

Parameters:

cpuID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getCpuRegionName(regionID)

Parameters:

regionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getCpuRegionRange(regionID)

Parameters:

regionID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getCpuRegionRangeExpression(regionID)

Parameters:

regionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getCpuRegionRangeID(regionID)

Parameters:

regionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getCpuRegionShortDescription(regionID)

Parameters:

regionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getCpuShortDescription(cpuID)

Parameters:

cpuID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getCpuWidth(cpuID)

Parameters:

cpuID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getCpuWidthExpression(cpuID)

Parameters:

cpuID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getCpuWidthID(cpuID)

Parameters:

cpuID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getCustomAttribute(elementID, *, _attr='custom', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getDataTypeAttribute(elementID, *, _attr='dataType', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getDataTypeDefinitionAttribute(elementID, *, _attr='dataTypeDefinition', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getDefaultBooleanAttribute(elementID, *, _attr='default', _rtype='bool', _kind='bool')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getDefineValue(defineID)

Return define value string.

Section: F.7.59.5.

Parameters:

defineID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getDefineValueExpression(defineID)

Return expression for define value.

Section: F.7.59.6.

Parameters:

defineID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getDefineValueID(defineID)

Return handle to define value (self handle).

Section: F.7.59.7.

Parameters:

defineID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getDelayTypeAttribute(elementID, *, _attr='delayType', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getDescription(elementID)

Return description text.

Section: F.7.63.1.

Parameters:

elementID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getDesignAdHocConnectionIDs(designID)

Return handles of adHocConnection children.

Section: F.7.37.12.

Parameters:

designID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getDesignChoiceIDs(designID)

Return handles of choice elements.

Section: F.7.37.13.

Parameters:

designID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getDesignComponentInstanceIDs(designID)

Return handles of componentInstance elements.

Section: F.7.37.14.

Parameters:

designID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getDesignConfigurationChoiceIDs(designConfigurationID)

Return handles of choice elements.

Section: F.7.39.7.

Parameters:

designConfigurationID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getDesignConfigurationDesignRefByID(designConfigurationID)

Return handle of the designRef element.

Section: F.7.39.8.

Parameters:

designConfigurationID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getDesignConfigurationDesignRefByVLNV(designConfigurationID)

Return designRef VLNV tuple.

Section: F.7.39.9.

Parameters:

designConfigurationID (str)

Return type:

tuple[str | None, str | None, str | None, str | None]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getDesignConfigurationGeneratorChainConfigurationIDs(designConfigurationID)

Return handles of generatorChainConfiguration entries.

Section: F.7.39.10.

Parameters:

designConfigurationID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getDesignConfigurationIDs(topElementID)

Return handles of Design Configurations (BASE).

Parameters:

topElementID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getDesignConfigurationInstantiationDesignConfigurationRefByID(designConfigurationInstantiationID)

Return designConfigurationRef handle for a designConfigurationInstantiation.

Section: F.7.55.16.

Parameters:

designConfigurationInstantiationID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getDesignConfigurationInstantiationDesignConfigurationRefByVLNV(designConfigurationInstantiationID)

Return VLNV tuple of the designConfigurationRef.

Section: F.7.55.17. Returns (None, None, None, None) if absent.

Parameters:

designConfigurationInstantiationID (str)

Return type:

tuple[str | None, str | None, str | None, str | None]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getDesignConfigurationInstantiationDesignConfigurationRefID(designConfigurationInstantiationID)

Alias of F.7.55.16 (explicit naming per spec).

Parameters:

designConfigurationInstantiationID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getDesignConfigurationInstantiationLanguage(designConfigurationInstantiationID)

Return language value of a designConfigurationInstantiation.

Section: F.7.55.19.

Parameters:

designConfigurationInstantiationID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getDesignConfigurationInstantiationLanguageID(designConfigurationInstantiationID)

Return handle of the language element.

Section: F.7.55.20.

Parameters:

designConfigurationInstantiationID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getDesignConfigurationInterconnectionConfigurationIDs(designConfigurationID)

Return handles of interconnectionConfiguration entries.

Section: F.7.39.11.

Parameters:

designConfigurationID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getDesignConfigurationViewConfigurationIDs(designConfigurationID)

Return handles of viewConfiguration entries.

Section: F.7.39.12.

Parameters:

designConfigurationID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getDesignID(top)

Return handle to current or top design.

Section: F.7.37.15. (Current DE context not tracked; return None.)

Parameters:

top (bool)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getDesignIDs(topElementID)

Return handles of Designs (BASE).

Parameters:

topElementID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getDesignInterconnectionIDs(designID)

Return handles of interconnection elements.

Section: F.7.37.16.

Parameters:

designID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getDesignMonitorInterconnectionIDs(designID)

Return handles of monitorInterconnection elements.

Section: F.7.37.17.

Parameters:

designID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getDimExpression(dimID)

Return dimension expression string.

Section: F.7.13.10.

Parameters:

dimID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getDimIndexVar(dimID)

Return the indexVar attribute of a dimension.

Section: F.7.13.11.

Parameters:

dimID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getDimValue(dimID)

Return evaluated integer value of a dimension expression.

Section: F.7.13.12.

Parameters:

dimID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getDirectionAttribute(elementID, *, _attr='direction', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getDisplayName(elementID)

Return displayName text.

Section: F.7.63.2.

Parameters:

elementID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getDomainTypeDefTypeDefinitionIDs(portID, domainTypeDefID)

Return handles for typeDefinition children of a domainTypeDef.

Section: F.7.67.2.

Parameters:

• portID (str)

• domainTypeDefID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getDomainTypeDefTypeDefinitions(portID, domainTypeDefID)

Return string values of typeDefinition entries for a domainTypeDef.

Section: F.7.67.3.

Parameters:

• portID (str)

• domainTypeDefID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getDomainTypeDefTypeName(portID, domainTypeDefID)

Return the typeName value of a domainTypeDef.

Section: F.7.67.4.

Parameters:

• portID (str)

• domainTypeDefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getDomainTypeDefTypeNameID(portID, domainTypeDefID)

Return the handle of the typeName element of a domainTypeDef.

Section: F.7.67.5.

Parameters:

• portID (str)

• domainTypeDefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getDomainTypeDefViewIDs(portID, domainTypeDefID)

Return handles of viewRef elements of a domainTypeDef.

Section: F.7.67.6.

Parameters:

• portID (str)

• domainTypeDefID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getDomainTypeDefViewRefIDs(portID, domainTypeDefID)

Alias of getDomainTypeDefViewIDs (spec splits naming).

Section: F.7.67.7.

Parameters:

• portID (str)

• domainTypeDefID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getDomainTypeDefViewRefs(portID, domainTypeDefID)

Return string values of viewRef elements for a domainTypeDef.

Section: F.7.67.8.

Parameters:

• portID (str)

• domainTypeDefID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getDriveConstraintOther(driveConstraintID)

Return the other attribute of driveConstraint.cellSpecification.cellFunction.

Section: F.7.33.13.

Parameters:

driveConstraintID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getDriveConstraintType(driveConstraintID)

Return type of driveConstraint (cellFunction value or cellClass value).

Section: F.7.33.14.

Parameters:

driveConstraintID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getDriveConstraintValue(driveConstraintID)

Return the drive constraint strength value (cellStrength attribute).

Section: F.7.33.15.

Parameters:

driveConstraintID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getDriverClockDriverID(driverID)

Return handle of clockDriver child of a driver.

Section: F.7.41.13.

Parameters:

driverID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getDriverDefaultValue(driverID)

Return defaultValue numeric or string value.

Section: F.7.41.14.

Parameters:

driverID (str)

Return type:

int | str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getDriverDefaultValueExpression(driverID)

Return expression of defaultValue.

Section: F.7.41.15.

Parameters:

driverID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getDriverDefaultValueID(driverID)

Return handle of defaultValue element.

Section: F.7.41.16.

Parameters:

driverID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getDriverLeftID(driverID)

Return handle of range.left.

Section: F.7.41.17.

Parameters:

driverID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getDriverRange(driverID)

Return (leftValue, rightValue) of range.

Section: F.7.41.18.

Parameters:

driverID (str)

Return type:

tuple[int | None, int | None]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getDriverRangeExpression(driverID)

Return (leftExpression, rightExpression) of range.

Section: F.7.41.19.

Parameters:

driverID (str)

Return type:

tuple[str | None, str | None]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getDriverRightID(driverID)

Return handle of range.right.

Section: F.7.41.20.

Parameters:

driverID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getDriverTypeAttribute(elementID, *, _attr='driverType', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getEnumeratedValueExpression(enumeratedValueID)

Return expression (F.7.73.28).

Parameters:

enumeratedValueID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getEnumeratedValueUsage(enumeratedValueID)

Return usage (F.7.73.29).

Parameters:

enumeratedValueID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getEnumeratedValueValue(enumeratedValueID)

Return numeric value (F.7.73.30).

Parameters:

enumeratedValueID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getEnumeratedValueValueExpression(enumeratedValueID)

Return value expression (F.7.73.31).

Parameters:

enumeratedValueID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getEnumeratedValueValueID(enumeratedValueID)

Return handle of value element (F.7.73.32).

Parameters:

enumeratedValueID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getEnumeratedValuesEnumeratedValueIDs(enumeratedValuesID)

Return enumeratedValue handles (F.7.73.33).

Parameters:

enumeratedValuesID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getEnumeratedValuesEnumerationDefinitionRefByExternalTypeDefID(enumeratedValuesID)

Return externalTypeDefinitions handle (F.7.73.34).

Parameters:

enumeratedValuesID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getEnumeratedValuesEnumerationDefinitionRefByID(enumeratedValuesID)

Return enumerationDefinition handle (F.7.73.35).

Parameters:

enumeratedValuesID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getEnumeratedValuesEnumerationDefinitionRefByName(enumeratedValuesID)

Return enumerationDefinitionRef value (F.7.73.36).

Parameters:

enumeratedValuesID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getEnumeratedValuesEnumerationDefinitionRefID(enumeratedValuesID)

Return handle of enumerationDefinitionRef (F.7.73.37).

Parameters:

enumeratedValuesID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getEnumerationDefinitionEnumeratedValueIDs(enumerationDefinitionID)

Parameters:

enumerationDefinitionID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getEnumerationDefinitionWidth(enumerationDefinitionID)

Parameters:

enumerationDefinitionID (str)

Return type:

Any | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getEnumerationDefinitionWidthExpression(enumerationDefinitionID)

Parameters:

enumerationDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getEnumerationDefinitionWidthID(enumerationDefinitionID)

Parameters:

enumerationDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getEnumerationValue(choiceEnumerationID)

Return the enumerationValue defined on the given enumeration element.

Section: F.7.25.2

Parameters:

choiceEnumerationID (str) – Handle to a Choices.Choice.Enumeration element.

Returns:

The enumeration value string, or None if not set.

Raises:

TgiError – If the handle is invalid.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getEnumerationValueExpression(choiceEnumerationID)

Return the expression defined on the given enumeration element.

Section: F.7.25.3

Parameters:

choiceEnumerationID (str) – Handle to a Choices.Choice.Enumeration element.

Returns:

The enumeration expression string, or None if not set.

Raises:

TgiError – If the handle is invalid.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getExactBooleanAttribute(elementID, *, _attr='exact', _rtype='bool', _kind='bool')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getExecutableImageFileBuilderIDs(executableImageID)

Return handles of all fileBuilder children of languageTools.

Section: F.7.45.11.

Parameters:

executableImageID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getExecutableImageFileSetRefIDs(executableImageID)

Return handles of all fileSetRef children.

Section: F.7.45.12.

Parameters:

executableImageID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getExecutableImageLanguageToolsID(executableImageID)

Return handle of languageTools or None.

Section: F.7.45.13.

Parameters:

executableImageID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getExecutableImageLinker(executableImageID)

Return linker command text.

Section: F.7.45.14.

Parameters:

executableImageID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getExecutableImageLinkerCommandFileID(executableImageID)

Return handle of first linkerCommandFile (if any).

Section: F.7.45.15.

Parameters:

executableImageID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getExecutableImageLinkerExpression(executableImageID)

Return expression for linker element.

Section: F.7.45.16.

Parameters:

executableImageID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getExecutableImageLinkerFlags(executableImageID)

Return textual linker flags.

Section: F.7.45.17.

Parameters:

executableImageID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getExecutableImageLinkerFlagsExpression(executableImageID)

Return expression for linker flags.

Section: F.7.45.18.

Parameters:

executableImageID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getExpression(expressionID)

Return raw expression text.

Section: F.7.59.8.

Parameters:

expressionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getExpressionIntValue(expressionID)

Attempt to parse the evaluated integer value of an expression.

Section: F.7.59.9. Simple heuristic: if expression or value parses as int base 0.

Parameters:

expressionID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getExpressionValue(expressionID)

Return evaluated value (returns value or expression text fallback).

Section: F.7.59.10.

Parameters:

expressionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getExternalDeclarationsBooleanAttribute(elementID, *, _attr='externalDeclarations', _rtype='bool', _kind='bool')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getExternalPortReferencePartSelectID(externalPortReferenceID)

Return handle of partSelect element of externalPortReference.

Section: F.7.37.18.

Parameters:

externalPortReferenceID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getExternalPortReferencePortRefByName(externalPortReferenceID)

Return portRef attribute of externalPortReference.

Section: F.7.37.19.

Parameters:

externalPortReferenceID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getExternalPortReferenceSubPortReferenceIDs(externalPortReferenceID)

Return handles of subPortReference elements for externalPortReference.

Section: F.7.37.20.

Parameters:

externalPortReferenceID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getExternalTypeDefinitionsModeLinksIDs(externalTypeDefinitionsID)

Parameters:

externalTypeDefinitionsID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getExternalTypeDefinitionsResetTypeLinkIDs(externalTypeDefinitionsID)

Parameters:

externalTypeDefinitionsID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getExternalTypeDefinitionsTypeDefinitionsRefByID(externalTypeDefinitionsID)

Parameters:

externalTypeDefinitionsID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getExternalTypeDefinitionsTypeDefinitionsRefByVLNV(externalTypeDefinitionsID)

Parameters:

externalTypeDefinitionsID (str)

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getExternalTypeDefinitionsViewLinkIDs(externalTypeDefinitionsID)

Parameters:

externalTypeDefinitionsID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldAccessPoliciesFieldAccessPolicyIDs(fieldAccessPoliciesID)

Section: F.7.9.16 Return fieldAccessPolicy handles inside fieldAccessPolicies.

Parameters:

fieldAccessPoliciesID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldAccessPolicyAccess(fieldAccessPolicyID)

Section: F.7.9.17 Return access value of a fieldAccessPolicy.

Parameters:

fieldAccessPolicyID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldAccessPolicyAccessRestrictionIDs(fieldAccessPolicyID)

Section: F.7.9.18 Return accessRestriction handles of a fieldAccessPolicy.

Parameters:

fieldAccessPolicyID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldAccessPolicyDefinitionAccess(definitionID)

Section: F.7.9 Get access value of a fieldAccessPolicyDefinition.

Parameters:

definitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldAccessPolicyDefinitionDescription(definitionID)

Section: F.7.9 Get description of a fieldAccessPolicyDefinition.

Parameters:

definitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldAccessPolicyDefinitionDisplayName(definitionID)

Section: F.7.9 Get displayName of a fieldAccessPolicyDefinition.

Parameters:

definitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldAccessPolicyDefinitionIDs(fieldAccessPolicyDefinitionsID)

Section: F.7.9 Return handles of fieldAccessPolicyDefinition children.

Parameters:

fieldAccessPolicyDefinitionsID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldAccessPolicyDefinitionModifiedWriteValue(definitionID)

Section: F.7.9 Get modifiedWriteValue of a fieldAccessPolicyDefinition.

Parameters:

definitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldAccessPolicyDefinitionName(definitionID)

Section: F.7.9 Get name of a fieldAccessPolicyDefinition.

Parameters:

definitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldAccessPolicyDefinitionReadAction(definitionID)

Section: F.7.9 Get readAction of a fieldAccessPolicyDefinition.

Parameters:

definitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldAccessPolicyDefinitionReadResponse(definitionID)

Section: F.7.9 Get readResponse of a fieldAccessPolicyDefinition.

Parameters:

definitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldAccessPolicyDefinitionShortDescription(definitionID)

Section: F.7.9 Get shortDescription of a fieldAccessPolicyDefinition.

Parameters:

definitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldAccessPolicyDefinitionWriteValueConstraint(definitionID)

Section: F.7.9 Get writeValueConstraint (string) of a fieldAccessPolicyDefinition.

Parameters:

definitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldAccessPolicyFieldAccessPolicyDefinitionRefByExternalTypeDefID(fieldAccessPolicyID)

Section: F.7.9.19 externalTypeDefinitions not represented -> raise INVALID_ARGUMENT.

Parameters:

fieldAccessPolicyID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldAccessPolicyFieldAccessPolicyDefinitionRefByID(fieldAccessPolicyID)

Section: F.7.9.20 Definition reference resolves by name only -> return None.

Parameters:

fieldAccessPolicyID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldAccessPolicyFieldAccessPolicyDefinitionRefByName(fieldAccessPolicyID)

Section: F.7.9.21 Return definition name from fieldAccessPolicyDefinitionRef.

Parameters:

fieldAccessPolicyID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldAccessPolicyFieldAccessPolicyDefinitionRefID(fieldAccessPolicyID)

Section: F.7.9.22 Return handle of fieldAccessPolicyDefinitionRef element.

Parameters:

fieldAccessPolicyID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldAccessPolicyModeRefByID(fieldAccessPolicyID, modeRefID)

Section: F.7.6.1 Return handle of indexed modeRef of a fieldAccessPolicy.

Parameters:

• fieldAccessPolicyID (str)

• modeRefID (int)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldAccessPolicyModeRefByName(fieldAccessPolicyID)

Section: F.7.9.23 Return list of modeRef names of a fieldAccessPolicy.

Parameters:

fieldAccessPolicyID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldAccessPolicyModeRefIDs(fieldAccessPolicyID)

Section: F.7.9.24 Return modeRef handles for a fieldAccessPolicy.

Parameters:

fieldAccessPolicyID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldAccessPolicyModifiedWriteValue(fieldAccessPolicyID)

Section: F.7.9.25 Return modifiedWriteValue value.

Parameters:

fieldAccessPolicyID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldAccessPolicyModifiedWriteValueID(fieldAccessPolicyID)

Section: F.7.9.26 Return handle of modifiedWriteValue element.

Parameters:

fieldAccessPolicyID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldAccessPolicyReadAction(fieldAccessPolicyID)

Section: F.7.9.27 Return readAction value.

Parameters:

fieldAccessPolicyID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldAccessPolicyReadActionID(fieldAccessPolicyID)

Section: F.7.9.28 Return handle of readAction element.

Parameters:

fieldAccessPolicyID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldAccessPolicyReadResponse(fieldAccessPolicyID)

Section: F.7.9.29 Return numeric readResponse value.

Parameters:

fieldAccessPolicyID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldAccessPolicyReadResponseExpression(fieldAccessPolicyID)

Section: F.7.9.30 Return readResponse expression string.

Parameters:

fieldAccessPolicyID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldAccessPolicyReadResponseID(fieldAccessPolicyID)

Section: F.7.9.31 Return handle of readResponse element.

Parameters:

fieldAccessPolicyID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldAccessPolicyReserved(fieldAccessPolicyID)

Section: F.7.9.32 Return reserved numeric value.

Parameters:

fieldAccessPolicyID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldAccessPolicyReservedExpression(fieldAccessPolicyID)

Section: F.7.9.33 Return reserved expression string.

Parameters:

fieldAccessPolicyID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldAccessPolicyReservedID(fieldAccessPolicyID)

Section: F.7.9.34 Return handle of reserved element.

Parameters:

fieldAccessPolicyID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldAccessPolicyTestable(fieldAccessPolicyID)

Section: F.7.9.35 Return testable boolean value.

Parameters:

fieldAccessPolicyID (str)

Return type:

bool | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldAccessPolicyTestableID(fieldAccessPolicyID)

Section: F.7.9.36 Return handle of testable element.

Parameters:

fieldAccessPolicyID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldAccessPolicyWriteValueConstraintID(fieldAccessPolicyID)

Section: F.7.9.37 Return handle of writeValueConstraint element.

Parameters:

fieldAccessPolicyID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldAccesspolicyBroadcastToIDs(fieldAccessPolicyID)

Section: F.7.9.38 Return broadcastTo handles under broadcasts.

Parameters:

fieldAccessPolicyID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldBitOffsetID(fieldID)

Return bitOffset handle (F.7.73.38).

Parameters:

fieldID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldDefinitionAccessPoliciesIDs(portID)

Return handles of access policy elements associated with the port field maps.

Section: F.7.67.9. Implementation note: Access policies are not explicitly modeled on FieldMap in the generated schema; returns empty list until/if modeled.

Parameters:

portID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldDefinitionBitWidthID(fieldDefinitionID)

Return bitWidth handle (F.7.73.39).

Parameters:

fieldDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldDefinitionEnumeratedValueIDs(fieldDefinitionID)

Return enumeratedValue handles (F.7.73.40).

Parameters:

fieldDefinitionID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldDefinitionTypeIdentifier(fieldDefinitionID)

Return typeIdentifier (F.7.73.41).

Parameters:

fieldDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldDefinitionVolatile(fieldDefinitionID)

Return volatile flag (F.7.73.42).

Parameters:

fieldDefinitionID (str)

Return type:

bool | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldMapFieldSliceID(fieldMapID)

Return handle of fieldSlice child of a FieldMap.

Section: F.7.67.10.

Parameters:

fieldMapID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldMapModeRefByID(fieldMapModeRefID)

Return (modeName, priority) for a modeRef handle.

Section: F.7.67.11.

Parameters:

fieldMapModeRefID (str)

Return type:

tuple[str | None, int | None]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldMapModeRefByNames(portID, fieldMapID, modeName)

Return handle of a modeRef within a FieldMap by its mode name.

Section: F.7.67.12.

Parameters:

• portID (str)

• fieldMapID (str)

• modeName (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldMapModeRefIDs(portID, fieldMapID)

Return handles of modeRef elements for a given FieldMap.

Section: F.7.67.13.

Parameters:

• portID (str)

• fieldMapID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldMapModeRefs(portID, fieldMapID)

Return list of (modeName, priority) for modeRefs of a FieldMap.

Section: F.7.67.14.

Parameters:

• portID (str)

• fieldMapID (str)

Return type:

list[tuple[str | None, int | None]]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldMapPartSelectID(fieldMapID)

Return handle of partSelect child of a FieldMap.

Section: F.7.67.15.

Parameters:

fieldMapID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldMapSubPortReferenceIDs(fieldMapID)

Return handles of subPortReference children of a FieldMap.

Section: F.7.67.16.

Parameters:

fieldMapID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldRefAttribute(elementID, *, _attr='fieldRef', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldRefAttributeByID(elementID, *, _attr='fieldRef', _rtype='ref', _kind='ref')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldRefFieldRefByName(fieldRefID)

Return fieldRef value (F.7.73.43).

Parameters:

fieldRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldRefIndexIDs(fieldRefID)

Return index handles (F.7.73.44).

Parameters:

fieldRefID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldSliceAddressBlockRefByID(fieldSliceID, addressBlockID)

Parameters:

• fieldSliceID (str)

• addressBlockID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldSliceAddressBlockRefByName(fieldSliceID, name)

Parameters:

• fieldSliceID (str)

• name (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldSliceAddressBlockRefID(fieldSliceID)

Parameters:

fieldSliceID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldSliceAddressSpaceRefByID(fieldSliceID, addressSpaceID)

Parameters:

• fieldSliceID (str)

• addressSpaceID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldSliceAddressSpaceRefByName(fieldSliceID, name)

Parameters:

• fieldSliceID (str)

• name (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldSliceAddressSpaceRefID(fieldSliceID)

Parameters:

fieldSliceID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldSliceAlternateRegisterRefByID(fieldSliceID, altRegisterID)

Parameters:

• fieldSliceID (str)

• altRegisterID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldSliceAlternateRegisterRefByName(fieldSliceID, name)

Parameters:

• fieldSliceID (str)

• name (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldSliceAlternateRegisterRefID(fieldSliceID)

Parameters:

fieldSliceID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldSliceBankRefByNames(fieldSliceID, vendor, library, name, version)

Parameters:

• fieldSliceID (str)

• vendor (str)

• library (str)

• name (str)

• version (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldSliceBankRefIDs(fieldSliceID)

Parameters:

fieldSliceID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldSliceFieldRefByName(fieldSliceID, name)

Parameters:

• fieldSliceID (str)

• name (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldSliceFieldRefID(fieldSliceID)

Parameters:

fieldSliceID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldSliceMemoryMapRefByID(fieldSliceID, memoryMapID)

Parameters:

• fieldSliceID (str)

• memoryMapID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldSliceMemoryMapRefByName(fieldSliceID, name)

Parameters:

• fieldSliceID (str)

• name (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldSliceMemoryMapRefID(fieldSliceID)

Parameters:

fieldSliceID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldSliceMemoryRemapRefByID(fieldSliceID, memoryRemapID)

Parameters:

• fieldSliceID (str)

• memoryRemapID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldSliceMemoryRemapRefByName(fieldSliceID, name)

Parameters:

• fieldSliceID (str)

• name (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldSliceMemoryRemapRefID(fieldSliceID)

Parameters:

fieldSliceID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldSliceRange(fieldSliceID)

Parameters:

fieldSliceID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldSliceRangeLeftID(fieldSliceID)

Parameters:

fieldSliceID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFieldSliceRangeRightID(fieldSliceID)

Parameters:

fieldSliceID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFileBuildCommandID(fileID)

Return handle of buildCommand element for a File.

Section: F.7.45.19.

Parameters:

fileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFileBuilderCommand(fileBuilderID)

Return command text of a fileBuilder.

Section: F.7.45.20.

Parameters:

fileBuilderID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFileDefineIDs(fileID)

Return handles of define symbols (Section: F.7.47.2).

Parameters:

fileID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFileDefineSymbolValue(fileDefineID)

Return value of a fileDefine (Section: F.7.47.3).

Parameters:

fileDefineID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFileDependencyIDs(fileID)

Return dependency handles for a file (Section: F.7.47.4).

Parameters:

fileID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFileExportedNameIDs(fileID)

Return exportedName handles (Section: F.7.47.5).

Parameters:

fileID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFileExportedNames(fileID)

Return exported names (Section: F.7.47.6).

Parameters:

fileID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFileFileTypeIDs(fileID)

Return fileType handles (Section: F.7.47.7).

Parameters:

fileID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFileFileTypes(fileID)

Return fileType enumeration literals (Section: F.7.47.8).

Parameters:

fileID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFileIdAttribute(elementID, *, _attr='fileId', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFileImageTypeIDs(fileID)

Return imageType handles (Section: F.7.47.9).

Parameters:

fileID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFileImageTypes(fileID)

Return image type values (Section: F.7.47.10).

Parameters:

fileID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFileIsIncludeFile(fileID)

Return isIncludeFile boolean (Section: F.7.47.11).

Parameters:

fileID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFileIsIncludeFileID(fileID)

Return handle to isIncludeFile element (Section: F.7.47.12).

Parameters:

fileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFileIsStructural(fileID)

Return isStructural value (Section: F.7.47.13).

Parameters:

fileID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFileLogicalName(fileID)

Return logicalName value (Section: F.7.47.14).

Parameters:

fileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFileLogicalNameID(fileID)

Return handle to logicalName element (Section: F.7.47.15).

Parameters:

fileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFileName(fileID)

Return file name path value (Section: F.7.47.16).

Parameters:

fileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFileSetDefaultFileBuilderIDs(fileSetID)

Return handles of defaultFileBuilder elements (Section: F.7.47.17).

Parameters:

fileSetID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFileSetDependencyIDs(fileSetID)

Return fileSet dependency handles (Section: F.7.47.18).

Parameters:

fileSetID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFileSetFileIDs(fileSetID)

Return file handles (Section: F.7.47.19).

Parameters:

fileSetID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFileSetFunctionIDs(fileSetID)

Return function handles (Section: F.7.47.20).

Parameters:

fileSetID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFileSetGroupFileSetRefIDs(fileSetGroupID)

Return fileSetRef handles (Section: F.7.47.21).

Not supported by current schema – returns empty list if group exists else raises INVALID_ID.

Parameters:

fileSetGroupID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFileSetGroupIDs(fileSetID)

Return group handles (Section: F.7.47.22).

Parameters:

fileSetID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFileSetGroups(fileSetID)

Return group string values (Section: F.7.47.23).

Parameters:

fileSetID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFileSetRefByID(fileSetRefID)

Return referenced fileSet handle (Section: F.7.47.24).

Unsupported (no fileSetRef element in schema) – always returns None or raises INVALID_ID if handle does not refer to a placeholder type.

Parameters:

fileSetRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFileSetRefGroupFileSetRefIDs(fileSetRefGroupID)

Return fileSetRef handles (Section: F.7.47.25 – unsupported).

Parameters:

fileSetRefGroupID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFileSetRefLocalNameRefByID(fileSetRefID)

Return referenced fileSet handle (Section: F.7.47.26 – unsupported).

Parameters:

fileSetRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFlowTypeAttribute(elementID, *, _attr='flowType', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getForceBooleanAttribute(elementID, *, _attr='force', _rtype='bool', _kind='bool')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFunctionArgumentDataType(argumentID)

Return argument dataType (Section: F.7.47.27).

Parameters:

argumentID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFunctionArgumentIDs(functionID)

Return function argument handles (Section: F.7.47.28).

Parameters:

functionID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFunctionDisabled(functionID)

Return disabled boolean (Section: F.7.47.29).

Parameters:

functionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFunctionDisabledExpression(functionID)

Return disabled expression (Section: F.7.47.30).

Parameters:

functionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFunctionDisabledID(functionID)

Return disabled element handle (Section: F.7.47.31).

Parameters:

functionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFunctionEntryPoint(functionID)

Return entryPoint (Section: F.7.47.32).

Parameters:

functionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFunctionFileID(functionID)

Return file handle referenced by function (Section: F.7.47.33).

Parameters:

functionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFunctionFileRefByID(functionID)

Alias of getFunctionFileID (Section: F.7.47.34).

Parameters:

functionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFunctionFileRefByName(functionID)

Return fileRef name (Section: F.7.47.35).

The schema encodes fileRef as string (the referenced fileId); no separate local name – we return the same value.

Parameters:

functionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFunctionReplicate(functionID)

Return replicate boolean (Section: F.7.47.36).

Parameters:

functionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFunctionReturnType(functionID)

Return returnType literal (Section: F.7.47.37).

Parameters:

functionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFunctionSourceFileIDs(functionID)

Return sourceFile handles (Section: F.7.47.38).

Parameters:

functionID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFunctionSourceFileName(functionSourceFileID)

Return sourceFile sourceName (Section: F.7.47.39).

Parameters:

functionSourceFileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getFunctionSourceFileType(functionSourceFileID)

Return sourceFile fileType literal (Section: F.7.47.40).

Parameters:

functionSourceFileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getGeneratorApiService(generatorID)

Return API service (SOAP/REST).

Section: F.7.49.4.

Parameters:

generatorID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getGeneratorApiTypeID(generatorID)

Return handle of the apiType element (not its value).

Section: F.7.49.5.

Parameters:

generatorID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getGeneratorChainChainGroupIDs(generatorChainID)

Return handles of all chainGroup elements.

Section: F.7.51.2.

Parameters:

generatorChainID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getGeneratorChainChoiceIDs(generatorChainID)

Return handles of all choice elements.

Section: F.7.51.3.

Parameters:

generatorChainID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getGeneratorChainComponentGeneratorSelectorIDs(generatorChainID)

Return handles of componentGeneratorSelector elements.

Section: F.7.51.4.

Parameters:

generatorChainID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getGeneratorChainConfigurationRefByID(generatorChainConfigurationID)

Return handle of a generatorChainConfiguration element (identity pass-through).

Section: F.7.39.13. Provided for spec completeness – the handle is the object itself.

Parameters:

generatorChainConfigurationID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getGeneratorChainConfigurationRefByVLNV(generatorChainConfigurationID)

Return VLNV of a generatorChainConfiguration reference.

Section: F.7.39.14.

Parameters:

generatorChainConfigurationID (str)

Return type:

tuple[str | None, str | None, str | None, str | None]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getGeneratorChainGeneratorChainSelectorIDs(generatorChainID)

Return handles of generatorChainSelector elements.

Section: F.7.51.5.

Parameters:

generatorChainID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getGeneratorChainGeneratorIDs(generatorChainID)

Return handles of generator child elements.

Section: F.7.51.6.

Parameters:

generatorChainID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getGeneratorChainIDs(topElementID)

Return handles of Generator Chains (BASE).

Parameters:

topElementID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getGeneratorChainSelectorGeneratorChainRefByID(generatorChainSelectorID)

Return handle of referenced generatorChain (generatorChainRef).

Section: F.7.51.7.

Parameters:

generatorChainSelectorID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getGeneratorChainSelectorGeneratorChainRefByVLNV(generatorChainSelectorID)

Return VLNV tuple of referenced generatorChain.

Section: F.7.51.8.

Parameters:

generatorChainSelectorID (str)

Return type:

tuple[str | None, str | None, str | None, str | None]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getGeneratorChainSelectorGroupSelectorID(generatorChainSelectorID)

Return handle of groupSelector element on a generatorChainSelector.

Section: F.7.51.9.

Parameters:

generatorChainSelectorID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getGeneratorExecutable(generatorID)

Return the path string of generatorExe.

Section: F.7.49.6.

Parameters:

generatorID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getGeneratorGeneratorExe(generatorID)

Return the ID (handle) of the generatorExe element.

Section: F.7.49.7. Returns None if absent.

Parameters:

generatorID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getGeneratorGroups(generatorID)

Return list of group values (works for instance generators only).

Section: F.7.49.8. Non-instance generators return empty list.

Parameters:

generatorID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getGeneratorPhase(generatorID)

Return numeric/string phase value or None.

Section: F.7.49.9.

Parameters:

generatorID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getGeneratorPhaseExpression(generatorID)

Return expression string of phase (same as value for this schema).

Section: F.7.49.10.

Parameters:

generatorID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getGeneratorPhaseID(generatorID)

Return handle of phase element.

Section: F.7.49.11.

Parameters:

generatorID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getGeneratorScope(generatorID)

Return scope attribute (INSTANCE or DESIGN) for instance generators.

Section: F.7.49.12. Returns None for plain Generator objects.

Parameters:

generatorID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getGeneratorTransportMethodsID(generatorID)

Return handle of transportMethods element.

Section: F.7.49.13.

Parameters:

generatorID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getGroup(elementID)

Return group attribute from element if any.

Section: F.7.59.11.

Parameters:

elementID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getGroupAttribute(elementID, *, _attr='group', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getGroupSelectorNameIDs(groupSelectorID)

Return handles of all Name elements within a groupSelector.

Section: F.7.51.10.

Parameters:

groupSelectorID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getGroupSelectorSelectionNames(groupSelectorID)

Return list of name values in a groupSelector.

Section: F.7.51.11.

Parameters:

groupSelectorID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getGroupSelectorSelectionOperator(groupSelectorID)

Return multipleGroupSelectionOperator value.

Section: F.7.51.12.

Parameters:

groupSelectorID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getHelpAttribute(elementID, *, _attr='help', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getHiddenBooleanAttribute(elementID, *, _attr='hidden', _rtype='bool', _kind='bool')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getID(elementID)

Return element handle (overloaded for VLNV sequences).

Spec (Top element BASE) defines getID(elementID) returning the handle if valid else None. The Administrative category defines getID(vlnvSequence) resolving a VLNV to a handle. To avoid one overshadowing the other in the aggregated namespace we implement a tolerant polymorphic version here: if elementID looks like a 4-length string sequence treat it as a VLNV, else treat it as an element handle.

Parameters:

elementID – Either a candidate handle string or a 4-sequence (vendor, library, name, version).

Returns:

Handle string or None if resolution fails.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getIdAttribute(elementID, *, _attr='id', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getImageIdAttribute(elementID, *, _attr='imageId', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getImageTypeAttribute(elementID, *, _attr='imageType', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getImplicitBooleanAttribute(elementID, *, _attr='implicit', _rtype='bool', _kind='bool')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getIndexVarAttribute(elementID, *, _attr='indexVar', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getIndirectAddressRefAddressBlockRefByName(indirectAddressRefID)

Return addressBlockRef attribute value.

Section: F.7.53.1.

Parameters:

indirectAddressRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getIndirectAddressRefAddressBlockRefID(indirectAddressRefID)

Return handle of addressBlockRef element.

Section: F.7.53.2.

Parameters:

indirectAddressRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getIndirectAddressRefAddressSpaceRefByName(indirectAddressRefID)

Return addressSpaceRef attribute value.

Section: F.7.53.3.

Parameters:

indirectAddressRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getIndirectAddressRefAddressSpaceRefID(indirectAddressRefID)

Return handle of addressSpaceRef element.

Section: F.7.53.4.

Parameters:

indirectAddressRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getIndirectAddressRefAlternateRegisterRefByName(indirectAddressRefID)

Return alternateRegisterRef attribute value.

Section: F.7.53.5.

Parameters:

indirectAddressRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getIndirectAddressRefAlternateRegisterRefID(indirectAddressRefID)

Return handle of alternateRegisterRef element.

Section: F.7.53.6.

Parameters:

indirectAddressRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getIndirectAddressRefBankRefByNames(indirectAddressRefID)

Return list of bankRef attribute values.

Section: F.7.53.7.

Parameters:

indirectAddressRefID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getIndirectAddressRefBankRefIDs(indirectAddressRefID)

Return handles of bankRef elements.

Section: F.7.53.8.

Parameters:

indirectAddressRefID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getIndirectAddressRefFieldRefByName(indirectAddressRefID)

Return fieldRef attribute value.

Section: F.7.53.9.

Parameters:

indirectAddressRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getIndirectAddressRefFieldRefID(indirectAddressRefID)

Return handle of fieldRef element.

Section: F.7.53.10.

Parameters:

indirectAddressRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getIndirectAddressRefMemoryMapRefByName(indirectAddressRefID)

Return memoryMapRef attribute value.

Section: F.7.53.11.

Parameters:

indirectAddressRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getIndirectAddressRefMemoryMapRefID(indirectAddressRefID)

Return handle of memoryMapRef element.

Section: F.7.53.12.

Parameters:

indirectAddressRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getIndirectAddressRefMemoryRemapRefByID(indirectAddressRefID)

Return memoryRemapRef attribute value (same as ByName for attribute form).

Section: F.7.53.13.

Parameters:

indirectAddressRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getIndirectAddressRefMemoryRemapRefByName(indirectAddressRefID)

Alias returning memoryRemapRef attribute value.

Section: F.7.53.14.

Parameters:

indirectAddressRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getIndirectAddressRefMemoryRemapRefID(indirectAddressRefID)

Return handle of memoryRemapRef element.

Section: F.7.53.15.

Parameters:

indirectAddressRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getIndirectAddressRefRegisterFileRefByNames(indirectAddressRefID)

Return registerFileRef attribute values.

Section: F.7.53.16.

Parameters:

indirectAddressRefID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getIndirectAddressRefRegisterFileRefIDs(indirectAddressRefID)

Return handles of registerFileRef elements.

Section: F.7.53.17.

Parameters:

indirectAddressRefID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getIndirectAddressRefRegisterRefByName(indirectAddressRefID)

Return registerRef attribute value.

Section: F.7.53.18.

Parameters:

indirectAddressRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getIndirectAddressRefRegisterRefID(indirectAddressRefID)

Return handle of registerRef element.

Section: F.7.53.19.

Parameters:

indirectAddressRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getIndirectDataRefAddressBlockRefByName(indirectDataRefID)

Return addressBlockRef attribute value for data ref.

Section: F.7.53.20.

Parameters:

indirectDataRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getIndirectDataRefAddressBlockRefID(indirectDataRefID)

Return handle of addressBlockRef element (data).

Section: F.7.53.21.

Parameters:

indirectDataRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getIndirectDataRefAddressSpaceRefByName(indirectDataRefID)

Return addressSpaceRef attribute value (data).

Section: F.7.53.22.

Parameters:

indirectDataRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getIndirectDataRefAddressSpaceRefID(indirectDataRefID)

Return handle of addressSpaceRef element (data).

Section: F.7.53.23.

Parameters:

indirectDataRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getIndirectDataRefAlternateRegisterRefByName(indirectDataRefID)

Return alternateRegisterRef attribute value (data).

Section: F.7.53.24.

Parameters:

indirectDataRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getIndirectDataRefAlternateRegisterRefID(indirectDataRefID)

Return handle of alternateRegisterRef element (data).

Section: F.7.53.25.

Parameters:

indirectDataRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getIndirectDataRefBankRefByNames(indirectDataRefID)

Return bankRef attribute values (data).

Section: F.7.53.26.

Parameters:

indirectDataRefID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getIndirectDataRefBankRefIDs(indirectDataRefID)

Return handles of bankRef elements (data).

Section: F.7.53.27.

Parameters:

indirectDataRefID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getIndirectDataRefFieldRefByName(indirectDataRefID)

Return fieldRef attribute value (data).

Section: F.7.53.28.

Parameters:

indirectDataRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getIndirectDataRefFieldRefID(indirectDataRefID)

Return handle of fieldRef element (data).

Section: F.7.53.29.

Parameters:

indirectDataRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getIndirectDataRefMemoryMapRefByName(indirectDataRefID)

Return memoryMapRef attribute value (data).

Section: F.7.53.30.

Parameters:

indirectDataRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getIndirectDataRefMemoryMapRefID(indirectDataRefID)

Return handle of memoryMapRef element (data).

Section: F.7.53.31.

Parameters:

indirectDataRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getIndirectDataRefMemoryRemapRefByID(indirectDataRefID)

Return memoryRemapRef attribute value (data).

Section: F.7.53.32.

Parameters:

indirectDataRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getIndirectDataRefMemoryRemapRefByName(indirectDataRefID)

Alias returning memoryRemapRef attribute value (data).

Section: F.7.53.33.

Parameters:

indirectDataRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getIndirectDataRefMemoryRemapRefID(indirectDataRefID)

Return handle of memoryRemapRef element (data).

Section: F.7.53.34.

Parameters:

indirectDataRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getIndirectDataRefRegisterFileRefByNames(indirectDataRefID)

Return registerFileRef attribute values (data).

Section: F.7.53.35.

Parameters:

indirectDataRefID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getIndirectDataRefRegisterFileRefIDs(indirectDataRefID)

Return handles of registerFileRef elements (data).

Section: F.7.53.36.

Parameters:

indirectDataRefID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getIndirectDataRefRegisterRefByName(indirectDataRefID)

Return registerRef attribute value (data).

Section: F.7.53.37.

Parameters:

indirectDataRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getIndirectDataRefRegisterRefID(indirectDataRefID)

Return handle of registerRef element (data).

Section: F.7.53.38.

Parameters:

indirectDataRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getInitiatorRefAttribute(elementID, *, _attr='initiatorRef', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getInitiatorRefAttributeByID(elementID, *, _attr='initiatorRef', _rtype='ref', _kind='ref')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getInterconnectionActiveInterfaceIDs(interconnectionID)

Return handles of activeInterface children.

Section: F.7.37.21.

Parameters:

interconnectionID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getInterconnectionConfigurationAbstractorsInstancesIDs(interconnectionConfigurationID)

Return handles of abstractorInstances groups under an interconnectionConfiguration.

Section: F.7.39.15.

Parameters:

interconnectionConfigurationID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getInterconnectionConfigurationInterconnectionRefByID(interconnectionConfigurationID)

Return the interconnectionRef as a string (ID form).

Section: F.7.39.16. The reference is a name string, so we return it directly.

Parameters:

interconnectionConfigurationID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getInterconnectionConfigurationInterconnectionRefByName(interconnectionConfigurationID)

Alias of F.7.39.16 per spec naming – returns the interconnectionRef name.

Section: F.7.39.17.

Parameters:

interconnectionConfigurationID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getInterconnectionHierInterfaceIDs(interconnectionID)

Return handles of hierInterface children.

Section: F.7.37.22.

Parameters:

interconnectionID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getInterfaceModeAttribute(elementID, *, _attr='interfaceMode', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getInternalPortReferenceComponentInstanceRefByName(internalPortReferenceID)

Return componentInstanceRef attribute value.

Section: F.7.37.7.

Parameters:

internalPortReferenceID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getInternalPortReferencePartSelectID(internalPortReferenceID)

Return handle of partSelect element for internalPortReference.

Section: F.7.37.23.

Parameters:

internalPortReferenceID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getInternalPortReferencePortRefByName(internalPortReferenceID)

Return portRef attribute from internalPortReference.

Section: F.7.37.24.

Parameters:

internalPortReferenceID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getInternalPortReferenceSubPortReferenceIDs(internalPortReferenceID)

Return handles of subPortReference elements of internalPortReference.

Section: F.7.37.25.

Parameters:

internalPortReferenceID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getInvertAttribute(elementID, *, _attr='invert', _rtype='bool', _kind='bool')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getIpxactFileName(ipxact_file)

Return the file name of an ipxactFile entry.

Parameters:

ipxact_file (IpxactFileType)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getIpxactFileVlnvRefByVLNV(ipxact_file)

Return the VLNV string (vendor:library:name:version) for an ipxactFile.

Parameters:

ipxact_file (IpxactFileType)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getIsIOBooleanAttribute(elementID, *, _attr='isIO', _rtype='bool', _kind='bool')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getLevelAttribute(elementID, *, _attr='level', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getLibextAttribute(elementID, *, _attr='libext', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getLibraryAttribute(elementID, *, _attr='library', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getLoadConstraintCellSpecificationID(loadConstraintID)

Return handle of the cellSpecification of a loadConstraint.

Section: F.7.33.16.

Parameters:

loadConstraintID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getLoadConstraintCount(loadConstraintID)

Return numeric count of a loadConstraint.

Section: F.7.33.17.

Parameters:

loadConstraintID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getLoadConstraintCountExpression(loadConstraintID)

Return textual count expression of a loadConstraint.

Section: F.7.33.18.

Parameters:

loadConstraintID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getLoadConstraintCountID(loadConstraintID)

Return handle of the count expression element.

Section: F.7.33.19.

Parameters:

loadConstraintID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getLoadConstraintOther(loadConstraintID)

Return the other attribute (cellFunction based specification only).

Section: F.7.33.20.

Parameters:

loadConstraintID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getLoadConstraintType(loadConstraintID)

Return type of a loadConstraint (cellFunction value or cellClass value).

Section: F.7.33.21.

Parameters:

loadConstraintID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getLoadConstraintValue(loadConstraintID)

Return the load constraint strength value (cellStrength attribute).

Section: F.7.33.22.

Parameters:

loadConstraintID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getLocalMemoryMapAddressBlockIDs(localMemoryMapID)

List addressBlock handles in a localMemoryMap.

Section: F.7.11.14.

Parameters:

localMemoryMapID (str) – Handle referencing a localMemoryMap.

Returns:

Handles of contained addressBlock elements (empty if none).

Return type:

list[str]

Raises:

TgiError – If handle invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getLocalMemoryMapBankIDs(localMemoryMapID)

List bank handles within a localMemoryMap.

Section: F.7.11.15.

Parameters:

localMemoryMapID (str) – Handle referencing a localMemoryMap.

Returns:

Bank handles (empty list if none present).

Return type:

list[str]

Raises:

TgiError – If handle invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getLogicalPortRange(portMapID)

Return handle of the logicalPort.range element.

Section: F.7.69.1.

Parameters:

portMapID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getLogicalPortRangeExpression(portMapID)

Return combined expression (“left:right”) for logicalPort.range.

Section: F.7.69.2.

Parameters:

portMapID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getLogicalPortRangeLeftID(portMapID)

Return handle to the left element of logicalPort.range.

Section: F.7.69.3.

Parameters:

portMapID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getLogicalPortRangeRightID(portMapID)

Return handle to the right element of logicalPort.range.

Section: F.7.69.4.

Parameters:

portMapID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getMandatoryBooleanAttribute(elementID, *, _attr='mandatory', _rtype='bool', _kind='bool')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getMaximumAttribute(elementID, *, _attr='maximum', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getMaximumDoubleAttribute(elementID, *, _attr='maximum', _rtype='float', _kind='float')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getMaximumIntAttribute(elementID, *, _attr='maximum', _rtype='int', _kind='int')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getMemoryMapAddressBlockIDs(memoryMapID)

Return handles of all addressBlock children.

Section: F.7.57.44.

Parameters:

memoryMapID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getMemoryMapAddressUnitBits(memoryMapID)

Return the numeric value of addressUnitBits.

Section: F.7.57.45. Returns None if element absent or not numeric.

Parameters:

memoryMapID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getMemoryMapAddressUnitBitsExpression(memoryMapID)

Return expression text of addressUnitBits if present.

Section: F.7.57.46. Returns None if no element.

Parameters:

memoryMapID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getMemoryMapAddressUnitBitsID(memoryMapID)

Return handle of addressUnitBits element.

Section: F.7.57.47. Returns None if absent.

Parameters:

memoryMapID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getMemoryMapBankIDs(memoryMapID)

Return handles of bank children.

Section: F.7.57.48.

Parameters:

memoryMapID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getMemoryMapElementIDs(memoryMapID)

Return handles of all direct memory map elements (addressBlocks, banks, subspaceMaps, memoryRemaps).

Section: F.7.57.49.

Parameters:

memoryMapID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getMemoryMapElementType(elementID)

Return the element type name for a memory map child handle.

Section: F.7.57.50. Returns the local element type string or None if the handle does not reference a known memory map element type.

Parameters:

elementID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getMemoryMapMemoryMapDefinitionRefByExternalTypeDefID(memoryMapID)

Return the referenced memoryMapDefinition name.

Section: F.7.57.51. Returns None if absent.

Parameters:

memoryMapID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getMemoryMapMemoryMapDefinitionRefByID(memoryMapID)

Return memoryMapDefinition name via element handle.

Section: F.7.57.52.

Parameters:

memoryMapID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getMemoryMapMemoryMapDefinitionRefByName(memoryMapID)

Return memoryMapDefinition name by its name lookup.

Section: F.7.57.53.

Parameters:

memoryMapID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getMemoryMapMemoryMapDefinitionRefID(memoryMapID)

Return handle of memoryMapDefinitionRef element.

Section: F.7.57.54.

Parameters:

memoryMapID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getMemoryMapMemoryRemapIDs(memoryMapID)

Return handles of memoryRemap children.

Section: F.7.57.55.

Parameters:

memoryMapID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getMemoryMapRefAttribute(elementID, *, _attr='memoryMapRef', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getMemoryMapRefAttributeByID(elementID, *, _attr='memoryMapRef', _rtype='ref', _kind='ref')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getMemoryMapRemapIDs(memoryMapID)

Alias for memory remap IDs (compat name per spec F.7.57.56).

Parameters:

memoryMapID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getMemoryMapShared(memoryMapID)

Return shared attribute value (if present).

Section: F.7.57 (paired with setter F.7.58.68). Returns None if not set.

Parameters:

memoryMapID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getMemoryReMapRefAttributeByID(elementID, *, _attr='memoryReMapRef', _rtype='ref', _kind='ref')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getMemoryRemapDefinitionAddressUnitBits(memoryRemapDefinitionID)

Parameters:

memoryRemapDefinitionID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getMemoryRemapDefinitionAddressUnitBitsExpression(memoryRemapDefinitionID)

Parameters:

memoryRemapDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getMemoryRemapDefinitionAddressUnitBitsID(memoryRemapDefinitionID)

Parameters:

memoryRemapDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getMemoryRemapRefAttribute(elementID, *, _attr='memoryRemapRef', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getMinimumAttribute(elementID, *, _attr='minimum', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getMinimumDoubleAttribute(elementID, *, _attr='minimum', _rtype='float', _kind='float')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getMinimumIntAttribute(elementID, *, _attr='minimum', _rtype='int', _kind='int')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getMisalignmentAllowedBooleanAttribute(elementID, *, _attr='misalignmentAllowed', _rtype='bool', _kind='bool')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getModeConstraintsDriveConstraintCellSpecificationID(modeConstraintsID)

Return handle to driveConstraint/cellSpecification.

Section: F.7.2.37.

Parameters:

modeConstraintsID (str) – Handle to a modeConstraints element.

Returns:

Handle to first cellSpecification element or None.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getModeConstraintsLoadConstraintID(modeConstraintsID)

Return handle to loadConstraint.

Section: F.7.2.38.

Parameters:

modeConstraintsID (str) – Handle to a modeConstraints element.

Returns:

Handle string or None if absent.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getModeConstraintsTimingConstraintIDs(modeConstraintsID)

Return timingConstraint handles.

Section: F.7.2.39.

Parameters:

modeConstraintsID (str) – Handle to a modeConstraints element.

Returns:

List of timingConstraint handles (possibly empty).

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getModeLinkExternalModeReferenceID(modeLinkID)

Parameters:

modeLinkID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getModeLinkExternalModeReferenceRefByName(modeLinkID)

Parameters:

modeLinkID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getModeLinkModeReferenceID(modeLinkID)

Parameters:

modeLinkID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getModeLinkModeReferenceRefByName(modeLinkID)

Parameters:

modeLinkID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getModeRefAttribute(elementID, *, _attr='modeRef', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getModifyAttribute(elementID, *, _attr='modify', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getModuleParameterDataTypeDefinitionRefByID(parameterID)

Return the data type definition reference ID (handle) if present.

Section: F.7.65.1. Current model: return None (placeholder) pending full type definitions integration.

Parameters:

parameterID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getModuleParameterIDs(moduleParameterContainerElementID)

Return handles of all moduleParameter elements in the container.

Section: F.7.61.1.

Parameters:

moduleParameterContainerElementID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getModuleParameterValue(moduleParameterID)

Return the parameter value simple string (None if absent).

Section: F.7.61.2.

Parameters:

moduleParameterID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getModuleParameterValueExpression(moduleParameterID)

Return the value expression (mirrors value in this model).

Section: F.7.61.3.

Parameters:

moduleParameterID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getMonitorInterconnectionMonitorInterfaceIDs(monitorInterconnectionID)

Return handles of monitorInterface elements.

Section: F.7.37.26.

Parameters:

monitorInterconnectionID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getMonitorInterconnectionMonitoredActiveInterfaceID(monitorInterconnectionID)

Return handle of monitoredActiveInterface element.

Section: F.7.37.27.

Parameters:

monitorInterconnectionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getMultipleGroupSelectionOperatorAttribute(elementID, *, _attr='multipleGroupSelectionOperator', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getName(elementID)

Return name text.

Section: F.7.63.3.

Parameters:

elementID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getNameAttribute(elementID, *, _attr='name', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getOnSystemGroup(onSystemID)

Return onSystem group attribute.

Section: F.7.2.40.

Parameters:

onSystemID (str) – Handle to an onSystem element (transactional or wire).

Returns:

Group name string or None.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getOrderFloatAttribute(elementID, *, _attr='order', _rtype='float', _kind='float')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getOtherAnyAttribute(elementID, *, _attr='otherAny', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getOtherAttribute(elementID, *, _attr='other', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getOtherAttributes(elementID, *, _attr='others', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPackedBooleanAttribute(elementID, *, _attr='packed', _rtype='bool', _kind='bool')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPacketEndianness(packetID)

Return packet endianness.

Section: F.7.2.41.

Parameters:

packetID (str) – Handle to a packet element.

Returns:

Endianness string (big/little) or None.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPacketFieldEndianness(packetFieldID)

Return packetField endianness.

Section: F.7.2.42.

Parameters:

packetFieldID (str) – Handle to a packetField element.

Returns:

Endianness string or None.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPacketFieldQualifierID(packetFieldID)

Return handle of packetField qualifier.

Section: F.7.2.43.

Parameters:

packetFieldID (str) – Handle to a packetField element.

Returns:

Qualifier handle string or None.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPacketFieldValue(packetFieldID)

Return numeric packetField value.

Section: F.7.2.44.

Parameters:

packetFieldID (str) – Handle to a packetField element.

Returns:

Integer value or None.

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPacketFieldValueExpression(packetFieldID)

Return packetField value expression.

Section: F.7.2.45.

Parameters:

packetFieldID (str) – Handle to a packetField element.

Returns:

Expression string or None.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPacketFieldWidth(packetFieldID)

Return packetField width numeric value.

Section: F.7.2.47.

Parameters:

packetFieldID (str) – Handle to a packetField element.

Returns:

Integer width or None.

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPacketFieldWidthExpression(packetFieldID)

Return packetField width expression.

Section: F.7.2.48.

Parameters:

packetFieldID (str) – Handle to a packetField element.

Returns:

Expression string or None.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPacketFieldWidthID(packetFieldID)

Return handle of packetField width element.

Section: F.7.2.49.

Parameters:

packetFieldID (str) – Handle to a packetField element.

Returns:

Width handle string or None.

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPacketPacketFieldIDs(packetID)

Return packetField child handles of a packet.

Section: F.7.2.50.

Parameters:

packetID (str) – Handle to a packet element.

Returns:

List of packetField handles (possibly empty).

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getParameterChoiceRefByName(parameterContainerElementID, parameterName)

Return handle of the choice referenced by parameter name.

Section: F.7.65.2. Placeholder returns None until choices are attached to parameters in the model.

Parameters:

• parameterContainerElementID (str)

• parameterName (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getParameterIDFromReferenceID(parameterContainerElementID, referenceParameterID)

Map a reference parameter ID to the actual parameter ID (identity).

Section: F.7.65.3. With no separate reference indirection layer yet, returns the input if it resolves to a Parameter.

Parameters:

• parameterContainerElementID (str)

• referenceParameterID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getParameterIDs(parameterContainerElementID)

Return handles of all parameter elements under the container.

Section: F.7.65.4.

Parameters:

parameterContainerElementID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getParameterIdAttribute(elementID, *, _attr='parameterId', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getParameterNameFromReferenceID(parameterContainerElementID, referenceParameterID)

Return parameter name given a (possibly reference) parameter ID.

Section: F.7.65.5.

Parameters:

• parameterContainerElementID (str)

• referenceParameterID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getParameterValue(parameterID)

Return parameter value simple text.

Section: F.7.65.6.

Parameters:

parameterID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getParameterValueExpression(parameterID)

Return expression for parameter value (mirrors value currently).

Section: F.7.65.7.

Parameters:

parameterID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getParameterValueID(parameterID)

Return handle to the value element (parameter itself here).

Section: F.7.65.8.

Parameters:

parameterID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPartSelectIndexIDs(partSelectID)

Return handles of each index element in a partSelect.

Section: F.7.59.12. Assumes attribute index list on object.

Parameters:

partSelectID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPartSelectIndices(partSelectID)

Return concrete integer indices for part select (best-effort).

Section: F.7.59.13.

Parameters:

partSelectID (str)

Return type:

list[int]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPartSelectIndicesExpression(partSelectID)

Return raw expressions/values for each index.

Section: F.7.59.14.

Parameters:

partSelectID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPartSelectRange(partSelectID)

Return (left,right) numeric range if can be parsed.

Section: F.7.59.15.

Parameters:

partSelectID (str)

Return type:

tuple[int | None, int | None]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPartSelectRangeExpression(partSelectID)

Return (leftExpr,rightExpr) raw expression/value strings.

Section: F.7.59.16.

Parameters:

partSelectID (str)

Return type:

tuple[str | None, str | None]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPartSelectRangeLeftID(partSelectID)

Return handle of left expression element if present.

Section: F.7.59.17.

Parameters:

partSelectID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPartSelectRangeRightID(partSelectID)

Return handle of right expression element if present.

Section: F.7.59.18.

Parameters:

partSelectID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPathAttribute(elementID, *, _attr='path', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPayloadExtension(portID)

Return payload extension string for a transactional port.

Section: F.7.67.17. Implementation note: Not modeled in schema; returns None.

Parameters:

portID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPayloadExtensionID(portID)

Return handle for payload extension element.

Section: F.7.67.18. Not modeled; returns None.

Parameters:

portID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPayloadType(portID)

Return payload type for a transactional port.

Section: F.7.67.19. Implementation note: Not modeled separately; returns None.

Parameters:

portID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPhantomBooleanAttribute(elementID, *, _attr='phantom', _rtype='bool', _kind='bool')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPhysicalPortPartSelectID(portMapID)

Return handle to physicalPort.partSelect.

Section: F.7.69.5.

Parameters:

portMapID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPhysicalPortSubPortIDs(portMapID)

Return handles of physicalPort.subPort elements.

Section: F.7.69.6.

Parameters:

portMapID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPortAccessID(portID)

Return handle of the access element of the port.

Section: F.7.67.20.

Parameters:

portID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPortMapIsInformative(portMapID)

Return isInformative flag value.

Section: F.7.69.7.

Parameters:

portMapID (str)

Return type:

bool | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPortMapLogicalPortID(portMapID)

Return handle of logicalPort element.

Section: F.7.69.8.

Parameters:

portMapID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPortMapLogicalTieOff(portMapID)

Return handle of logicalTieOff element.

Section: F.7.69.9.

Parameters:

portMapID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPortMapLogicalTieOffExpression(portMapID)

Return expression text of logicalTieOff.

Section: F.7.69.10.

Parameters:

portMapID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPortMapLogicalTieOffID(portMapID)

Alias for getPortMapLogicalTieOff (both return handle).

Section: F.7.69.11.

Parameters:

portMapID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPortMapPhysicalPortID(portMapID)

Return handle of physicalPort element.

Section: F.7.69.12.

Parameters:

portMapID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPortRefAttribute(elementID, *, _attr='portRef', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPortRefAttributeByID(elementID, *, _attr='portRef', _rtype='ref', _kind='ref')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPortTransactionalPowerConstraintIDs(portID)

Return IDs of transactional powerConstraint elements (F.7.71.1).

Parameters:

portID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPortWirePowerConstraintIDs(portID)

Return IDs of wire powerConstraint elements (F.7.71.2).

Parameters:

portID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPowerConstraintPowerDomainRefByID(powerConstraintID)

Return powerDomainRef value for constraint (F.7.71.3).

Parameters:

powerConstraintID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPowerConstraintPowerDomainRefByName(powerConstraintID)

Alias of getPowerConstraintPowerDomainRefByID (F.7.71.4).

Parameters:

powerConstraintID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPowerConstraintRange(powerConstraintID)

Return range handle if present (wire only) (F.7.71.5).

Parameters:

powerConstraintID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPowerConstraintRangeLeftID(powerConstraintID)

Return left bound handle of range (F.7.71.6).

Parameters:

powerConstraintID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPowerConstraintRangeRightID(powerConstraintID)

Return right bound handle of range (F.7.71.7).

Parameters:

powerConstraintID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPowerDomainAlwaysOn(powerDomainID)

Return boolean alwaysOn value (F.7.71.8).

Parameters:

powerDomainID (str)

Return type:

bool | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPowerDomainAlwaysOnExpression(powerDomainID)

Return expression string for alwaysOn (F.7.71.9).

Parameters:

powerDomainID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPowerDomainAlwaysOnID(powerDomainID)

Return handle of alwaysOn element (F.7.71.10).

Parameters:

powerDomainID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPowerDomainLinkExternalPowerDomainRef(powerDomainLinkID)

Return external power domain value from powerDomainLink.

Section: F.7.37.28.

Parameters:

powerDomainLinkID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPowerDomainLinkExternalPowerDomainRefByID(powerDomainLinkID)

Return handle to referenced external power domain (not resolved).

Section: F.7.37.29. (Not resolvable without external library; returns None.)

Parameters:

powerDomainLinkID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPowerDomainLinkExternalPowerDomainRefByName(powerDomainLinkID)

Return external power domain referenced (string).

Section: F.7.37.30.

Parameters:

powerDomainLinkID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPowerDomainLinkExternalPowerDomainRefID(powerDomainLinkID)

Return handle of external power domain expression element.

Section: F.7.37.32.

Parameters:

powerDomainLinkID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPowerDomainLinkInternalPowerDomainRefs(powerDomainLinkID)

Return internal power domain reference expressions (strings).

Section: F.7.37.33.

Parameters:

powerDomainLinkID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPowerDomainName(powerDomainID)

Return power domain name (F.7.71.11).

Parameters:

powerDomainID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPowerDomainRefAttribute(elementID, *, _attr='powerDomainRef', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPowerDomainRefAttributeByID(elementID, *, _attr='powerDomainRef', _rtype='ref', _kind='ref')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPowerDomainSubDomainOf(powerDomainID)

Return subDomainOf value (F.7.71.12).

Parameters:

powerDomainID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPowerDomainSubDomainOfRefByID(powerDomainID)

Alias of getPowerDomainSubDomainOf (F.7.71.13).

Parameters:

powerDomainID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPrefixAttribute(elementID, *, _attr='prefix', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPriorityIntAttribute(elementID, *, _attr='priority', _rtype='int', _kind='int')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getPromptAttribute(elementID, *, _attr='prompt', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getReferenceIdAttribute(elementID, *, _attr='referenceId', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegionAddressOffset(segmentID)

Get numeric value of a region (segment) addressOffset.

Section: F.7.11.16.

Parameters:

segmentID (str) – Handle referencing a segment.

Returns:

Evaluated offset or None if absent or not evaluable.

Return type:

int | None

Raises:

TgiError – If segment handle invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegionAddressOffsetExpression(segmentID)

Get expression string of a segment addressOffset.

Section: F.7.11.17.

Parameters:

segmentID (str) – Segment handle.

Returns:

Expression string or None if missing.

Return type:

str | None

Raises:

TgiError – If handle invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegionAddressOffsetID(segmentID)

Get handle of the segment addressOffset element.

Section: F.7.11.18.

Parameters:

segmentID (str) – Segment handle.

Returns:

Child handle or None when element absent.

Return type:

str | None

Raises:

TgiError – If handle invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegionRange(segmentID)

Get numeric value of a segment range.

Section: F.7.11.19.

Parameters:

segmentID (str) – Segment handle.

Returns:

Numeric range value or None if absent/not evaluable.

Return type:

int | None

Raises:

TgiError – If handle invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegionRangeExpression(segmentID)

Get expression string for a segment range.

Section: F.7.11.20.

Parameters:

segmentID (str) – Segment handle.

Returns:

Expression or None if element absent.

Return type:

str | None

Raises:

TgiError – If handle invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegionRangeID(segmentID)

Get handle of the segment range element.

Section: F.7.11.21.

Parameters:

segmentID (str) – Segment handle.

Returns:

Child handle or None when element absent.

Return type:

str | None

Raises:

TgiError – If handle invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterAccessPolicyIDs(registerID)

Section: F.7.9.39 Return accessPolicy handles of a register.

Parameters:

registerID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterAddressOffset(registerID)

Return addressOffset value (F.7.73.45).

Parameters:

registerID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterAddressOffsetExpression(registerID)

Return addressOffset expression (F.7.73.46).

Parameters:

registerID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterAddressOffsetID(registerID)

Return handle of addressOffset (F.7.73.47).

Parameters:

registerID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterAlternateRegisterIDs(registerID)

Return alternateRegister handles (F.7.73.48).

Parameters:

registerID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterArrayID(registerID)

Return array handle for a register element if it has one.

Section: F.7.13.13.

Parameters:

registerID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterFieldAliasOfID(registerFieldID)

Return aliasOf handle (F.7.73.49).

Parameters:

registerFieldID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterFieldArrayID(fieldID)

Return array handle for a register field element if present.

Section: F.7.13.14.

Parameters:

fieldID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterFieldBitOffset(registerFieldID)

Return bitOffset value (F.7.73.50).

Parameters:

registerFieldID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterFieldBitOffsetExpression(registerFieldID)

Return bitOffset expression (F.7.73.51).

Parameters:

registerFieldID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterFieldBitOffsetID(registerFieldID)

Return handle of bitOffset (F.7.73.52).

Parameters:

registerFieldID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterFieldBitWidth(registerFieldID)

Return bitWidth numeric value (F.7.73.53).

Parameters:

registerFieldID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterFieldBitWidthExpression(registerFieldID)

Return bitWidth expression (F.7.73.54).

Parameters:

registerFieldID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterFieldBitWidthID(registerFieldID)

Return bitWidth handle (F.7.73.55).

Parameters:

registerFieldID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterFieldEnumeratedValuesID(registerFieldID)

Return enumeratedValues handle (F.7.73.56).

Parameters:

registerFieldID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterFieldFieldAccessPoliciesID(registerFieldID)

Section: F.7.9.40 Return handle of fieldAccessPolicies container on a field.

Parameters:

registerFieldID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterFieldFieldDefinitionRefByExternalTypeDefID(registerFieldID)

Return externalTypeDefinitions handle (F.7.73.57).

Parameters:

registerFieldID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterFieldFieldDefinitionRefByID(registerFieldID)

Return fieldDefinition handle (F.7.73.58).

Parameters:

registerFieldID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterFieldFieldDefinitionRefByName(registerFieldID)

Return fieldDefinitionRef value (F.7.73.59).

Parameters:

registerFieldID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterFieldFieldDefinitionRefID(registerFieldID)

Return fieldDefinitionRef handle (F.7.73.60).

Parameters:

registerFieldID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterFieldIDs(registerID)

Return register field handles (F.7.73.61).

Parameters:

registerID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterFieldResetIDs(registerFieldID)

Return reset handles (F.7.73.62).

Parameters:

registerFieldID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterFieldTypeIdentifier(registerFieldID)

Return typeIdentifier (F.7.73.63).

Parameters:

registerFieldID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterFieldVolatility(registerFieldID)

Return volatility flag (F.7.73.64).

Parameters:

registerFieldID (str)

Return type:

bool | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterFileAccessHandleIDs(registerFileID)

Parameters:

registerFileID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterFileAccessPolicyIDs(registerFileID)

Parameters:

registerFileID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterFileAddressOffset(registerFileID)

Parameters:

registerFileID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterFileAddressOffsetExpression(registerFileID)

Parameters:

registerFileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterFileAddressOffsetID(registerFileID)

Return addressOffset handle (F.7.73.65).

Parameters:

registerFileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterFileArrayID(registerFileID)

Parameters:

registerFileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterFileDefinitionAddressUnitBits(registerFileDefinitionID)

Parameters:

registerFileDefinitionID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterFileDefinitionAddressUnitBitsExpression(registerFileDefinitionID)

Parameters:

registerFileDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterFileDefinitionAddressUnitBitsID(registerFileDefinitionID)

Parameters:

registerFileDefinitionID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterFileRange(registerFileID)

Parameters:

registerFileID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterFileRangeExpression(registerFileID)

Parameters:

registerFileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterFileRangeID(registerFileID)

Parameters:

registerFileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterFileRefAttribute(elementID, *, _attr='registerFileRef', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterFileRefAttributeByID(elementID, *, _attr='registerFileRef', _rtype='ref', _kind='ref')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterFileRefIndexIDs(registerFileID)

Parameters:

registerFileID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterFileRegisterFileDefinitionRefByExternalTypeDefID(registerFileID, externalTypeDefID)

Parameters:

• registerFileID (str)

• externalTypeDefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterFileRegisterFileDefinitionRefByID(registerFileID, byID)

Parameters:

• registerFileID (str)

• byID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterFileRegisterFileDefinitionRefByName(registerFileID, name)

Parameters:

• registerFileID (str)

• name (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterFileRegisterFileDefinitionRefID(registerFileID)

Parameters:

registerFileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterFileRegisterFileIDs(registerFileID)

Parameters:

registerFileID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterFileRegisterIDs(registerFileID)

Parameters:

registerFileID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterFileTypeIdentifier(registerFileID)

Parameters:

registerFileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterRefAttribute(elementID, *, _attr='registerRef', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterRefAttributeByID(registerRefID)

Return referenced register handle (F.7.73.66).

Parameters:

registerRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterRefIndexIDs(registerRefID)

Return index handles (F.7.73.67).

Parameters:

registerRefID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterRefRegisterRefByName(registerRefID)

Return registerRef value (F.7.73.68).

Parameters:

registerRefID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterRegisterDefinitionRefByExternalTypeDefID(registerID)

Return externalTypeDefinitions handle (F.7.73.69).

Parameters:

registerID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterRegisterDefinitionRefByID(registerID)

Return registerDefinition handle (F.7.73.70).

Parameters:

registerID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterRegisterDefinitionRefByName(registerID)

Return registerDefinitionRef value (F.7.73.71).

Parameters:

registerID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterRegisterDefinitionRefID(registerID)

Return registerDefinitionRef handle (F.7.73.72).

Parameters:

registerID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterSize(registerID)

Return size value (F.7.73.73).

Parameters:

registerID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterSizeExpression(registerID)

Return size expression (F.7.73.74).

Parameters:

registerID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterSizeID(registerID)

Return size handle (F.7.73.75).

Parameters:

registerID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterTypeIdentifier(registerID)

Return typeIdentifier (F.7.73.76).

Parameters:

registerID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getRegisterVolatility(registerID)

Return volatility boolean (F.7.73.77).

Parameters:

registerID (str)

Return type:

bool | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getReplicateBooleanAttribute(elementID, *, _attr='replicate', _rtype='bool', _kind='bool')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getResetMask(resetID)

Return reset mask resolved value (F.7.73.78).

Parameters:

resetID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getResetMaskExpression(resetID)

Return reset mask expression (F.7.73.79).

Parameters:

resetID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getResetMaskID(resetID)

Return mask handle (F.7.73.80).

Parameters:

resetID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getResetTypeLinkExternalResetTypeRefByName(resetTypeLinkID)

Parameters:

resetTypeLinkID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getResetTypeLinkExternalResetTypeReferenceID(resetTypeLinkID)

Parameters:

resetTypeLinkID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getResetTypeLinkResetTypeReferenceID(resetTypeLinkID)

Parameters:

resetTypeLinkID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getResetTypeLinkResetTypeReferenceRefByName(resetTypeLinkID)

Parameters:

resetTypeLinkID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getResetTypeRefAttribute(elementID, *, _attr='resetTypeRef', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getResetTypeRefAttributeByID(elementID, *, _attr='resetTypeRef', _rtype='ref', _kind='ref')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getResetValue(resetID)

Return reset value (F.7.73.81).

Parameters:

resetID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getResetValueExpression(resetID)

Return reset value expression (F.7.73.82).

Parameters:

resetID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getResetValueID(resetID)

Return reset value handle (F.7.73.83).

Parameters:

resetID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getResolveAttribute(elementID, *, _attr='resolve', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getScopeAttribute(elementID, *, _attr='scope', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getSegmentRefAttribute(elementID, *, _attr='segmentRef', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getSegmentRefAttributeByID(elementID, *, _attr='segmentRef', _rtype='ref', _kind='ref')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getShortDescription(elementID)

Return shortDescription text.

Section: F.7.63.4.

Parameters:

elementID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getSignAttribute(elementID, *, _attr='sign', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getSourceFileFileType(sourceFileID)

Return fileType value (Section: F.7.47.41).

Parameters:

sourceFileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getSourceFileFileTypeID(sourceFileID)

Return fileType element handle (Section: F.7.47.42).

Parameters:

sourceFileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getSourceFileSourceName(sourceFileID)

Return sourceName value (Section: F.7.47.43).

Parameters:

sourceFileID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getStrictBooleanAttribute(elementID, *, _attr='strict', _rtype='bool', _kind='bool')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getSubPortRefAttribute(elementID, *, _attr='subPortRef', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getSubPortRefAttributeByID(elementID, *, _attr='subPortRef', _rtype='ref', _kind='ref')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getTestConstraintAttribute(elementID, *, _attr='testConstraint', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getTextAttribute(elementID, *, _attr='text', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getTimingConstraintValue(timingConstraintID)

Return numeric value of a timingConstraint.

Section: F.7.33.23.

Parameters:

timingConstraintID (str)

Return type:

float | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getTransportMethodsTransportMethodID(transportMethodsID)

Return handle of the transportMethod child.

Section: F.7.49.14.

Parameters:

transportMethodsID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getTypeAttribute(elementID, *, _attr='type', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getTypeDefinitionsAddressBlockDefinitionIDs(typeDefinitionsID)

Parameters:

typeDefinitionsID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getTypeDefinitionsAttribute(elementID, *, _attr='typeDefinitions', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getTypeDefinitionsBankDefinitionIDs(typeDefinitionsID)

Parameters:

typeDefinitionsID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getTypeDefinitionsChoiceIDs(typeDefinitionsID)

Parameters:

typeDefinitionsID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getTypeDefinitionsEnumerationDefinitionIDs(typeDefinitionsID)

Parameters:

typeDefinitionsID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getTypeDefinitionsExternalTypeDefinitionsIDs(typeDefinitionsID)

Parameters:

typeDefinitionsID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getTypeDefinitionsFieldAccessPolicyDefinitionIDs(typeDefinitionsID)

Section: F.7.9.41 Return fieldAccessPolicyDefinition handles under typeDefinitions.

Parameters:

typeDefinitionsID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getTypeDefinitionsFieldDefinitionIDs(typeDefinitionsID)

Parameters:

typeDefinitionsID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getTypeDefinitionsIDs(topElementID)

Return handles of Type Definitions (BASE).

Parameters:

topElementID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getTypeDefinitionsMemoryMapDefinitionIDs(typeDefinitionsID)

Parameters:

typeDefinitionsID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getTypeDefinitionsMemoryRemapDefinitionIDs(typeDefinitionsID)

Parameters:

typeDefinitionsID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getTypeDefinitionsModeIDs(typeDefinitionsID)

Parameters:

typeDefinitionsID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getTypeDefinitionsRegisterDefinitionIDs(typeDefinitionsID)

Parameters:

typeDefinitionsID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getTypeDefinitionsRegisterFileDefinitionIDs(typeDefinitionsID)

Parameters:

typeDefinitionsID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getTypeDefinitionsResetTypeIDs(typeDefinitionsID)

Parameters:

typeDefinitionsID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getTypeDefinitionsViewIDs(typeDefinitionsID)

Parameters:

typeDefinitionsID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getUnconfiguredID(configuredElementID)

Return the unconfigured element ID for the given configured element.

Section: F.7.31.7.

Identity mapping placeholder (see module docstring). Always returns the provided ID after validating it resolves.

Parameters:

configuredElementID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getUniqueBooleanAttribute(elementID, *, _attr='unique', _rtype='bool', _kind='bool')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getUnitAttribute(elementID, *, _attr='unit', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getUnitsAttribute(elementID, *, _attr='units', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getUsageAttribute(elementID, *, _attr='usage', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getUsageTypeAttribute(elementID, *, _attr='usageType', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getUserAttribute(elementID, *, _attr='user', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getVLNV(elementID)

Return VLNV quadruple of an element (BASE).

If the handle refers to a root registered in the global registry we delegate to that (ensuring unregistered elements return None after removal). Otherwise we fall back to extracting vendor/library/name/ version attributes directly and returning a 4-tuple with None in missing positions. Invalid handles return (None, None, None, None).

Parameters:

elementID (str)

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getValue(elementID)

Return generic simple content value.

Section: F.7.59.19.

Parameters:

elementID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getVectorIDs(vectorContainerID)

Parameters:

vectorContainerID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getVectorIdAttribute(elementID)

Parameters:

elementID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getVectorLeftID(vectorID)

Parameters:

vectorID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getVectorRange(vectorID)

Parameters:

vectorID (str)

Return type:

list[int | None] | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getVectorRangeExpression(vectorID)

Parameters:

vectorID (str)

Return type:

list[str | None] | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getVectorRightID(vectorID)

Parameters:

vectorID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getVendorAttribute(elementID, *, _attr='vendor', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getVendorExtensionElementAttributeNames(parentID, elementName)

Parameters:

• parentID (str)

• elementName (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getVendorExtensionElementAttributeValue(parentID, elementName, attributeName)

Parameters:

• parentID (str)

• elementName (str)

• attributeName (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getVendorExtensionElementNames(parentID)

Parameters:

parentID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getVendorExtensionElementText(parentID, elementName)

Parameters:

• parentID (str)

• elementName (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getVendorExtensionElementsRaw(parentID)

Parameters:

parentID (str)

Return type:

list[Any]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getVendorExtensionsIDs(parentID)

Parameters:

parentID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getVersionAttribute(elementID, *, _attr='version', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getViewBusInterfaceRefIDs(viewID)

Parameters:

viewID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getViewComponentInstantiationRefByID(viewID)

Parameters:

viewID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getViewComponentInstantiationRefByName(viewID)

Parameters:

viewID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getViewConfigurationConfigurableElementValueIDs(viewConfigurationID)

Return handles of configurableElementValue children within a viewConfiguration’s view.

Section: F.7.39.18.

Parameters:

viewConfigurationID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getViewConfigurationInstanceName(viewConfigurationID)

Return instanceName for a viewConfiguration.

Section: F.7.39.19.

Parameters:

viewConfigurationID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getViewConfigurationViewID(viewConfigurationID)

Return handle of the view element of a viewConfiguration.

Section: F.7.39.20.

Parameters:

viewConfigurationID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getViewEnvIdentifierIDs(viewID)

Parameters:

viewID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getViewEnvIdentifiers(viewID)

Parameters:

viewID (str)

Return type:

list[str | None]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getViewFileSetRefIDs(viewID)

Parameters:

viewID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getViewLinkExternalViewReferenceID(viewLinkID)

Parameters:

viewLinkID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getViewLinkExternalViewReferenceRefByName(viewLinkID)

Parameters:

viewLinkID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getViewLinkViewReferenceID(viewLinkID)

Parameters:

viewLinkID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getViewLinkViewReferenceRefByID(viewLinkID)

Parameters:

viewLinkID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getViewLinkViewReferenceRefByName(viewLinkID)

Parameters:

viewLinkID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getViewModelName(viewID)

Parameters:

viewID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getViewModelParametersID(viewID)

Parameters:

viewID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getViewName(viewID)

Parameters:

viewID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getViewOtherClockDriverRefIDs(viewID)

Parameters:

viewID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getViewParametersID(viewID)

Parameters:

viewID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getViewPortWireRefIDs(viewID)

Parameters:

viewID (str)

Return type:

list[str]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getViewRefAttribute(elementID, *, _attr='viewRef', _rtype='str', _kind='str')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getViewRefAttributeByID(elementID, *, _attr='viewRef', _rtype='ref', _kind='ref')

Return the value (or handle) of the specified attribute.

Section: F.7.43.* (exact subsection per function name).

Parameters:

elementID (str) – Element handle.

Returns:

Attribute value coerced to the appropriate primitive or handle (for *ByID functions) or None if unset.

Return type:

Any

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getViewVendorExtensionsID(viewID)

Parameters:

viewID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getWriteValueConstraintMaximum(writeValueConstraintID)

Section: F.7.9.42 Return maximum numeric value.

Parameters:

writeValueConstraintID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getWriteValueConstraintMaximumExpression(writeValueConstraintID)

Section: F.7.9.43 Return maximum expression string.

Parameters:

writeValueConstraintID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getWriteValueConstraintMaximumID(writeValueConstraintID)

Section: F.7.9.44 Return handle of maximum element.

Parameters:

writeValueConstraintID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getWriteValueConstraintMinimum(writeValueConstraintID)

Section: F.7.9.45 Return minimum numeric value.

Parameters:

writeValueConstraintID (str)

Return type:

int | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getWriteValueConstraintMinimumExpression(writeValueConstraintID)

Section: F.7.9.46 Return minimum expression string.

Parameters:

writeValueConstraintID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getWriteValueConstraintMinimumID(writeValueConstraintID)

Section: F.7.9.47 Return handle of minimum element.

Parameters:

writeValueConstraintID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getWriteValueConstraintUseEnumeratedValues(writeValueConstraintID)

Section: F.7.9.48 Return useEnumeratedValues flag.

Parameters:

writeValueConstraintID (str)

Return type:

bool | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getWriteValueConstraintWriteAsRead(writeValueConstraintID)

Section: F.7.9.49 Return writeAsRead flag.

Parameters:

writeValueConstraintID (str)

Return type:

bool | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getXML(elementID)

Serialize an element to XML using xsdata’s XmlSerializer.

Section: F.7.59.20. Uses the project-wide serializer configuration (indentation two spaces). If the element cannot be resolved, None is returned. Errors during serialization raise TgiError with INVALID_ARGUMENT.

Parameters:

elementID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.getXMLPath(elementID)

Return XML path for an element or synthesize one from VLNV.

Synthesis produces /vendor:library:name:version skipping missing parts. Invalid handle returns None.

Parameters:

elementID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.get_handle(obj)

Return (and allocate if new) handle for obj.

Parameters:

obj (Any)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.init(apiVersion, failureMode, init_message=None)

Initialize a new TGI administrative session (Init command).

Section F.3.2 specifies Init as the required first administrative message from the generator to the DE. While the standard only mandates a boolean return status, practical service front-ends provide contextual arguments (API version negotiated, desired failure/reporting mode, and an optional initial status message).

Parameters:

• apiVersion (str) – API version string requested/advertised by the generator (e.g. “1685-2022”). Stored for later inspection.

• failureMode (str) – Strategy for fault handling (implementation defined – e.g. “strict”, “permissive”, “continue”). The value is stored verbatim; no enumeration enforcement is applied here.

• init_message (str | None)

Return type:

bool

init_message: Optional initial status line to record (equivalent to a

first Message command with informational severity).

Raises:

TgiError – If a session is already active (no intervening End), fault code ALREADY_EXISTS.

Returns:

True when initialization succeeds.

Parameters:

• apiVersion (str)

• failureMode (str)

• init_message (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.isSetAttribute(elementID, attributeName)

Return True if a named attribute exists and is not None.

Section: F.7.44.2.

Parameters:

• elementID (str) – Element handle.

• attributeName (str) – Raw attribute field name in data model.

Returns:

True if set, else False.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.isSetElement(elementID)

Return True if element handle resolves to an object.

Section: F.7.60.4.

Parameters:

elementID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.message(severity, text)

Record a status message (Message command) for the active session.

Section F.3.2 defines Message as a way for a generator to convey status to the user. This implementation captures both a required severity tag and the message text, storing them in the session log.

Parameters:

• severity (str) – Free-form severity level (e.g. INFO, WARN, ERROR). No validation is enforced; callers may adopt any taxonomy.

• text (str) – Message body. Empty strings are ignored (treated as no-op) but still return True.

Raises:

TgiError – If called before init or after end with fault code INVALID_ARGUMENT.

Returns:

True if accepted / ignored (empty text).

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.registerCatalogVLNVs(vlnvEntries)

Register multiple catalog VLNV entries (no roots known yet).

Section: F.7.60.6. Each entry is a 4-tuple; returns success flags. Root object association is undefined here so a lightweight placeholder object is used.

Parameters:

vlnvEntries (Iterable[Sequence[str] | str])

Return type:

list[bool]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.registerVLNV(elementID, vlnv)

Register a single VLNV for an element.

Section: F.7.60.7. Accepts either a handle string or the object itself (tests pass objects directly). Raises TgiError if duplicate.

Parameters:

• elementID (Any)

• vlnv (Sequence[str] | str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAbstractionDefChoice(choiceID)

Remove a choice element.

Section: F.7.3.9.

Parameters:

choiceID (str) – Choice handle.

Returns:

True if removed, False otherwise.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAbstractionDefPort(portID)

Remove a port.

Section: F.7.3.11.

Parameters:

portID (str) – Port handle.

Returns:

True if removed, False otherwise.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAbstractionDefPortMode(portModeID)

Remove a port mode element.

Section: F.7.3.13.

Parameters:

portModeID (str) – Handle of onInitiator/onTarget/onSystem element.

Returns:

True if removed, False otherwise.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAbstractionDefPortTransactionalModeBusWidth(portID)

Remove transactional mode busWidth.

Section: F.7.3.14.

Parameters:

portID (str) – Handle of a transactional port.

Returns:

True if at least one busWidth element was removed, else False.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAbstractionDefPortTransactionalModeInitiative(portID)

Remove transactional mode initiative across loci.

Section: F.7.3.15.

Parameters:

portID (str) – Transactional port handle.

Returns:

True if any initiative element cleared.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAbstractionDefPortTransactionalModeKind(portID)

Remove transactional mode kind across loci.

Section: F.7.3.16.

Parameters:

portID (str) – Transactional port handle.

Returns:

True if any kind element cleared.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAbstractionDefPortTransactionalModePresence(portID)

Remove transactional mode presence across loci.

Section: F.7.3.17.

Parameters:

portID (str) – Transactional port handle.

Returns:

True if any presence element cleared.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAbstractionDefPortTransactionalModeProtocol(portID)

Remove transactional mode protocol across loci.

Section: F.7.3.18.

Parameters:

portID (str) – Transactional port handle.

Returns:

True if any protocol element cleared.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAbstractionDefPortTransactionalOnInitiator(portID)

Remove the transactional onInitiator element.

Section: F.7.3.19.

Parameters:

portID (str) – Transactional port handle.

Returns:

True if removed, False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAbstractionDefPortTransactionalOnSystem(onSystemID)

Remove a transactional onSystem element.

Section: F.7.3.20.

Parameters:

onSystemID (str) – onSystem handle.

Returns:

True if removed, False otherwise.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAbstractionDefPortTransactionalOnTarget(portID)

Remove the transactional onTarget element.

Section: F.7.3.20.

Parameters:

portID (str) – Transactional port handle.

Returns:

True if removed, else False.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAbstractionDefPortTransactionalQualifier(portID)

Remove transactional qualifier element.

Section: F.7.3.21.

Parameters:

portID (str) – Transactional port handle.

Returns:

True if qualifier removed.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAbstractionDefPortWireModeDirection(portID)

Remove wire mode direction.

Section: F.7.3.22.

Parameters:

portID (str) – Wire port handle.

Returns:

True if direction removed.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAbstractionDefPortWireModeMirroredModeConstraints(portID)

Remove mirroredModeConstraints.

Section: F.7.3.23.

Parameters:

portID (str) – Wire port handle.

Returns:

True if element removed.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAbstractionDefPortWireModeModeConstraints(portID)

Remove modeConstraints.

Section: F.7.3.24.

Parameters:

portID (str) – Wire port handle.

Returns:

True if element removed.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAbstractionDefPortWireModePresence(portID)

Remove wire mode presence.

Section: F.7.3.25.

Parameters:

portID (str) – Wire port handle.

Returns:

True if presence removed.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAbstractionDefPortWireModeWidth(portID)

Remove wire mode width.

Section: F.7.3.26.

Parameters:

portID (str) – Wire port handle.

Returns:

True if width removed.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAbstractionDefPortWireOnInitiator(portID)

Remove wire onInitiator (not explicitly modeled).

Section: F.7.3.27 (stub – underlying schema lacks explicit element).

Parameters:

portID (str) – Wire port handle.

Returns:

Always False (no separate element to remove).

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAbstractionDefPortWireOnSystem(onSystemID)

Remove a wire onSystem element.

Section: F.7.3.30.

Parameters:

onSystemID (str) – onSystem handle.

Returns:

True if removed, False otherwise.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAbstractionDefPortWireOnTarget(portID)

Remove wire onTarget (not explicitly modeled).

Section: F.7.3.28 (stub – underlying schema lacks explicit element).

Parameters:

portID (str) – Wire port handle.

Returns:

Always False.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAbstractionDefPortWireQualifier(portID)

Remove wire qualifier.

Section: F.7.3.29.

Parameters:

portID (str) – Wire port handle.

Returns:

True if qualifier removed.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAbstractionDefPortWireRequiresDriver(portID)

Remove requiresDriver.

Section: F.7.3.30.

Parameters:

portID (str) – Wire port handle.

Returns:

True if element removed.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAbstractorAbstractorGenerator(abstractorGeneratorID)

Remove an abstractorGenerator.

Section: F.7.5.12.

Parameters:

abstractorGeneratorID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAbstractorChoice(choiceID)

Remove a choice element.

Section: F.7.5.13.

Parameters:

choiceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAbstractorComponentInstantiation(componentInstantiationID)

Remove a componentInstantiation.

Section: F.7.5.14.

Parameters:

componentInstantiationID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAbstractorFileSet(fileSetID)

Remove a fileSet element.

Section: F.7.5.15.

Parameters:

fileSetID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAbstractorGeneratorGroup(groupID)

Remove a group element from an AbstractorGenerator.

Section: F.7.50.3.

Parameters:

groupID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAbstractorInstancesAbstractorInstance(abstractorInstanceID)

Remove an abstractorInstance.

Section: F.7.40.8. Returns False if handle invalid or not found under its parent.

Parameters:

abstractorInstanceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAbstractorInstancesInterfaceRef(interfaceRefID)

Remove an interfaceRef.

Section: F.7.40.9.

Parameters:

interfaceRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAbstractorInterfaceAbstractionType(abstractionTypeID)

Remove an abstractionType from an abstractorInterface.

Section: F.7.5.16.

Parameters:

abstractionTypeID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAbstractorPort(portID)

Remove a model port (any style).

Section: F.7.5.17.

Parameters:

portID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAbstractorView(viewID)

Remove a model view.

Section: F.7.5.18.

Parameters:

viewID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAccessHandle(accessHandleID)

Remove an accessHandle element.

Section: F.7.8.6.

Parameters:

accessHandleID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAccessHandleIndex(indexID)

Remove an index element.

Section: F.7.8.7.

Parameters:

indexID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAccessHandlePathSegment(pathSegmentID)

Remove a pathSegment element.

Section: F.7.8.8.

Parameters:

pathSegmentID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAccessHandleSlice(sliceID)

Remove a slice element (port/sliced variants).

Section: F.7.8.9.

Parameters:

sliceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAccessHandleViewRef(viewRefID)

Remove a viewRef element.

Section: F.7.8.10.

Parameters:

viewRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAccessPolicyAccess(accessPolicyID)

Section: F.7.10.12 Remove access element from accessPolicy.

Parameters:

accessPolicyID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAccessRestrictionModeRef(modeRefID)

Section: F.7.10.13 Remove a modeRef from an accessRestriction.

Parameters:

modeRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAccessRestrictionReadAccessMask(accessRestrictionID)

Section: F.7.10.14 Remove readAccessMask element.

Parameters:

accessRestrictionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAccessRestrictionWriteAccessMask(accessRestrictionID)

Section: F.7.10.15 Remove writeAccessMask element.

Parameters:

accessRestrictionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeActiveInterfaceExcludePort(excludePortID)

Remove excludePort element.

Section: F.7.38.13.

Parameters:

excludePortID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAdHocConnectionExternalPortReference(externalPortReferenceID)

Remove externalPortReference element.

Section: F.7.38.14.

Parameters:

externalPortReferenceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAdHocConnectionInternalPortReference(internalPortReferenceID)

Remove internalPortReference element.

Section: F.7.38.15.

Parameters:

internalPortReferenceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAdHocConnectionTiedValue(adHocConnectionID)

Remove tiedValue element from adHocConnection.

Section: F.7.38.16.

Parameters:

adHocConnectionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAddressBlockAccessPolicyID(accessPolicyID)

Section: F.7.10.16 Remove accessPolicy (addressBlock container).

Parameters:

accessPolicyID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAddressBlockDefinitionAddressUnitBits(addressBlockDefinitionID)

Parameters:

addressBlockDefinitionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAddressSpaceAddressUnitBits(addressSpaceID)

Remove the addressUnitBits element if present.

Section: F.7.12.4.

Parameters:

addressSpaceID (str) – Address space handle.

Returns:

True if removed, False if it was absent.

Return type:

bool

Raises:

TgiError – If handle invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAddressSpaceLocalMemoryMap(addressSpaceID)

Remove the localMemoryMap element if present.

Section: F.7.12.5.

Parameters:

addressSpaceID (str) – Address space handle.

Returns:

True if removed, else False.

Return type:

bool

Raises:

TgiError – If handle invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAddressSpaceSegment(segmentID)

Remove a segment element.

Section: F.7.12.6.

Parameters:

segmentID (str) – Segment handle.

Returns:

True if removed, False if not found.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAliasOfAlternateRegisterRef(aliasOfID)

Remove alternateRegisterRef (F.7.74.11).

Parameters:

aliasOfID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAliasOfMemoryRemapRef(aliasOfMemoryRemapRefID)

Remove aliasOfMemoryRemapRef (global element reference removal).

Section: F.7.54.6.

Parameters:

aliasOfMemoryRemapRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAliasOfRegisterFileRef(aliasOfRegisterFileRefID)

Parameters:

aliasOfRegisterFileRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAliasOfRegisterRef(aliasOfID)

Remove registerRef (F.7.74.12).

Parameters:

aliasOfID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAllBitsAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAlternateRegisterAccessPolicy(accessPolicyID)

Section: F.7.10.17 Remove accessPolicy (alternateRegister container).

Parameters:

accessPolicyID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAlternateRegisterField(regFieldID)

Remove alternate register field (F.7.74.13).

Parameters:

regFieldID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAlternateRegisterTypeIdentifier(alternateRegisterID)

Remove typeIdentifier (F.7.74.14).

Parameters:

alternateRegisterID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAlternateRegisterVolatility(alternateRegisterID)

Remove volatility (F.7.74.15).

Parameters:

alternateRegisterID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAlternaterRegisterModeRef(modeRefID)

Remove modeRef element (F.7.74.16).

Parameters:

modeRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAppendAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeArray(arrayID)

Remove an array element.

Section: F.7.14.3.

Parameters:

arrayID (str) – Array handle.

Returns:

True if removed, else False.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeArrayDim(dimID)

Remove a dim element.

Section: F.7.14.4.

Parameters:

dimID (str) – Dimension handle.

Returns:

True if removed, else False.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeArrayIdAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeArrayStride(arrayID)

Remove stride element if present.

Section: F.7.14.5.

Parameters:

arrayID (str) – Array handle.

Returns:

True if present and removed, else False.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAssertion(assertionID)

Remove an assertion element.

Section: F.7.16.2.

Parameters:

assertionID (str) – Assertion handle.

Returns:

True if removed else False.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeAttribute(elementID, attributeName)

Remove (clear) an arbitrary attribute by name.

Parameters:

• elementID (str) – Element handle.

• attributeName (str) – Attribute field name to clear.

Returns:

True if removed; False if it was not set.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeBankDefinitionAddressUnitBits(bankDefinitionID)

Parameters:

bankDefinitionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeBroadcastToAddressBlockRef(broadcastToID)

Remove addressBlockRef (F.7.74.17).

Parameters:

broadcastToID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeBroadcastToAddressSpaceRef(broadcastToAddressSpaceRefID)

Remove broadcastToAddressSpaceRef.

Section: F.7.54.7.

Parameters:

broadcastToAddressSpaceRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeBroadcastToAlternateRegisterRef(broadcastToID)

Remove alternateRegisterRef (F.7.74.18).

Parameters:

broadcastToID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeBroadcastToBankRef(bankRefID)

Remove bankRef by element handle (F.7.74.19).

Parameters:

bankRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeBroadcastToMemoryMapRef(broadcastToID)

Remove memoryMapRef (F.7.74.20).

Parameters:

broadcastToID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeBroadcastToRegisterFileRef(registerRefID)

Remove registerFileRef (F.7.74.21).

Parameters:

registerRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeBroadcastToRegisterRef(registerRefID)

Remove registerRef (F.7.74.22).

Parameters:

registerRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeBuildCommandCommand(fileID)

Remove buildCommand.command element.

Section: F.7.46.5.

Parameters:

fileID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeBuildCommandFlags(fileID)

Remove buildCommand.flags element.

Section: F.7.46.6.

Parameters:

fileID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeBuildCommandReplaceDefaultFlags(fileID)

Remove replaceDefaultFlags element.

Section: F.7.46.7.

Parameters:

fileID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeBuildCommandTargetName(fileID)

Remove targetName element.

Section: F.7.46.8.

Parameters:

fileID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeBusDefinitionAssertion(assertionID)

Remove an assertion element by handle.

Parameters:

assertionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeBusDefinitionBroadcast(busDefinitionID)

Remove broadcast flag if present.

Parameters:

busDefinitionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeBusDefinitionChoice(choiceID)

Remove a choice element by handle.

Parameters:

choiceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeBusDefinitionDirectConnection(busDefinitionID)

Remove (clear) directConnection if set.

Parameters:

busDefinitionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeBusDefinitionExtends(busDefinitionID)

Remove extends reference if present.

Parameters:

busDefinitionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeBusDefinitionIsAddressable(busDefinitionID)

Remove isAddressable flag if present.

Parameters:

busDefinitionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeBusDefinitionMaxInitiators(busDefinitionID)

Remove maxInitiators element.

Parameters:

busDefinitionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeBusDefinitionMaxTargets(busDefinitionID)

Remove maxTargets element.

Parameters:

busDefinitionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeBusDefinitionParameter(parameterID)

Remove a parameter element by handle.

Parameters:

parameterID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeBusDefinitionSystemGroupName(systemGroupNameID)

Remove a systemGroupName element by handle.

Parameters:

systemGroupNameID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeBusInterface(busInterfaceID)

Remove a busInterface by handle.

Returns True if removed, False otherwise.

Parameters:

busInterfaceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeCatalogAbstractionDefIpxactFile(catalog, ipxactFileID)

Remove an abstractionDefinition ipxactFile entry by handle.

Parameters:

• catalog (Catalog)

• ipxactFileID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeCatalogAbstractorsIpxactFile(catalog, ipxactFileID)

Remove an abstractors ipxactFile entry by handle.

Parameters:

• catalog (Catalog)

• ipxactFileID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeCatalogBusDefinitionsIpxactFile(catalog, ipxactFileID)

Remove a busDefinitions ipxactFile entry by handle.

Parameters:

• catalog (Catalog)

• ipxactFileID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeCatalogCatalogsIpxactFile(catalog, ipxactFileID)

Remove a catalogs ipxactFile entry by handle.

Parameters:

• catalog (Catalog)

• ipxactFileID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeCatalogComponentsIpxactFile(catalog, ipxactFileID)

Remove a components ipxactFile entry by handle.

Parameters:

• catalog (Catalog)

• ipxactFileID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeCatalogDesignConfigurationsIpxactFile(catalog, ipxactFileID)

Remove a designConfigurations ipxactFile entry by handle.

Parameters:

• catalog (Catalog)

• ipxactFileID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeCatalogDesignsIpxactFile(catalog, ipxactFileID)

Remove a designs ipxactFile entry by handle.

Parameters:

• catalog (Catalog)

• ipxactFileID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeCatalogGeneratorChainsIpxactFile(catalog, ipxactFileID)

Remove a generatorChains ipxactFile entry by handle.

Parameters:

• catalog (Catalog)

• ipxactFileID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeCatalogTypeDefinitionsIpxactFile(catalog, ipxactFileID)

Remove a typeDefinitions ipxactFile entry by handle.

Parameters:

• catalog (Catalog)

• ipxactFileID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeCellStrengthAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeChoiceEnumeration(choiceEnumerationID)

Remove the given choiceEnumeration from its parent choice.

Section: F.7.26.2

Parameters:

choiceEnumerationID (str) – Handle to a Choices.Choice.Enumeration element.

Returns:

True if removed, False if not found.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeChoiceRefAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeClearboxElementDriveable(clearboxElementID)

Remove the driveable element from a clearboxElement.

Section: F.7.28.3

Parameters:

clearboxElementID (str) – Handle to a clearboxElement element.

Returns:

True if removed, False if not present or invalid.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeClearboxElementRefLocation(clearboxElementRefLocationID)

Remove a clearboxElementRefLocation element.

Section: F.7.28.4

Parameters:

clearboxElementRefLocationID (str) – Handle to a clearboxElementRefLocation element.

Returns:

True if removed, False otherwise.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeClockEdgeAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeClockNameAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeClockSourceAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeComponentAddressSpace(componentID, addressSpaceID)

Remove an addressSpace.

Section: F.7.30.29.

Parameters:

• componentID (str)

• addressSpaceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeComponentBusInterface(componentID, busInterfaceID)

Remove a busInterface (any role).

Section: F.7.30.30.

Parameters:

• componentID (str)

• busInterfaceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeComponentChannel(componentID, channelID)

Remove a channel.

Section: F.7.30.31.

Parameters:

• componentID (str)

• channelID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeComponentChoice(componentID, choiceID)

Remove a choice.

Section: F.7.30.32.

Parameters:

• componentID (str)

• choiceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeComponentClearboxElement(componentID, clearboxElementID)

Remove a clearboxElement.

Section: F.7.30.33.

Parameters:

• componentID (str)

• clearboxElementID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeComponentComponentGenerator(componentID, componentGeneratorID)

Remove a componentGenerator.

Section: F.7.30.34.

Parameters:

• componentID (str)

• componentGeneratorID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeComponentComponentInstantiation(componentID, componentInstantiationID)

Remove a componentInstantiation.

Section: F.7.30.35.

Parameters:

• componentID (str)

• componentInstantiationID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeComponentCpu(cpuID)

Remove a cpu element.

Returns True if removed.

Parameters:

cpuID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeComponentDesignConfigurationInstantiation(componentID, designConfigurationInstantiationID)

Remove a designConfigurationInstantiation.

Section: F.7.30.37.

Parameters:

• componentID (str)

• designConfigurationInstantiationID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeComponentDesignInstantiation(componentID, designInstantiationID)

Remove a designInstantiation.

Section: F.7.30.38.

Parameters:

• componentID (str)

• designInstantiationID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeComponentExternalTypeDefinitions(componentID)

Parameters:

componentID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeComponentFileSet(componentID, fileSetID)

Remove a fileSet.

Section: F.7.30.39.

Parameters:

• componentID (str)

• fileSetID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeComponentGeneratorGroup(groupID)

Remove a group element from a ComponentGenerator.

Section: F.7.50.4.

Parameters:

groupID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeComponentIndirectInterface(componentID, indirectInterfaceID)

Remove an indirectInterface.

Section: F.7.30.40.

Parameters:

• componentID (str)

• indirectInterfaceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeComponentInstancePowerDomainLink(powerDomainLinkID)

Remove powerDomainLink (F.7.72.6).

Parameters:

powerDomainLinkID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeComponentInstantiationArchitectureName(componentInstantiationID)

Remove (clear) architectureName.

Section: F.7.56.5.

Parameters:

componentInstantiationID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeComponentInstantiationClearboxElementRef(clearboxElementRefID)

Remove a specific clearboxElementRef by handle.

Section: F.7.56.6.

Parameters:

clearboxElementRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeComponentInstantiationConfigurationName(componentInstantiationID)

Clear configurationName.

Section: F.7.56.7.

Parameters:

componentInstantiationID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeComponentInstantiationConstraintSetRef(constraintSetRefID)

Remove a constraintSetRef by handle.

Section: F.7.56.8.

Parameters:

constraintSetRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeComponentInstantiationDefaultFileBuilder(fileBuilderID)

Remove a defaultFileBuilder by handle.

Section: F.7.56.9.

Parameters:

fileBuilderID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeComponentInstantiationFileSetRef(fileSetRefID)

Remove a fileSetRef.

Section: F.7.56.10.

Parameters:

fileSetRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeComponentInstantiationIsVirtual(componentInstantiationID)

Clear isVirtual element.

Section: F.7.56.11.

Parameters:

componentInstantiationID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeComponentInstantiationLanguage(componentInstantiationID)

Remove language element.

Section: F.7.56.12.

Parameters:

componentInstantiationID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeComponentInstantiationLibraryName(componentInstantiationID)

Clear libraryName.

Section: F.7.56.13.

Parameters:

componentInstantiationID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeComponentInstantiationModuleName(componentInstantiationID)

Clear moduleName.

Section: F.7.56.14.

Parameters:

componentInstantiationID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeComponentInstantiationPackageName(componentInstantiationID)

Clear packageName.

Section: F.7.56.15.

Parameters:

componentInstantiationID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeComponentMemoryMap(componentID, memoryMapID)

Remove a memoryMap.

Section: F.7.30.41.

Parameters:

• componentID (str)

• memoryMapID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeComponentMode(componentID, modeID)

Remove a mode.

Section: F.7.30.42.

Parameters:

• componentID (str)

• modeID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeComponentOtherClockDriver(componentID, otherClockDriverID)

Remove an otherClockDriver.

Section: F.7.30.43.

Parameters:

• componentID (str)

• otherClockDriverID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeComponentPort(componentID, portID)

Remove a port (any style) from model.ports.

Section: F.7.30.44.

Parameters:

• componentID (str)

• portID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeComponentPowerDomain(powerDomainID)

Remove component powerDomain (F.7.72.7).

Parameters:

powerDomainID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeComponentResetType(componentID, resetTypeID)

Remove a resetType element.

Section: F.7.30.45.

Parameters:

• componentID (str)

• resetTypeID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeComponentView(componentID, viewID)

Remove a view element.

Section: F.7.30.46.

Parameters:

• componentID (str)

• viewID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeConfigGroupsAttribute(parameterID)

Remove configGroups attribute from parameter (placeholder).

Section: F.7.66.2. Current model: if attribute exists set to None. Returns True if removed, False if not present or parameter invalid.

Parameters:

parameterID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeConfigurableElementValue(configurableElementValueID)

Remove the referenced configurable element value.

Section: F.7.32.3.

Parameters:

configurableElementValueID (str) – Handle of the value to remove.

Returns:

True if removed, False if not found / wrong type.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeConstrainedAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeConstraintSetDriveConstraint(constraintSetID)

Remove the driveConstraint child from a constraintSet.

Section: F.7.34.1.

Parameters:

constraintSetID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeConstraintSetIdAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeConstraintSetLoadConstraint(constraintSetID)

Remove the loadConstraint child from a constraintSet.

Section: F.7.34.2.

Parameters:

constraintSetID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeConstraintSetTimingConstraint(timingConstraintID)

Remove a timingConstraint element.

Section: F.7.34.3.

Parameters:

timingConstraintID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeConstraintSetVector(constraintSetID)

Remove vector element from a constraintSet.

Section: F.7.34.4.

Parameters:

constraintSetID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeCpuAddressUnitBits(cpuID)

Remove addressUnitBits (alias for set with None).

Parameters:

cpuID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeCpuRegion(regionID)

Remove a CPU region by handle.

Parameters:

regionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeDataTypeAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeDataTypeDefinitionAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeDefaultAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeDefaultFileBuilderCommand(fileBuilderID)

Remove command child from fileBuilder.

Section: F.7.46.9.

Parameters:

fileBuilderID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeDelayTypeAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeDescription(elementID)

Remove description element.

Section: F.7.64.1.

Parameters:

elementID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeDesignAdHocConnection(adHocConnectionID)

Remove adHocConnection element.

Section: F.7.38.17.

Parameters:

adHocConnectionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeDesignChoice(choiceID)

Remove choice element.

Section: F.7.38.18.

Parameters:

choiceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeDesignComponentInstance(componentInstanceID)

Remove componentInstance element.

Section: F.7.38.19.

Parameters:

componentInstanceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeDesignConfChoice(choiceID)

Remove a design configuration choice.

Section: F.7.40.10.

Parameters:

choiceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeDesignConfigurationDesignRef(designConfigurationID)

Remove the designRef element.

Section: F.7.40.11.

Parameters:

designConfigurationID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeDesignConfigurationGeneratorChainConfiguration(generatorChainConfigurationID)

Remove a generatorChainConfiguration reference.

Section: F.7.40.12.

Parameters:

generatorChainConfigurationID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeDesignConfigurationInstantiationLanguage(designConfigurationInstantiationID)

Remove language element from designConfigurationInstantiation.

Section: F.7.56.16.

Parameters:

designConfigurationInstantiationID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeDesignConfigurationInterconnectionConfiguration(interconnectionConfigurationID)

Remove an interconnectionConfiguration element.

Section: F.7.40.13.

Parameters:

interconnectionConfigurationID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeDesignConfigurationViewConfiguration(viewConfigurationID)

Remove a viewConfiguration element.

Section: F.7.40.14.

Parameters:

viewConfigurationID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeDesignInterconnection(interconnectionID)

Remove interconnection element.

Section: F.7.38.20.

Parameters:

interconnectionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeDesignMonitorConnection(monitorInterconnectionID)

Remove monitorInterconnection element.

Section: F.7.38.21.

Parameters:

monitorInterconnectionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeDirectionAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeDisplayName(elementID)

Remove displayName element.

Section: F.7.64.2.

Parameters:

elementID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeDriverClockDriver(clockDriverID)

Remove the clockDriver element.

Section: F.7.42.3.

Parameters:

clockDriverID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeDriverRange(driverID)

Remove the range child of a driver.

Section: F.7.42.4.

Parameters:

driverID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeDriverSingleShotDriver(singleShotDriverID)

Remove the singleShotDriver element.

Section: F.7.42.5.

Parameters:

singleShotDriverID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeDriverTypeAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeDriverViewRef(viewRefID)

Remove a viewRef entry.

Section: F.7.42.6.

Parameters:

viewRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeEnumerationDefinitionEnumeratedValue(enumeratedValueID)

Parameters:

enumeratedValueID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeExecutableImageFileBuilderID(fileBuilderID)

Detach a fileBuilder from its parent list.

Section: F.7.46.10.

Parameters:

fileBuilderID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeExecutableImageFileSetRef(fileSetRefID)

Remove an executableImage fileSetRef (stub).

Section: F.7.12.7.

Returns:

Always False (schema gap).

Return type:

bool

Parameters:

fileSetRefID (str)

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeExecutableImageLanguageTools(executableImageID)

Remove the entire languageTools element.

Section: F.7.46.11.

Parameters:

executableImageID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeExecutableImageLinkerCommandFile(executableImageID)

Remove first linkerCommandFile under languageTools.

Section: F.7.46.12.

Parameters:

executableImageID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeExternalDeclarationsAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeExternalPortReferencePartSelect(externalPortReferenceID)

Remove partSelect from externalPortReference.

Section: F.7.38.22.

Parameters:

externalPortReferenceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeExternalPortReferenceSubPortReference(subPortRefID)

Remove a subPortReference element (external).

Section: F.7.38.23.

Parameters:

subPortRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeExternalTypeDefinitionsModeLink(modeLinkID)

Parameters:

modeLinkID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeExternalTypeDefinitionsResetTypeLink(resetTypeLinkID)

Parameters:

resetTypeLinkID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeExternalTypeDefinitionsViewLink(viewLinkID)

Parameters:

viewLinkID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeFieldAccessPoliciesFieldAccessPolicy(fieldAccessPoliciesID, fieldAccessPolicyID)

Section: F.7.10.18 Remove fieldAccessPolicy from fieldAccessPolicies.

Parameters:

• fieldAccessPoliciesID (str)

• fieldAccessPolicyID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeFieldAccessPolicyAccess(fieldAccessPolicyID)

Section: F.7.10.19 Remove access from fieldAccessPolicy.

Parameters:

fieldAccessPolicyID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeFieldAccessPolicyAccessRestriction(accessRestrictionID)

Section: F.7.10.20 Remove accessRestriction.

Parameters:

accessRestrictionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeFieldAccessPolicyBroadcastTo(broadcastToID)

Section: F.7.10.21 Remove broadcastTo element.

Parameters:

broadcastToID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeFieldAccessPolicyFieldAccessPolicyDefinitionRef(fieldAccessPolicyID)

Section: F.7.10.22 Remove fieldAccessPolicyDefinitionRef.

Parameters:

fieldAccessPolicyID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeFieldAccessPolicyModeRef(modeRefID)

Section: F.7.10.23 Remove fieldAccessPolicy modeRef.

Parameters:

modeRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeFieldAccessPolicyModifiedWriteValue(fieldAccessPolicyID)

Section: F.7.10.24 Remove modifiedWriteValue.

Parameters:

fieldAccessPolicyID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeFieldAccessPolicyReadAction(fieldAccessPolicyID)

Section: F.7.10.25 Remove readAction.

Parameters:

fieldAccessPolicyID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeFieldAccessPolicyReadResponse(fieldAccessPolicyID)

Section: F.7.10.26 Remove readResponse.

Parameters:

fieldAccessPolicyID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeFieldAccessPolicyReserved(fieldAccessPolicyID)

Section: F.7.10.27 Remove reserved.

Parameters:

fieldAccessPolicyID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeFieldAccessPolicyTestable(fieldAccessPolicyID)

Section: F.7.10.28 Remove testable.

Parameters:

fieldAccessPolicyID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeFieldAccessPolicyWriteValueConstraint(fieldAccessPolicyID)

Section: F.7.10.29 Remove writeValueConstraint.

Parameters:

fieldAccessPolicyID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeFieldDefinitionEnumerationDefinitionRef(fieldDefinitionID)

Parameters:

fieldDefinitionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeFieldDefinitionFieldAccessPolicy(accessPolicyID)

Section: F.7.10.30 Remove fieldAccessPolicy from fieldDefinition.

Parameters:

accessPolicyID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeFieldDefinitionsEnumeratedValue(enumeratedValueID)

Parameters:

enumeratedValueID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeFieldSliceAlternateRegisterRef(fieldSliceAlternateRegisterRefID)

Parameters:

fieldSliceAlternateRegisterRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeFieldSliceBankRef(fieldSliceBankRefID)

Parameters:

fieldSliceBankRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeFieldSliceMemoryRemapRef(fieldSliceMemoryRemapRefID)

Parameters:

fieldSliceMemoryRemapRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeFieldSliceRange(fieldSliceRangeID)

Parameters:

fieldSliceRangeID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeFieldSliceRegisterFileRef(fieldSliceRegisterFileRefID)

Parameters:

fieldSliceRegisterFileRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeFileBuildCommand(fileID)

Remove buildCommand (Section: F.7.48.14).

Parameters:

fileID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeFileBuilderCommand(fileBuilderID)

Remove command element of fileBuilder.

Section: F.7.46.13.

Parameters:

fileBuilderID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeFileBuilderFlags(fileBuilderID)

Remove flags element of fileBuilder.

Section: F.7.46.14.

Parameters:

fileBuilderID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeFileBuilderReplaceDefaultFlags(fileBuilderID)

Remove replaceDefaultFlags element of fileBuilder.

Section: F.7.46.15.

Parameters:

fileBuilderID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeFileDefine(defineID)

Remove define (Section: F.7.48.15).

Parameters:

defineID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeFileDependency(dependencyID)

Remove dependency (Section: F.7.48.16).

Parameters:

dependencyID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeFileExportedName(exportedNameID)

Remove exportedName (Section: F.7.48.17).

Parameters:

exportedNameID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeFileFileType(fileTypeID)

Remove fileType (Section: F.7.48.18).

Parameters:

fileTypeID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeFileIdAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeFileImageType(imageTypeID)

Remove imageType (Section: F.7.48.19).

Parameters:

imageTypeID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeFileIsIncludeFile(fileID)

Remove isIncludeFile (Section: F.7.48.20).

Parameters:

fileID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeFileIsStructural(fileID)

Remove isStructural (Section: F.7.48.21).

Parameters:

fileID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeFileLogicalName(fileID)

Remove logicalName (Section: F.7.48.22).

Parameters:

fileID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeFileSetDefaultFileBuilder(fileBuilderID)

Remove defaultFileBuilder (Section: F.7.48.23).

Parameters:

fileBuilderID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeFileSetDependency(dependencyID)

Remove fileSet dependency (Section: F.7.48.24).

Parameters:

dependencyID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeFileSetFile(fileID)

Remove file from fileSet (Section: F.7.48.25).

Parameters:

fileID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeFileSetFunction(functionID)

Remove function (Section: F.7.48.26).

Parameters:

functionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeFileSetGroup(groupID)

Remove group (Section: F.7.48.27).

Parameters:

groupID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeFlowTypeAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeForceAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeFunctionArgument(argumentID)

Remove function argument (Section: F.7.48.28).

Parameters:

argumentID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeFunctionDisabled(functionID)

Remove disabled element (Section: F.7.48.29).

Parameters:

functionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeFunctionEntryPoint(functionID)

Remove entryPoint (Section: F.7.48.30).

Parameters:

functionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeFunctionReturnType(functionID)

Remove returnType (Section: F.7.48.31).

Parameters:

functionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeFunctionSourceFile(functionSourceFileID)

Remove sourceFile (Section: F.7.48.32).

Parameters:

functionSourceFileID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeGeneratorApiService(generatorID)

Remove the apiService element.

Section: F.7.50.5.

Parameters:

generatorID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeGeneratorApiType(generatorID)

Remove the apiType element.

Section: F.7.50.6.

Parameters:

generatorID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeGeneratorChainChainGroup(chainGroupID)

Remove a chainGroup element.

Section: F.7.52.7.

Parameters:

chainGroupID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeGeneratorChainChoice(choiceID)

Remove a choice element.

Section: F.7.52.8.

Parameters:

choiceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeGeneratorChainComponentGeneratorSelector(componentGeneratorSelectorID)

Remove a componentGeneratorSelector element.

Section: F.7.52.9.

Parameters:

componentGeneratorSelectorID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeGeneratorChainGenerator(generatorID)

Remove a generator element.

Section: F.7.52.10.

Parameters:

generatorID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeGeneratorChainGeneratorChainSelector(generatorChainSelectorID)

Remove a generatorChainSelector element.

Section: F.7.52.11.

Parameters:

generatorChainSelectorID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeGeneratorPhase(generatorID)

Remove the phase element.

Section: F.7.50.7.

Parameters:

generatorID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeGeneratorTransportMethods(generatorID)

Remove the transportMethods container.

Section: F.7.50.8.

Parameters:

generatorID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeGroupAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeGroupSelectorName(groupSelectorNameID)

Remove a Name element from a groupSelector.

Section: F.7.52.12.

Parameters:

groupSelectorNameID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeHelpAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeHiddenAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeIdAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeImageTypeAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeImplicitAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeIndexVarAttribute(dimID)

Remove the indexVar attribute from a dimension.

Section: F.7.14.6.

Parameters:

dimID (str) – Dimension handle.

Returns:

True if removed, False if not set.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeIndirectAddressRefAddressBlockRef(indirectAddressRefID)

Remove addressBlockRef from indirectAddressRef.

Section: F.7.54.8.

Parameters:

indirectAddressRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeIndirectAddressRefAddressSpaceRef(indirectAddressRefID)

Remove addressSpaceRef from indirectAddressRef.

Section: F.7.54.9.

Parameters:

indirectAddressRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeIndirectAddressRefAlternateRegisterRef(indirectAddressRefID)

Remove alternateRegisterRef from indirectAddressRef.

Section: F.7.54.10.

Parameters:

indirectAddressRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeIndirectAddressRefBankRef(bankRefID)

Remove a bankRef element (by handle).

Section: F.7.54.11.

Parameters:

bankRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeIndirectAddressRefMemoryMapRef(indirectAddressRefID)

Remove memoryMapRef from indirectAddressRef.

Section: F.7.54.12.

Parameters:

indirectAddressRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeIndirectAddressRefMemoryRemapRef(indirectAddressRefID)

Remove memoryRemapRef from indirectAddressRef.

Section: F.7.54.13.

Parameters:

indirectAddressRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeIndirectAddressRefRegisterFileRef(registerFileRefID)

Remove a registerFileRef element (by handle) from indirectAddressRef.

Section: F.7.54.14.

Parameters:

registerFileRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeIndirectAddressRefRegisterRef(indirectAddressRefID)

Remove registerRef from indirectAddressRef.

Section: F.7.54.15.

Parameters:

indirectAddressRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeIndirectDataRefAddressBlockRef(indirectDataRefID)

Remove addressBlockRef from indirectDataRef.

Section: F.7.54.16.

Parameters:

indirectDataRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeIndirectDataRefAddressSpaceRef(indirectDataRefID)

Remove addressSpaceRef from indirectDataRef.

Section: F.7.54.17.

Parameters:

indirectDataRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeIndirectDataRefAlternateRegisterRef(indirectDataRefID)

Remove alternateRegisterRef from indirectDataRef.

Section: F.7.54.18.

Parameters:

indirectDataRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeIndirectDataRefBankRef(bankRefID)

Remove a bankRef (data) by handle.

Section: F.7.54.19.

Parameters:

bankRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeIndirectDataRefMemoryMapRef(indirectDataRefID)

Remove memoryMapRef from indirectDataRef.

Section: F.7.54.20.

Parameters:

indirectDataRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeIndirectDataRefMemoryRemapRef(indirectDataRefID)

Remove memoryRemapRef from indirectDataRef.

Section: F.7.54.21.

Parameters:

indirectDataRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeIndirectDataRefRegisterFileRef(registerFileRefID)

Remove registerFileRef element (data) by handle.

Section: F.7.54.22.

Parameters:

registerFileRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeIndirectDataRefRegisterRef(indirectDataRefID)

Remove registerRef from indirectDataRef.

Section: F.7.54.23.

Parameters:

indirectDataRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeInterconnectionActiveInterface(activeInterfaceID)

Remove activeInterface element.

Section: F.7.38.24.

Parameters:

activeInterfaceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeInterconnectionConfigurationAbstractorInstances(abstractorInstancesID)

Remove an abstractorInstances grouping.

Section: F.7.40.15.

Parameters:

abstractorInstancesID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeInterconnectionHierInterface(hierInterfaceID)

Remove hierInterface element.

Section: F.7.38.25.

Parameters:

hierInterfaceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeInternalPortReferencePartSelect(internalPortReferenceID)

Remove partSelect from internalPortReference.

Section: F.7.38.26.

Parameters:

internalPortReferenceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeInternalPortReferenceSubPortReference(subPortRefID)

Remove subPortReference element (internal).

Section: F.7.38.27.

Parameters:

subPortRefID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeInvertAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeIsIOAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeLanguageToolsFileBuilder(fileBuilderID)

Remove fileBuilder from languageTools (alias context).

Section: F.7.46.16.

Parameters:

fileBuilderID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeLanguageToolsLinkerCommandFile(languageToolsID)

Remove first linkerCommandFile of languageTools.

Section: F.7.46.17.

Parameters:

languageToolsID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeLanguageToolsLinkerFlags(languageToolsID)

Remove linkerFlags element.

Section: F.7.46.18.

Parameters:

languageToolsID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeLevelAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeLibextAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeLinkerCommandFileGenerator(generatorID)

Remove a linkerCommandFile generator (stub).

Section: F.7.12.8.

Returns:

Always False (schema gap).

Return type:

bool

Parameters:

generatorID (str)

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeLinkerCommandFileGeneratorRef(linkerCommandFileID)

Clear all generatorRef entries from linkerCommandFile.

Section: F.7.46.19.

Parameters:

linkerCommandFileID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeLoadConstraintCount(loadConstraintID)

Remove count element from a loadConstraint.

Section: F.7.34.5.

Parameters:

loadConstraintID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeLocalMemoryMapAddressBlock(addressBlockID)

Remove an addressBlock.

Section: F.7.12.9.

Parameters:

addressBlockID (str) – AddressBlock handle.

Returns:

True if removed, False otherwise.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeLocalMemoryMapBank(bankID)

Remove a bank element.

Section: F.7.12.10.

Parameters:

bankID (str) – Bank handle.

Returns:

True if removed, False otherwise.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeLocationSlice(locationSliceID)

Parameters:

locationSliceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeMaximumAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeMemoryMapMemoryRemap(memoryRemapID)

Remove a memoryRemap element.

Section: F.7.58.40.

Parameters:

memoryRemapID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeMemoryMapSubspaceMap(subspaceMapID)

Remove a subspaceMap element.

Section: F.7.58.42.

Parameters:

subspaceMapID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeMemoryRemapDefinitionAddressUnitBits(memoryRemapDefinitionID)

Parameters:

memoryRemapDefinitionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeMinimumAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeMisalignmentAllowedAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeModeAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeModeFieldSlice(modeFieldSliceID)

Parameters:

modeFieldSliceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeModePortSlice(modePortSliceID)

Parameters:

modePortSliceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeModifyAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeModuleParameter(moduleParameterID)

Remove a moduleParameter by handle.

Section: F.7.62.2.

Parameters:

moduleParameterID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeMonitorInterconnectionMonitorInterface(monitorInterfaceID)

Remove monitorInterface element.

Section: F.7.38.28.

Parameters:

monitorInterfaceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeMultipleGroupSelectionOperatorAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeName(elementID)

Remove name element.

Section: F.7.64.3.

Parameters:

elementID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeOrderAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeOtherAnyAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeOtherAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removePackedAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeParameter(parameterID)

Remove a parameter by handle.

Section: F.7.66.3. Uses parent registry for structural detach.

Parameters:

parameterID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeParameterIdAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removePartSelectIndex(indexID)

Remove an index element from its parent partSelect list.

Section: F.7.60.8.

Parameters:

indexID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removePartSelectRange(partSelectID)

Remove range (left/right) elements.

Section: F.7.60.17.

Parameters:

partSelectID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removePathAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removePhantomAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removePhysicalPortPartSelect(physicalPortID)

Remove partSelect from a physicalPort.

Section: F.7.70.3.

Parameters:

physicalPortID (str)

Return type:

None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removePhysicalPortSubPort(subPortID)

Remove a subPort from its parent physicalPort.

Section: F.7.70.4. Best-effort linear search over known port maps.

Parameters:

subPortID (str)

Return type:

None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removePortMapIsInformative(portMapID)

Clear the isInformative element.

Section: F.7.70.5.

Parameters:

portMapID (str)

Return type:

None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removePortSlicePartSelect(portSlicePartSelectID)

Parameters:

portSlicePartSelectID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removePortSliceSubPortReference(portSliceSubPortReferenceID)

Parameters:

portSliceSubPortReferenceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removePowerConstraintRange(powerConstraintID)

Remove range from powerConstraint (F.7.72.8).

Parameters:

powerConstraintID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removePowerDomainLinkInternalPowerDomainRef(powerDomainLinkID, internalRefExpression)

Remove an internalPowerDomainReference by expression or ID (F.7.72.9).

Parameters:

• powerDomainLinkID (str)

• internalRefExpression (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removePowerDomainRefAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removePowerDomainSubDomainOf(powerDomainID)

Clear subDomainOf (F.7.72.10).

Parameters:

powerDomainID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removePrefixAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removePromptAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeRegisterAccessPolicy(accessPolicyID)

Section: F.7.10.31 Remove accessPolicy from register.

Parameters:

accessPolicyID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeRegisterFileAccessHandle(registerFileAccessHandleID)

Parameters:

registerFileAccessHandleID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeRegisterFileAccessPolicy(accessPolicyID)

Section: F.7.10.32 Remove accessPolicy from registerFile.

Parameters:

accessPolicyID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeRegisterFileDefinitionAddressUnitBits(registerFileDefinitionID)

Parameters:

registerFileDefinitionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeRegisterFileRefIndex(registerFileRefIndexID)

Parameters:

registerFileRefIndexID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeRegisterFileRegister(registerFileRegisterID)

Parameters:

registerFileRegisterID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeRegisterFileRegisterFile(registerFileRegisterFileID)

Parameters:

registerFileRegisterFileID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeRegisterFileTypeIdentifier(registerFileID)

Parameters:

registerFileID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeReplicateAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeResetTypeRefAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeResolveAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeScopeAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeSegmentRefAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeShortDescription(elementID)

Remove shortDescription element.

Section: F.7.64.4.

Parameters:

elementID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeSignAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeSlicePathSegment(slicePathSegmentID)

Parameters:

slicePathSegmentID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeSliceRange(sliceRangeID)

Parameters:

sliceRangeID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeStrictAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeTestConstraintAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeTextAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeTransportMethodsTransportMethod(transportMethodsID)

Remove the transportMethod child from a container.

Section: F.7.50.9. Container itself remains.

Parameters:

transportMethodsID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeTypeAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeTypeDefinitionsAddressBlockDefinition(addressBlockDefinitionID)

Parameters:

addressBlockDefinitionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeTypeDefinitionsAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeTypeDefinitionsBankDefinition(bankDefinitionID)

Parameters:

bankDefinitionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeTypeDefinitionsChoice(choiceID)

Parameters:

choiceID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeTypeDefinitionsEnumerationDefinition(enumerationDefinitionID)

Parameters:

enumerationDefinitionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeTypeDefinitionsExternalTypeDefinitions(externalTypeDefinitionsID)

Parameters:

externalTypeDefinitionsID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeTypeDefinitionsFieldAccessPolicyDefinition(fieldAccessPolicyDefinitionID)

Parameters:

fieldAccessPolicyDefinitionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeTypeDefinitionsFieldDefinition(fieldDefinitionID)

Parameters:

fieldDefinitionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeTypeDefinitionsMemoryMapDefinition(memoryMapDefinitionID)

Parameters:

memoryMapDefinitionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeTypeDefinitionsMemoryRemapDefinition(memoryRemapDefinitionID)

Parameters:

memoryRemapDefinitionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeTypeDefinitionsMode(modeID)

Parameters:

modeID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeTypeDefinitionsRegisterDefinition(registerDefinitionID)

Parameters:

registerDefinitionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeTypeDefinitionsRegisterFileDefinition(registerFileDefinitionID)

Parameters:

registerFileDefinitionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeTypeDefinitionsResetType(resetTypeID)

Parameters:

resetTypeID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeTypeDefinitionsView(viewID)

Parameters:

viewID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeUniqueAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeUnitAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeUnitsAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeUsageTypeAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeUserAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeVectorIdAttribute(elementID)

Remove attribute if present (spec EXTENDED remove function).

Parameters:

elementID (str) – Element handle.

Returns:

True if removed; False if absent.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeVectorLeft(vectorID)

Parameters:

vectorID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeVectorRight(vectorID)

Parameters:

vectorID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeVendorExtensionsElement(extensionID)

Parameters:

extensionID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeViewBusInterfaceRef(refID)

Parameters:

refID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeViewComponentInstantiationRef(refID)

Parameters:

refID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeViewConfigurationConfigurableElementValue(configurableElementValueID)

Remove a configurableElementValue.

Section: F.7.40.16.

Parameters:

configurableElementValueID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeViewEnvIdentifier(envIdentifierID)

Parameters:

envIdentifierID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeViewFileSetRef(refID)

Parameters:

refID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeViewOtherClockDriverRef(refID)

Parameters:

refID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.removeViewPortWireRef(refID)

Parameters:

refID (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.resolveExpression(expression)

Resolve expression (stub returns input).

Parameters:

expression (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.resolve_handle(handle)

Return underlying object or None if unknown.

Parameters:

handle (str)

Return type:

Any | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.save()

Persist current model state (no-op True).

Section: F.7.60.10.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setAbstractionDefExtends(abstractionDefinitionID, vendor, library, name, version)

Set the extends reference.

Section: F.7.3.44.

Parameters:

• abstractionDefinitionID (str) – Abstraction definition handle.

• vendor (str) – Vendor string.

• library (str) – Library string.

• name (str) – Name string.

• version (str) – Version string.

Returns:

True on success.

Raises:

TgiError – If the handle is invalid.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setAbstractionDefPortTransactional(portID)

Ensure port has transactional style container.

Section: F.7.3.56.

Parameters:

portID (str) – Port handle.

Returns:

True (idempotent create).

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setAbstractionDefPortTransactionalModeBusWidth(portID, value)

Set transactional mode busWidth.

Section: F.7.3.48.

Parameters:

• portID (str) – Transactional port handle.

• value (int | str) – Integer or expression for width.

Returns:

True on success.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setAbstractionDefPortTransactionalModeInitiative(portID, value)

Set transactional mode initiative (stored on initiator locus).

Section: F.7.3.49.

Parameters:

• portID (str) – Transactional port handle.

• value (str) – Initiative enumeration string.

Returns:

True on success.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setAbstractionDefPortTransactionalModeKind(portID, value)

Set transactional mode kind (stored on initiator locus or raw string).

Section: F.7.3.50.

Parameters:

• portID (str) – Transactional port handle.

• value (str) – Kind enumeration string.

Returns:

True on success.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setAbstractionDefPortTransactionalModePresence(portID, value)

Set transactional mode presence (initiator locus).

Section: F.7.3.51.

Parameters:

• portID (str) – Transactional port handle.

• value (str) – Presence enumeration string.

Returns:

True on success.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setAbstractionDefPortTransactionalModeProtocol(portID, protocol)

Set transactional mode protocol (initiator locus).

Section: F.7.3.52.

Parameters:

• portID (str) – Transactional port handle.

• protocol (str) – Protocol enumeration / identifier string.

Returns:

True on success.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setAbstractionDefPortTransactionalOnInitiator(portID)

Ensure presence of onInitiator element.

Section: F.7.3.53.

Parameters:

portID (str) – Transactional port handle.

Returns:

True (idempotent).

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setAbstractionDefPortTransactionalOnTarget(portID)

Ensure presence of onTarget element.

Section: F.7.3.54.

Parameters:

portID (str) – Transactional port handle.

Returns:

True (idempotent).

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setAbstractionDefPortTransactionalQualifier(portID, qualifier)

Set transactional qualifier.

Section: F.7.3.55.

Parameters:

• portID (str) – Transactional port handle.

• qualifier (str) – Qualifier string.

Returns:

True on success.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setAbstractionDefPortWire(portID)

Ensure port has wire style container.

Section: F.7.3.57.

Parameters:

portID (str) – Port handle.

Returns:

True (idempotent create).

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setAbstractionDefPortWireDefaultValue(portID, value)

Set wire defaultValue.

Section: F.7.3.58.

Parameters:

• portID (str) – Wire port handle.

• value (int | str) – Integer or expression string.

Returns:

True on success.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setAbstractionDefPortWireModeDirection(portID, direction)

Set wire mode direction.

Section: F.7.3.59.

Parameters:

• portID (str) – Wire port handle.

• direction (str) – Direction enumeration string.

Returns:

True on success.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setAbstractionDefPortWireModeMirroredModeConstraints(portID)

Create mirroredModeConstraints container.

Section: F.7.3.60.

Parameters:

portID (str) – Wire port handle.

Returns:

True on success.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setAbstractionDefPortWireModeModeConstraints(portID)

Create modeConstraints container.

Section: F.7.3.61.

Parameters:

portID (str) – Wire port handle.

Returns:

True on success.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setAbstractionDefPortWireModePresence(portID, value)

Set wire mode presence.

Section: F.7.3.62.

Parameters:

• portID (str) – Wire port handle.

• value (str) – Presence enumeration string.

Returns:

True on success.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setAbstractionDefPortWireModeWidth(portID, value)

Set wire mode width.

Section: F.7.3.63.

Parameters:

• portID (str) – Wire port handle.

• value (int | str) – Integer or expression string.

Returns:

True on success.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setAbstractionDefPortWireOnInitiator(portID)

Stub: ensure wire onInitiator (no-op).

Section: F.7.3.64 (schema does not expose a distinct element).

Parameters:

portID (str) – Wire port handle.

Returns:

True (no-op).

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setAbstractionDefPortWireOnTarget(portID)

Stub: ensure wire onTarget (no-op).

Section: F.7.3.65 (schema does not expose a distinct element).

Parameters:

portID (str) – Wire port handle.

Returns:

True (no-op).

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setAbstractionDefPortWireQualifier(portID, qualifier)

Set wire qualifier.

Section: F.7.3.66.

Parameters:

• portID (str) – Wire port handle.

• qualifier (str) – Qualifier string.

Returns:

True on success.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setAbstractionDefPortWireRequiresDriver(portID, flag)

Set requiresDriver flag.

Section: F.7.3.67.

Parameters:

• portID (str) – Wire port handle.

• flag (bool) – Boolean value.

Returns:

True on success.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setAbstractionTypeAbstractionRef(abstractionTypeID, vlnv)

Set abstractionRef VLNV string (vendor:library:name:version).

Section: F.7.70.6.

Parameters:

• abstractionTypeID (str)

• vlnv (str)

Return type:

None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setAbstractorAbstractorMode(abstractorID, modeValue, group=None)

Set/replace the abstractorMode element.

Section: F.7.5.19.

Parameters:

• abstractorID (str)

• modeValue (str)

• group (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setAbstractorBusType(abstractorID, vlnv)

Set/replace the busType reference.

Section: F.7.5.20.

Parameters:

• abstractorID (str)

• vlnv (tuple[str, str, str, str])

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setAbstractorInstanceAbstractorRef(abstractorInstanceID, vlnv)

Set (replace) the abstractorRef of an abstractorInstance.

Section: F.7.40.17.

Parameters:

• abstractorInstanceID (str)

• vlnv (tuple[str, str, str, str])

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setAbstractorInstanceInstanceName(abstractorInstanceID, instanceName)

Set instanceName of an abstractorInstance.

Section: F.7.40.18.

Parameters:

• abstractorInstanceID (str)

• instanceName (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setAbstractorInstanceViewName(abstractorInstanceID, viewName)

Set viewName of an abstractorInstance.

Section: F.7.40.19.

Parameters:

• abstractorInstanceID (str)

• viewName (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setAccessHandleForce(accessHandleID, value)

Set or clear the force attribute of a sliced/port accessHandle.

Section: F.7.8.11.

Parameters:

• accessHandleID (str) – Handle referencing a slicedAccessHandle or portAccessHandle.

• value (bool | None) – Boolean to set or None to clear (restore default semantics).

Returns:

True on success, False if not applicable.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setAccessPolicyAccess(accessPolicyID, access)

Section: F.7.10.33 Set access value on accessPolicy.

Parameters:

• accessPolicyID (str)

• access (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setAccessRestrictionReadAccessMask(accessRestrictionID, value)

Section: F.7.10.34 Set readAccessMask expression/value.

Parameters:

• accessRestrictionID (str)

• value (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setAccessRestrictionWriteAccessMask(accessRestrictionID, value)

Section: F.7.10.35 Set writeAccessMask expression/value.

Parameters:

• accessRestrictionID (str)

• value (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setAdHocConnectionTiedValue(adHocConnectionID, tiedValue)

Set tiedValue value (creates element if absent).

Section: F.7.38.29.

Parameters:

• adHocConnectionID (str)

• tiedValue (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setAddressBlockDefinitionAddressUnitBits(addressBlockDefinitionID, value)

Parameters:

• addressBlockDefinitionID (str)

• value (int | str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setAddressBlockRefAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setAddressSpaceAddressUnitBits(addressSpaceID, value)

Set or create addressUnitBits.

Section: F.7.12.11.

Parameters:

• addressSpaceID (str) – Address space handle.

• value (int | str) – Integer or expression string.

Returns:

True on success.

Return type:

bool

Raises:

TgiError – If handle invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setAddressSpaceLocalMemoryMap(addressSpaceID, name=None)

Create or replace the localMemoryMap element.

Section: F.7.12.12.

Parameters:

• addressSpaceID (str) – Parent addressSpace handle.

• name (str | None) – Optional name for the new localMemoryMap.

Returns:

True on success.

Return type:

bool

Raises:

TgiError – If handle invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setAddressSpaceRange(addressSpaceID, value)

Set or create the range element.

Section: F.7.12.13.

Parameters:

• addressSpaceID (str) – Address space handle.

• value (int | str) – Integer or expression string.

Returns:

True on success.

Return type:

bool

Raises:

TgiError – If handle invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setAddressSpaceRefAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setAddressSpaceWidth(addressSpaceID, value)

Set or create the width element.

Section: F.7.12.14.

Parameters:

• addressSpaceID (str) – Address space handle.

• value (int | str) – Integer or expression string.

Returns:

True on success.

Return type:

bool

Raises:

TgiError – If handle invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setAllBitsBooleanAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setAllLogicalDirectionsAllowedBooleanAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setAllLogicalInitiativesAllowedBooleanAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setAlternateRegisterRefAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setAppendBooleanAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setArgumentValue(argumentID, value)

Set or clear argument value.

Section: F.7.60.11.

Parameters:

• argumentID (str)

• value (str | int | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setArrayIdAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setArrayStride(arrayID, value)

Set or create the stride element.

Section: F.7.14.7.

Parameters:

• arrayID (str) – Array handle.

• value (int | str) – Integer or expression string.

Returns:

True on success.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setAssertionDescription(assertionID, value)

Set or create description.

Section: F.7.16.6.

Parameters:

• assertionID (str)

• value (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setAssertionDisplayName(assertionID, value)

Set or create displayName.

Section: F.7.16.4.

Parameters:

• assertionID (str)

• value (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setAssertionExpression(assertionID, expression)

Set the assert expression string.

Section: F.7.16.7. Creates the expression container if absent.

Parameters:

• assertionID (str)

• expression (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setAssertionName(assertionID, name)

Set assertion name.

Section: F.7.16.3.

Parameters:

• assertionID (str)

• name (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setAssertionShortDescription(assertionID, value)

Set or create shortDescription.

Section: F.7.16.5.

Parameters:

• assertionID (str)

• value (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setBankAlignmentAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setBankDefinitionAddressUnitBits(bankDefinitionID, value)

Parameters:

• bankDefinitionID (str)

• value (int | str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setBankRefAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setBooleanValue(booleanID, value)

Set or clear boolean value.

Section: F.7.60.12.

Parameters:

• booleanID (str)

• value (bool | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setBuildCommandCommand(fileID, command)

Set buildCommand.command value (creates buildCommand if absent).

Section: F.7.46.20.

Parameters:

• fileID (str)

• command (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setBuildCommandFlags(fileID, flags)

Set buildCommand.flags value.

Section: F.7.46.21.

Parameters:

• fileID (str)

• flags (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setBuildCommandReplaceDefaultFlags(fileID, replace)

Set replaceDefaultFlags boolean.

Section: F.7.46.22.

Parameters:

• fileID (str)

• replace (bool)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setBuildCommandTargetName(fileID, targetName)

Set targetName value.

Section: F.7.46.23.

Parameters:

• fileID (str)

• targetName (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setBusDefinitionBroadcast(busDefinitionID, flag)

Set broadcast flag.

Parameters:

• busDefinitionID (str)

• flag (bool)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setBusDefinitionDescription(busDefinitionID, value)

Set or create the description element.

Parameters:

• busDefinitionID (str)

• value (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setBusDefinitionDirectConnection(busDefinitionID, flag)

Set directConnection boolean.

Parameters:

• busDefinitionID (str)

• flag (bool)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setBusDefinitionDisplayName(busDefinitionID, value)

Set or create the displayName element.

Parameters:

• busDefinitionID (str)

• value (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setBusDefinitionExtends(busDefinitionID, vendor, library, name, version)

Set or create the extends reference (VLNV).

Parameters:

• busDefinitionID (str)

• vendor (str)

• library (str)

• name (str)

• version (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setBusDefinitionIsAddressable(busDefinitionID, flag)

Set isAddressable flag.

Parameters:

• busDefinitionID (str)

• flag (bool)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setBusDefinitionMaxInitiators(busDefinitionID, value)

Set (or create) maxInitiators expression.

Parameters:

• busDefinitionID (str)

• value (int | str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setBusDefinitionMaxTargets(busDefinitionID, value)

Set (or create) maxTargets expression.

Parameters:

• busDefinitionID (str)

• value (int | str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setBusDefinitionShortDescription(busDefinitionID, value)

Set or create the shortDescription element.

Parameters:

• busDefinitionID (str)

• value (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setBusInterfaceBusTypeRefByVLNV(busInterfaceID, busTypeVLNV)

Set or clear the busType reference of a busInterface.

Parameters:

• busInterfaceID (str)

• busTypeVLNV (tuple[str, str, str, str] | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setBusInterfaceConnectionRequired(busInterfaceID, required)

Set or clear the connectionRequired flag.

Parameters:

• busInterfaceID (str)

• required (bool | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setBusRefAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setCellSpecificationCellClass(cellSpecificationID, cellClass)

Set cellClass enumeration of a cellSpecification (clears cellFunction).

Section: F.7.34.6.

Parameters:

• cellSpecificationID (str)

• cellClass (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setCellSpecificationCellFunction(cellSpecificationID, cellFunction)

Set cellFunction enumeration of a cellSpecification (clears cellClass).

Section: F.7.34.7.

Parameters:

• cellSpecificationID (str)

• cellFunction (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setCellStrengthAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setChoiceRefAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setClearboxElementClearboxType(clearboxID, clearboxType)

Set the clearbox type of a clearbox element.

Section: F.7.28.5

Parameters:

• clearboxID (str) – Handle to a clearboxElement element.

• clearboxType (str) – New clearbox type string.

Returns:

True if set, False if not found.

Raises:

TgiError – If the handle is invalid.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setClearboxElementDriveable(clearboxElementID, value)

Set the driveable value for a clearboxElement.

Section: F.7.28.6

Parameters:

• clearboxElementID (str) – Handle to a clearboxElement element.

• value (bool) – Boolean driveable state.

Returns:

True if set, False if not found.

Raises:

TgiError – If the handle is invalid.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setClockDriverClockPeriod(clockDriverID, value, expression=None)

Set clockPeriod value/expression of an existing clockDriver.

Section: F.7.42.7.

Parameters:

• clockDriverID (str)

• value (float)

• expression (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setClockDriverClockPulseDuration(clockDriverID, value, expression=None)

Set clockPulseDuration fields.

Section: F.7.42.8.

Parameters:

• clockDriverID (str)

• value (float)

• expression (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setClockDriverClockPulseOffset(clockDriverID, value, expression=None)

Set clockPulseOffset fields.

Section: F.7.42.9.

Parameters:

• clockDriverID (str)

• value (float)

• expression (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setClockDriverClockPulseValue(clockDriverID, value, expression=None)

Set clockPulseValue fields.

Section: F.7.42.10.

Parameters:

• clockDriverID (str)

• value (int)

• expression (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setClockEdgeAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setClockNameAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setClockSourceAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setComponentGeneratorSelectorGroupSelector(componentGeneratorSelectorID, names)

Set groupSelector (names list) on componentGeneratorSelector.

Section: F.7.52.13. Replaces any existing groupSelector.

Parameters:

• componentGeneratorSelectorID (str)

• names (list[str])

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setComponentInstanceComponentRef(componentInstanceID, componentVLNV)

Set componentRef VLNV on componentInstance.

Section: F.7.38.30.

Parameters:

• componentInstanceID (str)

• componentVLNV (tuple[str, str, str, str])

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setComponentInstanceRefAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setComponentInstantiationArchitectureName(componentInstantiationID, architectureName)

Set architectureName.

Section: F.7.56.17.

Parameters:

• componentInstantiationID (str)

• architectureName (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setComponentInstantiationConfigurationName(componentInstantiationID, configurationName)

Set configurationName.

Section: F.7.56.18.

Parameters:

• componentInstantiationID (str)

• configurationName (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setComponentInstantiationIsVirtual(componentInstantiationID, value)

Set isVirtual element value.

Section: F.7.56.19.

Parameters:

• componentInstantiationID (str)

• value (bool)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setComponentInstantiationLanguage(componentInstantiationID, language)

Set language element (creates if absent).

Section: F.7.56.20.

Parameters:

• componentInstantiationID (str)

• language (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setComponentInstantiationLibraryName(componentInstantiationID, libraryName)

Set libraryName.

Section: F.7.56.21.

Parameters:

• componentInstantiationID (str)

• libraryName (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setComponentInstantiationModuleName(componentInstantiationID, moduleName)

Set moduleName.

Section: F.7.56.22.

Parameters:

• componentInstantiationID (str)

• moduleName (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setComponentInstantiationPackageName(componentInstantiationID, packageName)

Set packageName.

Section: F.7.56.23.

Parameters:

• componentInstantiationID (str)

• packageName (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setComponentRefAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setConfigGroupsAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setConfigurableElementValue(configurableElementID, expression)

Set the default value/expression of a configurable element.

Section: F.7.32.4.

Parameters:

• configurableElementID (str) – Handle of the value element.

• expression (str) – New expression text.

Returns:

True if updated, False if not.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setConfigurableElementValueReferenceID(configurableElementValueID, referenceID)

Set the referenceId attribute of a configurable element value.

Section: F.7.32.5.

Parameters:

• configurableElementValueID (str) – Handle of the value element.

• referenceID (str) – New reference ID string.

Returns:

True if updated, False otherwise.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setConfigurableElementValueValue(configurableElementValueID, expression)

Set the expression text of a configurable element value.

Section: F.7.32.6.

Parameters:

• configurableElementValueID (str) – Handle of the value element.

• expression (str) – New expression/value string.

Returns:

True if updated, False otherwise.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setConstraintSetDriveConstraint(constraintSetID, cellFunctionOrCellClass)

Create/replace driveConstraint with given type (function or class).

Section: F.7.34.8. Strength left unspecified (None) until separately set.

Parameters:

• constraintSetID (str)

• cellFunctionOrCellClass (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setConstraintSetIdAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setConstraintSetLoadConstraint(constraintSetID, cellFunctionOrCellClass)

Create/replace loadConstraint with given type (function or class).

Section: F.7.34.9.

Parameters:

• constraintSetID (str)

• cellFunctionOrCellClass (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setConstraintSetReferenceName(constraintSetID, referenceName)

Set the constraintSetId attribute of a constraintSet.

Section: F.7.34.10.

Parameters:

• constraintSetID (str)

• referenceName (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setConstraintSetVector(constraintSetID, vector)

Set vector left/right expression values for a constraintSet.

Section: F.7.34.11. Expects list/tuple of two strings.

Parameters:

• constraintSetID (str)

• vector (list[str])

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setCpuAddressUnitBits(cpuID, value)

Set or clear addressUnitBits.

Value is stored as an AddressUnitBits expression. Clearing occurs when value is None.

Parameters:

• cpuID (str)

• value (int | str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setCpuMemoryMapRef(cpuID, memoryMapRef)

Set or clear the memoryMapRef value.

Parameters:

• cpuID (str)

• memoryMapRef (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setCpuRange(cpuID, value)

Set or clear the range expression of a CPU.

Parameters:

• cpuID (str)

• value (int | str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setCpuRegionAddressOffset(regionID, value)

Set or clear a region addressOffset expression.

Parameters:

• regionID (str)

• value (int | str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setCpuRegionRange(regionID, value)

Set or clear a region range expression.

Parameters:

• regionID (str)

• value (int | str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setCpuWidth(cpuID, value)

Set or clear the width expression of a CPU.

Parameters:

• cpuID (str)

• value (int | str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setCustomAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setDataTypeAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setDataTypeDefinitionAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setDefaultBooleanAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setDefineValue(defineID, value)

Set or clear define value.

Section: F.7.60.13.

Parameters:

• defineID (str)

• value (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setDelayTypeAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setDescription(elementID, value)

Set description text (None clears).

Section: F.7.64.5.

Parameters:

• elementID (str)

• value (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setDesignConfigurationDesignRef(designConfigurationID, vlnv)

Set (or create) the designRef reference.

Section: F.7.40.20.

Parameters:

• designConfigurationID (str)

• vlnv (tuple[str, str, str, str])

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setDesignConfigurationInstantiationDesignConfigurationRef(designConfigurationInstantiationID, designConfigurationVLNV)

Set the designConfigurationRef (creates if absent).

Section: F.7.56.24.

Parameters:

• designConfigurationInstantiationID (str)

• designConfigurationVLNV (tuple[str, str, str, str])

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setDesignConfigurationInstantiationLanguage(designConfigurationInstantiationID, language)

Set language element for designConfigurationInstantiation.

Section: F.7.56.25.

Parameters:

• designConfigurationInstantiationID (str)

• language (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setDimIndexVar(dimID, name)

Set (or create) indexVar attribute of a dimension.

Section: F.7.14.8.

Parameters:

• dimID (str) – Dimension handle.

• name (str) – Index variable name.

Returns:

True on success.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setDirectionAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setDisplayName(elementID, value)

Set displayName text (None clears). Handles both naming variants.

Section: F.7.64.6.

Parameters:

• elementID (str)

• value (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setDriveConstraintOtherValue(driveConstraintID, other)

Set other attribute for driveConstraint cellFunction variant.

Section: F.7.34.12.

Parameters:

• driveConstraintID (str)

• other (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setDriveConstraintValue(driveConstraintID, value)

Set cellStrength (value) for driveConstraint cellSpecification.

Section: F.7.34.13.

Parameters:

• driveConstraintID (str)

• value (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setDriverClockDriver(driverID)

Ensure clockDriver exists (creating if necessary) and return its handle.

Section: F.7.42.11.

Parameters:

driverID (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setDriverDefaultValue(driverID, value, expression=None)

Set defaultValue contents (creating element if missing).

Section: F.7.42.13.

Parameters:

• driverID (str)

• value (int | str)

• expression (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setDriverRange(driverID, leftValue, rightValue, leftExpression=None, rightExpression=None)

Set range bounds creating range if required.

Section: F.7.42.14.

Parameters:

• driverID (str)

• leftValue (int)

• rightValue (int)

• leftExpression (str | None)

• rightExpression (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setDriverSingleShotDriver(driverID)

Ensure singleShotDriver exists and return its handle.

Section: F.7.42.12.

Parameters:

driverID (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setDriverTypeAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setEnumerationDefinitionWidth(enumerationDefinitionID, value)

Parameters:

• enumerationDefinitionID (str)

• value (int | str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setEnumerationValue(choiceEnumerationID, value)

Set the value on the given enumeration element.

Section: F.7.26.3

Parameters:

• choiceEnumerationID (str) – Handle to a Choices.Choice.Enumeration element.

• value (str) – New value expression.

Returns:

True if set, False if not found.

Raises:

TgiError – If the handle is invalid.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setExactBooleanAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setExecutableImageLanguageTools(executableImageID)

Create (if absent) and return handle of languageTools.

Section: F.7.46.24.

Parameters:

executableImageID (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setExecutableImageLinker(executableImageID, linker)

Set linker text inside languageTools.

Section: F.7.46.25.

Parameters:

• executableImageID (str)

• linker (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setExecutableImageLinkerFlags(executableImageID, flags)

Set linkerFlags text inside languageTools.

Section: F.7.46.26.

Parameters:

• executableImageID (str)

• flags (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setExpressionValue(expressionID, expression)

Set or clear expression text.

Section: F.7.60.14.

Parameters:

• expressionID (str)

• expression (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setExternalDeclarationsBooleanAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setExternalPortReferencePartSelect(externalPortReferenceID, range, indices)

Set partSelect on externalPortReference (replaces existing).

Section: F.7.38.31.

Parameters:

• externalPortReferenceID (str)

• range (tuple[str, str] | None)

• indices (list[str] | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setExternalTypeDefinitionsTypeDefinitionsRef(externalTypeDefinitionsID, vlnv)

Parameters:

• externalTypeDefinitionsID (str)

• vlnv (tuple[str, str, str, str])

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setFieldAccessPolicyAccess(fieldAccessPolicyID, access)

Section: F.7.10.36 Set access of fieldAccessPolicy.

Parameters:

• fieldAccessPolicyID (str)

• access (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setFieldAccessPolicyFieldAccessPolicyDefinitionRef(fieldAccessPolicyID, name, typeDefinitions=None)

Section: F.7.10.37 Set fieldAccessPolicyDefinitionRef values.

Parameters:

• fieldAccessPolicyID (str)

• name (str)

• typeDefinitions (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setFieldAccessPolicyModifiedWriteValue(fieldAccessPolicyID, value, modify=None)

Section: F.7.10.38 Set modifiedWriteValue element.

Parameters:

• fieldAccessPolicyID (str)

• value (str)

• modify (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setFieldAccessPolicyReadAction(fieldAccessPolicyID, value)

Section: F.7.10.39 Set readAction element.

Parameters:

• fieldAccessPolicyID (str)

• value (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setFieldAccessPolicyReadResponse(fieldAccessPolicyID, value)

Section: F.7.10.40 Set readResponse element.

Parameters:

• fieldAccessPolicyID (str)

• value (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setFieldAccessPolicyReserved(fieldAccessPolicyID, value)

Section: F.7.10.41 Set reserved element.

Parameters:

• fieldAccessPolicyID (str)

• value (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setFieldAccessPolicyTestable(fieldAccessPolicyID, value, testConstraint=None)

Section: F.7.10.42 Set testable (boolean + optional constraint).

Parameters:

• fieldAccessPolicyID (str)

• value (bool)

• testConstraint (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setFieldAccessPolicyWriteValueConstraintMinMax(fieldAccessPolicyID, minimum, maximum)

Section: F.7.10.43 Set minimum/maximum on writeValueConstraint (create if absent).

Parameters:

• fieldAccessPolicyID (str)

• minimum (str | None)

• maximum (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setFieldAccessPolicyWriteValueConstraintUseEnumeratedValue(fieldAccessPolicyID, value)

Section: F.7.10.44 Set useEnumeratedValues flag.

Parameters:

• fieldAccessPolicyID (str)

• value (bool)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setFieldAccessPolicyWriteValueConstraintWriteAsRead(fieldAccessPolicyID, value)

Section: F.7.10.45 Set writeAsRead flag.

Parameters:

• fieldAccessPolicyID (str)

• value (bool)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setFieldRefAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setFieldSliceAddressBlockRef(fieldSliceID, name)

Parameters:

• fieldSliceID (str)

• name (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setFieldSliceAddressSpaceRef(fieldSliceID, name)

Parameters:

• fieldSliceID (str)

• name (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setFieldSliceAlternateRegisterRef(fieldSliceID, name)

Parameters:

• fieldSliceID (str)

• name (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setFieldSliceFieldRef(fieldSliceID, name)

Parameters:

• fieldSliceID (str)

• name (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setFieldSliceMemoryMapRef(fieldSliceID, name)

Parameters:

• fieldSliceID (str)

• name (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setFieldSliceMemoryRemapRef(fieldSliceID, name)

Parameters:

• fieldSliceID (str)

• name (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setFieldSliceRange(fieldSliceID, value=None, expression=None)

Parameters:

• fieldSliceID (str)

• value (int | None)

• expression (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setFieldSliceRegisterRef(fieldSliceID, name)

Parameters:

• fieldSliceID (str)

• name (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setFileBuildCommand(fileID)

Ensure buildCommand exists and return its handle.

Section: F.7.46.27.

Parameters:

fileID (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setFileBuilderCommand(fileBuilderID, command)

Set fileBuilder.command.

Section: F.7.46.28.

Parameters:

• fileBuilderID (str)

• command (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setFileBuilderFileType(fileBuilderID, fileType)

Set fileBuilder.fileType.

Section: F.7.46.29.

Parameters:

• fileBuilderID (str)

• fileType (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setFileBuilderFlags(fileBuilderID, flags)

Set fileBuilder.flags.

Section: F.7.46.30.

Parameters:

• fileBuilderID (str)

• flags (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setFileBuilderReplaceDefaultFlags(fileBuilderID, replace)

Set fileBuilder.replaceDefaultFlags.

Section: F.7.46.31.

Parameters:

• fileBuilderID (str)

• replace (bool)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setFileIdAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setFileIsIncludeFile(fileID, value)

Set isIncludeFile (Section: F.7.48.33).

Parameters:

• fileID (str)

• value (bool)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setFileIsStructural(fileID, value)

Set isStructural (Section: F.7.48.34).

Parameters:

• fileID (str)

• value (bool)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setFileLogicalName(fileID, logicalName)

Set logicalName (Section: F.7.48.35).

Parameters:

• fileID (str)

• logicalName (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setFileName(fileID, name)

Set file name path (Section: F.7.48.36).

Parameters:

• fileID (str)

• name (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setFlowTypeAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setForceBooleanAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setFunctionArgumentDataType(argumentID, dataType)

Set argument dataType (Section: F.7.48.37).

Parameters:

• argumentID (str)

• dataType (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setFunctionDisabled(functionID, disabledExpression)

Set disabled expression (Section: F.7.48.38).

Parameters:

• functionID (str)

• disabledExpression (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setFunctionEntryPoint(functionID, entryPoint)

Set entryPoint (Section: F.7.48.39).

Parameters:

• functionID (str)

• entryPoint (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setFunctionFileRef(functionID, fileRef)

Set fileRef (Section: F.7.48.40).

Parameters:

• functionID (str)

• fileRef (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setFunctionReplicate(functionID, replicate)

Set replicate (Section: F.7.48.41).

Parameters:

• functionID (str)

• replicate (bool)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setFunctionReturnType(functionID, returnType)

Set returnType (Section: F.7.48.42).

Parameters:

• functionID (str)

• returnType (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setFunctionSourceFileName(functionID, value)

Set first sourceFile’s sourceName (Section: F.7.48.43).

If no sourceFile exists a new one (without fileType) is created.

Parameters:

• functionID (str)

• value (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setGeneratorApiService(generatorID, apiService)

Set or clear the apiService element.

Section: F.7.50.10.

Parameters:

• generatorID (str)

• apiService (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setGeneratorApiType(generatorID, apiType)

Set or clear the apiType element.

Section: F.7.50.11.

Parameters:

• generatorID (str)

• apiType (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setGeneratorChainSelectorGeneratorChainRef(generatorChainSelectorID, generatorChainVLNV)

Set generatorChainRef VLNV on a generatorChainSelector.

Section: F.7.52.14.

Parameters:

• generatorChainSelectorID (str)

• generatorChainVLNV (tuple[str, str, str, str])

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setGeneratorChainSelectorGroupSelector(generatorChainSelectorID, names, operator=None)

Set groupSelector (names + optional operator) on generatorChainSelector.

Section: F.7.52.15.

Parameters:

• generatorChainSelectorID (str)

• names (list[str])

• operator (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setGeneratorGeneratorExe(generatorID, path)

Set the path of generatorExe (creates element if absent).

Section: F.7.50.12.

Parameters:

• generatorID (str)

• path (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setGeneratorPhase(generatorID, phaseValue)

Set (or create) the phase element value.

Section: F.7.50.13. The value is stored as the expression string.

Parameters:

• generatorID (str)

• phaseValue (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setGeneratorScope(generatorID, scope)

Set scope attribute of an instance generator (INSTANCE/DESIGN).

Section: F.7.50.14.

Parameters:

• generatorID (str)

• scope (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setGeneratorTransportMethods(generatorID)

Ensure a transportMethods container exists; return its handle.

Section: F.7.50.15. Does not create a transportMethod child.

Parameters:

generatorID (str)

Return type:

str | None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setGroupAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setHelpAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setHiddenBooleanAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setIdAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setImageIdAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setImageTypeAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setImplicitBooleanAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setIndexVarAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setInitiatorRefAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setInterconnectionActiveInterface(interconnectionID, componentInstanceRef, busRef)

Set (replace) first activeInterface of interconnection.

Section: F.7.38.33.

Parameters:

• interconnectionID (str)

• componentInstanceRef (str)

• busRef (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setInterconnectionHierInterface(interconnectionID, busRef)

Set (replace) first hierInterface entry.

Section: F.7.38.34.

Parameters:

• interconnectionID (str)

• busRef (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setInterfaceModeAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setInternalPortReferencePartSelect(internalPortReferenceID, range, indices)

Set partSelect on internalPortReference.

Section: F.7.38.32.

Parameters:

• internalPortReferenceID (str)

• range (tuple[str, str] | None)

• indices (list[str] | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setInvertAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setIpxactFileName(ipxact_file, name)

Set the file name of an ipxactFile entry.

Parameters:

• ipxact_file (IpxactFileType)

• name (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setIpxactFileVlnv(ipxact_file, vlnv)

Set the VLNV reference of an ipxactFile entry.

Parameters:

• ipxact_file (IpxactFileType)

• vlnv (Sequence[str])

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setIsIOBooleanAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setLanguageToolsLinker(languageToolsID, linker)

Set linker value under languageTools.

Section: F.7.46.32.

Parameters:

• languageToolsID (str)

• linker (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setLanguageToolsLinkerCommandFile(languageToolsID)

Append new linkerCommandFile under languageTools.

Section: F.7.46.33.

Parameters:

languageToolsID (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setLanguageToolsLinkerFlags(languageToolsID, flags)

Set linkerFlags for languageTools.

Section: F.7.46.34.

Parameters:

• languageToolsID (str)

• flags (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setLevelAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setLibextAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setLibraryAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setLinkerCommandFileCommandLineSwitch(linkerCommandFileID, switch)

Set commandLineSwitch of linkerCommandFile.

Section: F.7.46.35.

Parameters:

• linkerCommandFileID (str)

• switch (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setLinkerCommandFileEnable(linkerCommandFileID, enable)

Set enable flag of linkerCommandFile.

Section: F.7.46.36.

Parameters:

• linkerCommandFileID (str)

• enable (bool)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setLoadConstraintCellSpecification(loadConstraintID, cellFunctionOrCellClass)

Replace loadConstraint cellSpecification definition.

Section: F.7.34.14.

Parameters:

• loadConstraintID (str)

• cellFunctionOrCellClass (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setLoadConstraintCount(loadConstraintID, count)

Set numeric count (expression) of loadConstraint.

Section: F.7.34.15.

Parameters:

• loadConstraintID (str)

• count (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setLoadConstraintOtherValue(loadConstraintID, other)

Set other attribute for loadConstraint cellFunction variant.

Section: F.7.34.16.

Parameters:

• loadConstraintID (str)

• other (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setLogicalPortRange(portMapID, left_expr, right_expr)

Create or update logicalPort.range with given left/right expressions.

Section: F.7.70.7.

Parameters:

• portMapID (str)

• left_expr (str)

• right_expr (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setMandatoryBooleanAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setMaximumAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setMaximumDoubleAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setMaximumIntAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setMemoryMapMemoryMapDefinitionRef(memoryMapID, name)

Set or clear memoryMapDefinitionRef (named reference).

Section: F.7.58.67. Name corresponds to a memoryMapDefinition in typeDefinitions. Passing None removes the element.

Parameters:

• memoryMapID (str)

• name (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setMemoryMapRefAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setMemoryMapShared(memoryMapID, shared)

Set or clear shared attribute value (string form).

Section: F.7.58.68. Accepts None to remove the element.

Parameters:

• memoryMapID (str)

• shared (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setMemoryRemapDefinitionAddressUnitBits(memoryRemapDefinitionID, value)

Parameters:

• memoryRemapDefinitionID (str)

• value (int | str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setMemoryRemapRefAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setMinimumAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setMinimumDoubleAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setMinimumIntAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setMisalignmentAllowedBooleanAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setModeLinkExternalModeReference(modeLinkID, name)

Parameters:

• modeLinkID (str)

• name (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setModeLinkModeReference(modeLinkID, name)

Parameters:

• modeLinkID (str)

• name (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setModeRefAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setModifyAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setModuleParameterValue(moduleParameterID, newValue)

Set parameter value, creating value element if needed.

Section: F.7.62.3.

Parameters:

• moduleParameterID (str)

• newValue (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setMonitorInterconnectionMonitoredActiveInterface(monitorInterconnectionID, componentInstanceRef, busRef)

Set monitoredActiveInterface element.

Section: F.7.38.35.

Parameters:

• monitorInterconnectionID (str)

• componentInstanceRef (str)

• busRef (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setMonitoredActiveInterfacePath(monitoredActiveInterfaceID, path)

Set path attribute on monitoredActiveInterface.

Section: F.7.38.36.

Parameters:

• monitoredActiveInterfaceID (str)

• path (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setMultipleGroupSelectionOperatorAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setName(elementID, value)

Set name text (None clears).

Section: F.7.64.7.

Parameters:

• elementID (str)

• value (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setNameAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setOrderFloatAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setOtherAnyAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setOtherAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setOtherClockDriverClockPeriod(driverID, value, expression=None)

Create/ensure clockDriver then set clockPeriod.

Section: F.7.42.15.

Parameters:

• driverID (str)

• value (float)

• expression (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setOtherClockDriverClockPulseDuration(driverID, value, expression=None)

Ensure clockDriver then set clockPulseDuration.

Section: F.7.42.16.

Parameters:

• driverID (str)

• value (float)

• expression (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setOtherClockDriverClockPulseOffset(driverID, value, expression=None)

Ensure clockDriver then set clockPulseOffset.

Section: F.7.42.17.

Parameters:

• driverID (str)

• value (float)

• expression (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setOtherClockDriverClockPulseValue(driverID, value, expression=None)

Ensure clockDriver then set clockPulseValue.

Section: F.7.42.18.

Parameters:

• driverID (str)

• value (int)

• expression (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setPackedBooleanAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setParameterIdAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setParameterValue(parameterID, newValue)

Set (or clear if None) parameter value.

Section: F.7.66.4.

Parameters:

• parameterID (str)

• newValue (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setPartSelectRange(partSelectID, left, right)

Set (left,right) range expressions or clear when None.

Section: F.7.60.15.

Parameters:

• partSelectID (str)

• left (str | None)

• right (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setPathAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setPhantomBooleanAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setPhysicalPortPartSelect(physicalPortID, left_expr, right_expr)

Set or update partSelect on a physicalPort.

Section: F.7.70.8.

Parameters:

• physicalPortID (str)

• left_expr (str)

• right_expr (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setPortMapIsInformative(portMapID, value)

Set the isInformative flag.

Section: F.7.70.9.

Parameters:

• portMapID (str)

• value (bool)

Return type:

None

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setPortMapLogicalPort(portMapID, name)

Set the logicalPort name (create logicalPort if absent).

Section: F.7.70.10.

Parameters:

• portMapID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setPortMapLogicalTieOff(portMapID, expression)

Create/update logicalTieOff expression.

Section: F.7.70.11.

Parameters:

• portMapID (str)

• expression (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setPortMapPhysicalPort(portMapID, name)

Set or create physicalPort with provided name.

Section: F.7.70.12.

Parameters:

• portMapID (str)

• name (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setPortRefAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setPortSlicePartSelect(portSliceID, leftExpression, rightExpression)

Parameters:

• portSliceID (str)

• leftExpression (str)

• rightExpression (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setPortSlicePortRef(portSliceID, name)

Parameters:

• portSliceID (str)

• name (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setPowerConstraintPowerDomainRef(powerConstraintID, powerDomainName)

Set powerDomainRef (F.7.72.11).

Parameters:

• powerConstraintID (str)

• powerDomainName (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setPowerConstraintRange(powerConstraintID, left_expr, right_expr)

Create or update range (wire only) (F.7.72.12).

Parameters:

• powerConstraintID (str)

• left_expr (str)

• right_expr (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setPowerDomainAlwaysOn(powerDomainID, expression)

Set alwaysOn (boolean or expression) (F.7.72.13).

Parameters:

• powerDomainID (str)

• expression (str | bool)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setPowerDomainLinkExternalPowerDomainRef(powerDomainLinkID, expression)

Set external power domain reference expression.

Section: F.7.38.37.

Parameters:

• powerDomainLinkID (str)

• expression (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setPowerDomainRefAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setPowerDomainSubDomainOf(powerDomainID, parentName)

Set subDomainOf (F.7.72.14).

Parameters:

• powerDomainID (str)

• parentName (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setPrefixAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setPriorityIntAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setPromptAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setReferenceIdAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setRegisterFileAddressOffset(registerFileID, value=None, expression=None)

Parameters:

• registerFileID (str)

• value (int | None)

• expression (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setRegisterFileDefinitionAddressUnitBits(registerFileDefinitionID, value)

Parameters:

• registerFileDefinitionID (str)

• value (int | str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setRegisterFileRange(registerFileID, value=None, expression=None)

Parameters:

• registerFileID (str)

• value (int | None)

• expression (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setRegisterFileRefAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setRegisterFileRegisterFileDefinitionRef(registerFileID, name=None, vlnv=None)

Parameters:

• registerFileID (str)

• name (str | None)

• vlnv (tuple[str, str, str, str] | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setRegisterFileTypeIdentifier(registerFileID, typeIdentifier)

Parameters:

• registerFileID (str)

• typeIdentifier (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setRegisterRefAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setReplicateBooleanAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setResetTypeLinkExternalResetTypeReference(resetTypeLinkID, name)

Parameters:

• resetTypeLinkID (str)

• name (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setResetTypeLinkResetTypeReference(resetTypeLinkID, name)

Parameters:

• resetTypeLinkID (str)

• name (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setResetTypeRefAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setResolveAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setScopeAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setSegmentAddressOffset(segmentID, value)

Set or create a segment’s addressOffset.

Section: F.7.12.15.

Parameters:

• segmentID (str) – Segment handle.

• value (int | str) – Integer or expression string.

Returns:

True on success.

Return type:

bool

Raises:

TgiError – If handle invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setSegmentRange(segmentID, value)

Set or create a segment’s range element.

Section: F.7.12.16.

Parameters:

• segmentID (str) – Segment handle.

• value (int | str) – Integer or expression string.

Returns:

True on success.

Return type:

bool

Raises:

TgiError – If handle invalid.

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setSegmentRefAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setShortDescription(elementID, value)

Set shortDescription text (None clears). Supports both variants.

Section: F.7.64.8.

Parameters:

• elementID (str)

• value (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setSignAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setSingleShotDriverSingleShotDuration(singleShotDriverID, value, expression=None)

Set duration field of an existing singleShotDriver.

Section: F.7.42.19.

Parameters:

• singleShotDriverID (str)

• value (float)

• expression (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setSingleShotDriverSingleShotOffset(singleShotDriverID, value, expression=None)

Set offset field of an existing singleShotDriver.

Section: F.7.42.20.

Parameters:

• singleShotDriverID (str)

• value (float)

• expression (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setSliceRange(sliceID, leftExpression, rightExpression)

Parameters:

• sliceID (str)

• leftExpression (str)

• rightExpression (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setSourceFileFileType(sourceFileID, value)

Set sourceFile fileType (Section: F.7.48.44).

Parameters:

• sourceFileID (str)

• value (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setSourceFileSourceName(sourceFileID, sourceName)

Set sourceName (Section: F.7.48.45).

Parameters:

• sourceFileID (str)

• sourceName (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setStrictBooleanAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setSubPortMapPartSelect(subPortID, left_expr, right_expr)

Set partSelect on a subPort.

Section: F.7.70.13.

Parameters:

• subPortID (str)

• left_expr (str)

• right_expr (str)

Return type:

str

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setSubPortRefAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setTestConstraintAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setTextAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setTimingConstraintValue(timingConstraintID, value)

Set value of a timingConstraint (stored as float).

Section: F.7.34.17.

Parameters:

• timingConstraintID (str)

• value (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setTransportMethodsTransportMethod(transportMethodsID, method)

Set/clear the transportMethod child (currently only ‘file’).

Section: F.7.50.16.

Parameters:

• transportMethodsID (str)

• method (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setTypeAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setTypeDefinitionsAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setUniqueBooleanAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setUnitAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setUnitsAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setUsageAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setUsageTypeAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setUserAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setValue(elementID, value)

Set generic value simple content.

Section: F.7.60.16.

Parameters:

• elementID (str)

• value (str | int | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setVector(vectorID, left, right)

Parameters:

• vectorID (str)

• left (str | int | None)

• right (str | int | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setVectorIdAttribute(elementID, vectorId)

Parameters:

• elementID (str)

• vectorId (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setVectorLeft(vectorID, left)

Parameters:

• vectorID (str)

• left (str | int | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setVectorRight(vectorID, right)

Parameters:

• vectorID (str)

• right (str | int | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setVendorAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setVersionAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setViewComponentInstantiationRef(viewID, name)

Parameters:

• viewID (str)

• name (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setViewLinkExternalViewReference(viewLinkID, name)

Parameters:

• viewLinkID (str)

• name (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setViewLinkViewReference(viewLinkID, name)

Parameters:

• viewLinkID (str)

• name (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setViewModelName(viewID, modelName)

Parameters:

• viewID (str)

• modelName (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setViewName(viewID, name)

Parameters:

• viewID (str)

• name (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setViewRefAttribute(elementID, value)

Set (create or replace) attribute value.

Parameters:

• elementID (str) – Element handle.

• value (Any) – New attribute value.

Returns:

Always True.

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setWriteValueConstraintMaximum(writeValueConstraintID, maximum)

Section: F.7.10.46 Set maximum element (None clears).

Parameters:

• writeValueConstraintID (str)

• maximum (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setWriteValueConstraintMinimum(writeValueConstraintID, minimum)

Section: F.7.10.47 Set minimum element (None clears).

Parameters:

• writeValueConstraintID (str)

• minimum (str | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setWriteValueConstraintUseEnumeratedValues(writeValueConstraintID, value)

Section: F.7.10.48 Set useEnumeratedValues flag (None clears).

Parameters:

• writeValueConstraintID (str)

• value (bool | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setWriteValueConstraintWriteAsRead(writeValueConstraintID, value)

Section: F.7.10.49 Set writeAsRead flag (None clears).

Parameters:

• writeValueConstraintID (str)

• value (bool | None)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.setXMLPath(elementID, path)

Associate an XML path with an element (EXTENDED).

Parameters:

• elementID (str)

• path (str)

Return type:

bool

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.unregisterCatalogVLNVs(vlnvEntries)

Unregister multiple VLNVs returning success flags.

Section: F.7.60.18.

Parameters:

vlnvEntries (Iterable[Sequence[str] | str])

Return type:

list[bool]

amal.eda.ipxact_de.tgi.ipxact.v1685_2022.unregisterVLNV(vlnv)

Unregister a single VLNV mapping.

Section: F.7.60.19.

Parameters:

vlnv (Sequence[str] | str)

Return type:

bool