InPathEventDataBuilder Class

class NXOpen.CAM.InPathEventDataBuilder

Bases: NXOpen.NXObject

Represents a InPath Event Data Builder

To create a new instance of this class, use NXOpen.CAM.WedmCustomBoundaryDataBuilder.CreateInpathEventDataBuilder()

New in version NX5.0.0.

Properties

Property Description
Distance Returns or sets the Inpath Events Distance
IsOccurrence Returns whether this object is an occurrence or not.
JournalIdentifier Returns the identifier that would be recorded in a journal for this object.
Method Returns or sets the Inpath Events Location method
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
Pass Returns or sets the Inpath Event pass number
Point Returns or sets the Inpath Events Location
Prototype Returns the prototype of this object if it is an occurrence.
Status Returns or sets the in path event output status
Tag Returns the Tag for this object.
Udeset Returns or sets the Inpath Events Set
UdesetBuilder Returns the UDE Set Builder

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.

Enumerations

InPathEventDataBuilderLocationMethod Enumeration InPath Events Location Method Options

Property Detail

Distance

InPathEventDataBuilder.Distance

Returns or sets the Inpath Events Distance

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

Getter Method

Signature Distance

Returns:the Events distance from start or end
Return type:float

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

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

Setter Method

Signature Distance

Parameters:distance (float) – the Events distance from start or end

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

IsOccurrence

InPathEventDataBuilder.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

InPathEventDataBuilder.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.

Method

InPathEventDataBuilder.Method

Returns or sets the Inpath Events Location method

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

Getter Method

Signature Method

Returns:the Events location specification method
Return type:NXOpen.CAM.InPathEventDataBuilderLocationMethod

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

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

Setter Method

Signature Method

Parameters:method (NXOpen.CAM.InPathEventDataBuilderLocationMethod) – the Events location specification method

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

Name

InPathEventDataBuilder.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

InPathEventDataBuilder.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

InPathEventDataBuilder.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.

Pass

InPathEventDataBuilder.Pass

Returns or sets the Inpath Event pass number

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

Getter Method

Signature Pass

Returns:the current pass number
Return type:int

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

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

Setter Method

Signature Pass

Parameters:passNum (int) – the current pass number

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

Point

InPathEventDataBuilder.Point

Returns or sets the Inpath Events Location

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

Getter Method

Signature Point

Returns:the Events Location
Return type:NXOpen.Point

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

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

Setter Method

Signature Point

Parameters:point (NXOpen.Point) – the Events Location

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

Prototype

InPathEventDataBuilder.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.

Status

InPathEventDataBuilder.Status

Returns or sets the in path event output status

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

Getter Method

Signature Status

Returns:the in path event output value
Return type:bool

New in version NX7.5.0.

License requirements: cam_base (“CAM BASE”)

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

Setter Method

Signature Status

Parameters:status (bool) – the in path event output value

New in version NX7.5.0.

License requirements: cam_base (“CAM BASE”)

Udeset

InPathEventDataBuilder.Udeset

Returns or sets the Inpath Events Set

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

Getter Method

Signature Udeset

Returns:the Events Set
Return type:NXOpen.NXObject

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

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

Setter Method

Signature Udeset

Parameters:udeSet (NXOpen.NXObject) – the Events Set

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

UdesetBuilder

InPathEventDataBuilder.UdesetBuilder

Returns the UDE Set Builder

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

Getter Method

Signature UdesetBuilder

Returns:the ude set builder
Return type:NXOpen.CAM.UdeSet

New in version NX7.5.0.

License requirements: cam_base (“CAM BASE”)

Method Detail

FindObject

InPathEventDataBuilder.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

InPathEventDataBuilder.Print

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

Signature Print()

New in version NX3.0.0.

License requirements: None.

SetName

InPathEventDataBuilder.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.