NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::UserDefinedObjects::UserDefinedClass Class Reference

JA interface for the UserDefinedClass object
To create a new instance of this class, use UserDefinedObjects::UserDefinedClassManager::NewUserDefinedClass
More...

Inheritance diagram for NXOpen::UserDefinedObjects::UserDefinedClass:
NXOpen::TransientObject

List of all members.

Public Types

enum  AllowOwnedObjectSelection { AllowOwnedObjectSelectionOff = 1, AllowOwnedObjectSelectionOn }
 Allow owned object selection on all objects owned by an object of this UserDefinedClass . More...
enum  AllowQueryClass { AllowQueryClassOff = 1, AllowQueryClassOn }
 Allow query class from name options for a UserDefinedObject of this class. More...
typedef NXOpen::Callback1< int,
NXOpen::UserDefinedObjects::UserDefinedDisplayEvent * > 
DisplayCallback
 Prototype for display, selection, attention point, fit and screen-size-fit callbacks
Created in NX5.0.0.
typedef NXOpen::Callback1< int,
NXOpen::UserDefinedObjects::UserDefinedEvent * > 
GenericCallback
 Prototype for information, edit, and suppress callbacks
Created in NX5.0.0.
typedef NXOpen::Callback1< int,
NXOpen::UserDefinedObjects::UserDefinedLinkEvent * > 
LinkCallback
 Prototype for update, and delete callbacks
Created in NX5.0.0.
enum  Selection { SelectionOff = 1, SelectionOn }
 Allow query class from name options for a UserDefinedObject . More...

Public Member Functions

void AddAttentionPointHandler (const NXOpen::UserDefinedObjects::UserDefinedClass::DisplayCallback &displayEvent)
 Registers the attention point callback.
void AddDeleteHandler (const NXOpen::UserDefinedObjects::UserDefinedClass::LinkCallback &linkEvent)
 Registers the delete callback.
void AddDisplayHandler (const NXOpen::UserDefinedObjects::UserDefinedClass::DisplayCallback &displayEvent)
 Registers UDO display callback.
void AddEditHandler (const NXOpen::UserDefinedObjects::UserDefinedClass::GenericCallback &udoEvent)
 Registers the edit callback.
void AddFitHandler (const NXOpen::UserDefinedObjects::UserDefinedClass::DisplayCallback &displayEvent)
 Registers the fit callback.
void AddInformationHandler (const NXOpen::UserDefinedObjects::UserDefinedClass::GenericCallback &udoEvent)
 Registers the information callback.
void AddScreenSizeFitHandler (const NXOpen::UserDefinedObjects::UserDefinedClass::DisplayCallback &displayEvent)
 Registers the screen size fit callback.
void AddSelectionHandler (const NXOpen::UserDefinedObjects::UserDefinedClass::DisplayCallback &displayEvent)
 Registers the UDO selection callback.
void AddSuppressHandler (const NXOpen::UserDefinedObjects::UserDefinedClass::GenericCallback &udoEvent)
 Registers the suppress callback.
void AddUpdateHandler (const NXOpen::UserDefinedObjects::UserDefinedClass::LinkCallback &linkEvent)
 Registers the update callback.
NXOpen::UserDefinedObjects::UserDefinedClass::AllowOwnedObjectSelection AllowOwnedObjectSelectionOption ()
 Returns the allow owned object selection flag.
NXOpen::UserDefinedObjects::UserDefinedClass::AllowQueryClass AllowQueryClassFromName ()
 Returns the allow query class from name flag.
NXString ClassName ()
 Returns the class name of the UserDefinedClass .
NXString FriendlyName ()
 Returns the friendly name of the UserDefinedClass .
bool GetIsOccurrenceableFlag ()
 Gets the is occurrenceable flag for this class.
void SetAllowOwnedObjectSelectionOption (NXOpen::UserDefinedObjects::UserDefinedClass::AllowOwnedObjectSelection allowOwnedObjectSelectionOption)
 Sets the allow owned object selection flag.
void SetAllowQueryClassFromName (NXOpen::UserDefinedObjects::UserDefinedClass::AllowQueryClass allowQueryClassFromName)
 Sets the allow query class from name flag.
void SetIsOccurrenceableFlag (bool isOccurrenceable)
 Sets the is occurrenceable flag for this class.
void SetWarnUserFlag (bool warnUser)
 Sets the warn user flag.
bool WarnUserFlag ()
 Returns the warn user flag.
virtual ~UserDefinedClass ()
 Frees the memory associated with this object.

Detailed Description

JA interface for the UserDefinedClass object
To create a new instance of this class, use UserDefinedObjects::UserDefinedClassManager::NewUserDefinedClass


Member Typedef Documentation

Prototype for display, selection, attention point, fit and screen-size-fit callbacks
Created in NX5.0.0.



License requirements : None

Prototype for information, edit, and suppress callbacks
Created in NX5.0.0.



License requirements : None

Prototype for update, and delete callbacks
Created in NX5.0.0.



License requirements : None


Member Enumeration Documentation

Allow owned object selection on all objects owned by an object of this UserDefinedClass .

Enumerator:
AllowOwnedObjectSelectionOn 

You have permission to select objects owned by this class.

Allow query class from name options for a UserDefinedObject of this class.

Enumerator:
AllowQueryClassOn 

You have permission to query the class from it's name.

Allow query class from name options for a UserDefinedObject .

Enumerator:
SelectionOn 

UDO's of this class will be selectable.


Constructor & Destructor Documentation

Frees the memory associated with this object.

After invocation of this method, the object is no longer valid.
Created in NX5.0.0.

License requirements : None


Member Function Documentation

Registers the attention point callback.


Created in NX5.0.0.

License requirements : None

Parameters:
displayEventdisplay event

Registers the delete callback.


Created in NX5.0.0.

License requirements : None

Parameters:
linkEventlink event

Registers UDO display callback.


Created in NX5.0.0.

License requirements : None

Parameters:
displayEventdisplay event

Registers the edit callback.


Created in NX5.0.0.

License requirements : None

Parameters:
udoEventudo event

Registers the fit callback.


Created in NX5.0.0.

License requirements : None

Parameters:
displayEventdisplay event

Registers the information callback.


Created in NX5.0.0.

License requirements : None

Parameters:
udoEventudo event

Registers the screen size fit callback.

The screen size fit callback is called when it is necesary to determine the bounding box of a screen size object (one which remains the same size on the screen independent of the view scale) during a fit computation. As of NX 8.0 the only geometry types supported for User Defined Objects which are screen size are ScreenStandardText and AbsoluteRotationScreenSizeText. If your User Defined Object does not have any of these objects, then you should not call UserDefinedObjects::UserDefinedClass::AddScreenSizeFitHandler because to do do would incur a performance penalty.
Created in NX8.0.0.

License requirements : None

Parameters:
displayEventdisplay event

Registers the UDO selection callback.


Created in NX5.0.0.

License requirements : None

Parameters:
displayEventdisplay event

Registers the suppress callback.

Note this callback is not called unless you have a UDO FEATURE. Also it *may* not get called when the system automatically suppresses the feature during update.

Also note the user should check the suppression status of the feature in their callback to see if the input udo feature is currently getting suppressed or unsuppressed.
Created in NX5.0.0.

License requirements : None

Parameters:
udoEventudo event

Registers the update callback.


Created in NX5.0.0.

License requirements : None

Parameters:
linkEventlink event

Returns the allow owned object selection flag.

Specifies whether or not you have permission to select objects owned by UserDefinedObjects::UserDefinedObject 's of this class.
Created in NX5.0.0.

License requirements : None

Returns the allow query class from name flag.

Specifies whether or not you are allowed to query the UserDefinedObject from the class name.
Created in NX5.0.0.

License requirements : None

Returns the class name of the UserDefinedClass .


Created in NX5.0.0.

License requirements : None

Returns the friendly name of the UserDefinedClass .


Created in NX5.0.0.

License requirements : None

Gets the is occurrenceable flag for this class.

Legacy Open C UDO's required a reference UDO to determine Occurrenceability. Occurrenceability is now set on a class by class basis (no reference UDO required). In the event that you have a legacy UDO you wish to query for occurenceability, you will need set the is occurrenceable flag with the new native language method (which does not require a reference UDO) If you do not set the is occurrenceable flag, and instead use the old open c is occurrenceable callback, you will risk error raising during this method because we will automatically pass NULL in as the reference UDO to the legacy is occurrenceable callback.

Returns:
Specifies whether or not to populate occurrences for UserDefinedObjects::UserDefinedObject 's of this class.
Created in NX5.0.0.

License requirements : None

Sets the allow owned object selection flag.

Specifies whether or not you have permission to select objects owned by UserDefinedObjects::UserDefinedObject 's of this class.
Created in NX5.0.0.

License requirements : None

Parameters:
allowOwnedObjectSelectionOptionallow owned object selection option

Sets the allow query class from name flag.

Specifies whether or not you are allowed to query the UserDefinedObject from the class name.
Created in NX5.0.0.

License requirements : None

Parameters:
allowQueryClassFromNameallow query class from name

Sets the is occurrenceable flag for this class.


Created in NX5.0.0.

License requirements : None

Parameters:
isOccurrenceableSpecifies whether or not to populate occurrences for UserDefinedObjects::UserDefinedObject 's of this class.

Sets the warn user flag.

Specifies the behavior of warning the user if a UserDefinedObjects::UserDefinedObject of the given UserDefinedObjects::UserDefinedClass is found in a part, but the code implementing the methods for the UDO is not loaded. The default action is to not warn the user. If the UDO author sets this flag to TRUE, all UDO's of this class that are created will be marked so that the user will be warned if the UDO methods have not been loaded, but a UDO of the class is in the part. This warning will be issued to the listing window, when the first object of the given class is retrieved. This warning will only be given once per session.

This flag is set on every UDO object. Therefore for any part, there may be a mixture UDO objects of a given class, some having this flag set to TRUE and some objects having the flag set to FALSE. This is particularly true since all UDO objects created before NX 3.0 will have this flag set to FALSE. If the UDO methods for a class are not loaded, any one UDO with this flag set to TRUE in a part is enough for the warning to be issued to the listing window.
Created in NX5.0.0.

License requirements : None

Parameters:
warnUserTRUE - the user will be warned when opening a part containing a UDO of this class without first loading it's required methods. FALSE - the user will NOT be warned.

Returns the warn user flag.

Specifies the behavior of warning the user if a UserDefinedObjects::UserDefinedObject of the given UserDefinedObjects::UserDefinedClass is found in a part, but the code implementing the methods for the UDO is not loaded. The default action is to not warn the user. If the UDO author sets this flag to TRUE, all UDO's of this class that are created will be marked so that the user will be warned if the UDO methods have not been loaded, but a UDO of the class is in the part. This warning will be issued to the listing window, when the first object of the given class is retrieved. This warning will only be given once per session.

This flag is set on every UDO object. Therefore for any part, there may be a mixture UDO objects of a given class, some having this flag set to TRUE and some objects having the flag set to FALSE. This is particularly true since all UDO objects created before NX 3.0 will have this flag set to FALSE. If the UDO methods for a class are not loaded, any one UDO with this flag set to TRUE in a part is enough for the warning to be issued to the listing window.
Created in NX5.0.0.

License requirements : None


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