PerformanceManager Class

class NXOpen.PerformanceManager

Bases: NXOpen.TransientObject

Represents class containing APIs used for monitoring performance.

This class should not be made available to customers

New in version NX7.0.0.

Properties

Property	Description
BsmMemory	Returns the BSM memory obtaied during performance monitoring
CpuTimeOption	Returns or sets the CPU time for particular process/application is returned and is measured either from the start or the last time performance statistics were gathered
CpuTimeValidationTolerance	Returns or sets the CPU time validation tolerance is returned which is getting used for validating the autotest XML.
DeltaBsmMemory	Returns the delta BSM memory obtaied during performance monitoring
DeltaCpuTime	Returns the delta CPU time obtaied during performance monitoring
DeltaNxProcessMemory	Returns the delta NX process memory obtaied during performance monitoring
DeltaRealTime	Returns the delta Real time obtaied during performance monitoring
DeltaWorkingSetMemory	Returns the delta NX working set memory obtaied during performance monitoring
MaxBsmMemory	Returns the Max BSM memory obtaied during performance monitoring
NxProcessMemory	Returns the NX process memory obtaied during performance monitoring
ProcessMemoryOption	Returns or sets the process memory for particular process/application is returned and is measured either from the start or the last time performance statistics were gathered
ProcessMemoryValidationTolerance	Returns or sets the process memory validation tolerance is returned which is getting used for validating the autotest XML.
PromptForUserCommentOption	Returns or sets the option to prompt for user comment, which is available only in autotest mode
RealTimeOption	Returns or sets the Real time for particular process/application is returned and is measured either from the start or the last time performance statistics were gathered
RealTimeValidationTolerance	Returns or sets the Real time validation tolerance is returned which is getting used for validating the autotest XML.
UserComment	Returns or sets the User Comment string obtained while recording the performance results.
WorkingSetMemory	Returns the NX working set memory obtaied during performance monitoring
WorkingSetMemoryOption	Returns or sets the working set memory for particular process/application is returned and is measured either from the start or the last time performance statistics were gathered
WorkingSetMemoryValidationTolerance	Returns or sets the working set memory validation tolerance is returned which is getting used for validating the autotest XML.

Methods

Method	Description
Dispose	Frees the object from memory.
RecordPerformanceResults	Record performance results at any point of time (once monitor is started).
StartPerformanceMonitor	Start the performance monitor at any point of time typically before any application/process
StopPerformanceMonitor	Record the performance results and stop monitoring

Property Detail

BsmMemory

PerformanceManager.BsmMemory

Returns the BSM memory obtaied during performance monitoring

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

Getter Method

Signature BsmMemory

Returns: Return type:float

New in version NX7.0.0.

License requirements: None.

CpuTimeOption

PerformanceManager.CpuTimeOption

Returns or sets the CPU time for particular process/application is returned and is measured either from the start or the last time performance statistics were gathered

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

Getter Method

Signature CpuTimeOption

Returns: Return type:bool

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature CpuTimeOption

Parameters:cpuTime (bool) –

New in version NX7.0.0.

License requirements: None.

CpuTimeValidationTolerance

PerformanceManager.CpuTimeValidationTolerance

Returns or sets the CPU time validation tolerance is returned which is getting used for validating the autotest XML.

The CPU time validation tolerance is set through PerformanceManager.CpuTimeValidationTol() which is getting used for validating the autotest XML. User need to be very careful while seletcing the tolerance values. Choose larger tolerances for smaller values

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

Getter Method

Signature CpuTimeValidationTolerance

Returns: Return type:int

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature CpuTimeValidationTolerance

Parameters:cpuTimeValidationTol (int) –

New in version NX7.0.0.

License requirements: None.

DeltaBsmMemory

PerformanceManager.DeltaBsmMemory

Returns the delta BSM memory obtaied during performance monitoring

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

Getter Method

Signature DeltaBsmMemory

Returns: Return type:float

New in version NX7.0.0.

License requirements: None.

DeltaCpuTime

PerformanceManager.DeltaCpuTime

Returns the delta CPU time obtaied during performance monitoring

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

Getter Method

Signature DeltaCpuTime

Returns: Return type:float

New in version NX7.0.0.

License requirements: None.

DeltaNxProcessMemory

PerformanceManager.DeltaNxProcessMemory

Returns the delta NX process memory obtaied during performance monitoring

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

Getter Method

Signature DeltaNxProcessMemory

Returns: Return type:float

New in version NX7.0.0.

License requirements: None.

DeltaRealTime

PerformanceManager.DeltaRealTime

Returns the delta Real time obtaied during performance monitoring

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

Getter Method

Signature DeltaRealTime

Returns: Return type:float

New in version NX7.0.0.

License requirements: None.

DeltaWorkingSetMemory

PerformanceManager.DeltaWorkingSetMemory

Returns the delta NX working set memory obtaied during performance monitoring

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

Getter Method

Signature DeltaWorkingSetMemory

Returns: Return type:float

New in version NX12.0.0.

License requirements: None.

MaxBsmMemory

PerformanceManager.MaxBsmMemory

Returns the Max BSM memory obtaied during performance monitoring

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

Getter Method

Signature MaxBsmMemory

Returns: Return type:float

New in version NX7.0.0.

License requirements: None.

NxProcessMemory

PerformanceManager.NxProcessMemory

Returns the NX process memory obtaied during performance monitoring

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

Getter Method

Signature NxProcessMemory

Returns: Return type:float

New in version NX7.0.0.

License requirements: None.

ProcessMemoryOption

PerformanceManager.ProcessMemoryOption

Returns or sets the process memory for particular process/application is returned and is measured either from the start or the last time performance statistics were gathered

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

Getter Method

Signature ProcessMemoryOption

Returns: Return type:bool

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature ProcessMemoryOption

Parameters:processMemory (bool) –

New in version NX7.0.0.

License requirements: None.

ProcessMemoryValidationTolerance

PerformanceManager.ProcessMemoryValidationTolerance

Returns or sets the process memory validation tolerance is returned which is getting used for validating the autotest XML.

The process memory validation tolerance is set through PerformanceManager.SetProcessMemoryTol() which is getting used for validating the autotest XML. User need to be very careful while seletcing the tolerance values. Choose larger tolerances for smaller values

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

Getter Method

Signature ProcessMemoryValidationTolerance

Returns: Return type:int

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature ProcessMemoryValidationTolerance

Parameters:processMemoryTol (int) –

New in version NX7.0.0.

License requirements: None.

PromptForUserCommentOption

PerformanceManager.PromptForUserCommentOption

Returns or sets the option to prompt for user comment, which is available only in autotest mode

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

Getter Method

Signature PromptForUserCommentOption

Returns: Return type:bool

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature PromptForUserCommentOption

Parameters:userComment (bool) –

New in version NX7.0.0.

License requirements: None.

RealTimeOption

PerformanceManager.RealTimeOption

Returns or sets the Real time for particular process/application is returned and is measured either from the start or the last time performance statistics were gathered

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

Getter Method

Signature RealTimeOption

Returns: Return type:bool

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature RealTimeOption

Parameters:realTime (bool) –

New in version NX7.0.0.

License requirements: None.

RealTimeValidationTolerance

PerformanceManager.RealTimeValidationTolerance

Returns or sets the Real time validation tolerance is returned which is getting used for validating the autotest XML.

The Real time validation tolerance is set through PerformanceManager.RealTimeValidationTol() which is getting used for validating the autotest XML. User need to be very careful while seletcing the tolerance values. Choose larger tolerances for smaller values

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

Getter Method

Signature RealTimeValidationTolerance

Returns: Return type:int

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature RealTimeValidationTolerance

Parameters:realTimeValidationTol (int) –

New in version NX7.0.0.

License requirements: None.

UserComment

PerformanceManager.UserComment

Returns or sets the User Comment string obtained while recording the performance results.

User comment field is populated only in autotest mode.

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

Getter Method

Signature UserComment

Returns: Return type:str

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature UserComment

Parameters:userComment (str) –

New in version NX7.0.0.

License requirements: None.

WorkingSetMemory

PerformanceManager.WorkingSetMemory

Returns the NX working set memory obtaied during performance monitoring

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

Getter Method

Signature WorkingSetMemory

Returns: Return type:float

New in version NX12.0.0.

License requirements: None.

WorkingSetMemoryOption

PerformanceManager.WorkingSetMemoryOption

Returns or sets the working set memory for particular process/application is returned and is measured either from the start or the last time performance statistics were gathered

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

Getter Method

Signature WorkingSetMemoryOption

Returns: Return type:bool

New in version NX12.0.0.

License requirements: None.

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

Setter Method

Signature WorkingSetMemoryOption

Parameters:workingSetMemory (bool) –

New in version NX12.0.0.

License requirements: None.

WorkingSetMemoryValidationTolerance

PerformanceManager.WorkingSetMemoryValidationTolerance

Returns or sets the working set memory validation tolerance is returned which is getting used for validating the autotest XML.

The working set memory validation tolerance is set through PerformanceManager.SetWorkingSetMemoryTol() which is getting used for validating the autotest XML. User need to be very careful while seletcing the tolerance values. Choose larger tolerances for smaller values

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

Getter Method

Signature WorkingSetMemoryValidationTolerance

Returns: Return type:int

New in version NX12.0.0.

License requirements: None.

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

Setter Method

Signature WorkingSetMemoryValidationTolerance

Parameters:workingSetMemoryTol (int) –

New in version NX12.0.0.

License requirements: None.

Method Detail

Dispose

PerformanceManager.Dispose

Frees the object from memory.

After this method is called, it is illegal to use the object. In .NET, this method is automatically called when the object is deleted by the garbage collector.

Signature Dispose()

New in version NX7.0.0.

License requirements: None.

RecordPerformanceResults

PerformanceManager.RecordPerformanceResults

Record performance results at any point of time (once monitor is started).

Mention where you want to put the output information by specifying outputDevice. Options(syslog, listing window and XML) to print all the performance statistics information. By default, all information get printed to listing window.

Signature RecordPerformanceResults()

New in version NX7.0.0.

License requirements: None.

StartPerformanceMonitor

PerformanceManager.StartPerformanceMonitor

Start the performance monitor at any point of time typically before any application/process

Signature StartPerformanceMonitor()

New in version NX7.0.0.

License requirements: None.

StopPerformanceMonitor

PerformanceManager.StopPerformanceMonitor

Record the performance results and stop monitoring

Signature StopPerformanceMonitor()

New in version NX7.0.0.

License requirements: None.