ReuseLibraryDragData Class

class NXOpen.LineDesigner.ReuseLibraryDragData

Bases: NXOpen.NXObject

Represents a manager of line designer plant model

Established by LineDesigner_ReuseLibraryUtilityBuilder whenever it is needed.

New in version NX9.0.0.

Properties

Property Description
ActionType Returns or sets the action type of drag data
CategoryName Returns or sets the category name of Drag Data
HasCsysImport Returns or sets an API to check if drag data has csys import
HasSketchImport Returns or sets an API to check if drag data has sketch to import
IsOccurrence Returns whether this object is an occurrence or not.
JournalIdentifier Returns the identifier that would be recorded in a journal for this object.
KrxFile Returns or sets the krx file name
LibName Returns or sets the library name of Reuse Library Drag data
Name Returns the custom name of the object.
NativeItem Returns or sets the native item
ObjectId Returns or sets the object id of Drag Data
OwningComponent Returns the owning component, if this object is an occurrence.
OwningPart Returns the owning part of this object
PartFile Returns or sets the part file name is return
PartType Returns or sets the part type of Reuse Library Drag data
PathInLib Returns or sets the path in library of drag data
Prototype Returns the prototype of this object if it is an occurrence.
SpareDialogForDragAndDrop Returns or sets an API to check if spare dialog for drag and drop is allowed
Tag Returns the Tag for this object.
TemplateName Returns or sets the template name
TypeName Returns or sets an API to get type name

Methods

Method Description
CreateAttributeIterator Create an attribute iterator
DeleteAllAttributesByType Deletes all attributes of a specific type.
DeleteAttributeByTypeAndTitle Deletes an attribute by type and title.
DeleteUserAttribute Deletes the first attribute encountered with the given Type, Title.
DeleteUserAttributes Deletes the attributes on the object, if any, that satisfy the given iterator
FindObject Finds the NXOpen.NXObject with the given identifier as recorded in a journal.
GetAttributeTitlesByType Gets all the attribute titles of a specific type.
GetBooleanUserAttribute Gets a boolean attribute by Title and array Index.
GetComputationalTimeUserAttribute Gets a time attribute by Title and array Index.
GetIntegerAttribute Gets an integer attribute by title.
GetIntegerUserAttribute Gets an integer attribute by Title and array Index.
GetNextUserAttribute Gets the next attribute encountered on the object, if any, that satisfies the given iterator.
GetPdmReferenceAttributeValue Gets the value of PDM Reference attribute for given object.
GetRealAttribute Gets a real attribute by title.
GetRealUserAttribute Gets a real attribute by Title and array Index.
GetReferenceAttribute Gets the reference string (not the calculated value) of a string attribute that uses a reference string.
GetStringAttribute Gets a string attribute value by title.
GetStringUserAttribute Gets a string attribute by Title and array Index.
GetTimeAttribute Gets a time attribute by title.
GetTimeUserAttribute Gets a time attribute by Title and array Index.
GetUserAttribute Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index.
GetUserAttributeAsString Gets the first attribute encountered on the object, if any, with a given title, type and array index.
GetUserAttributeCount Gets the count of set attributes on the object, if any, that satisfy the given iterator.
GetUserAttributeLock Determine the lock of the given attribute.
GetUserAttributeSize Gets the size of the first attribute encountered on the object, if any, with a given Title and Type.
GetUserAttributeSourceObjects Returns an array of objects from which this object presents attributes.
GetUserAttributes Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator.
GetUserAttributesAsStrings Gets all the attributes that have been set on the given object.
HasUserAttribute Determines if an attribute exists on the object, that satisfies the given iterator
Print Prints a representation of this object to the system log file.
SetAttribute Creates or modifies an integer attribute.
SetBooleanUserAttribute Creates or modifies a boolean attribute with the option to update or not.
SetName Sets the custom name of the object.
SetPdmReferenceAttribute Sets the value of PDM Reference attribute on the object.
SetReferenceAttribute Creates or modifies a string attribute which uses a reference string.
SetTimeAttribute Creates or modifies a time attribute.
SetTimeUserAttribute Creates or modifies a time attribute with the option to update or not.
SetUserAttribute Creates or modifies an attribute with the option to update or not.
SetUserAttributeLock Lock or unlock the given attribute.

Property Detail

ActionType

ReuseLibraryDragData.ActionType

Returns or sets the action type of drag data

-------------------------------------

Getter Method

Signature ActionType

Returns:
Return type:int

New in version NX9.0.0.

License requirements: ld_line_designer (“FULL LINE DESIGNER”)

-------------------------------------

Setter Method

Signature ActionType

Parameters:actionType (int) –

New in version NX9.0.0.

License requirements: ld_line_designer (“FULL LINE DESIGNER”)

CategoryName

ReuseLibraryDragData.CategoryName

Returns or sets the category name of Drag Data

-------------------------------------

Getter Method

Signature CategoryName

Returns:
Return type:str

New in version NX9.0.0.

License requirements: ld_line_designer (“FULL LINE DESIGNER”)

-------------------------------------

Setter Method

Signature CategoryName

Parameters:categoryName (str) –

New in version NX9.0.0.

License requirements: ld_line_designer (“FULL LINE DESIGNER”)

HasCsysImport

ReuseLibraryDragData.HasCsysImport

Returns or sets an API to check if drag data has csys import

-------------------------------------

Getter Method

Signature HasCsysImport

Returns:
Return type:bool

New in version NX9.0.0.

License requirements: ld_line_designer (“FULL LINE DESIGNER”)

-------------------------------------

Setter Method

Signature HasCsysImport

Parameters:hasCsysImport (bool) –

New in version NX9.0.0.

License requirements: ld_line_designer (“FULL LINE DESIGNER”)

HasSketchImport

ReuseLibraryDragData.HasSketchImport

Returns or sets an API to check if drag data has sketch to import

-------------------------------------

Getter Method

Signature HasSketchImport

Returns:
Return type:bool

New in version NX9.0.0.

License requirements: ld_line_designer (“FULL LINE DESIGNER”)

-------------------------------------

Setter Method

Signature HasSketchImport

Parameters:hasSketchImport (bool) –

New in version NX9.0.0.

License requirements: ld_line_designer (“FULL LINE DESIGNER”)

IsOccurrence

ReuseLibraryDragData.IsOccurrence

Returns whether this object is an occurrence or not.

-------------------------------------

Getter Method

Signature IsOccurrence

Returns:This object is an occurrence
Return type:bool

New in version NX3.0.0.

License requirements: None.

JournalIdentifier

ReuseLibraryDragData.JournalIdentifier

Returns the identifier that would be recorded in a journal for this object.

This may not be the same across different releases of the software.

-------------------------------------

Getter Method

Signature JournalIdentifier

Returns:
Return type:str

New in version NX3.0.0.

License requirements: None.

KrxFile

ReuseLibraryDragData.KrxFile

Returns or sets the krx file name

-------------------------------------

Getter Method

Signature KrxFile

Returns:
Return type:str

New in version NX9.0.0.

License requirements: ld_line_designer (“FULL LINE DESIGNER”)

-------------------------------------

Setter Method

Signature KrxFile

Parameters:krxFile (str) –

New in version NX9.0.0.

License requirements: ld_line_designer (“FULL LINE DESIGNER”)

LibName

ReuseLibraryDragData.LibName

Returns or sets the library name of Reuse Library Drag data

-------------------------------------

Getter Method

Signature LibName

Returns:
Return type:str

New in version NX9.0.0.

License requirements: ld_line_designer (“FULL LINE DESIGNER”)

-------------------------------------

Setter Method

Signature LibName

Parameters:libName (str) –

New in version NX9.0.0.

License requirements: ld_line_designer (“FULL LINE DESIGNER”)

Name

ReuseLibraryDragData.Name

Returns the custom name of the object.

-------------------------------------

Getter Method

Signature Name

Returns:
Return type:str

New in version NX3.0.0.

License requirements: None.

NativeItem

ReuseLibraryDragData.NativeItem

Returns or sets the native item

-------------------------------------

Getter Method

Signature NativeItem

Returns:
Return type:int

New in version NX9.0.0.

License requirements: ld_line_designer (“FULL LINE DESIGNER”)

-------------------------------------

Setter Method

Signature NativeItem

Parameters:nativeItem (int) –

New in version NX9.0.0.

License requirements: ld_line_designer (“FULL LINE DESIGNER”)

ObjectId

ReuseLibraryDragData.ObjectId

Returns or sets the object id of Drag Data

-------------------------------------

Getter Method

Signature ObjectId

Returns:
Return type:str

New in version NX9.0.0.

License requirements: ld_line_designer (“FULL LINE DESIGNER”)

-------------------------------------

Setter Method

Signature ObjectId

Parameters:objectId (str) –

New in version NX9.0.0.

License requirements: ld_line_designer (“FULL LINE DESIGNER”)

OwningComponent

ReuseLibraryDragData.OwningComponent

Returns the owning component, if this object is an occurrence.

-------------------------------------

Getter Method

Signature OwningComponent

Returns:
Return type:NXOpen.Assemblies.Component

New in version NX3.0.0.

License requirements: None.

OwningPart

ReuseLibraryDragData.OwningPart

Returns the owning part of this object

-------------------------------------

Getter Method

Signature OwningPart

Returns:The owning part of this object or null if it does not have an owner
Return type:NXOpen.BasePart

New in version NX3.0.0.

License requirements: None.

PartFile

ReuseLibraryDragData.PartFile

Returns or sets the part file name is return

-------------------------------------

Getter Method

Signature PartFile

Returns:
Return type:str

New in version NX9.0.0.

License requirements: ld_line_designer (“FULL LINE DESIGNER”)

-------------------------------------

Setter Method

Signature PartFile

Parameters:partFile (str) –

New in version NX9.0.0.

License requirements: ld_line_designer (“FULL LINE DESIGNER”)

PartType

ReuseLibraryDragData.PartType

Returns or sets the part type of Reuse Library Drag data

-------------------------------------

Getter Method

Signature PartType

Returns:
Return type:int

New in version NX9.0.0.

License requirements: ld_line_designer (“FULL LINE DESIGNER”)

-------------------------------------

Setter Method

Signature PartType

Parameters:partType (int) –

New in version NX9.0.0.

License requirements: ld_line_designer (“FULL LINE DESIGNER”)

PathInLib

ReuseLibraryDragData.PathInLib

Returns or sets the path in library of drag data

-------------------------------------

Getter Method

Signature PathInLib

Returns:
Return type:str

New in version NX9.0.0.

License requirements: ld_line_designer (“FULL LINE DESIGNER”)

-------------------------------------

Setter Method

Signature PathInLib

Parameters:pathInLib (str) –

New in version NX9.0.0.

License requirements: ld_line_designer (“FULL LINE DESIGNER”)

Prototype

ReuseLibraryDragData.Prototype

Returns the prototype of this object if it is an occurrence.

-------------------------------------

Getter Method

Signature Prototype

Returns:The prototype of this object or null if this object is not an occurrence
Return type:NXOpen.INXObject

New in version NX3.0.0.

License requirements: None.

SpareDialogForDragAndDrop

ReuseLibraryDragData.SpareDialogForDragAndDrop

Returns or sets an API to check if spare dialog for drag and drop is allowed

-------------------------------------

Getter Method

Signature SpareDialogForDragAndDrop

Returns:
Return type:bool

New in version NX9.0.0.

License requirements: ld_line_designer (“FULL LINE DESIGNER”)

-------------------------------------

Setter Method

Signature SpareDialogForDragAndDrop

Parameters:spareDialogForDragAndDrop (bool) –

New in version NX9.0.0.

License requirements: ld_line_designer (“FULL LINE DESIGNER”)

TemplateName

ReuseLibraryDragData.TemplateName

Returns or sets the template name

-------------------------------------

Getter Method

Signature TemplateName

Returns:
Return type:str

New in version NX9.0.0.

License requirements: ld_line_designer (“FULL LINE DESIGNER”)

-------------------------------------

Setter Method

Signature TemplateName

Parameters:templateName (str) –

New in version NX9.0.0.

License requirements: ld_line_designer (“FULL LINE DESIGNER”)

TypeName

ReuseLibraryDragData.TypeName

Returns or sets an API to get type name

-------------------------------------

Getter Method

Signature TypeName

Returns:
Return type:str

New in version NX9.0.0.

License requirements: ld_line_designer (“FULL LINE DESIGNER”)

-------------------------------------

Setter Method

Signature TypeName

Parameters:typeName (str) –

New in version NX9.0.0.

License requirements: ld_line_designer (“FULL LINE DESIGNER”)

Method Detail

FindObject

ReuseLibraryDragData.FindObject

Finds the NXOpen.NXObject with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Signature FindObject(journalIdentifier)

Parameters:journalIdentifier (str) – Journal identifier of the object
Returns:
Return type:NXOpen.INXObject

New in version NX3.0.0.

License requirements: None.

Print

ReuseLibraryDragData.Print

Prints a representation of this object to the system log file.

Signature Print()

New in version NX3.0.0.

License requirements: None.

SetName

ReuseLibraryDragData.SetName

Sets the custom name of the object.

NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Signature SetName(name)

Parameters:name (str) –

New in version NX3.0.0.

License requirements: None.