NX Open C++ Reference Guide
Classes | Public Member Functions | List of all members
NXOpen::UserDefinedObjects::UserDefinedObjectManager Class Reference

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

Created in NX5.0.0. More...

Classes

struct  LinkedUdoDefinition
 Used to define a link to a UserDefinedObject. More...
 

Public Member Functions

NXOpen::UserDefinedObjects::UserDefinedObjectCreateUserDefinedObject (NXOpen::UserDefinedObjects::UserDefinedClass *udoClass)
 Constructs a new NXOpen::Features::UserDefinedObjectFeature . More...
 
std::vector
< NXOpen::UserDefinedObjects::UserDefinedObjectManager::LinkedUdoDefinition
GetLinksToObject (NXOpen::TaggedObject *linkObject)
 Queries an NX Object to find all UserDefinedObjects::UserDefinedObject 's that are linked to the given NXObject (note this will not find owning udos) More...
 
NXOpen::UserDefinedObjects::UserDefinedObjectGetOwningUserDefinedObject (NXOpen::TaggedObject *linkObject)
 Queries an NX Object to find the UserDefinedObjects::UserDefinedObject that owns the given NXObject (note this will return null for the owning udo if the object is not owned) More...
 
std::vector
< NXOpen::UserDefinedObjects::UserDefinedObject * > 
GetUdosOfClass (NXOpen::UserDefinedObjects::UserDefinedClass *udoClass)
 Finds all UserDefinedObjects::UserDefinedObject instances that use the given NXOpen::UserDefinedObjects::UserDefinedClass . More...
 
bool IsObjectLinkable (NXOpen::TaggedObject *linkObject, NXOpen::UserDefinedObjects::UserDefinedObject::LinkType linkType)
 Queries an NX Object to see if it can be linked to a UserDefinedObjects::UserDefinedObject via the given link type. More...
 
bool IsObjectLinkedToUserDefinedObject (NXOpen::TaggedObject *linkObject)
 Queries an NX Object to see if it is linked to a UserDefinedObjects::UserDefinedObject (note this will not tell you if the object is owned by a UDO with an owning link) More...
 
bool IsObjectOwnedByUserDefinedObject (NXOpen::TaggedObject *linkObject)
 Queries an NX Object to see if it is owned by a UserDefinedObjects::UserDefinedObject. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

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

Created in NX5.0.0.


Member Function Documentation

NXOpen::UserDefinedObjects::UserDefinedObject* NXOpen::UserDefinedObjects::UserDefinedObjectManager::CreateUserDefinedObject ( NXOpen::UserDefinedObjects::UserDefinedClass udoClass)

Constructs a new NXOpen::Features::UserDefinedObjectFeature .

Returns
The new UserDefinedObject instance
Created in NX5.0.0.

License requirements : None
Parameters
udoClassThe UserDefinedClass used to define the new UserDefinedObject
std::vector<NXOpen::UserDefinedObjects::UserDefinedObjectManager::LinkedUdoDefinition> NXOpen::UserDefinedObjects::UserDefinedObjectManager::GetLinksToObject ( NXOpen::TaggedObject linkObject)

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

Returns
The link definitions from UDO's to the NXObject
Created in NX5.0.0.

License requirements : None
Parameters
linkObjectNXObject to query for links
NXOpen::UserDefinedObjects::UserDefinedObject* NXOpen::UserDefinedObjects::UserDefinedObjectManager::GetOwningUserDefinedObject ( NXOpen::TaggedObject linkObject)

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

Returns
The UDO which owns the NXObject
Created in NX5.0.0.

License requirements : None
Parameters
linkObjectNXObject to query for an owning UDO
std::vector<NXOpen::UserDefinedObjects::UserDefinedObject *> NXOpen::UserDefinedObjects::UserDefinedObjectManager::GetUdosOfClass ( NXOpen::UserDefinedObjects::UserDefinedClass udoClass)

Finds all UserDefinedObjects::UserDefinedObject instances that use the given NXOpen::UserDefinedObjects::UserDefinedClass .

Returns
User Defined Objects of the given class
Created in NX5.0.0.

License requirements : None
Parameters
udoClassThe UserDefinedClass we want to find
bool NXOpen::UserDefinedObjects::UserDefinedObjectManager::IsObjectLinkable ( NXOpen::TaggedObject linkObject,
NXOpen::UserDefinedObjects::UserDefinedObject::LinkType  linkType 
)

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

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
Created in NX5.0.0.

License requirements : None
Parameters
linkObjectNXObject to query for linkability
linkTypeThe link type used to link this object to a UDO
bool NXOpen::UserDefinedObjects::UserDefinedObjectManager::IsObjectLinkedToUserDefinedObject ( NXOpen::TaggedObject linkObject)

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

Returns
TRUE - This object is linked to a UDO, FALSE - this object is NOT linked to a UDO
Created in NX5.0.0.

License requirements : None
Parameters
linkObjectNXObject to query for links
bool NXOpen::UserDefinedObjects::UserDefinedObjectManager::IsObjectOwnedByUserDefinedObject ( NXOpen::TaggedObject linkObject)

Queries an NX Object to see if it is owned by a UserDefinedObjects::UserDefinedObject.

Returns
TRUE - This object is owned by a UDO, FALSE - this object is NOT owned by a UDO
Created in NX5.0.0.

License requirements : None
Parameters
linkObjectNXObject to query for an owning UDO
tag_t NXOpen::UserDefinedObjects::UserDefinedObjectManager::Tag ( ) const

Returns the tag of this object.


The documentation for this class was generated from the following file:
Copyright 2012 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.