System Interface CATIASettingController

Usage: you cannot implement this base interface directly. You must first derive it and then implement the derived interface.

interface CATIASettingController

Base interface to handle a setting controller for Automation.
Role: A setting controller manages the values of all or only a part of the attributes available in a property page of the dialog displayed using the Options command of the Tools menu.

CATIASettingController supplies the methods common to all setting controllers for the setting controller Automation implementation:

• Commit to make a memory copy of the setting attribute values
• Rollback to restore the last memory copy of the setting attribute values
• ResetToAdminValues to restore the administrated values of all the attributes
• ResetToAdminValuesByName to restore the administrated values of a subset of the attributes
• SaveRepository to make a persistent copy of the setting attribute values on file

CATIASettingController must be implemented, through a derived interface that stands for the setting controller for Automation, by a V5 component, as follows:

• Create an interface that derives from CATIASettingController with the methods appropriate to manage the attributes handled by the setting controller
• Create a class, data extension of your setting controller V5 component, that derives from class to implement this interface. Usually the methods that manage the attributes should simply call their counterpart in your implementation of the interface derived from the C++ interface. In addition, supplies the implementation of the five methods of CATIASettingController. In most cases, you should not re-implement these methods, except if you create a bufferized setting controller. Refer to the CAA Encyclopedia to know about such controllers.

Your setting controller V5 component should in addition implement the C++ interface

See also:

, ,

Method Index

o Commit()

Makes a memory copy of the setting attribute values.

o ResetToAdminValues()

Restores the administrated values of all the attributes.

o ResetToAdminValuesByName(CATSafeArrayVariant&)

Restores the administrated values of a subset of the attributes.

o Rollback()

Restores the last memory copy of the setting attribute values.

o SaveRepository()

Makes a persistent copy of the setting attribute values on file.

Methods

Makes a memory copy of the setting attribute values.
Role: Commit saves the current values of the setting attributes managed by the setting controller in a specific memory area. Successive calls to Commit overwrite the memory area. The values saved by the last call to Commit can be restored from that memory area using the method.

Returns:

Legal values: S_OK on success, and E_FAIL otherwise

Restores the administrated values of all the attributes.
Role: ResetToAdminValues restores all the values of the setting attributes managed by the setting controller to either the values set by the setting administrator, or to their default values if the setting administrator did not change them.

Returns:

Legal values: S_OK on success, and E_FAIL otherwise

Restores the administrated values of a subset of the attributes.
Role: ResetToAdminValuesByName restores the values of a subset of the setting attributes managed by the setting controller to either the values set by the setting administrator, or to their default values if the setting administrator did not change them.

Parameters:

[in]

iAttList The attribute subset to which the administrated values are to be restored

Returns:

Legal values: S_OK on success, and E_FAIL otherwise

Restores the last memory copy of the setting attribute values.
Role: Rollback restores the values of the setting attributes managed by the setting controller from the memory area. All values of the setting attributes managed by the setting controller modified since the last call to are restored to the values they had when this last was called.

Returns:

Legal values: S_OK on success, and E_FAIL otherwise

Makes a persistent copy of the setting attribute values on file.
Role: SaveRepository saves the current values of the setting attributes managed by the setting controller in a setting repository file. To avoid inconsistencies, SaveRepository first saves the values in the memory area used by the method by calling before writing the values in the setting repository file.

Returns:

Legal values: S_OK on success, and E_FAIL otherwise

Copyright © 1999-2015, Dassault Systèmes. All rights reserved.