OnPathDimWithValueBuilder Class

class NXOpen.GeometricUtilities.OnPathDimWithValueBuilder

Bases: NXOpen.TaggedObject, NXOpen.INXObject, NXOpen.GeometricUtilities.IComponentBuilder

Represents a NXOpen.GeometricUtilities.OnPathDimWithValueBuilder

New in version NX5.0.0.

Properties

Property	Description
IsOccurrence	Returns whether this object is an occurrence or not.
JournalIdentifier	Returns the identifier that would be recorded in a journal for this object.
Location	Returns the location on path
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
Prototype	Returns the prototype of this object if it is an occurrence.
Tag	Returns the Tag for this object.
Value	Returns the value expression

Methods

Method	Description
FindObject	Finds the NXOpen.NXObject with the given identifier as recorded in a journal.
InheritLocation	Inherits location data of a NXOpen.GeometricUtilities.OnPathDimWithValueBuilder object
InheritValue	Inherits value of a NXOpen.GeometricUtilities.OnPathDimWithValueBuilder object
Print	Prints a representation of this object to the system log file.
SetName	Sets the custom name of the object.
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail

IsOccurrence

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

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

Location

OnPathDimWithValueBuilder.Location

Returns the location on path

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

Getter Method

Signature Location

Returns: Return type:NXOpen.GeometricUtilities.OnPathDimensionBuilder

New in version NX5.0.0.

License requirements: None.

Name

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

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

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

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

Value

OnPathDimWithValueBuilder.Value

Returns the value expression

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

Getter Method

Signature Value

Returns: Return type:NXOpen.Expression

New in version NX5.0.0.

License requirements: None.

Method Detail

FindObject

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

InheritLocation

OnPathDimWithValueBuilder.InheritLocation

Inherits location data of a NXOpen.GeometricUtilities.OnPathDimWithValueBuilder object

Signature InheritLocation(sourceBuilder)

Parameters:sourceBuilder (NXOpen.GeometricUtilities.OnPathDimWithValueBuilder) –

New in version NX8.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”) OR free_form_modeling (“FREE-FORM MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

InheritValue

OnPathDimWithValueBuilder.InheritValue

Inherits value of a NXOpen.GeometricUtilities.OnPathDimWithValueBuilder object

Signature InheritValue(sourceBuilder)

Parameters:sourceBuilder (NXOpen.GeometricUtilities.OnPathDimWithValueBuilder) –

New in version NX8.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”) OR free_form_modeling (“FREE-FORM MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

Print

OnPathDimWithValueBuilder.Print

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

Signature Print()

New in version NX3.0.0.

License requirements: None.

SetName

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

Validate

OnPathDimWithValueBuilder.Validate

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:Was self validation successful Return type:bool

New in version NX3.0.1.

License requirements: None.