All Frameworks  Class Hierarchy  This Framework  Indexes   

DMAPSInterfaces Interface CATISPPTreeTabSettingAtt

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


interface CATISPPTreeTabSettingAtt

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


Method Index


o GetApplicativeDataFilterInfo(CATSettingInfo*)
Retrieves the state of the "Applicative Data" option.
o GetApplicativeDataFilter(int&)
Retrieves the value to signify Whether "Applicative Data" created by an application is visible in the PPR tree.
o GetAssignedViewerInfo(CATSettingInfo*)
Retrieves the state of the "Assigned Viewer" option.
o GetAssignedViewer(int&)
Retrieves the value to signify whether the default viewer is the 3D Assigned Viewer or not.
o GetAttributesFilterInfo(CATSettingInfo*)
Retrieves the state of the "Attributes" option.
o GetAttributesFilter(int&)
Retrieves the value to signify Whether "Attributes" of an activity are visible in PPR tree.
o GetCollapseExpandFilterInfo(CATSettingInfo*)
Retrieves the state of the "Disable Collapse/Expand" option.
o GetCollapseExpandFilter(int&)
Retrieves the value to signify Whether double clicking on an activity expands/collapses a given activity in the PPR tree.
o GetDisplayNameModeInfo(CATSettingInfo*)
Retrieves the state of the "Display E5 Configured Name" option.
o GetDisplayNameMode(int&)
Retrieves the value to signify whether to display the Label or the E5 Configured Name
Role: Retrieves the value to signify whether to display the Label or the E5 Configured Name
o GetItemsFilterInfo(CATSettingInfo*)
Retrieves the state of the 'Items Folder' parameter.
o GetItemsFilter(int&)
Retrieves the value to signify the visualization of Assigned Items in the PPR tree.
o GetItemsPerRelationFilterInfo(CATSettingInfo*)
Retrieves the state of the 'Items Folder( per Relation Type)' parameter.
o GetItemsPerRelationFilter(int&)
Retrieves the value to signify the visualization of Assigned Items with its type of Relation.
o GetLogicalActFilterInfo(CATSettingInfo*)
Retrieves the state of the "Logical Activities" option.
o GetLogicalActFilter(int&)
Retrieves the value to signify Whether the logical activites are visible in the PPR tree.
o GetOutputProductFilterInfo(CATSettingInfo*)
Retrieves the state of the "Output Product Folder" option.
o GetOutputProductFilter(int&)
Retrieves the value to signify Whether "Output Products" associated with an activity are visible or not.
o GetRenderStyleInfo(CATSettingInfo*)
Retrieves the state of the "Render Style" option.
o GetRenderStyle(int&)
Retrieves the value to signify whether the default render style should be Parallel or Perspective
Role: Retrieves the value of the "Render Style" option to signify whether the 3D Render Style should be Parallel or Perspective
o GetResourceFilterInfo(CATSettingInfo*)
Retrieves the state of the 'Resource Folder' parameter.
o GetResourceFilter(int&)
Retrieves the value of the 'Resource Filter'.
o SetApplicativeDataFilterLock(unsigned char)
Locks or unlocks the "Attributes" option.
o SetApplicativeDataFilter(int&)
Sets the value to signify Whether "Applicative Data" created by an application is visible in the PPR tree.
o SetAssignedViewerLock(unsigned char)
Locks or unlocks the "Assigned Viewer" option.
o SetAssignedViewer(int&)
Sets the value to signify whether the default viewer is the 3D Assigned Viewer or not.
o SetAttributesFilterLock(unsigned char)
Locks or unlocks the "Attributes" option.
o SetAttributesFilter(int&)
Sets the value to signify Whether "Attributes" of an activity are visible in PPR tree.
o SetCollapseExpandFilterLock(unsigned char)
Locks or unlocks the "Disable Collapse/Expand" option.
o SetCollapseExpandFilter(int&)
Sets the value to signify Whether the double clicking on an activity expands/collapses a given activity in the PPR tree.
o SetDisplayNameModeLock(unsigned char)
Locks or unlocks the "Display E5 Configured Name" option.
o SetDisplayNameMode(int&)
Sets the value to signify whether the E5 Configured Name is to be displayed
Role: Sets the value to signify whether the E5 Configured Name is to be displayed
o SetItemsFilterLock(unsigned char)
Locks or unlocks the 'Resource Filter' parameter.
o SetItemsFilter(int&)
Sets the value to signify the visualization of Assigned Items in the PPR tree.
o SetItemsPerRelationFilterLock(unsigned char)
Locks or unlocks the 'Items Folder( per Relation Type)' parameter.
o SetItemsPerRelationFilter(int&)
Sets the value to signify the visualization of Assigned Items with it's type of Relation.
o SetLogicalActFilterLock(unsigned char)
Locks or unlocks the "Logical Activities" option.
o SetLogicalActFilter(int&)
Sets the value to signify Whether the logical activites are visible in the PPR tree.
o SetOutputProductFilterLock(unsigned char)
Locks or unlocks the "Output Product Folder" option.
o SetOutputProductFilter(int&)
Sets the value to signify Whether Output Products associated with an activity is visible in the PPR tree.
o SetRenderStyleLock(unsigned char)
Locks or unlocks the "Render Style" option.
o SetRenderStyle(int&)
Sets the value to signify whether the default viewer is the 3D Assigned Viewer or not.
o SetResourceFilterLock(unsigned char)
Locks or unlocks the 'Resource Folder' parameter.
o SetResourceFilter(int&)
Sets the value of the 'Resource Filter'.

Methods


o GetApplicativeDataFilterInfo
public virtual GetApplicativeDataFilterInfo( oInfo)
Retrieves the state of the "Applicative Data" option.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetApplicativeDataFilter
public virtual GetApplicativeDataFilter( ioAppFilter)
Retrieves the value to signify Whether "Applicative Data" created by an application is visible in the PPR tree.
Role: Retrieves the value of the "Applicative Data" option to signify whether the "Applicative Containers" are visible in the PPR tree
Parameters:
ioAppFilter
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 GetAssignedViewerInfo
public virtual GetAssignedViewerInfo( oInfo)
Retrieves the state of the "Assigned Viewer" option.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetAssignedViewer
public virtual GetAssignedViewer( ioAssignedViewer)
Retrieves the value to signify whether the default viewer is the 3D Assigned Viewer or not.
Role: Retrieves the value of the "Assigned Viewer" option to signify whether the 3D Assigned Viewer is the default viewer or not.
Parameters:
ioAssignedViewer
The value to say whether 3D Assigned Viewer is default or not
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetAttributesFilterInfo
public virtual GetAttributesFilterInfo( oInfo)
Retrieves the state of the "Attributes" option.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetAttributesFilter
public virtual GetAttributesFilter( ioAttFilter)
Retrieves the value to signify Whether "Attributes" of an activity are visible in PPR tree.
Role: Retrieves the value of the "Attributes" option to signify whether the user attributes of a Process are visible in the PPR tree
Parameters:
ioAttFilter
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 GetCollapseExpandFilterInfo
public virtual GetCollapseExpandFilterInfo( oInfo)
Retrieves the state of the "Disable Collapse/Expand" option.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetCollapseExpandFilter
public virtual GetCollapseExpandFilter( ioCollapseFilter)
Retrieves the value to signify Whether double clicking on an activity expands/collapses a given activity in the PPR tree.
Role: Retrieves the value of the "Disable Collapse/Expand" option to signify whether double clicking on an activity expands/collapses the PPr tree
Parameters:
ioCollapseFilter
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 GetDisplayNameModeInfo
public virtual GetDisplayNameModeInfo( oInfo)
Retrieves the state of the "Display E5 Configured Name" option.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDisplayNameMode
public virtual GetDisplayNameMode( ioDisplayNameMode)
Retrieves the value to signify whether to display the Label or the E5 Configured Name
Role: Retrieves the value to signify whether to display the Label or the E5 Configured Name
Parameters:
ioDisplayNameMode
The value to say whether the E5 Configured Name is to be displayed
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetItemsFilterInfo
public virtual GetItemsFilterInfo( oInfo)
Retrieves the state of the 'Items Folder' parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetItemsFilter
public virtual GetItemsFilter( ioItemsFilter)
Retrieves the value to signify the visualization of Assigned Items in the PPR tree.
Role: Retrieves the value of the 'Items Folder' to signify whether the Assigned Items would be visible in the PPR tree
Parameters:
ioItemsFilter
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 GetItemsPerRelationFilterInfo
public virtual GetItemsPerRelationFilterInfo( oInfo)
Retrieves the state of the 'Items Folder( per Relation Type)' parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetItemsPerRelationFilter
public virtual GetItemsPerRelationFilter( ioItemsRelFilter)
Retrieves the value to signify the visualization of Assigned Items with its type of Relation.
Role: Retrieves the value of the 'Items Folder (per Relation Type)' to signify whether the Assigned Items with different relations ( like First Processes Product) would be visible in the PPR tree
Parameters:
ioItemsRelFilter
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 GetLogicalActFilterInfo
public virtual GetLogicalActFilterInfo( oInfo)
Retrieves the state of the "Logical Activities" option.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetLogicalActFilter
public virtual GetLogicalActFilter( ioLogActFilter)
Retrieves the value to signify Whether the logical activites are visible in the PPR tree.
Role: Retrieves the value of the "Logical Activities" option to signify whether the logical activities are visible in the PPR tree
Parameters:
ioLogActFilter
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 GetOutputProductFilterInfo
public virtual GetOutputProductFilterInfo( oInfo)
Retrieves the state of the "Output Product Folder" option.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetOutputProductFilter
public virtual GetOutputProductFilter( ioPrdFilter)
Retrieves the value to signify Whether "Output Products" associated with an activity are visible or not.
Role: Retrieves the value of the "Output Product Folder" option to signify whether the assigned output products of an activity are visible in the PPR tree
Parameters:
ioPrdFilter
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 GetRenderStyleInfo
public virtual GetRenderStyleInfo( oInfo)
Retrieves the state of the "Render Style" option.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetRenderStyle
public virtual GetRenderStyle( ioRenderStyle)
Retrieves the value to signify whether the default render style should be Parallel or Perspective
Role: Retrieves the value of the "Render Style" option to signify whether the 3D Render Style should be Parallel or Perspective
Parameters:
ioRenderStyle
The value to say whether 3D Render Style should be Parallel or Perspective
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetResourceFilterInfo
public virtual GetResourceFilterInfo( oInfo)
Retrieves the state of the 'Resource Folder' parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetResourceFilter
public virtual GetResourceFilter( ioResFilter)
Retrieves the value of the 'Resource Filter'.
Role: Retrieves the value of the 'Resource Folder' to signify whether the Assigned Resources would be visible in the PPR tree
Parameters:
ioResFilter
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 SetApplicativeDataFilterLock
public virtual SetApplicativeDataFilterLock( iLocked)
Locks or unlocks the "Attributes" option.
Role: Locks or unlocks the "Attributes" 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 SetApplicativeDataFilter
public virtual SetApplicativeDataFilter( const iAppFilter)
Sets the value to signify Whether "Applicative Data" created by an application is visible in the PPR tree.
Role: Sets the value of the "Applicative Data" option to signify whether the "Applicative Containers" are visible in the PPR tree
Parameters:
iAppFilter
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 SetAssignedViewerLock
public virtual SetAssignedViewerLock( iLocked)
Locks or unlocks the "Assigned Viewer" option.
Role: Locks or unlocks the "Assigned Viewer" 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 SetAssignedViewer
public virtual SetAssignedViewer( const iAssignedViewer)
Sets the value to signify whether the default viewer is the 3D Assigned Viewer or not.
Role: Sets the value of the "Assigned Viewer" option to signify whether the 3D Assigned Viewer is the default viewer or not.
Parameters:
iAssignedViewer
The value to say whether 3D Assigned Viewer is default or not
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetAttributesFilterLock
public virtual SetAttributesFilterLock( iLocked)
Locks or unlocks the "Attributes" option.
Role: Locks or unlocks the "Attributes" 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 SetAttributesFilter
public virtual SetAttributesFilter( const iAttFilter)
Sets the value to signify Whether "Attributes" of an activity are visible in PPR tree.
Role: Sets the value of the "Attributes" option to signify whether the user attributes of a Process would be visible in the PPR tree
Parameters:
iAttFilter
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 SetCollapseExpandFilterLock
public virtual SetCollapseExpandFilterLock( iLocked)
Locks or unlocks the "Disable Collapse/Expand" option.
Role: Locks or unlocks the "Disable Collapse/Expand" 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 SetCollapseExpandFilter
public virtual SetCollapseExpandFilter( const iCollapseFilter)
Sets the value to signify Whether the double clicking on an activity expands/collapses a given activity in the PPR tree.
Role: Sets the value of the "Disable Collapse/Expand" option to signify whether double clicking on an activity expands/collapses the PPr tree
Parameters:
iCollapseFilter
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 SetDisplayNameModeLock
public virtual SetDisplayNameModeLock( iLocked)
Locks or unlocks the "Display E5 Configured Name" option.
Role: Locks or unlocks the "Display E5 Configured Name" 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 SetDisplayNameMode
public virtual SetDisplayNameMode( const iDisplayNameMode)
Sets the value to signify whether the E5 Configured Name is to be displayed
Role: Sets the value to signify whether the E5 Configured Name is to be displayed
Parameters:
iDisplayNameMode
The value to say whether E5 Configured Name is to be displayed
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetItemsFilterLock
public virtual SetItemsFilterLock( iLocked)
Locks or unlocks the 'Resource Filter' 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
o SetItemsFilter
public virtual SetItemsFilter( const iItemsFilter)
Sets the value to signify the visualization of Assigned Items in the PPR tree.
Role: Sets the value of the 'Items Folder' to signify whether the Assigned Items would be visible in the PPR tree or not.
Parameters:
iItemsFilter
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 SetItemsPerRelationFilterLock
public virtual SetItemsPerRelationFilterLock( iLocked)
Locks or unlocks the 'Items Folder( per Relation Type)' 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
o SetItemsPerRelationFilter
public virtual SetItemsPerRelationFilter( const iItemsRelFilter)
Sets the value to signify the visualization of Assigned Items with it's type of Relation.
Role: Sets the value of the 'Items Folder (per Relation Type)' to signify whether the Assigned Items with different relations ( like First Processes Product) would be visible in the PPR tree or not.
Parameters:
iItemsRelFilter
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 SetLogicalActFilterLock
public virtual SetLogicalActFilterLock( iLocked)
Locks or unlocks the "Logical Activities" option.
Role: Locks or unlocks the "Logical Activities" 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 SetLogicalActFilter
public virtual SetLogicalActFilter( const iLogActFilter)
Sets the value to signify Whether the logical activites are visible in the PPR tree.
Role: Sets the value of the "Logical Activities" option to signify whether the logical activities are visible in the PPR tree
Parameters:
iLogActFilter
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 SetOutputProductFilterLock
public virtual SetOutputProductFilterLock( iLocked)
Locks or unlocks the "Output Product Folder" option.
Role: Locks or unlocks the "Output Product Folder" 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 SetOutputProductFilter
public virtual SetOutputProductFilter( const iPrdFilter)
Sets the value to signify Whether Output Products associated with an activity is visible in the PPR tree.
Role: Sets the value of the "Output Product Folder" option to signify whether the assigned output products for an activity would be visible in the PPR tree
Parameters:
iAppFilter
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 SetRenderStyleLock
public virtual SetRenderStyleLock( iLocked)
Locks or unlocks the "Render Style" option.
Role: Locks or unlocks the "Render Style" 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 SetRenderStyle
public virtual SetRenderStyle( const iRenderStyle)
Sets the value to signify whether the default viewer is the 3D Assigned Viewer or not.
Role: Sets the value of the "Render Style" option to signify whether the 3D Render Style should be Parallel or Perspective
Parameters:
iAssignedViewer
The value to say whether 3D Render Style should be Parallel or Perspective
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetResourceFilterLock
public virtual SetResourceFilterLock( iLocked)
Locks or unlocks the 'Resource Folder' 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
o SetResourceFilter
public virtual SetResourceFilter( const iResFilter)
Sets the value of the 'Resource Filter'.
Role: Sets the value of the 'Resource Folder' to signify whether the Assigned Resources would be visible in the PPR tree or not
Parameters:
iResFilter
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

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

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