NXOpen::LineDesigner::LineDesignerUserCallBackManager Class Reference

Represents a manager of line designer user callbacks
Use the static method in this class to obtain an instance. More...

Public Types
typedef NXOpen::Callback2 < void, NXOpen::Assemblies::Component *, NXOpen::Assemblies::Component * >	CustomerCallbackHandler
	User defined method that is called from a particular event Created in NX11.0.1. More...
enum	EventType { EventTypePasteEvent, EventTypeEndPasteEvent, EventTypeComponentReplaceEvent }
	This enum is providing the event id. More...

Public Member Functions
void	CallUserdefinedFunctions (NXOpen::LineDesigner::LineDesignerUserCallBackManager::EventType eventId, NXOpen::Assemblies::Component *srcOcc, NXOpen::Assemblies::Component *targetOcc)
	To call user defined function Created in NX11.0.1. More...
void	IsUserdefinedFunctionAvailable (NXOpen::LineDesigner::LineDesignerUserCallBackManager::EventType eventId)
	To check if user defined function is registered Created in NX11.0.1. More...
void	RegisterUserdefinedFunctions (const NXOpen::LineDesigner::LineDesignerUserCallBackManager::CustomerCallbackHandler &handler, NXOpen::LineDesigner::LineDesignerUserCallBackManager::EventType eventId)
	To register user defined function Created in NX11.0.1. More...
tag_t	Tag () const
	Returns the tag of this object. More...
void	UnregisterUserdefinedFunctions (NXOpen::LineDesigner::LineDesignerUserCallBackManager::EventType eventId)
	To register user defined function Created in NX11.0.1. More...

Static Public Member Functions
static LineDesignerUserCallBackManager *	GetLineDesignerUserCallBackManager (NXOpen::Session *owner)
	Returns the LineDesignerUserCallBackManager object for the running session which serves as the 'gateway' class for the application API. More...

Detailed Description

Represents a manager of line designer user callbacks
Use the static method in this class to obtain an instance.

Created in NX11.0.1.

Member Typedef Documentation

typedef NXOpen::Callback2<void, NXOpen::Assemblies::Component *, NXOpen::Assemblies::Component *> NXOpen::LineDesigner::LineDesignerUserCallBackManager::CustomerCallbackHandler

User defined method that is called from a particular event
Created in NX11.0.1.

License requirements : ld_line_designer ("FULL LINE DESIGNER")

Member Enumeration Documentation

enum NXOpen::LineDesigner::LineDesignerUserCallBackManager::EventType

This enum is providing the event id.

Enumerator
EventTypePasteEvent	paste event
EventTypeEndPasteEvent	end paste event
EventTypeComponentReplaceEvent	component replace event

Member Function Documentation

void NXOpen::LineDesigner::LineDesignerUserCallBackManager::CallUserdefinedFunctions	(	NXOpen::LineDesigner::LineDesignerUserCallBackManager::EventType	eventId,
		NXOpen::Assemblies::Component *	srcOcc,
		NXOpen::Assemblies::Component *	targetOcc
	)

To call user defined function
Created in NX11.0.1.

License requirements : ld_line_designer ("FULL LINE DESIGNER")

Parameters

eventId	event Id to find the function to be invoke
srcOcc	src occ
targetOcc	target occ

static LineDesignerUserCallBackManager* NXOpen::LineDesigner::LineDesignerUserCallBackManager::GetLineDesignerUserCallBackManager ( NXOpen::Session *  owner )

static

Returns the LineDesignerUserCallBackManager object for the running session which serves as the 'gateway' class for the application API.

References to all other objects in this API are obtained either directly or indirectly via methods and properties on this class. Platform Session should be initialized using 'GetSession' method from NXOpen API prior to this call.

void NXOpen::LineDesigner::LineDesignerUserCallBackManager::IsUserdefinedFunctionAvailable

(

NXOpen::LineDesigner::LineDesignerUserCallBackManager::EventType

eventId

)

To check if user defined function is registered
Created in NX11.0.1.

License requirements : ld_line_designer ("FULL LINE DESIGNER")

Parameters

eventId

event Id to find the function to be invoke

void NXOpen::LineDesigner::LineDesignerUserCallBackManager::RegisterUserdefinedFunctions	(	const NXOpen::LineDesigner::LineDesignerUserCallBackManager::CustomerCallbackHandler &	handler,
		NXOpen::LineDesigner::LineDesignerUserCallBackManager::EventType	eventId
	)

To register user defined function
Created in NX11.0.1.

License requirements : ld_line_designer ("FULL LINE DESIGNER")

Parameters

handler	method to register
eventId	event id

tag_t NXOpen::LineDesigner::LineDesignerUserCallBackManager::Tag

(

)

const

Returns the tag of this object.

void NXOpen::LineDesigner::LineDesignerUserCallBackManager::UnregisterUserdefinedFunctions

(

NXOpen::LineDesigner::LineDesignerUserCallBackManager::EventType

eventId

)

To register user defined function
Created in NX11.0.1.

License requirements : ld_line_designer ("FULL LINE DESIGNER")

Parameters

eventId

event id

---

The documentation for this class was generated from the following file:

• LineDesigner_LineDesignerUserCallBackManager.hxx