Represents the program information for command automation. More...

Inheritance diagram for NXOpen::Report::ProgramInformation:

Public Types
enum	LanguageType { LanguageTypeNone, LanguageTypeCPlusplus, LanguageTypeCSharp, LanguageTypeVb, LanguageTypeJava, LanguageTypePython }
	Represents the automation program. More...

Public Member Functions
virtual NXOpen::INXObject *	FindObject (const NXString &journalIdentifier)
	Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More...

virtual NXOpen::INXObject *	FindObject (const char *journalIdentifier)
	Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More...

NXString	FunctionName ()
	Returns the program entry function name. More...

virtual bool	IsOccurrence ()
	Returns whether this object is an occurrence or not. More...

virtual NXString	JournalIdentifier ()
	Returns the identifier that would be recorded in a journal for this object. More...

NXOpen::Report::ProgramInformation::LanguageType	Language ()
	Returns the automation program language. More...

virtual NXString	Name ()
	Returns the custom name of the object. More...

virtual NXOpen::Assemblies::Component *	OwningComponent ()
	Returns the owning component, if this object is an occurrence. More...

virtual NXOpen::BasePart *	OwningPart ()
	Returns the owning part of this object Created in NX3.0.0. More...

virtual void	Print ()
	Prints a representation of this object to the system log file. More...

NXString	ProgramFile ()
	Returns the automation program executer file. More...

virtual NXOpen::INXObject *	Prototype ()
	Returns the prototype of this object if it is an occurrence. More...

void	SetFunctionName (const NXString &functionName)
	Sets the program entry function name. More...

void	SetFunctionName (const char *functionName)
	Sets the program entry function name. More...

void	SetLanguage (NXOpen::Report::ProgramInformation::LanguageType languageType)
	Sets the automation program language. More...

virtual void	SetName (const NXString &name)
	Sets the custom name of the object. More...

virtual void	SetName (const char *name)
	Sets the custom name of the object. More...

void	SetProgramFile (const NXString &programFile)
	Sets the automation program executer file. More...

void	SetProgramFile (const char *programFile)
	Sets the automation program executer file. More...

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

Represents the program information for command automation.

Created in NX11.0.0.

Member Enumeration Documentation

enum NXOpen::Report::ProgramInformation::LanguageType

Represents the automation program.

Enumerator
LanguageTypeNone	None language.
LanguageTypeCPlusplus	C plus plus language.
LanguageTypeCSharp	C sharp language.
LanguageTypeVb	Visual basic language.
LanguageTypeJava	Java language.
LanguageTypePython	Python language.

Member Function Documentation

virtual NXOpen::INXObject* NXOpen::Report::ProgramInformation::FindObject ( const NXString & journalIdentifier )

virtual

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.

Returns: Created in NX3.0.0.

License requirements : None

Parameters

journalIdentifier Journal identifier of the object

Implements NXOpen::INXObject.

virtual NXOpen::INXObject* NXOpen::Report::ProgramInformation::FindObject ( const char * journalIdentifier )

virtual

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.

Returns: Created in NX3.0.0.

License requirements : None

Parameters

journalIdentifier Journal identifier of the object

Implements NXOpen::INXObject.

NXString NXOpen::Report::ProgramInformation::FunctionName ( )

Returns 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".
Created in NX11.0.0.

License requirements : None

virtual bool NXOpen::Report::ProgramInformation::IsOccurrence ( )

virtual

Returns whether this object is an occurrence or not.

Created in NX3.0.0.

License requirements : None

Implements NXOpen::INXObject.

virtual NXString NXOpen::Report::ProgramInformation::JournalIdentifier ( )

virtual

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.
Created in NX3.0.0.

License requirements : None

Implements NXOpen::INXObject.

NXOpen::Report::ProgramInformation::LanguageType NXOpen::Report::ProgramInformation::Language ( )

Returns the automation program language.

Created in NX11.0.0.

License requirements : None

virtual NXString NXOpen::Report::ProgramInformation::Name ( )

virtual

Returns the custom name of the object.

Created in NX3.0.0.

License requirements : None

Implements NXOpen::INXObject.

virtual NXOpen::Assemblies::Component* NXOpen::Report::ProgramInformation::OwningComponent ( )

virtual

Returns the owning component, if this object is an occurrence.

Created in NX3.0.0.

License requirements : None

Implements NXOpen::INXObject.

virtual NXOpen::BasePart* NXOpen::Report::ProgramInformation::OwningPart ( )

virtual

Returns the owning part of this object
Created in NX3.0.0.

License requirements : None

Implements NXOpen::INXObject.

virtual void NXOpen::Report::ProgramInformation::Print ( )

virtual

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

Created in NX3.0.0.

License requirements : None

Implements NXOpen::INXObject.

NXString NXOpen::Report::ProgramInformation::ProgramFile ( )

Returns 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.
Created in NX11.0.0.

License requirements : None

virtual NXOpen::INXObject* NXOpen::Report::ProgramInformation::Prototype ( )

virtual

Returns the prototype of this object if it is an occurrence.

Created in NX3.0.0.

License requirements : None

Implements NXOpen::INXObject.

void NXOpen::Report::ProgramInformation::SetFunctionName ( const NXString & functionName )

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".
Created in NX11.0.0.

License requirements : None

Parameters

functionName functionname

void NXOpen::Report::ProgramInformation::SetFunctionName ( const char * functionName )

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".
Created in NX11.0.0.

License requirements : None

Parameters

functionName functionname

void NXOpen::Report::ProgramInformation::SetLanguage ( NXOpen::Report::ProgramInformation::LanguageType languageType )

Sets the automation program language.

Created in NX11.0.0.

License requirements : None

Parameters

languageType languagetype

virtual void NXOpen::Report::ProgramInformation::SetName ( const NXString & name )

virtual

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.
Created in NX3.0.0.

License requirements : None

Parameters

name name

Implements NXOpen::INXObject.

virtual void NXOpen::Report::ProgramInformation::SetName ( const char * name )

virtual

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.
Created in NX3.0.0.

License requirements : None

Parameters

name name

Implements NXOpen::INXObject.

void NXOpen::Report::ProgramInformation::SetProgramFile ( const NXString & programFile )

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.
Created in NX11.0.0.

License requirements : None

Parameters

programFile the program file with full path

void NXOpen::Report::ProgramInformation::SetProgramFile ( const char * programFile )

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.
Created in NX11.0.0.

License requirements : None

Parameters

programFile the program file with full path

The documentation for this class was generated from the following file:

Report_ProgramInformation.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation