PenetrationRequest Class¶
-
class
NXOpen.Features.ShipDesign.
PenetrationRequest
¶ Bases:
NXOpen.Issue.IssueContent
Represents the Penetration Request object.
Not support KF.
New in version NX8.0.0.
Properties¶
Property | Description |
---|---|
AssignedUser | Returns or sets the assigned user |
Comment | Returns or sets the issue comment |
DueDate | Returns or sets the due date |
IsLocked | Returns the lock state |
IsOccurrence | Returns whether this object is an occurrence or not. |
IssueId | Returns the issue id |
JournalIdentifier | Returns the identifier that would be recorded in a journal for this object. |
Name | Returns the custom name of the object. |
OwningComponent | Returns the owning component, if this object is an occurrence. |
OwningPart | Returns the owning part of this object |
PreviewImage | Returns or sets the preview image |
Priority | Returns or sets the issue priority |
Prototype | Returns the prototype of this object if it is an occurrence. |
Status | Returns or sets the issue status |
Tag | Returns the Tag for this object. |
Title | Returns or sets the issue title |
Methods¶
Method | Description |
---|---|
AddAttachment | Adds an NXOpen.Issue.IssueAttachment |
Close | Closes the issue |
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 |
DiscardIssue | Discards the newly created issue which has not saved in external db yet |
FindObject | Finds the NXOpen.NXObject with the given identifier as recorded in a journal. |
GetAllAttachments | Returns all the :py:class:`NXOpen.Issue.IssueAttachment`s |
GetAttachment | Returns the NXOpen.Issue.IssueAttachment with this attachment name |
GetAttributeTitlesByType | Gets all the attribute titles of a specific type. |
GetBooleanUserAttribute | Gets a boolean attribute by Title and array Index. |
GetChildAttachments | Returns the child :py:class:`NXOpen.Issue.IssueAttachment`s |
GetComputationalTimeUserAttribute | Gets a time attribute by Title and array Index. |
GetFolders | Returns all the child :py:class:`NXOpen.Issue.IssueFolder`s |
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. |
GetPartAttachment | Returns the NXOpen.Issue.IssueAttachment with part type |
GetPdmReferenceAttributeValue | Gets the value of PDM Reference attribute for given object. |
GetProperty | Returns the NXOpen.Issue.IssueProperty with this property name |
GetPropertyValue | Returns the value of NXOpen.Issue.IssueProperty |
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. |
GetUserProperties | Returns the user definded :py:class:`NXOpen.Issue.IssueProperty`s |
HasUserAttribute | Determines if an attribute exists on the object, that satisfies the given iterator |
IsCheckedOut | Returns whether the issue is checked out |
IsClosed | Returns whether the issue is closed |
IsReadOnly | Returns whether the issue is read only |
LoadAttachments | Loads the :py:class:`NXOpen.Issue.IssueAttachment`s |
Prints a representation of this object to the system log file. | |
ReloadProperties | Reloads all the :py:class:`NXOpen.Issue.IssueProperty`s |
RemoveAttachment | Removes an NXOpen.Issue.IssueAttachment |
Review | Signs off the current workflow task with decision |
SaveChanges | Saves the changes to issue server |
SendToWorkflow | Sends the issue to workflow process |
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. |
SetPropertyValue | Sets the value of NXOpen.Issue.IssueProperty |
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. |
Enumerations¶
PenetrationRequestCompensationType Enumeration | Represents the Compensation type |
PenetrationRequestCoutoutType Enumeration | Represents the Coutout type |
PenetrationRequestDirectionType Enumeration | Represents the Direction type |
PenetrationRequestPenetrationType Enumeration | Represents the penetration type |
PenetrationRequestRequestType Enumeration | Represents the request type |
Property Detail¶
IsOccurrence¶
-
PenetrationRequest.
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¶
-
PenetrationRequest.
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.
Name¶
-
PenetrationRequest.
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.
OwningComponent¶
-
PenetrationRequest.
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¶
-
PenetrationRequest.
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.
Prototype¶
-
PenetrationRequest.
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.
Method Detail¶
FindObject¶
-
PenetrationRequest.
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¶
-
PenetrationRequest.
Print
¶ Prints a representation of this object to the system log file.
Signature
Print()
New in version NX3.0.0.
License requirements: None.
SetName¶
-
PenetrationRequest.
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.