IRowCountOptions

class IRowCountOptions

Bases: ImpactCOMWrapperBase

Summary:

An object to aid the counting of data table rows matching a specific query.

Remarks:

Introduced in Impact 9.0.0.42.

Wraps a COM object or another wrapper instance. Accepts: - A valid impact_object - An existing impact_com_wrapper_base-derived instance

property count_items_options

Gets count_items_options.

Summary:

An ICountItemsOptions containing criteria for the count.

Returns:

The value of count_items_options.

Return type:

count_items_options (ICountItemsOptions)

property inactive_row_context

Gets inactive_row_context.

Summary:

Determines whether to count active and/or inactive items.

Remarks:

Introduced in Impact 11.0.0.80

Returns:

The value of inactive_row_context.

Return type:

inactive_row_context (ipInactiveRowContext)

property primary_table_name

Gets primary_table_name.

Summary:

Name of primary table.

Returns:

The value of primary_table_name.

Return type:

primary_table_name (str)

property separate_layer_types

Gets separate_layer_types.

Summary:

separate_layer_types determines how the layers will be counted.

Remarks:

When separate_layer_types is true, the layer type names and their corresponding counts are returned in separated_layer_type_names and separated_layer_type_counts respectively - these variant arrays have 1:1 relationship. Otherwise, it behaves as normal and just returns a single count of the composite types.

Returns:

The value of separate_layer_types.

Return type:

separate_layer_types (bool)

property separated_layer_type_counts

Gets separated_layer_type_counts.

Summary:

Array of layer counts.

Returns:

The value of separated_layer_type_counts.

Return type:

separated_layer_type_counts (any)

property separated_layer_type_names

Gets separated_layer_type_names.

Summary:

Array of layer types.

Returns:

The value of separated_layer_type_names.

Return type:

separated_layer_type_names (any)

isNone()

Checks if the COM object is None. This is useful for determining if the wrapper has been initialized with a valid COM object.

use_relationship_lookup(value)
Summary:

Use the specified database table relationship.

Remarks:

Introduced in Impact 11.0.0.31

Parameters:

value (str) – A string representing the database table relationship.