public interface ComponentDefinitionCollection extends TaggedObjectCollection
ComponentDefinition
objects. Part
TaggedObjectCollection.Iterator
Modifier and Type | Method and Description |
---|---|
void |
delete(Layout2dDefinitionLocation location,
String definitionPath)
Deletes definition
License requirements: nx_layout ("NX Layout") . |
ComponentDefinition |
findObject(String sid)
Finds the
ComponentDefinition with the given sid. |
void |
refreshAllReferences()
Refreshes all definition references in part to obtain the actual out-of-date status of components
License requirements: nx_layout ("NX Layout") . |
void |
rename(Layout2dDefinitionLocation location,
String definitionPath,
String newName)
Renames definition
License requirements: nx_layout ("NX Layout") . |
void |
setAutomaticPreview(Layout2dDefinitionLocation location,
String definitionPath,
boolean isAutomatic)
Sets the automatic preview mode of definition with the given path
License requirements: nx_layout ("NX Layout") . |
void |
update(Layout2dDefinitionLocation location,
String definitionPath)
Updates definition with the given path
License requirements: nx_layout ("NX Layout") . |
void |
updateImage(Layout2dDefinitionLocation location,
String definitionPath,
String imagePath)
Updates definition preview
License requirements: nx_layout ("NX Layout") . |
_find_next, iterator
ComponentDefinition findObject(String sid) throws NXException, RemoteException
ComponentDefinition
with the given sid.
An exception will be thrown if no object can be found with the given sid.
This method can only be used to find Local definitions
sid
- The sid of the definition to findNXException
RemoteException
void rename(Layout2dDefinitionLocation location, String definitionPath, String newName) throws NXException, RemoteException
location
- Location of the definition to renamedefinitionPath
- Path of the definition to renamenewName
- New definition nameNXException
RemoteException
void delete(Layout2dDefinitionLocation location, String definitionPath) throws NXException, RemoteException
location
- Location of the definition to deletedefinitionPath
- Path of the definition to deleteNXException
RemoteException
void updateImage(Layout2dDefinitionLocation location, String definitionPath, String imagePath) throws NXException, RemoteException
location
- Location of the definition to update imagedefinitionPath
- Path of the definition to update imageimagePath
- Path of the image file used to update definition previewNXException
RemoteException
void setAutomaticPreview(Layout2dDefinitionLocation location, String definitionPath, boolean isAutomatic) throws NXException, RemoteException
location
- Location of the definition to set the preview modedefinitionPath
- Path of the definition to set the preview modeisAutomatic
- NXException
RemoteException
void update(Layout2dDefinitionLocation location, String definitionPath) throws NXException, RemoteException
location
- Location of the definition to updatedefinitionPath
- Path of the definition to updateNXException
RemoteException
void refreshAllReferences() throws NXException, RemoteException
NXException
RemoteException
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.