Represents a NXOpen::CAE::ModelAndLoadPreProcessTimeSignal builder
There is no kf creator for this. More...

Inheritance diagram for NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder:

Public Types
enum	AveragingTypeEnum { AveragingTypeEnumAmplitudePhaseLinear, AveragingTypeEnumMaximumPeakHold, AveragingTypeEnumRMSEnergy, AveragingTypeEnumRealImaginaryLinear }
	Represents different averaging modes. More...

enum	CorrectionModeEnum { CorrectionModeEnumAmplitude }
	Represents Correction Modes. More...

enum	TimeLimitEnum { TimeLimitEnumNone, TimeLimitEnumTime, TimeLimitEnumSamples }
	Possible types of the time range limits. More...

enum	WindowTypeEnum { WindowTypeEnumRectangular, WindowTypeEnumHanning, WindowTypeEnumHamming, WindowTypeEnumKaiserBessel, WindowTypeEnumBlackman, WindowTypeEnumFlatTop }
	Represent different Windowing Types. More...

Public Member Functions
NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::AveragingTypeEnum	AveragingType ()
	Returns the type of averaging to be used (when enabled) Created in NX1847.0.0. More...

int	BlockSize ()
	Returns the block size to use, when segmentation is enabled Created in NX1847.0.0. More...

NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::CorrectionModeEnum	CorrectionMode ()
	Returns the Windowing Correction mode, used when FFT is enabled Created in NX1847.0.0. More...

bool	EnableAveraging ()
	Returns the flags which enables averaging of the multiple spectra resulted by the time-segmentation (time-segmentation must be also enabled) Created in NX1847.0.0. More...

bool	EnableFFT ()
	Returns the flags that enables time-to-frequency domain transform (Fast-Fourier-Transform) Created in NX1847.0.0. More...

bool	EnableLowerFrequencyLimit ()
	Returns the flag which enables limiting the lower-range of the resulting frequency spectrum Created in NX1847.0.0. More...

bool	EnableTimeSegmentation ()
	Returns the flag which controls whether time-segmentation should be enabled or not. More...

bool	EnableUpperFrequencyLimit ()
	Returns the flag which enables limiting the upper-range of the resulting frequency spectrum Created in NX1847.0.0. More...

NXOpen::Expression *	LowerFrequencyLimit ()
	Returns the lower limit of the frequency range, in Hz (when enabled) Created in NX1847.0.0. More...

NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::TimeLimitEnum	LowerLimitType ()
	Returns the type of specification of the lower-limit Created in NX1847.0.0. More...

int	LowerSampleLimit ()
	Returns the lower-limit of the input-signal range, in sample units (when type is TimeLimitEnum_Samples) Created in NX1847.0.0. More...

NXOpen::Expression *	LowerTimeLimit ()
	Returns the lower limit, in time-units (seconds) (when type is TimeLimitEnum_Time) Created in NX1847.0.0. More...

double	Overlap ()
	Returns the overlap factor (in percents) to use, when segmentation is enabled Created in NX1847.0.0. More...

void	SetAveragingType (NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::AveragingTypeEnum averagingType)
	Sets the type of averaging to be used (when enabled) Created in NX1847.0.0. More...

void	SetBlockSize (int blockSize)
	Sets the block size to use, when segmentation is enabled Created in NX1847.0.0. More...

void	SetCorrectionMode (NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::CorrectionModeEnum correctionMode)
	Sets the Windowing Correction mode, used when FFT is enabled Created in NX1847.0.0. More...

void	SetEnableAveraging (bool enableAveraging)
	Sets the flags which enables averaging of the multiple spectra resulted by the time-segmentation (time-segmentation must be also enabled) Created in NX1847.0.0. More...

void	SetEnableFFT (bool enableFFT)
	Sets the flags that enables time-to-frequency domain transform (Fast-Fourier-Transform) Created in NX1847.0.0. More...

void	SetEnableLowerFrequencyLimit (bool enableLowerFrequencyLimit)
	Sets the flag which enables limiting the lower-range of the resulting frequency spectrum Created in NX1847.0.0. More...

void	SetEnableTimeSegmentation (bool enableTimeSegmentation)
	Sets the flag which controls whether time-segmentation should be enabled or not. More...

void	SetEnableUpperFrequencyLimit (bool enableUpperFrequencyLimit)
	Sets the flag which enables limiting the upper-range of the resulting frequency spectrum Created in NX1847.0.0. More...

void	SetLowerLimitType (NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::TimeLimitEnum lowerLimitType)
	Sets the type of specification of the lower-limit Created in NX1847.0.0. More...

void	SetLowerSampleLimit (int lowerSampleLimit)
	Sets the lower-limit of the input-signal range, in sample units (when type is TimeLimitEnum_Samples) Created in NX1847.0.0. More...

void	SetOverlap (double overlap)
	Sets the overlap factor (in percents) to use, when segmentation is enabled Created in NX1847.0.0. More...

void	SetUpperLimitType (NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::TimeLimitEnum upperLimitType)
	Sets the type of the upper-limit range specification Created in NX1847.0.0. More...

void	SetUpperSampleLimit (int upperSampleLimit)
	Sets the upper limit, in sample units Created in NX1847.0.0. More...

void	SetWindowType (NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::WindowTypeEnum windowType)
	Sets the Windowing type to be used when FFT is enabled Created in NX1847.0.0. More...

NXOpen::Expression *	UpperFrequencyLimit ()
	Returns the upper limit of the frequency range, in Hz (when enabled) Created in NX1847.0.0. More...

NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::TimeLimitEnum	UpperLimitType ()
	Returns the type of the upper-limit range specification Created in NX1847.0.0. More...

int	UpperSampleLimit ()
	Returns the upper limit, in sample units Created in NX1847.0.0. More...

NXOpen::Expression *	UpperTimeLimit ()
	Returns the upper limit, in time units (seconds) Created in NX1847.0.0. More...

NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::WindowTypeEnum	WindowType ()
	Returns the Windowing type to be used when FFT is enabled Created in NX1847.0.0. More...

Public Member Functions inherited from NXOpen::CAE::ModelAndLoadPreProcessOperationBuilder
NXString	OperationName ()
	Returns the operation name. More...

void	SetOperationName (const NXString &title)
	Sets the operation name. More...

void	SetOperationName (const char *title)
	Sets the operation name. More...

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder. More...

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder. More...

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder. More...

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...

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

Detailed Description

Represents a NXOpen::CAE::ModelAndLoadPreProcessTimeSignal builder
There is no kf creator for this.

Created in NX1847.0.0.

Member Enumeration Documentation

enum NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::AveragingTypeEnum

Represents different averaging modes.

Enumerator
AveragingTypeEnumAmplitudePhaseLinear	amplitude phase linear
AveragingTypeEnumMaximumPeakHold	maximum peak hold
AveragingTypeEnumRMSEnergy	rmsenergy
AveragingTypeEnumRealImaginaryLinear	real imaginary linear

enum NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::CorrectionModeEnum

Represents Correction Modes.

Currently only Amplitude is supported.

Enumerator
CorrectionModeEnumAmplitude	amplitude

enum NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::TimeLimitEnum

Possible types of the time range limits.

Enumerator
TimeLimitEnumNone	none
TimeLimitEnumTime	time
TimeLimitEnumSamples	samples

enum NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::WindowTypeEnum

Represent different Windowing Types.

Enumerator
WindowTypeEnumRectangular	rectangular
WindowTypeEnumHanning	hanning
WindowTypeEnumHamming	hamming
WindowTypeEnumKaiserBessel	kaiser bessel
WindowTypeEnumBlackman	blackman
WindowTypeEnumFlatTop	flat top

Member Function Documentation

NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::AveragingTypeEnum NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::AveragingType ( )

Returns the type of averaging to be used (when enabled)
Created in NX1847.0.0.

License requirements : None

int NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::BlockSize ( )

Returns the block size to use, when segmentation is enabled
Created in NX1847.0.0.

License requirements : None

NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::CorrectionModeEnum NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::CorrectionMode ( )

Returns the Windowing Correction mode, used when FFT is enabled
Created in NX1847.0.0.

License requirements : None

bool NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::EnableAveraging ( )

Returns the flags which enables averaging of the multiple spectra resulted by the time-segmentation (time-segmentation must be also enabled)
Created in NX1847.0.0.

License requirements : None

bool NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::EnableFFT ( )

Returns the flags that enables time-to-frequency domain transform (Fast-Fourier-Transform)
Created in NX1847.0.0.

License requirements : None

bool NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::EnableLowerFrequencyLimit ( )

Returns the flag which enables limiting the lower-range of the resulting frequency spectrum
Created in NX1847.0.0.

License requirements : None

bool NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::EnableTimeSegmentation ( )

Returns the flag which controls whether time-segmentation should be enabled or not.

If not enabled, then the entire signal is processed at once. If enabled, then the signal is split into fixed-size intervals (see BlockSize), with a configurable overlap percentage. The last segment, if smaller than the block size, is discarded.

Created in NX1847.0.0.

License requirements : None

bool NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::EnableUpperFrequencyLimit ( )

Returns the flag which enables limiting the upper-range of the resulting frequency spectrum
Created in NX1847.0.0.

License requirements : None

NXOpen::Expression* NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::LowerFrequencyLimit ( )

Returns the lower limit of the frequency range, in Hz (when enabled)
Created in NX1847.0.0.

License requirements : None

NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::TimeLimitEnum NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::LowerLimitType ( )

Returns the type of specification of the lower-limit
Created in NX1847.0.0.

License requirements : None

int NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::LowerSampleLimit ( )

Returns the lower-limit of the input-signal range, in sample units (when type is TimeLimitEnum_Samples)
Created in NX1847.0.0.

License requirements : None

NXOpen::Expression* NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::LowerTimeLimit ( )

Returns the lower limit, in time-units (seconds) (when type is TimeLimitEnum_Time)
Created in NX1847.0.0.

License requirements : None

double NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::Overlap ( )

Returns the overlap factor (in percents) to use, when segmentation is enabled
Created in NX1847.0.0.

License requirements : None

void NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::SetAveragingType ( NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::AveragingTypeEnum averagingType )

Sets the type of averaging to be used (when enabled)
Created in NX1847.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

averagingType averagingtype

void NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::SetBlockSize ( int blockSize )

Sets the block size to use, when segmentation is enabled
Created in NX1847.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

blockSize blocksize

void NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::SetCorrectionMode ( NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::CorrectionModeEnum correctionMode )

Sets the Windowing Correction mode, used when FFT is enabled
Created in NX1847.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

correctionMode correctionmode

void NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::SetEnableAveraging ( bool enableAveraging )

Sets the flags which enables averaging of the multiple spectra resulted by the time-segmentation (time-segmentation must be also enabled)
Created in NX1847.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

enableAveraging enableaveraging

void NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::SetEnableFFT ( bool enableFFT )

Sets the flags that enables time-to-frequency domain transform (Fast-Fourier-Transform)
Created in NX1847.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

enableFFT enablefft

void NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::SetEnableLowerFrequencyLimit ( bool enableLowerFrequencyLimit )

Sets the flag which enables limiting the lower-range of the resulting frequency spectrum
Created in NX1847.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

enableLowerFrequencyLimit enablelowerfrequencylimit

void NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::SetEnableTimeSegmentation ( bool enableTimeSegmentation )

Sets the flag which controls whether time-segmentation should be enabled or not.

If not enabled, then the entire signal is processed at once. If enabled, then the signal is split into fixed-size intervals (see BlockSize), with a configurable overlap percentage. The last segment, if smaller than the block size, is discarded.

Created in NX1847.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

enableTimeSegmentation enabletimesegmentation

void NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::SetEnableUpperFrequencyLimit ( bool enableUpperFrequencyLimit )

Sets the flag which enables limiting the upper-range of the resulting frequency spectrum
Created in NX1847.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

enableUpperFrequencyLimit enableupperfrequencylimit

void NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::SetLowerLimitType ( NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::TimeLimitEnum lowerLimitType )

Sets the type of specification of the lower-limit
Created in NX1847.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

lowerLimitType lowerlimittype

void NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::SetLowerSampleLimit ( int lowerSampleLimit )

Sets the lower-limit of the input-signal range, in sample units (when type is TimeLimitEnum_Samples)
Created in NX1847.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

lowerSampleLimit lowersamplelimit

void NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::SetOverlap ( double overlap )

Sets the overlap factor (in percents) to use, when segmentation is enabled
Created in NX1847.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

overlap overlap

void NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::SetUpperLimitType ( NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::TimeLimitEnum upperLimitType )

Sets the type of the upper-limit range specification
Created in NX1847.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

upperLimitType upperlimittype

void NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::SetUpperSampleLimit ( int upperSampleLimit )

Sets the upper limit, in sample units
Created in NX1847.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

upperSampleLimit uppersamplelimit

void NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::SetWindowType ( NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::WindowTypeEnum windowType )

Sets the Windowing type to be used when FFT is enabled
Created in NX1847.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

windowType windowtype

NXOpen::Expression* NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::UpperFrequencyLimit ( )

Returns the upper limit of the frequency range, in Hz (when enabled)
Created in NX1847.0.0.

License requirements : None

NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::TimeLimitEnum NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::UpperLimitType ( )

Returns the type of the upper-limit range specification
Created in NX1847.0.0.

License requirements : None

int NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::UpperSampleLimit ( )

Returns the upper limit, in sample units
Created in NX1847.0.0.

License requirements : None

NXOpen::Expression* NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::UpperTimeLimit ( )

Returns the upper limit, in time units (seconds)
Created in NX1847.0.0.

License requirements : None

NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::WindowTypeEnum NXOpen::CAE::ModelAndLoadPreProcessTimeSignalBuilder::WindowType ( )

Returns the Windowing type to be used when FFT is enabled
Created in NX1847.0.0.

License requirements : None

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

CAE_ModelAndLoadPreProcessTimeSignalBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation