nxopen.userdefinedobjects

Interface UserDefinedObjectManager

All Superinterfaces:

Remote

public interface UserDefinedObjectManager
extends Remote

This class creates and manages UserDefinedObjects
To obtain an instance of this class, refer to BasePart

Created in NX5.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	UserDefinedObjectManager.LinkedUdoDefinition Used to define a link to a UserDefinedObject

Method Summary

Modifier and Type	Method and Description
UserDefinedObject	createUserDefinedObject(UserDefinedClass udoClass) Constructs a new UserDefinedObjectFeature .
UserDefinedObjectManager.LinkedUdoDefinition[]	getLinksToObject(TaggedObject linkObject) Queries an NX Object to find all UserDefinedObject 's that are linked to the given NXObject (note this will not find owning udos) License requirements: None.
UserDefinedObject	getOwningUserDefinedObject(TaggedObject linkObject) Queries an NX Object to find the UserDefinedObject that owns the given NXObject (note this will return null for the owning udo if the object is not owned) License requirements: None.
UserDefinedObject[]	getUdosOfClass(UserDefinedClass udoClass) Finds all UserDefinedObject instances that use the given UserDefinedClass .
boolean	isObjectLinkable(TaggedObject linkObject, UserDefinedObject.LinkType linkType) Queries an NX Object to see if it can be linked to a UserDefinedObject via the given link type License requirements: None.
boolean	isObjectLinkedToUserDefinedObject(TaggedObject linkObject) Queries an NX Object to see if it is linked to a UserDefinedObject (note this will not tell you if the object is owned by a UDO with an owning link) License requirements: None.
boolean	isObjectOwnedByUserDefinedObject(TaggedObject linkObject) Queries an NX Object to see if it is owned by a UserDefinedObject License requirements: None.

Method Detail

createUserDefinedObject

UserDefinedObject createUserDefinedObject(UserDefinedClass udoClass)
                                   throws NXException,
                                          RemoteException

Constructs a new UserDefinedObjectFeature .
License requirements: None.

Created in NX5.0.0

Parameters:

udoClass - The UserDefinedClass used to define the new UserDefinedObject

Returns:

The new UserDefinedObject instance

Throws:

NXException

RemoteException

getUdosOfClass

UserDefinedObject[] getUdosOfClass(UserDefinedClass udoClass)
                            throws NXException,
                                   RemoteException

Finds all UserDefinedObject instances that use the given UserDefinedClass .
License requirements: None.

Created in NX5.0.0

Parameters:

udoClass - The UserDefinedClass we want to find

Returns:

User Defined Objects of the given class

Throws:

NXException

RemoteException

isObjectLinkable

boolean isObjectLinkable(TaggedObject linkObject,
                         UserDefinedObject.LinkType linkType)
                  throws NXException,
                         RemoteException

Queries an NX Object to see if it can be linked to a UserDefinedObject via the given link type
License requirements: None.

Created in NX5.0.0

Parameters:

linkObject - NXObject to query for linkability

linkType - The link type used to link this object to a UDO

Returns:

TRUE - This object can be linked to a UDO with the given link type, FALSE - this object can not be NOT linked to a UDO with the given link type

Throws:

NXException

RemoteException

isObjectLinkedToUserDefinedObject

boolean isObjectLinkedToUserDefinedObject(TaggedObject linkObject)
                                   throws NXException,
                                          RemoteException

Queries an NX Object to see if it is linked to a UserDefinedObject (note this will not tell you if the object is owned by a UDO with an owning link)
License requirements: None.

Created in NX5.0.0

Parameters:

linkObject - NXObject to query for links

Returns:

TRUE - This object is linked to a UDO, FALSE - this object is NOT linked to a UDO

Throws:

NXException

RemoteException

getLinksToObject

UserDefinedObjectManager.LinkedUdoDefinition[] getLinksToObject(TaggedObject linkObject)
                                                         throws NXException,
                                                                RemoteException

Queries an NX Object to find all UserDefinedObject 's that are linked to the given NXObject (note this will not find owning udos)
License requirements: None.

Created in NX5.0.0

Parameters:

linkObject - NXObject to query for links

Returns:

The link definitions from UDO's to the NXObject

Throws:

NXException

RemoteException

isObjectOwnedByUserDefinedObject

boolean isObjectOwnedByUserDefinedObject(TaggedObject linkObject)
                                  throws NXException,
                                         RemoteException

Queries an NX Object to see if it is owned by a UserDefinedObject
License requirements: None.

Created in NX5.0.0

Parameters:

linkObject - NXObject to query for an owning UDO

Returns:

TRUE - This object is owned by a UDO, FALSE - this object is NOT owned by a UDO

Throws:

NXException

RemoteException

getOwningUserDefinedObject

UserDefinedObject getOwningUserDefinedObject(TaggedObject linkObject)
                                      throws NXException,
                                             RemoteException

Queries an NX Object to find the UserDefinedObject that owns the given NXObject (note this will return null for the owning udo if the object is not owned)
License requirements: None.

Created in NX5.0.0

Parameters:

linkObject - NXObject to query for an owning UDO

Returns:

The UDO which owns the NXObject

Throws:

NXException

RemoteException