IMasterSetting

class IMasterSetting

Bases: ImpactCOMWrapperBase

Summary:

Represents a master tool setting in the database.

Remarks:

This object is normally used in a method requiring a master tool setting. To retrieve an IMasterSetting use the IDatabase.find_master_tool_setting method.

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

property full_name

Gets full_name.

Summary:

Gets the full name of the setting including the path.

Returns:

The value of full_name.

Return type:

full_name (str)

property key

Gets Key.

Summary:

Gets the key of the setting.

Returns:

The value of Key.

Return type:

key (int)

property name

Gets Name.

Summary:

Gets the name of the setting.

Returns:

The value of Name.

Return type:

name (str)

property sites

Gets Sites.

Summary:

An ISites collection containing all the sites with which this MTS is associated.

Remarks:

If IDatabase.settings.mts_sites is false, then NULL will be returned.

Returns:

The value of Sites.

Return type:

sites (ISites)

Examples:

property type

Gets Type.

Summary:

The type of setting.

Returns:

The value of Type.

Return type:

type (ipMasterSettingType)

isNone()

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

refresh()
Summary:

Refresh the setting from the database.

Examples