ProgramInformation Class

class NXOpen.Report.ProgramInformation

Bases: NXOpen.TaggedObject, NXOpen.INXObject

Represents the program information for command automation.

New in version NX11.0.0.

Properties

Property	Description
FunctionName	Returns or sets the program entry function name.
IsOccurrence	Returns whether this object is an occurrence or not.
JournalIdentifier	Returns the identifier that would be recorded in a journal for this object.
Language	Returns or sets the automation program language.
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
ProgramFile	Returns or sets the automation program executer file.
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

ProgramInformationLanguageType Enumeration

Represents the automation program.

Property Detail

FunctionName

ProgramInformation.FunctionName

Returns or sets the program entry function name.

CPlusplus language: the function name is the exported function following required interface, Java language: the function name is the exported java class name, CSharp, Vb and Python language: the function name is “Main”.

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

Getter Method

Signature FunctionName

Returns: Return type:str

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature FunctionName

Parameters:functionName (str) –

New in version NX11.0.0.

License requirements: None.

IsOccurrence

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

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

Language

ProgramInformation.Language

Returns or sets the automation program language.

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

Getter Method

Signature Language

Returns: Return type:NXOpen.Report.ProgramInformationLanguageType

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature Language

Parameters:languageType (NXOpen.Report.ProgramInformationLanguageType) –

New in version NX11.0.0.

License requirements: None.

Name

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

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

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

ProgramFile

ProgramInformation.ProgramFile

Returns or sets the automation program executer file.

CPlusplus language: the dll file, CSharp language: the CS file or CS dll file, Vb language: the VB file or VB dll file, Java language: the Jar file, Python language: the Py file.

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

Getter Method

Signature ProgramFile

Returns:the program file with full path Return type:str

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature ProgramFile

Parameters:programFile (str) – the program file with full path

New in version NX11.0.0.

License requirements: None.

Prototype

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

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

ProgramInformation.Print

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

Signature Print()

New in version NX3.0.0.

License requirements: None.

SetName

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