All Frameworks Class Hierarchy This Framework Previous Indexes
DNBD5IInterfaces Interface DNBID5IImportD5SettingAtt
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---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.
- Methods to set value of each parameter xxx
- Methods to get value of each parameter xxx
- Methods to get information on each parameter xxx
- Methods to lock/unlock value of each parameter xxx
Here are the list of parameters to use and their meanings:
- ImportLibrary: define the D5 root libraries. For several
libraries, they are separated by the character ;.
- D:\Syslib;D:\Robotlib; for Windows
- /usr/deneb/Syslib;/usr/deneb/Robotlib; for UNIX
- ImportConfigFile: defines the configuration file to append.
- ImportConfigFile: defines the configuration file to append.
- ImportPDBCache : defines the D5 pdb cache directory for UG
files.
- ImportRecording : defines the option for importing D5 recording
file into V5 replays.
- ImportUserViews : defines the option for importing D5 user views
into V5 cameras. For workcells only.
- ImportAnnotation: defines the option for importing D5 annotations
into V5 3D annotations. For workcells only.
- ImportWclMessage: defines the option for displaying the D5
workcell messages after importing. Message is stored on the product. For
workcells only.
- ImportCollision : defines the option for importing D5 collision
queues into V5 interferences objects. For workcells only.
- ImportFloor : defines the option for importing D5 floor into
V5 Area. For workcells only.
- ImportUserAttr : defines the option for importing D5 user
attributes into V5 knowledgeware parameters.
- ImportEdge : defines the option for importing D5 edge geometry
information.
- ImportCoorsys : defines the option for importing D5 coorsys
into V5 frames of interests (by default as DESIGN).
- ImportToolFrm : defines the option for importing D5 tool frame
into V5 frames of interests (by default as TOOL).
- ImportBaseFrm : defines the option for importing D5 base frame
into V5 base frames of interests (by default as BASE).
- ImportWclPath : defines the option for importing D5 workcell
paths into V5 frames of interests (by default as MANUFACTURING).
- VisCoorsys : defines the visibility status at the import of
D5 coorsys.
- VisToolFrm : defines the visibility status at the import of
D5 tool frame.
- VisBaseFrm : defines the visibility status at the import of
D5 base frame.
- VisWclPath : defines the visibility status at the import of
D5 workcell paths.
- TypeCoorsys : defines the V5 frame of interest matching type
when importing D5 coorsys.
- TypeToolFrm : defines the V5 frame of interest matching type
when importing D5 tool frame.
- TypeBaseFrm : defines the V5 frame of interest matching type
when importing D5 base frame.
- TypeWclPath : defines the V5 frame of interest matching type
when importing D5 workcell paths.
Method Index
- o
GetImportAnnotation(CATBoolean&)
- Retrieves the ImportAnnotation attribute.
- o
GetImportAnnotationInfo(CATSettingInfo*)
- Retrieves the state of the ImportAnnotation parameter.
- o
GetImportBaseFrm(CATBoolean&)
- Retrieves the ImportBaseFrm attribute.
- o
GetImportBaseFrmInfo(CATSettingInfo*)
- Retrieves the state of the ImportBaseFrm parameter.
- o
GetImportCollision(CATBoolean&)
- Retrieves the ImportCollision attribute.
- o
GetImportCollisionInfo(CATSettingInfo*)
- Retrieves the state of the ImportCollision parameter.
- o
GetImportConfigFile(CATUnicodeString&)
- Retrieves the ImportConfigFile attribute.
- o
GetImportConfigFileExpanded(CATUnicodeString&)
- Retrieves the ImportConfigFile attribute (manages expanded file pathnames).
- o
GetImportConfigFileInfo(CATSettingInfo*)
- Retrieves the state of the ImportConfigFile parameter.
- o
GetImportCoorsys(CATBoolean&)
- Retrieves the ImportCoorsys attribute.
- o
GetImportCoorsysInfo(CATSettingInfo*)
- Retrieves the state of the ImportCoorsys parameter.
- o
GetImportEdge(CATBoolean&)
- Retrieves the ImportEdge attribute.
- o
GetImportEdgeInfo(CATSettingInfo*)
- Retrieves the state of the ImportEdge parameter.
- o
GetImportFloor(CATBoolean&)
- Retrieves the ImportFloor attribute.
- o
GetImportFloorInfo(CATSettingInfo*)
- Retrieves the state of the ImportFloor parameter.
- o
GetImportLibrary(CATUnicodeString&)
- Retrieves the ImportLibrary attribute.
- o
GetImportLibraryExpanded(CATUnicodeString&)
- Retrieves the ImportLibrary attribute (manages expanded file pathnames).
- o
GetImportLibraryInfo(CATSettingInfo*)
- Retrieves the state of the ImportLibrary parameter.
- o
GetImportPDBCache(CATUnicodeString&)
- Retrieves the ImportPDBCache attribute.
- o
GetImportPDBCacheExpanded(CATUnicodeString&)
- Retrieves the ImportPDBCache attribute (manages expanded file pathnames).
- o
GetImportPDBCacheInfo(CATSettingInfo*)
- Retrieves the state of the ImportPDBCache parameter.
- o
GetImportRecording(CATBoolean&)
- Retrieves the ImportRecording attribute.
- o
GetImportRecordingInfo(CATSettingInfo*)
- Retrieves the state of the ImportRecording parameter.
- o
GetImportToolFrm(CATBoolean&)
- Retrieves the ImportToolFrm attribute.
- o
GetImportToolFrmInfo(CATSettingInfo*)
- Retrieves the state of the ImportToolFrm parameter.
- o
GetImportUserAttr(CATBoolean&)
- Retrieves the ImportUserAttr attribute.
- o
GetImportUserAttrInfo(CATSettingInfo*)
- Retrieves the state of the ImportUserAttr parameter.
- o
GetImportUserViews(CATBoolean&)
- Retrieves the ImportUserViews attribute.
- o
GetImportUserViewsInfo(CATSettingInfo*)
- Retrieves the state of the ImportUserViews parameter.
- o
GetImportWclMessage(CATBoolean&)
- Retrieves the ImportWclMessage attribute.
- o
GetImportWclMessageInfo(CATSettingInfo*)
- Retrieves the state of the ImportWclMessage parameter.
- o
GetImportWclPath(CATBoolean&)
- Retrieves the ImportWclPath attribute.
- o
GetImportWclPathInfo(CATSettingInfo*)
- Retrieves the state of the ImportWclPath parameter.
- o
GetTypeBaseFrm(int&)
- Retrieves the TypeBaseFrm attribute.
- o
GetTypeBaseFrmInfo(CATSettingInfo*)
- Retrieves the state of the TypeBaseFrm parameter.
- o
GetTypeCoorsys(int&)
- Retrieves the TypeCoorsys attribute.
- o
GetTypeCoorsysInfo(CATSettingInfo*)
- Retrieves the state of the TypeCoorsys parameter.
- o
GetTypeToolFrm(int&)
- Retrieves the TypeToolFrm attribute.
- o
GetTypeToolFrmInfo(CATSettingInfo*)
- Retrieves the state of the TypeToolFrm parameter.
- o
GetTypeWclPath(int&)
- Retrieves the TypeWclPath attribute.
- o
GetTypeWclPathInfo(CATSettingInfo*)
- Retrieves the state of the TypeWclPath parameter.
- o
GetVisBaseFrm(FrameVisibility&)
- Retrieves the VisBaseFrm attribute.
- o
GetVisBaseFrmInfo(CATSettingInfo*)
- Retrieves the state of the VisBaseFrm parameter.
- o
GetVisCoorsys(FrameVisibility&)
- Retrieves the VisCoorsys attribute.
- o
GetVisCoorsysInfo(CATSettingInfo*)
- Retrieves the state of the VisCoorsys parameter.
- o
GetVisToolFrm(FrameVisibility&)
- Retrieves the VisToolFrm attribute.
- o
GetVisToolFrmInfo(CATSettingInfo*)
- Retrieves the state of the VisToolFrm parameter.
- o
GetVisWclPath(FrameVisibility&)
- Retrieves the VisWclPath attribute.
- o
GetVisWclPathInfo(CATSettingInfo*)
- Retrieves the state of the VisWclPath parameter.
- o
SetImportAnnotation(CATBoolean)
- Sets the ImportAnnotation attribute.
- o
SetImportAnnotationLock(unsigned char)
- Locks or unlocks the ImportAnnotation parameter.
- o
SetImportBaseFrm(CATBoolean)
- Sets the ImportBaseFrm attribute.
- o
SetImportBaseFrmLock(unsigned char)
- Locks or unlocks the ImportBaseFrm parameter.
- o
SetImportCollision(CATBoolean)
- Sets the ImportCollision attribute.
- o
SetImportCollisionLock(unsigned char)
- Locks or unlocks the ImportCollision parameter.
- o
SetImportConfigFile(CATUnicodeString&)
- Sets the ImportConfigFile attribute.
- o
SetImportConfigFileLock(unsigned char)
- Locks or unlocks the ImportConfigFile parameter.
- o
SetImportCoorsys(CATBoolean)
- Sets the ImportCoorsys attribute.
- o
SetImportCoorsysLock(unsigned char)
- Locks or unlocks the ImportCoorsys parameter.
- o
SetImportEdge(CATBoolean)
- Sets the ImportEdge attribute.
- o
SetImportEdgeLock(unsigned char)
- Locks or unlocks the ImportEdge parameter.
- o
SetImportFloor(CATBoolean)
- Sets the ImportFloor attribute.
- o
SetImportFloorLock(unsigned char)
- Locks or unlocks the ImportFloor parameter.
- o
SetImportLibrary(CATUnicodeString&)
- Sets the ImportLibrary attribute.
- o
SetImportLibraryLock(unsigned char)
- Locks or unlocks the ImportLibrary parameter.
- o
SetImportPDBCache(CATUnicodeString&)
- Sets the ImportPDBCache attribute.
- o
SetImportPDBCacheLock(unsigned char)
- Locks or unlocks the ImportPDBCache parameter.
- o
SetImportRecording(CATBoolean)
- Sets the ImportRecording attribute.
- o
SetImportRecordingLock(unsigned char)
- Locks or unlocks the ImportRecording parameter.
- o
SetImportToolFrm(CATBoolean)
- Sets the ImportToolFrm attribute.
- o
SetImportToolFrmLock(unsigned char)
- Locks or unlocks the ImportToolFrm parameter.
- o
SetImportUserAttr(CATBoolean)
- Sets the ImportUserAttr attribute.
- o
SetImportUserAttrLock(unsigned char)
- Locks or unlocks the ImportUserAttr parameter.
- o
SetImportUserViews(CATBoolean)
- Sets the ImportUserViews attribute.
- o
SetImportUserViewsLock(unsigned char)
- Locks or unlocks the ImportUserViews parameter.
- o
SetImportWclMessage(CATBoolean)
- Sets the ImportWclMessage attribute.
- o
SetImportWclMessageLock(unsigned char)
- Locks or unlocks the ImportWclMessage parameter.
- o
SetImportWclPath(CATBoolean)
- Sets the ImportWclPath attribute.
- o
SetImportWclPathLock(unsigned char)
- Locks or unlocks the ImportWclPath parameter.
- o
SetTypeBaseFrm(int)
- Sets the TypeBaseFrm attribute.
- o
SetTypeBaseFrmLock(unsigned char)
- Locks or unlocks the TypeBaseFrm parameter.
- o
SetTypeCoorsys(int)
- Sets the TypeCoorsys attribute.
- o
SetTypeCoorsysLock(unsigned char)
- Locks or unlocks the TypeCoorsys parameter.
- o
SetTypeToolFrm(int)
- Sets the TypeToolFrm attribute.
- o
SetTypeToolFrmLock(unsigned char)
- Locks or unlocks the TypeToolFrm parameter.
- o
SetTypeWclPath(int)
- Sets the TypeWclPath attribute.
- o
SetTypeWclPathLock(unsigned char)
- Locks or unlocks the TypeWclPath parameter.
- o
SetVisBaseFrm(FrameVisibility)
- Sets the VisBaseFrm attribute.
- o
SetVisBaseFrmLock(unsigned char)
- Locks or unlocks the VisBaseFrm parameter.
- o
SetVisCoorsys(FrameVisibility)
- Sets the VisCoorsys attribute.
- o
SetVisCoorsysLock(unsigned char)
- Locks or unlocks the VisCoorsys parameter.
- o
SetVisToolFrm(FrameVisibility)
- Sets the VisToolFrm attribute.
- o
SetVisToolFrmLock(unsigned char)
- Locks or unlocks the VisToolFrm parameter.
- o
SetVisWclPath(FrameVisibility)
- Sets the VisWclPath attribute.
- o
SetVisWclPathLock(unsigned char)
- Locks or unlocks the VisWclPath parameter.
Methods
o GetImportAnnotation
-
Retrieves the ImportAnnotation attribute. It defines the state of the D5
annotation import.
The state can be:
- TRUE
if the import of D5 annotation is activ.
- FALSE
if the import of D5 annotation is inactiv.
- 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 GetImportAnnotationInfo
-
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 GetImportBaseFrm
-
Retrieves the ImportBaseFrm attribute. It defines the state of the D5
base frame import.
The state can be:
- TRUE
if the import of D5 base frame is activ.
- FALSE
if the import of D5 base frame is inactiv.
- 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 GetImportBaseFrmInfo
-
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 GetImportCollision
-
Retrieves the ImportCollision attribute. It defines the state of the D5
collision queues import.
The state can be:
- TRUE
if the import of D5 collision queues is activ.
- FALSE
if the import of D5 collision queues is inactiv.
- 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 GetImportCollisionInfo
-
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 GetImportConfigFile
-
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 GetImportConfigFileExpanded
-
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
-
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 GetImportCoorsys
-
Retrieves the ImportCoorsys attribute. It defines the state of the D5
coorsys import.
The state can be:
- TRUE
if the import of D5 coorsys is activ.
- FALSE
if the import of D5 coorsys is inactiv.
- 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 GetImportCoorsysInfo
-
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 GetImportEdge
-
Retrieves the ImportEdge attribute. It defines the state of the D5
edge import data .
The state can be:
- TRUE
if the import of D5 geometric(edge) information
is activ.
- FALSE
if the import of D5 geometric(edge)
information is inactiv.
- 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 GetImportEdgeInfo
-
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 GetImportFloor
-
Retrieves the ImportFloor attribute. It defines the state of the D5
floor import.
The state can be:
- TRUE
if the import of D5 floor is activ.
- FALSE
if the import of D5 floor is inactiv.
- 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 GetImportFloorInfo
-
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 GetImportLibrary
-
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 GetImportLibraryExpanded
-
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
-
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 GetImportPDBCache
-
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 GetImportPDBCacheExpanded
-
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
-
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 GetImportRecording
-
Retrieves the ImportRecording attribute. It defines the state of the D5
recordings import.
The state can be:
- TRUE
if the import of D5 recordings is activ.
- FALSE
if the import of D5 recordings is inactiv.
- 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 GetImportRecordingInfo
-
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 GetImportToolFrm
-
Retrieves the ImportToolFrm attribute. It defines the state of the D5
tool frame import.
The state can be:
- TRUE
if the import of D5 tool frame is activ.
- FALSE
if the import of D5 tool frame is inactiv.
- 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 GetImportToolFrmInfo
-
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 GetImportUserAttr
-
Retrieves the ImportUserAttr attribute. It defines the state of the D5
user-attributes import.
The state can be:
- TRUE
if the import of D5 user-attributes is activ.
- FALSE
if the import of D5 user-attributes is inactiv.
- 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 GetImportUserAttrInfo
-
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 GetImportUserViews
-
Retrieves the ImportUserViews attribute. It defines the state of the D5
user views import.
The state can be:
- TRUE
if the import of D5 user views is activ.
- FALSE
if the import of D5 user views is inactiv.
- 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 GetImportUserViewsInfo
-
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 GetImportWclMessage
-
Retrieves the ImportWclMessage attribute. It defines the state of the D5
workcell messages import.
The state can be:
- TRUE
if the import of D5 workcell messages is activ.
- FALSE
if the import of D5 workcell messages is inactiv.
- 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 GetImportWclMessageInfo
-
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 GetImportWclPath
-
Retrieves the ImportWclPath attribute. It defines the state of the D5
workcell path import.
The state can be:
- TRUE
if the import of D5 workcell path is activ.
- FALSE
if the import of D5 workcell path is inactiv.
- 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 GetImportWclPathInfo
-
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 GetTypeBaseFrm
public virtual HRESULT GetTypeBaseFrm( | int& | ioTypeBaseFrm)= 0 |
-
Retrieves the TypeBaseFrm attribute. Defines the V5 frame type when
importing D5 base frame.
The type can be:
- 0
for V5 DESIGN frames.
- 1
for V5 TOOL frames.
- 2
for V5 BASE frames.
- 3
for V5 MANUFACTURING frames.
- Parameters:
-
- ioTypeBaseFrm
- Integer. Type of V5 frames.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetTypeBaseFrmInfo
-
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 GetTypeCoorsys
public virtual HRESULT GetTypeCoorsys( | int& | ioTypeCoorsys)= 0 |
-
Retrieves the TypeCoorsys attribute. Defines the V5 frame type when
importing D5 coorsys.
The type can be:
- 0
for V5 DESIGN frames.
- 1
for V5 TOOL frames.
- 2
for V5 BASE frames.
- 3
for V5 MANUFACTURING frames.
- Parameters:
-
- ioTypeCoorsys
- Integer. Type of V5 frames.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetTypeCoorsysInfo
-
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 GetTypeToolFrm
public virtual HRESULT GetTypeToolFrm( | int& | ioTypeToolFrm)= 0 |
-
Retrieves the TypeToolFrm attribute. Defines the V5 frame type when
importing D5 tool frame.
The type can be:
- 0
for V5 DESIGN frames.
- 1
for V5 TOOL frames.
- 2
for V5 BASE frames.
- 3
for V5 MANUFACTURING frames.
- Parameters:
-
- ioTypeToolFrm
- Integer. Type of V5 frames.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetTypeToolFrmInfo
-
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 GetTypeWclPath
public virtual HRESULT GetTypeWclPath( | int& | ioTypeWclPath)= 0 |
-
Retrieves the TypeWclPath attribute. Defines the V5 frame type when
importing D5 workcell paths.
The type can be:
- 0
for V5 DESIGN frames.
- 1
for V5 TOOL frames.
- 2
for V5 BASE frames.
- 3
for V5 MANUFACTURING frames.
- Parameters:
-
- ioTypeWclPath
- Integer. Type of V5 frames.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetTypeWclPathInfo
-
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 GetVisBaseFrm
-
Retrieves the VisBaseFrm attribute. Defines the visibility state of D5
base frame at the import.
The state can be:
- VisYes
if imported D5 base frame are visible.
- VisNo
if imported D5 base frame are not visible.
- VisRetain
if imported D5 base frame has D5 visibility status.
- 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 GetVisBaseFrmInfo
-
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 GetVisCoorsys
-
Retrieves the VisCoorsys attribute. Defines the visibility state of D5
coorsys at the import.
The state can be:
- VisYes
if imported D5 coorsys are visible.
- VisNo
if imported D5 coorsys are not visible.
- VisRetain
if imported D5 coorsys has D5 visibility status.
- 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 GetVisCoorsysInfo
-
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 GetVisToolFrm
-
Retrieves the VisToolFrm attribute. Defines the visibility state of D5
tool frame at the import.
The state can be:
- VisYes
if imported D5 tool frame are visible.
- VisNo
if imported D5 tool frame are not visible.
- VisRetain
if imported D5 tool frame has D5 visibility status.
- 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 GetVisToolFrmInfo
-
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 GetVisWclPath
-
Retrieves the VisWclPath attribute. Defines the visibility state of D5
workcell paths at the import.
The state can be:
- VisYes
if imported D5 workcell paths are visible.
- VisNo
if imported D5 workcell paths are not visible.
- VisRetain
if imported D5 workcell paths has D5 visibility status.
- 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 GetVisWclPathInfo
-
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 SetImportAnnotation
-
Sets the ImportAnnotation attribute.
- See also:
- GetImportAnnotation
o SetImportAnnotationLock
public virtual HRESULT SetImportAnnotationLock( | unsigned char | iLocked)= 0 |
-
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 SetImportBaseFrm
-
Sets the ImportBaseFrm attribute.
- See also:
- GetImportBaseFrm
o SetImportBaseFrmLock
public virtual HRESULT SetImportBaseFrmLock( | unsigned char | iLocked)= 0 |
-
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 SetImportCollision
-
Sets the ImportCollision attribute.
- See also:
- GetImportCollision
o SetImportCollisionLock
public virtual HRESULT SetImportCollisionLock( | unsigned char | iLocked)= 0 |
-
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 SetImportConfigFile
-
Sets the ImportConfigFile attribute.
- Parameters:
-
- iImportConfigFile
- CATUnicodeString. Absolute config file path.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetImportConfigFileLock
public virtual HRESULT SetImportConfigFileLock( | unsigned char | iLocked)= 0 |
-
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 SetImportCoorsys
-
Sets the ImportCoorsys attribute.
- See also:
- GetImportCoorsys
o SetImportCoorsysLock
public virtual HRESULT SetImportCoorsysLock( | unsigned char | iLocked)= 0 |
-
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 SetImportEdge
-
Sets the ImportEdge attribute.
- See also:
- GetImportEdge
o SetImportEdgeLock
public virtual HRESULT SetImportEdgeLock( | unsigned char | iLocked)= 0 |
-
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 SetImportFloor
-
Sets the ImportFloor attribute.
- See also:
- GetImportFloor
o SetImportFloorLock
public virtual HRESULT SetImportFloorLock( | unsigned char | iLocked)= 0 |
-
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 SetImportLibrary
-
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 SetImportLibraryLock
public virtual HRESULT SetImportLibraryLock( | unsigned char | iLocked)= 0 |
-
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 SetImportPDBCache
-
Sets the ImportPDBCache attribute.
- Parameters:
-
- ioImportPDBCache
- CATUnicodeString. Absolute path to cache directory.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetImportPDBCacheLock
public virtual HRESULT SetImportPDBCacheLock( | unsigned char | iLocked)= 0 |
-
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 SetImportRecording
-
Sets the ImportRecording attribute.
- See also:
- GetImportRecording
o SetImportRecordingLock
public virtual HRESULT SetImportRecordingLock( | unsigned char | iLocked)= 0 |
-
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 SetImportToolFrm
-
Sets the ImportToolFrm attribute.
- See also:
- GetImportToolFrm
o SetImportToolFrmLock
public virtual HRESULT SetImportToolFrmLock( | unsigned char | iLocked)= 0 |
-
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 SetImportUserAttr
-
Sets the ImportUserAttr attribute.
- See also:
- GetImportUserAttr
o SetImportUserAttrLock
public virtual HRESULT SetImportUserAttrLock( | unsigned char | iLocked)= 0 |
-
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 SetImportUserViews
-
Sets the ImportUserViews attribute.
- See also:
- GetImportUserViews
o SetImportUserViewsLock
public virtual HRESULT SetImportUserViewsLock( | unsigned char | iLocked)= 0 |
-
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 SetImportWclMessage
-
Sets the ImportWclMessage attribute.
- See also:
- GetImportWclMessage
o SetImportWclMessageLock
public virtual HRESULT SetImportWclMessageLock( | unsigned char | iLocked)= 0 |
-
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 SetImportWclPath
-
Sets the ImportWclPath attribute.
- See also:
- GetImportWclPath
o SetImportWclPathLock
public virtual HRESULT SetImportWclPathLock( | unsigned char | iLocked)= 0 |
-
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 SetTypeBaseFrm
public virtual HRESULT SetTypeBaseFrm( | const int | iTypeBaseFrm)= 0 |
-
Sets the TypeBaseFrm attribute.
- See also:
- GetTypeBaseFrm
o SetTypeBaseFrmLock
public virtual HRESULT SetTypeBaseFrmLock( | unsigned char | iLocked)= 0 |
-
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 SetTypeCoorsys
public virtual HRESULT SetTypeCoorsys( | const int | iTypeCoorsys)= 0 |
-
Sets the TypeCoorsys attribute.
o SetTypeCoorsysLock
public virtual HRESULT SetTypeCoorsysLock( | unsigned char | iLocked)= 0 |
-
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 SetTypeToolFrm
public virtual HRESULT SetTypeToolFrm( | const int | iTypeToolFrm)= 0 |
-
Sets the TypeToolFrm attribute.
- See also:
- GetTypeToolFrm
o SetTypeToolFrmLock
public virtual HRESULT SetTypeToolFrmLock( | unsigned char | iLocked)= 0 |
-
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 SetTypeWclPath
public virtual HRESULT SetTypeWclPath( | const int | iTypeWclPath)= 0 |
-
Sets the TypeWclPath attribute.
- See also:
- GetTypeWclPath
o SetTypeWclPathLock
public virtual HRESULT SetTypeWclPathLock( | unsigned char | iLocked)= 0 |
-
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 SetVisBaseFrm
-
Sets the VisBaseFrm attribute.
- See also:
- GetVisBaseFrm
o SetVisBaseFrmLock
public virtual HRESULT SetVisBaseFrmLock( | unsigned char | iLocked)= 0 |
-
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 SetVisCoorsys
-
Sets the VisCoorsys attribute.
- See also:
- GetVisCoorsys
o SetVisCoorsysLock
public virtual HRESULT SetVisCoorsysLock( | unsigned char | iLocked)= 0 |
-
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 SetVisToolFrm
-
Sets the VisToolFrm attribute.
- See also:
- GetVisToolFrm
o SetVisToolFrmLock
public virtual HRESULT SetVisToolFrmLock( | unsigned char | iLocked)= 0 |
-
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 SetVisWclPath
-
Sets the VisWclPath attribute.
- See also:
- GetVisWclPath
o SetVisWclPathLock
public virtual HRESULT SetVisWclPathLock( | unsigned char | iLocked)= 0 |
-
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
This object is included in the file: DNBID5IImportD5SettingAtt.h
If needed, your Imakefile.mk should include the module: DNBD5IItf