BaseArgument Class

class NXOpen.Report.BaseArgument

Bases: NXOpen.TaggedObject, NXOpen.INXObject

Represents an abstract command argument.

Not support KF.

New in version NX11.0.0.

Properties

Property	Description
DisplayName	Returns or sets the argument display name
Hint	Returns or sets the argument hint.
IsOccurrence	Returns whether this object is an occurrence or not.
JournalIdentifier	Returns the identifier that would be recorded in a journal for this object.
Name	Returns the custom name of the object.
Optional	Returns or sets a value that indicates whether this argument is optional or not.
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.

Methods

Method	Description
FindObject	Finds the NXOpen.NXObject with the given identifier as recorded in a journal.
Print	Prints a representation of this object to the system log file.
SetName	Sets the custom name of the object.

Enumerations

BaseArgumentType Enumeration

Represents the argument type.

Property Detail

DisplayName

BaseArgument.DisplayName

Returns or sets the argument display name

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

Getter Method

Signature DisplayName

Returns: Return type:str

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature DisplayName

Parameters:displayName (str) –

New in version NX11.0.0.

License requirements: None.

Hint

BaseArgument.Hint

Returns or sets the argument hint.

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

Getter Method

Signature Hint

Returns: Return type:str

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature Hint

Parameters:argumentHint (str) –

New in version NX11.0.0.

License requirements: None.

IsOccurrence

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

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

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

Optional

BaseArgument.Optional

Returns or sets a value that indicates whether this argument is optional or not.

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

Getter Method

Signature Optional

Returns: Return type:bool

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature Optional

Parameters:isOptional (bool) –

New in version NX11.0.0.

License requirements: None.

OwningComponent

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

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

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

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

BaseArgument.Print

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

Signature Print()

New in version NX3.0.0.

License requirements: None.

SetName

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