All Frameworks  Class Hierarchy  This Framework  Indexes   

DNBD5IInterfaces Interface DNBID5IImportD5SettingAtt

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


interface DNBID5IImportD5SettingAtt

Interface to handle parameters of General-Compatibility-DELMIA D5 Tools Options Tab page.
Role: This interface is implemented by a component which represents the controller of DELMIA D5 Tools Options parameter settings.

Here are the list of parameters to use and their meanings:


Method Index


o GetImportAnnotationInfo(CATSettingInfo*)
Retrieves the state of the ImportAnnotation parameter.
o GetImportAnnotation(CATBoolean&)
Retrieves the ImportAnnotation attribute.
o GetImportBaseFrmInfo(CATSettingInfo*)
Retrieves the state of the ImportBaseFrm parameter.
o GetImportBaseFrm(CATBoolean&)
Retrieves the ImportBaseFrm attribute.
o GetImportCollisionInfo(CATSettingInfo*)
Retrieves the state of the ImportCollision parameter.
o GetImportCollision(CATBoolean&)
Retrieves the ImportCollision attribute.
o GetImportConfigFileExpanded(CATUnicodeString&)
Retrieves the ImportConfigFile attribute (manages expanded file pathnames).
o GetImportConfigFileInfo(CATSettingInfo*)
Retrieves the state of the ImportConfigFile parameter.
o GetImportConfigFile(CATUnicodeString&)
Retrieves the ImportConfigFile attribute.
o GetImportCoorsysInfo(CATSettingInfo*)
Retrieves the state of the ImportCoorsys parameter.
o GetImportCoorsys(CATBoolean&)
Retrieves the ImportCoorsys attribute.
o GetImportEdgeInfo(CATSettingInfo*)
Retrieves the state of the ImportEdge parameter.
o GetImportEdge(CATBoolean&)
Retrieves the ImportEdge attribute.
o GetImportFloorInfo(CATSettingInfo*)
Retrieves the state of the ImportFloor parameter.
o GetImportFloor(CATBoolean&)
Retrieves the ImportFloor attribute.
o GetImportLibraryExpanded(CATUnicodeString&)
Retrieves the ImportLibrary attribute (manages expanded file pathnames).
o GetImportLibraryInfo(CATSettingInfo*)
Retrieves the state of the ImportLibrary parameter.
o GetImportLibrary(CATUnicodeString&)
Retrieves the ImportLibrary attribute.
o GetImportPDBCacheExpanded(CATUnicodeString&)
Retrieves the ImportPDBCache attribute (manages expanded file pathnames).
o GetImportPDBCacheInfo(CATSettingInfo*)
Retrieves the state of the ImportPDBCache parameter.
o GetImportPDBCache(CATUnicodeString&)
Retrieves the ImportPDBCache attribute.
o GetImportRecordingInfo(CATSettingInfo*)
Retrieves the state of the ImportRecording parameter.
o GetImportRecording(CATBoolean&)
Retrieves the ImportRecording attribute.
o GetImportToolFrmInfo(CATSettingInfo*)
Retrieves the state of the ImportToolFrm parameter.
o GetImportToolFrm(CATBoolean&)
Retrieves the ImportToolFrm attribute.
o GetImportUserAttrInfo(CATSettingInfo*)
Retrieves the state of the ImportUserAttr parameter.
o GetImportUserAttr(CATBoolean&)
Retrieves the ImportUserAttr attribute.
o GetImportUserViewsInfo(CATSettingInfo*)
Retrieves the state of the ImportUserViews parameter.
o GetImportUserViews(CATBoolean&)
Retrieves the ImportUserViews attribute.
o GetImportWclMessageInfo(CATSettingInfo*)
Retrieves the state of the ImportWclMessage parameter.
o GetImportWclMessage(CATBoolean&)
Retrieves the ImportWclMessage attribute.
o GetImportWclPathInfo(CATSettingInfo*)
Retrieves the state of the ImportWclPath parameter.
o GetImportWclPath(CATBoolean&)
Retrieves the ImportWclPath attribute.
o GetTypeBaseFrmInfo(CATSettingInfo*)
Retrieves the state of the TypeBaseFrm parameter.
o GetTypeBaseFrm(int&)
Retrieves the TypeBaseFrm attribute.
o GetTypeCoorsysInfo(CATSettingInfo*)
Retrieves the state of the TypeCoorsys parameter.
o GetTypeCoorsys(int&)
Retrieves the TypeCoorsys attribute.
o GetTypeToolFrmInfo(CATSettingInfo*)
Retrieves the state of the TypeToolFrm parameter.
o GetTypeToolFrm(int&)
Retrieves the TypeToolFrm attribute.
o GetTypeWclPathInfo(CATSettingInfo*)
Retrieves the state of the TypeWclPath parameter.
o GetTypeWclPath(int&)
Retrieves the TypeWclPath attribute.
o GetVisBaseFrmInfo(CATSettingInfo*)
Retrieves the state of the VisBaseFrm parameter.
o GetVisBaseFrm(FrameVisibility&)
Retrieves the VisBaseFrm attribute.
o GetVisCoorsysInfo(CATSettingInfo*)
Retrieves the state of the VisCoorsys parameter.
o GetVisCoorsys(FrameVisibility&)
Retrieves the VisCoorsys attribute.
o GetVisToolFrmInfo(CATSettingInfo*)
Retrieves the state of the VisToolFrm parameter.
o GetVisToolFrm(FrameVisibility&)
Retrieves the VisToolFrm attribute.
o GetVisWclPathInfo(CATSettingInfo*)
Retrieves the state of the VisWclPath parameter.
o GetVisWclPath(FrameVisibility&)
Retrieves the VisWclPath attribute.
o SetImportAnnotationLock(unsigned char)
Locks or unlocks the ImportAnnotation parameter.
o SetImportAnnotation(CATBoolean)
Sets the ImportAnnotation attribute.
o SetImportBaseFrmLock(unsigned char)
Locks or unlocks the ImportBaseFrm parameter.
o SetImportBaseFrm(CATBoolean)
Sets the ImportBaseFrm attribute.
o SetImportCollisionLock(unsigned char)
Locks or unlocks the ImportCollision parameter.
o SetImportCollision(CATBoolean)
Sets the ImportCollision attribute.
o SetImportConfigFileLock(unsigned char)
Locks or unlocks the ImportConfigFile parameter.
o SetImportConfigFile(CATUnicodeString&)
Sets the ImportConfigFile attribute.
o SetImportCoorsysLock(unsigned char)
Locks or unlocks the ImportCoorsys parameter.
o SetImportCoorsys(CATBoolean)
Sets the ImportCoorsys attribute.
o SetImportEdgeLock(unsigned char)
Locks or unlocks the ImportEdge parameter.
o SetImportEdge(CATBoolean)
Sets the ImportEdge attribute.
o SetImportFloorLock(unsigned char)
Locks or unlocks the ImportFloor parameter.
o SetImportFloor(CATBoolean)
Sets the ImportFloor attribute.
o SetImportLibraryLock(unsigned char)
Locks or unlocks the ImportLibrary parameter.
o SetImportLibrary(CATUnicodeString&)
Sets the ImportLibrary attribute.
o SetImportPDBCacheLock(unsigned char)
Locks or unlocks the ImportPDBCache parameter.
o SetImportPDBCache(CATUnicodeString&)
Sets the ImportPDBCache attribute.
o SetImportRecordingLock(unsigned char)
Locks or unlocks the ImportRecording parameter.
o SetImportRecording(CATBoolean)
Sets the ImportRecording attribute.
o SetImportToolFrmLock(unsigned char)
Locks or unlocks the ImportToolFrm parameter.
o SetImportToolFrm(CATBoolean)
Sets the ImportToolFrm attribute.
o SetImportUserAttrLock(unsigned char)
Locks or unlocks the ImportUserAttr parameter.
o SetImportUserAttr(CATBoolean)
Sets the ImportUserAttr attribute.
o SetImportUserViewsLock(unsigned char)
Locks or unlocks the ImportUserViews parameter.
o SetImportUserViews(CATBoolean)
Sets the ImportUserViews attribute.
o SetImportWclMessageLock(unsigned char)
Locks or unlocks the ImportWclMessage parameter.
o SetImportWclMessage(CATBoolean)
Sets the ImportWclMessage attribute.
o SetImportWclPathLock(unsigned char)
Locks or unlocks the ImportWclPath parameter.
o SetImportWclPath(CATBoolean)
Sets the ImportWclPath attribute.
o SetTypeBaseFrmLock(unsigned char)
Locks or unlocks the TypeBaseFrm parameter.
o SetTypeBaseFrm(int)
Sets the TypeBaseFrm attribute.
o SetTypeCoorsysLock(unsigned char)
Locks or unlocks the TypeCoorsys parameter.
o SetTypeCoorsys(int)
Sets the TypeCoorsys attribute.
o SetTypeToolFrmLock(unsigned char)
Locks or unlocks the TypeToolFrm parameter.
o SetTypeToolFrm(int)
Sets the TypeToolFrm attribute.
o SetTypeWclPathLock(unsigned char)
Locks or unlocks the TypeWclPath parameter.
o SetTypeWclPath(int)
Sets the TypeWclPath attribute.
o SetVisBaseFrmLock(unsigned char)
Locks or unlocks the VisBaseFrm parameter.
o SetVisBaseFrm(FrameVisibility)
Sets the VisBaseFrm attribute.
o SetVisCoorsysLock(unsigned char)
Locks or unlocks the VisCoorsys parameter.
o SetVisCoorsys(FrameVisibility)
Sets the VisCoorsys attribute.
o SetVisToolFrmLock(unsigned char)
Locks or unlocks the VisToolFrm parameter.
o SetVisToolFrm(FrameVisibility)
Sets the VisToolFrm attribute.
o SetVisWclPathLock(unsigned char)
Locks or unlocks the VisWclPath parameter.
o SetVisWclPath(FrameVisibility)
Sets the VisWclPath attribute.

Methods


o GetImportAnnotationInfo
public virtual GetImportAnnotationInfo( oInfo)
Retrieves the state of the ImportAnnotation parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetImportAnnotation
public virtual GetImportAnnotation( ioImportAnnotation)
Retrieves the ImportAnnotation attribute. It defines the state of the D5 annotation import.
The state can be:
Parameters:
ioImportAnnotation
Legal values:
TRUE : import of D5 annotation.
FALSE: no import of D5 annotation.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetImportBaseFrmInfo
public virtual GetImportBaseFrmInfo( oInfo)
Retrieves the state of the ImportBaseFrm parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetImportBaseFrm
public virtual GetImportBaseFrm( ioImportBaseFrm)
Retrieves the ImportBaseFrm attribute. It defines the state of the D5 base frame import.
The state can be:
Parameters:
ioImportBaseFrm
Legal values:
TRUE : import of D5 base frame.
FALSE: no import of D5 base frame.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetImportCollisionInfo
public virtual GetImportCollisionInfo( oInfo)
Retrieves the state of the ImportCollision parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetImportCollision
public virtual GetImportCollision( ioImportCollision)
Retrieves the ImportCollision attribute. It defines the state of the D5 collision queues import.
The state can be:
Parameters:
ioImportCollision
Legal values:
TRUE : import of D5 collision queues.
FALSE: no import of D5 collision queues.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetImportConfigFileExpanded
public virtual GetImportConfigFileExpanded( ioImportConfigFile)
Retrieves the ImportConfigFile attribute (manages expanded file pathnames).
See also:
GetImportConfigFile
Parameters:
ioImportConfigFile
CATUnicodeString. Absolute config file path.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetImportConfigFileInfo
public virtual GetImportConfigFileInfo( oInfo)
Retrieves the state of the ImportConfigFile parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetImportConfigFile
public virtual GetImportConfigFile( ioImportConfigFile)
Retrieves the ImportConfigFile attribute. Contains the absolute config file path.
Parameters:
ioImportConfigFile
CATUnicodeString. Absolute config file path.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetImportCoorsysInfo
public virtual GetImportCoorsysInfo( oInfo)
Retrieves the state of the ImportCoorsys parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetImportCoorsys
public virtual GetImportCoorsys( ioImportCoorsys)
Retrieves the ImportCoorsys attribute. It defines the state of the D5 coorsys import.
The state can be:
Parameters:
ioImportCoorsys
Legal values:
TRUE : import of D5 coorsys.
FALSE: no import of D5 coorsys.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetImportEdgeInfo
public virtual GetImportEdgeInfo( oInfo)
Retrieves the state of the ImportEdge parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetImportEdge
public virtual GetImportEdge( ioImportEdge)
Retrieves the ImportEdge attribute. It defines the state of the D5 edge import data .
The state can be:
Parameters:
ioImportEdge
Legal values:
TRUE : import of D5 geometric(edge) information.
FALSE: no import of D5 geometric(edge) information.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetImportFloorInfo
public virtual GetImportFloorInfo( oInfo)
Retrieves the state of the ImportFloor parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetImportFloor
public virtual GetImportFloor( ioImportFloor)
Retrieves the ImportFloor attribute. It defines the state of the D5 floor import.
The state can be:
Parameters:
ioImportFloor
Legal values:
TRUE : import of D5 floor.
FALSE: no import of D5 floor.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetImportLibraryExpanded
public virtual GetImportLibraryExpanded( ioImportLibrary)
Retrieves the ImportLibrary attribute (manages expanded file pathnames).
See also:
GetImportLibrary
Parameters:
ioImportLibrary
CATUnicodeString. Contains the list of D5 root libraries paths.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetImportLibraryInfo
public virtual GetImportLibraryInfo( oInfo)
Retrieves the state of the ImportLibrary parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetImportLibrary
public virtual GetImportLibrary( ioImportLibrary)
Retrieves the ImportLibrary attribute. Contains the list of D5 root libraries paths separated by ;.
Parameters:
ioImportLibrary
CATUnicodeString. Contains the list of D5 root libraries paths.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetImportPDBCacheExpanded
public virtual GetImportPDBCacheExpanded( ioImportPDBCache)
Retrieves the ImportPDBCache attribute (manages expanded file pathnames).
See also:
GetImportPDBCache
Parameters:
ioImportPDBCache
CATUnicodeString. Absolute path to cache directory.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetImportPDBCacheInfo
public virtual GetImportPDBCacheInfo( oInfo)
Retrieves the state of the ImportPDBCache parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetImportPDBCache
public virtual GetImportPDBCache( ioImportPDBCache)
Retrieves the ImportPDBCache attribute. Containts the absolute path to D5 CACHE directory for foreign data.
Parameters:
ioImportPDBCache
CATUnicodeString. Absolute path to cache directory.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetImportRecordingInfo
public virtual GetImportRecordingInfo( oInfo)
Retrieves the state of the ImportRecording parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetImportRecording
public virtual GetImportRecording( ioImportRecording)
Retrieves the ImportRecording attribute. It defines the state of the D5 recordings import.
The state can be:
Parameters:
ioImportRecording
Legal values:
TRUE : import of D5 recordings
FALSE: no import of D5 recordings
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetImportToolFrmInfo
public virtual GetImportToolFrmInfo( oInfo)
Retrieves the state of the ImportToolFrm parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetImportToolFrm
public virtual GetImportToolFrm( ioImportToolFrm)
Retrieves the ImportToolFrm attribute. It defines the state of the D5 tool frame import.
The state can be:
Parameters:
ioImportToolFrm
Legal values:
TRUE : import of D5 tool frame.
FALSE: no import of D5 tool frame.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetImportUserAttrInfo
public virtual GetImportUserAttrInfo( oInfo)
Retrieves the state of the ImportUserAttr parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetImportUserAttr
public virtual GetImportUserAttr( ioImportUserAttr)
Retrieves the ImportUserAttr attribute. It defines the state of the D5 user-attributes import.
The state can be:
Parameters:
ioImportUserAttr
Legal values:
TRUE : import of D5 user-attributes.
FALSE: no import of D5 user-attributes.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetImportUserViewsInfo
public virtual GetImportUserViewsInfo( oInfo)
Retrieves the state of the ImportUserViews parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetImportUserViews
public virtual GetImportUserViews( ioImportUserViews)
Retrieves the ImportUserViews attribute. It defines the state of the D5 user views import.
The state can be:
Parameters:
ioImportUserViews
Legal values:
TRUE : import of D5 user views
FALSE: no import of D5 user views
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetImportWclMessageInfo
public virtual GetImportWclMessageInfo( oInfo)
Retrieves the state of the ImportWclMessage parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetImportWclMessage
public virtual GetImportWclMessage( ioImportWclMessage)
Retrieves the ImportWclMessage attribute. It defines the state of the D5 workcell messages import.
The state can be:
Parameters:
ioImportWclMessage
Legal values:
TRUE : import of D5 workcell messages.
FALSE: no import of D5 workcell messages.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetImportWclPathInfo
public virtual GetImportWclPathInfo( oInfo)
Retrieves the state of the ImportWclPath parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetImportWclPath
public virtual GetImportWclPath( ioImportWclPath)
Retrieves the ImportWclPath attribute. It defines the state of the D5 workcell path import.
The state can be:
Parameters:
ioImportWclPath
Legal values:
TRUE : import of D5 workcell path.
FALSE: no import of D5 workcell path.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetTypeBaseFrmInfo
public virtual GetTypeBaseFrmInfo( oInfo)
Retrieves the state of the TypeBaseFrm parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetTypeBaseFrm
public virtual GetTypeBaseFrm( ioTypeBaseFrm)
Retrieves the TypeBaseFrm attribute. Defines the V5 frame type when importing D5 base frame.
The type can be:
Parameters:
ioTypeBaseFrm
Integer. Type of V5 frames.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetTypeCoorsysInfo
public virtual GetTypeCoorsysInfo( oInfo)
Retrieves the state of the TypeCoorsys parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetTypeCoorsys
public virtual GetTypeCoorsys( ioTypeCoorsys)
Retrieves the TypeCoorsys attribute. Defines the V5 frame type when importing D5 coorsys.
The type can be:
Parameters:
ioTypeCoorsys
Integer. Type of V5 frames.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetTypeToolFrmInfo
public virtual GetTypeToolFrmInfo( oInfo)
Retrieves the state of the TypeToolFrm parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetTypeToolFrm
public virtual GetTypeToolFrm( ioTypeToolFrm)
Retrieves the TypeToolFrm attribute. Defines the V5 frame type when importing D5 tool frame.
The type can be:
Parameters:
ioTypeToolFrm
Integer. Type of V5 frames.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetTypeWclPathInfo
public virtual GetTypeWclPathInfo( oInfo)
Retrieves the state of the TypeWclPath parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetTypeWclPath
public virtual GetTypeWclPath( ioTypeWclPath)
Retrieves the TypeWclPath attribute. Defines the V5 frame type when importing D5 workcell paths.
The type can be:
Parameters:
ioTypeWclPath
Integer. Type of V5 frames.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetVisBaseFrmInfo
public virtual GetVisBaseFrmInfo( oInfo)
Retrieves the state of the VisBaseFrm parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetVisBaseFrm
public virtual GetVisBaseFrm( ioVisBaseFrm)
Retrieves the VisBaseFrm attribute. Defines the visibility state of D5 base frame at the import.
The state can be:
Parameters:
ioVisBaseFrm
Legal values:
VisYes: visible
VisNo: not visible
VisRetain: D5 Visibility status
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetVisCoorsysInfo
public virtual GetVisCoorsysInfo( oInfo)
Retrieves the state of the VisCoorsys parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetVisCoorsys
public virtual GetVisCoorsys( ioVisCoorsys)
Retrieves the VisCoorsys attribute. Defines the visibility state of D5 coorsys at the import.
The state can be:
Parameters:
ioVisCoorsys
Legal values:
VisYes: visible
VisNo: not visible
VisRetain: D5 Visibility status
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetVisToolFrmInfo
public virtual GetVisToolFrmInfo( oInfo)
Retrieves the state of the VisToolFrm parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetVisToolFrm
public virtual GetVisToolFrm( ioVisToolFrm)
Retrieves the VisToolFrm attribute. Defines the visibility state of D5 tool frame at the import.
The state can be:
Parameters:
ioVisToolFrm
Legal values:
VisYes: visible
VisNo: not visible
VisRetain: D5 Visibility status
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetVisWclPathInfo
public virtual GetVisWclPathInfo( oInfo)
Retrieves the state of the VisWclPath parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetVisWclPath
public virtual GetVisWclPath( ioVisWclPath)
Retrieves the VisWclPath attribute. Defines the visibility state of D5 workcell paths at the import.
The state can be:
Parameters:
ioVisWclPath
Legal values:
VisYes: visible
VisNo: not visible
VisRetain: D5 Visibility status
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetImportAnnotationLock
public virtual SetImportAnnotationLock( iLocked)
Locks or unlocks the ImportAnnotation parameter.
Role: Locks or unlocks the ImportAnnotation 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 SetImportAnnotation
public virtual SetImportAnnotation( const iImportAnnotation)
Sets the ImportAnnotation attribute.
See also:
GetImportAnnotation
o SetImportBaseFrmLock
public virtual SetImportBaseFrmLock( iLocked)
Locks or unlocks the ImportBaseFrm parameter.
Role: Locks or unlocks the ImportBaseFrm 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 SetImportBaseFrm
public virtual SetImportBaseFrm( const iImportBaseFrm)
Sets the ImportBaseFrm attribute.
See also:
GetImportBaseFrm
o SetImportCollisionLock
public virtual SetImportCollisionLock( iLocked)
Locks or unlocks the ImportCollision parameter.
Role: Locks or unlocks the ImportCollision 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 SetImportCollision
public virtual SetImportCollision( const iImportCollision)
Sets the ImportCollision attribute.
See also:
GetImportCollision
o SetImportConfigFileLock
public virtual SetImportConfigFileLock( iLocked)
Locks or unlocks the ImportConfigFile parameter.
Role: Locks or unlocks the ImportConfigFile 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 SetImportConfigFile
public virtual SetImportConfigFile( const iImportConfigFile)
Sets the ImportConfigFile attribute.
Parameters:
iImportConfigFile
CATUnicodeString. Absolute config file path.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetImportCoorsysLock
public virtual SetImportCoorsysLock( iLocked)
Locks or unlocks the ImportCoorsys parameter.
Role: Locks or unlocks the ImportCoorsys 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 SetImportCoorsys
public virtual SetImportCoorsys( const iImportCoorsys)
Sets the ImportCoorsys attribute.
See also:
GetImportCoorsys
o SetImportEdgeLock
public virtual SetImportEdgeLock( iLocked)
Locks or unlocks the ImportEdge parameter.
Role: Locks or unlocks the ImportEdge 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 SetImportEdge
public virtual SetImportEdge( const iImportEdge)
Sets the ImportEdge attribute.
See also:
GetImportEdge
o SetImportFloorLock
public virtual SetImportFloorLock( iLocked)
Locks or unlocks the ImportFloor parameter.
Role: Locks or unlocks the ImportFloor 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 SetImportFloor
public virtual SetImportFloor( const iImportFloor)
Sets the ImportFloor attribute.
See also:
GetImportFloor
o SetImportLibraryLock
public virtual SetImportLibraryLock( iLocked)
Locks or unlocks the ImportLibrary parameter.
Role: Locks or unlocks the ImportLibrary 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 SetImportLibrary
public virtual SetImportLibrary( const iImportLibrary)
Sets the ImportLibrary attribute. Defines the D5 root libraries paths to use. Paths must be separated by the character ;.
Parameters:
iImportLibrary
CATUnicodeString. List of D5 root libraries to set.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetImportPDBCacheLock
public virtual SetImportPDBCacheLock( iLocked)
Locks or unlocks the ImportPDBCache parameter.
Role: Locks or unlocks the ImportPDBCache 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 SetImportPDBCache
public virtual SetImportPDBCache( const iImportPDBCache)
Sets the ImportPDBCache attribute.
Parameters:
ioImportPDBCache
CATUnicodeString. Absolute path to cache directory.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetImportRecordingLock
public virtual SetImportRecordingLock( iLocked)
Locks or unlocks the ImportRecording parameter.
Role: Locks or unlocks the ImportRecording 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 SetImportRecording
public virtual SetImportRecording( const iImportRecording)
Sets the ImportRecording attribute.
See also:
GetImportRecording
o SetImportToolFrmLock
public virtual SetImportToolFrmLock( iLocked)
Locks or unlocks the ImportToolFrm parameter.
Role: Locks or unlocks the ImportToolFrm 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 SetImportToolFrm
public virtual SetImportToolFrm( const iImportToolFrm)
Sets the ImportToolFrm attribute.
See also:
GetImportToolFrm
o SetImportUserAttrLock
public virtual SetImportUserAttrLock( iLocked)
Locks or unlocks the ImportUserAttr parameter.
Role: Locks or unlocks the ImportUserAttr 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 SetImportUserAttr
public virtual SetImportUserAttr( const iImportUserAttr)
Sets the ImportUserAttr attribute.
See also:
GetImportUserAttr
o SetImportUserViewsLock
public virtual SetImportUserViewsLock( iLocked)
Locks or unlocks the ImportUserViews parameter.
Role: Locks or unlocks the ImportUserViews 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 SetImportUserViews
public virtual SetImportUserViews( const iImportUserViews)
Sets the ImportUserViews attribute.
See also:
GetImportUserViews
o SetImportWclMessageLock
public virtual SetImportWclMessageLock( iLocked)
Locks or unlocks the ImportWclMessage parameter.
Role: Locks or unlocks the ImportWclMessage 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 SetImportWclMessage
public virtual SetImportWclMessage( const iImportWclMessage)
Sets the ImportWclMessage attribute.
See also:
GetImportWclMessage
o SetImportWclPathLock
public virtual SetImportWclPathLock( iLocked)
Locks or unlocks the ImportWclPath parameter.
Role: Locks or unlocks the ImportWclPath 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 SetImportWclPath
public virtual SetImportWclPath( const iImportWclPath)
Sets the ImportWclPath attribute.
See also:
GetImportWclPath
o SetTypeBaseFrmLock
public virtual SetTypeBaseFrmLock( iLocked)
Locks or unlocks the TypeBaseFrm parameter.
Role: Locks or unlocks the TypeBaseFrm 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 SetTypeBaseFrm
public virtual SetTypeBaseFrm( const iTypeBaseFrm)
Sets the TypeBaseFrm attribute.
See also:
GetTypeBaseFrm
o SetTypeCoorsysLock
public virtual SetTypeCoorsysLock( iLocked)
Locks or unlocks the TypeCoorsys parameter.
Role: Locks or unlocks the TypeCoorsys 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 SetTypeCoorsys
public virtual SetTypeCoorsys( const iTypeCoorsys)
Sets the TypeCoorsys attribute.
o SetTypeToolFrmLock
public virtual SetTypeToolFrmLock( iLocked)
Locks or unlocks the TypeToolFrm parameter.
Role: Locks or unlocks the TypeToolFrm 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 SetTypeToolFrm
public virtual SetTypeToolFrm( const iTypeToolFrm)
Sets the TypeToolFrm attribute.
See also:
GetTypeToolFrm
o SetTypeWclPathLock
public virtual SetTypeWclPathLock( iLocked)
Locks or unlocks the TypeWclPath parameter.
Role: Locks or unlocks the TypeWclPath 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 SetTypeWclPath
public virtual SetTypeWclPath( const iTypeWclPath)
Sets the TypeWclPath attribute.
See also:
GetTypeWclPath
o SetVisBaseFrmLock
public virtual SetVisBaseFrmLock( iLocked)
Locks or unlocks the VisBaseFrm parameter.
Role: Locks or unlocks the VisBaseFrm 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 SetVisBaseFrm
public virtual SetVisBaseFrm( const iVisBaseFrm)
Sets the VisBaseFrm attribute.
See also:
GetVisBaseFrm
o SetVisCoorsysLock
public virtual SetVisCoorsysLock( iLocked)
Locks or unlocks the VisCoorsys parameter.
Role: Locks or unlocks the VisCoorsys 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 SetVisCoorsys
public virtual SetVisCoorsys( const iVisCoorsys)
Sets the VisCoorsys attribute.
See also:
GetVisCoorsys
o SetVisToolFrmLock
public virtual SetVisToolFrmLock( iLocked)
Locks or unlocks the VisToolFrm parameter.
Role: Locks or unlocks the VisToolFrm 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 SetVisToolFrm
public virtual SetVisToolFrm( const iVisToolFrm)
Sets the VisToolFrm attribute.
See also:
GetVisToolFrm
o SetVisWclPathLock
public virtual SetVisWclPathLock( iLocked)
Locks or unlocks the VisWclPath parameter.
Role: Locks or unlocks the VisWclPath 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 SetVisWclPath
public virtual SetVisWclPath( const iVisWclPath)
Sets the VisWclPath attribute.
See also:
GetVisWclPath

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

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