All Frameworks  Class Hierarchy  This Framework  Previous  Indexes

DMAPSInterfaces Interface CATISPPVerifTabSettingAtt

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATISPPVerifTabSettingAtt
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATISPPVerifTabSettingAtt

Interface to handle the parameters of the Verification Tab page for Visualization.
Role: This interface is implemented by a component which represents the controller of the Verification.
This interface defines:


Method Index


o GetAllResourceFilter(int&)
Retrieves the value of the 'View All Resources' option.
o GetAllResourceFilterInfo(CATSettingInfo*)
Retrieves the state of the 'View All Resources' parameter.
o GetAutoReframeFilter(int&)
Retrieves the value of the 'Auto Reframe'.
o GetAutoReframeFilterInfo(CATSettingInfo*)
Retrieves the information of the 'Auto Reframe' parameter.
o GetImpliedResourceFilter(int&)
Retrieves the value to say whether the Assigned resource would be visible while Navigating the Process.
o GetImpliedResourceFilterInfo(CATSettingInfo*)
Retrieves the state of the 'View Implied Resource' parameter.
o SetAllResourceFilter(int&)
Sets the value of the 'View All Resources'.
o SetAllResourceFilterLock(unsigned char)
Locks or unlocks the 'View All Resources' parameter.
o SetAutoReframeFilter(int&)
Sets the value of the 'Auto Reframe'.
o SetAutoReframeFilterLock(unsigned char)
Locks or unlocks the 'Auto Reframe' parameter.
o SetImpliedResourceFilter(int&)
Sets the value of the 'View Implied Resource'.
o SetImpliedResourceFilterLock(unsigned char)
Locks or unlocks the 'View Implied Resource' parameter.

Methods


o GetAllResourceFilter
public virtual HRESULT GetAllResourceFilter(int& ioAllRes) = 0
Retrieves the value of the 'View All Resources' option.
Role: Retrieves the value of the 'View All Resources'option to signify whether all the Assigned Resources would be visible while navigating the Process
Parameters:
ioAllRes
The Value to say whether it is a 'Show' or 'Hide'.The default value needs to be passed by the caller ( Show=0, Hide=1)
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetAllResourceFilterInfo
public virtual HRESULT GetAllResourceFilterInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the 'View All Resources' parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetAutoReframeFilter
public virtual HRESULT GetAutoReframeFilter(int& ioAutoRef) = 0
Retrieves the value of the 'Auto Reframe'.
Role: Retrieves the value of the 'Auto Reframe' during Process Navigation
Parameters:
ioAutoRef
The Value to say whether it is a 'Show' or 'Hide'. The default value needs to be passed by the caller ( Show=0, Hide=1)
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetAutoReframeFilterInfo
public virtual HRESULT GetAutoReframeFilterInfo(CATSettingInfo* oInfo)= 0
Retrieves the information of the 'Auto Reframe' parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetImpliedResourceFilter
public virtual HRESULT GetImpliedResourceFilter(int& ioImplRes) = 0
Retrieves the value to say whether the Assigned resource would be visible while Navigating the Process.
Role: Retrieves the value of the 'View Implied Resource' to signify whether the Assigned Resources would be visible while navigating the Process
Parameters:
ioImplRes
The Value to say whether it is a 'Show' or 'Hide'.The default value needs to be passed by the caller ( Show=0, Hide=1)
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetImpliedResourceFilterInfo
public virtual HRESULT GetImpliedResourceFilterInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the 'View Implied Resource' parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetAllResourceFilter
public virtual HRESULT SetAllResourceFilter( const int& iImplRes) = 0
Sets the value of the 'View All Resources'.
Role: Sets the value of the 'View All Resources' option to signify whether the all the Assigned Resources would be visible while navigating the Process
Parameters:
iImplRes
The Value to say whether it is a 'Show' or 'Hide'( Show=0, Hide=1)
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetAllResourceFilterLock
public virtual HRESULT SetAllResourceFilterLock(unsigned char iLocked)= 0
Locks or unlocks the 'View All Resources' parameter.
Role: Locks or unlocks the 'View All Resources' parameter if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetAutoReframeFilter
public virtual HRESULT SetAutoReframeFilter( const int& iAutoRef) = 0
Sets the value of the 'Auto Reframe'.
Role: Sets the value of the 'Resource Folder' to signify whether the Assigned Resources would be visible in the PPR tree or not
Parameters:
iAutoRef
The Value to say whether it is a 'Show' or 'Hide' (Show=0, Hide=1)
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetAutoReframeFilterLock
public virtual HRESULT SetAutoReframeFilterLock(unsigned char iLocked)= 0
Locks or unlocks the 'Auto Reframe' parameter.
Role: Locks or unlocks the 'Auto Reframe' parameter if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetImpliedResourceFilter
public virtual HRESULT SetImpliedResourceFilter( const int& iImplRes) = 0
Sets the value of the 'View Implied Resource'.
Role: Sets the value of the 'View Implied Resource' to signify whether the Assigned Resources would be visible while navigating the Process
Parameters:
iImplRes
The Value to say whether it is a 'Show' or 'Hide'.( Show=0, Hide=1)
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetImpliedResourceFilterLock
public virtual HRESULT SetImpliedResourceFilterLock(unsigned char iLocked)= 0
Locks or unlocks the 'View Implied Resource' parameter.
Role: Locks or unlocks the 'ResourceFilter' parameter if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure

This object is included in the file: CATISPPVerifTabSettingAtt.h
If needed, your Imakefile.mk should include the module: CATProcessInterfaces

Copyright © 2003, Dassault Systèmes. All rights reserved.