IEnquireInsertions¶
- class IEnquireInsertions¶
Bases:
ImpactCOMWrapperBase,Iterable- Description:
The IEnquireInsertions object is used to enquire about the number of sub-block and symbol insertions within a block.
- Remarks:
This object operates on the IBlock that created it. The IBlock does not need to be active to use this object. The default IEnquireInsertions object will recurse into sub-blocks, set the Recurse property to false to change this behaviour. Set the IEnquireInsertions properties to specify the insertions to enquire about and call the Perform method. The Count and Item properties will contain the results as a list of IEnquireInsertion objects. When determining the insertions the scale of blocks and symbols within the block is taken into account. An entry will exist in the Item list for each scale of the same block or symbol. For instance if the block ‘A’ is inserted at both a scale of 1.0 and 1.5 then the Item property will contain two entries for the block ‘A’.
Wraps a COM object or another wrapper instance. Accepts: - A valid impact_object - An existing impact_com_wrapper_base-derived instance
- property block_or_symbol_name¶
Gets block_or_symbol_name.
- Description:
Specifies a block or symbol to enquire about.
- Remarks:
You can restrict the results for the insertions enquiry to only those using the block or symbol with the specified name.
- Returns:
The value of block_or_symbol_name.
- Return type:
block_or_symbol_name (str)
- property count¶
Gets Count.
- Description:
Returns the number of IEnquireInsertion objects in the Item property.
- Returns:
The value of Count.
- Return type:
count (int)
- property include_insertions_in_symbols¶
Gets include_insertions_in_symbols.
- Description:
Specifies whether to include insertions of block or symbols contained in symbols.
- Returns:
The value of include_insertions_in_symbols.
- Return type:
- property recurse¶
Gets Recurse.
- Description:
Specifies whether the enquiry recurses into ‘sub-blocks’ within the IBlock.
- Remarks:
The default value is true.
- Returns:
The value of Recurse.
- Return type:
recurse (bool)
- item(index)¶
- Description:
Gets and IEnquireInsertion object with the specified name or index.
- Parameters:
index (any) – Specifies the name or index of the IEnquireInsertion object to get. If the collection contains more than one IEnquireInsertion object for the same block or symbol and you specify the Index by name then the first matching object is returned.
- perform()¶
- Description:
Call the Perform method to calculate the Item and Count result properties.