NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::CAE::LaminateSineEventBuilder Class Reference

Represents a NXOpen::CAE::LaminateSineEvent builder
To create a new instance of this class, use NXOpen::CAE::LaminateDynamicEventCollection::CreateSineEventBuilder

Created in NX10.0.0. More...

Inheritance diagram for NXOpen::CAE::LaminateSineEventBuilder:
NXOpen::CAE::LaminateDynamicEventBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  AdditionalFrequeciesUnitsEnum { AdditionalFrequeciesUnitsEnumHz, AdditionalFrequeciesUnitsEnumKHz, AdditionalFrequeciesUnitsEnumMHz, AdditionalFrequeciesUnitsEnumGHz }
 The additional frequencies units. More...
 
enum  IntermediateFrequeciesBetweenEnum { IntermediateFrequeciesBetweenEnumLinear, IntermediateFrequeciesBetweenEnumLogarithmic }
 The intermediate in between frequencies increment option. More...
 
enum  IntermediateFrequeciesEnum { IntermediateFrequeciesEnumIncrementLinear, IntermediateFrequeciesEnumIncrementLogarithmic, IntermediateFrequeciesEnumBetweenFrequencies }
 The intermediate frequencies options. More...
 
enum  NaturalFrequeciesEnum { NaturalFrequeciesEnumAll, NaturalFrequeciesEnumSelect }
 The reference enum. More...
 
- Public Types inherited from NXOpen::CAE::LaminateDynamicEventBuilder
enum  ExcitationSelectedAxisEnum { ExcitationSelectedAxisEnumX, ExcitationSelectedAxisEnumY, ExcitationSelectedAxisEnumZ }
 The excitation axis enum. More...
 
enum  ReferenceTypeEnum { ReferenceTypeEnumRelative, ReferenceTypeEnumAbsolute }
 The reference enum. More...
 

Public Member Functions

bool AdditionalFrequenciesBreakPoints ()
 Returns the option to consider break points
Created in NX10.0.0. More...
 
NXOpen::CAE::LaminateSineEventBuilder::AdditionalFrequeciesUnitsEnum AdditionalFrequenciesUnits ()
 Returns the option to consider break points
Created in NX10.0.0. More...
 
NXOpen::CAE::LaminateSineEventBuilder::IntermediateFrequeciesBetweenEnum IntermediateFrequenciesBetweenOption ()
 Returns the intermediate in between frequencies option
Created in NX10.0.0. More...
 
double IntermediateFrequenciesCluster ()
 Returns the intermediate in between frequencies number of excitations
Created in NX10.0.0. More...
 
bool IntermediateFrequenciesEnable ()
 Returns the intermediate frequencies control
Created in NX10.0.0. More...
 
bool IntermediateFrequenciesIncludeNatFreq ()
 Returns the option to include the natural frequencis in the intermediate frequencies with the linear and logarithmic options
More...
 
int IntermediateFrequenciesNumExcitations ()
 Returns the intermediate in between frequencies number of excitations
Created in NX10.0.0. More...
 
int IntermediateFrequenciesNumIncrements ()
 Returns the intermediate frequencies number of increments for linear and logarithmic options
Created in NX10.0.0. More...
 
NXOpen::CAE::LaminateSineEventBuilder::IntermediateFrequeciesEnum IntermediateFrequenciesOption ()
 Returns the intermediate frequencies option
Created in NX10.0.0. More...
 
NXOpen::CAE::LaminateSineEventBuilder::NaturalFrequeciesEnum NaturalFrequenciesChoice ()
 Returns the natural frequencies selection option
Created in NX10.0.0. More...
 
bool NaturalFrequenciesEnable ()
 Returns the natural frequencies option
Created in NX10.0.0. More...
 
void SelectModes (const std::vector< NXOpen::CAE::LaminateModeProperty * > &selectedModes)
 Sets the a mode property selection
Created in NX10.0.0. More...
 
void SetAdditionalFrequencies (const std::vector< double > &additionalFrequencies)
 Sets the additional frequencies values
Created in NX10.0.0. More...
 
void SetAdditionalFrequenciesBreakPoints (bool additionalFrequenciesBreakPoints)
 Sets the option to consider break points
Created in NX10.0.0. More...
 
void SetAdditionalFrequenciesUnits (NXOpen::CAE::LaminateSineEventBuilder::AdditionalFrequeciesUnitsEnum additionalFrequenciesUnits)
 Sets the option to consider break points
Created in NX10.0.0. More...
 
void SetIntermediateFrequenciesBetweenOption (NXOpen::CAE::LaminateSineEventBuilder::IntermediateFrequeciesBetweenEnum intermediateFrequenciesBetweenOption)
 Sets the intermediate in between frequencies option
Created in NX10.0.0. More...
 
void SetIntermediateFrequenciesCluster (double intermediateFrequenciesCluster)
 Sets the intermediate in between frequencies number of excitations
Created in NX10.0.0. More...
 
void SetIntermediateFrequenciesEnable (bool intermediateFrequenciesEnable)
 Sets the intermediate frequencies control
Created in NX10.0.0. More...
 
void SetIntermediateFrequenciesIncludeNatFreq (bool intermediateFrequenciesIncludeNatFreq)
 Sets the option to include the natural frequencis in the intermediate frequencies with the linear and logarithmic options
More...
 
void SetIntermediateFrequenciesNumExcitations (int intermediateFrequenciesNumExcitations)
 Sets the intermediate in between frequencies number of excitations
Created in NX10.0.0. More...
 
void SetIntermediateFrequenciesNumIncrements (int intermediateFrequenciesNumIncrements)
 Sets the intermediate frequencies number of increments for linear and logarithmic options
Created in NX10.0.0. More...
 
void SetIntermediateFrequenciesOption (NXOpen::CAE::LaminateSineEventBuilder::IntermediateFrequeciesEnum intermediateFrequenciesOption)
 Sets the intermediate frequencies option
Created in NX10.0.0. More...
 
void SetNaturalFrequenciesChoice (NXOpen::CAE::LaminateSineEventBuilder::NaturalFrequeciesEnum naturalFrequenciesChoice)
 Sets the natural frequencies selection option
Created in NX10.0.0. More...
 
void SetNaturalFrequenciesEnable (bool naturalFrequenciesEnable)
 Sets the natural frequencies option
Created in NX10.0.0. More...
 
- Public Member Functions inherited from NXOpen::CAE::LaminateDynamicEventBuilder
NXString DynamicEventName ()
 Returns the event name
Created in NX10.0.0. More...
 
NXOpen::CoordinateSystemExcitationCsys ()
 Returns the excitation coordinate system
Created in NX10.0.0. More...
 
NXOpen::CAE::LaminateDynamicEventBuilder::ExcitationSelectedAxisEnum ExcitationSelectedAxis ()
 Returns the excitation axis
Created in NX10.0.0. More...
 
NXOpen::CAE::ModelingObjectPropertyTableGetOutputRequestObject ()
 Get the output request. More...
 
double LowerBoundFrequency ()
 Returns the lower bound freq
Created in NX10.0.0. More...
 
bool NastranBasicCsys ()
 Returns the nastran basic
Created in NX10.0.0. More...
 
NXOpen::CAE::LaminateDynamicEventBuilder::ReferenceTypeEnum ReferenceType ()
 Returns the reference type
Created in NX10.0.0. More...
 
void SetDynamicEventName (const NXString &dynamicEventName)
 Sets the event name
Created in NX10.0.0. More...
 
void SetDynamicEventName (const char *dynamicEventName)
 Sets the event name
Created in NX10.0.0. More...
 
void SetExcitationCsys (NXOpen::CoordinateSystem *excitationCsys)
 Sets the excitation coordinate system
Created in NX10.0.0. More...
 
void SetExcitationSelectedAxis (NXOpen::CAE::LaminateDynamicEventBuilder::ExcitationSelectedAxisEnum excitationSelectedAxis)
 Sets the excitation axis
Created in NX10.0.0. More...
 
void SetLowerBoundFrequency (double lowerBoundFrequency)
 Sets the lower bound freq
Created in NX10.0.0. More...
 
void SetNastranBasicCsys (bool nastranBasicCsys)
 Sets the nastran basic
Created in NX10.0.0. More...
 
void SetOutputRequestObject (NXOpen::CAE::ModelingObjectPropertyTable *ssmo)
 Set the output request. More...
 
void SetReferenceType (NXOpen::CAE::LaminateDynamicEventBuilder::ReferenceTypeEnum referenceType)
 Sets the reference type
Created in NX10.0.0. More...
 
void SetUpperBoundFrequency (double upperBoundFrequency)
 Sets the upper bound freq
Created in NX10.0.0. More...
 
void SetUserFunction (NXOpen::TaggedObject *userFunction)
 Sets the function. More...
 
double UpperBoundFrequency ()
 Returns the upper bound freq
Created in NX10.0.0. More...
 
NXOpen::TaggedObjectUserFunction ()
 Returns the function. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 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::NXObjectGetObject ()
 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::LaminateSineEvent builder
To create a new instance of this class, use NXOpen::CAE::LaminateDynamicEventCollection::CreateSineEventBuilder

Created in NX10.0.0.


Member Enumeration Documentation

The additional frequencies units.

Enumerator
AdditionalFrequeciesUnitsEnumHz 

hz

AdditionalFrequeciesUnitsEnumKHz 

khz

AdditionalFrequeciesUnitsEnumMHz 

mhz

AdditionalFrequeciesUnitsEnumGHz 

ghz

The intermediate in between frequencies increment option.

Enumerator
IntermediateFrequeciesBetweenEnumLinear 

Linear increments.

IntermediateFrequeciesBetweenEnumLogarithmic 

Logarithmic increments.

The intermediate frequencies options.

Enumerator
IntermediateFrequeciesEnumIncrementLinear 

Linear Increments.

IntermediateFrequeciesEnumIncrementLogarithmic 

Logarithmic Increments.

IntermediateFrequeciesEnumBetweenFrequencies 

Between Frequencies.

The reference enum.

Enumerator
NaturalFrequeciesEnumAll 

Select all natural frequencies.

NaturalFrequeciesEnumSelect 

Manually select natural frequencies.

Member Function Documentation

bool NXOpen::CAE::LaminateSineEventBuilder::AdditionalFrequenciesBreakPoints ( )

Returns the option to consider break points
Created in NX10.0.0.



License requirements : None

NXOpen::CAE::LaminateSineEventBuilder::AdditionalFrequeciesUnitsEnum NXOpen::CAE::LaminateSineEventBuilder::AdditionalFrequenciesUnits ( )

Returns the option to consider break points
Created in NX10.0.0.



License requirements : None

NXOpen::CAE::LaminateSineEventBuilder::IntermediateFrequeciesBetweenEnum NXOpen::CAE::LaminateSineEventBuilder::IntermediateFrequenciesBetweenOption ( )

Returns the intermediate in between frequencies option
Created in NX10.0.0.



License requirements : None

double NXOpen::CAE::LaminateSineEventBuilder::IntermediateFrequenciesCluster ( )

Returns the intermediate in between frequencies number of excitations
Created in NX10.0.0.



License requirements : None

bool NXOpen::CAE::LaminateSineEventBuilder::IntermediateFrequenciesEnable ( )

Returns the intermediate frequencies control
Created in NX10.0.0.



License requirements : None

bool NXOpen::CAE::LaminateSineEventBuilder::IntermediateFrequenciesIncludeNatFreq ( )

Returns the option to include the natural frequencis in the intermediate frequencies with the linear and logarithmic options

Deprecated:
Deprecated in NX11.0.0.

This function has no replacement. The IntermediateFrequenciesIncludeNatFreq property is simply not supported by the Sine Event solver and has never been. This parameter is useless.


Created in NX10.0.0.

License requirements : None

int NXOpen::CAE::LaminateSineEventBuilder::IntermediateFrequenciesNumExcitations ( )

Returns the intermediate in between frequencies number of excitations
Created in NX10.0.0.



License requirements : None

int NXOpen::CAE::LaminateSineEventBuilder::IntermediateFrequenciesNumIncrements ( )

Returns the intermediate frequencies number of increments for linear and logarithmic options
Created in NX10.0.0.



License requirements : None

NXOpen::CAE::LaminateSineEventBuilder::IntermediateFrequeciesEnum NXOpen::CAE::LaminateSineEventBuilder::IntermediateFrequenciesOption ( )

Returns the intermediate frequencies option
Created in NX10.0.0.



License requirements : None

NXOpen::CAE::LaminateSineEventBuilder::NaturalFrequeciesEnum NXOpen::CAE::LaminateSineEventBuilder::NaturalFrequenciesChoice ( )

Returns the natural frequencies selection option
Created in NX10.0.0.



License requirements : None

bool NXOpen::CAE::LaminateSineEventBuilder::NaturalFrequenciesEnable ( )

Returns the natural frequencies option
Created in NX10.0.0.



License requirements : None

void NXOpen::CAE::LaminateSineEventBuilder::SelectModes ( const std::vector< NXOpen::CAE::LaminateModeProperty * > &  selectedModes)

Sets the a mode property selection
Created in NX10.0.0.



License requirements : nx_lam_comp_adv ("Laminate Composites Advanced")

Parameters
selectedModesselected modes
void NXOpen::CAE::LaminateSineEventBuilder::SetAdditionalFrequencies ( const std::vector< double > &  additionalFrequencies)

Sets the additional frequencies values
Created in NX10.0.0.



License requirements : nx_lam_comp_adv ("Laminate Composites Advanced")

Parameters
additionalFrequenciesadditionalfrequencies
void NXOpen::CAE::LaminateSineEventBuilder::SetAdditionalFrequenciesBreakPoints ( bool  additionalFrequenciesBreakPoints)

Sets the option to consider break points
Created in NX10.0.0.



License requirements : nx_lam_comp_adv ("Laminate Composites Advanced")

Parameters
additionalFrequenciesBreakPointsadditionalfrequenciesbreakpoints
void NXOpen::CAE::LaminateSineEventBuilder::SetAdditionalFrequenciesUnits ( NXOpen::CAE::LaminateSineEventBuilder::AdditionalFrequeciesUnitsEnum  additionalFrequenciesUnits)

Sets the option to consider break points
Created in NX10.0.0.



License requirements : nx_lam_comp_adv ("Laminate Composites Advanced")

Parameters
additionalFrequenciesUnitsadditionalfrequenciesunits
void NXOpen::CAE::LaminateSineEventBuilder::SetIntermediateFrequenciesBetweenOption ( NXOpen::CAE::LaminateSineEventBuilder::IntermediateFrequeciesBetweenEnum  intermediateFrequenciesBetweenOption)

Sets the intermediate in between frequencies option
Created in NX10.0.0.



License requirements : nx_lam_comp_adv ("Laminate Composites Advanced")

Parameters
intermediateFrequenciesBetweenOptionintermediatefrequenciesbetweenoption
void NXOpen::CAE::LaminateSineEventBuilder::SetIntermediateFrequenciesCluster ( double  intermediateFrequenciesCluster)

Sets the intermediate in between frequencies number of excitations
Created in NX10.0.0.



License requirements : nx_lam_comp_adv ("Laminate Composites Advanced")

Parameters
intermediateFrequenciesClusterintermediatefrequenciescluster
void NXOpen::CAE::LaminateSineEventBuilder::SetIntermediateFrequenciesEnable ( bool  intermediateFrequenciesEnable)

Sets the intermediate frequencies control
Created in NX10.0.0.



License requirements : nx_lam_comp_adv ("Laminate Composites Advanced")

Parameters
intermediateFrequenciesEnableintermediatefrequenciesenable
void NXOpen::CAE::LaminateSineEventBuilder::SetIntermediateFrequenciesIncludeNatFreq ( bool  intermediateFrequenciesIncludeNatFreq)

Sets the option to include the natural frequencis in the intermediate frequencies with the linear and logarithmic options

Deprecated:
Deprecated in NX11.0.0.

This function has no replacement. The IntermediateFrequenciesIncludeNatFreq property is simply not supported by the Sine Event solver and has never been. This parameter is useless.


Created in NX10.0.0.

License requirements : nx_lam_comp_adv ("Laminate Composites Advanced")

Parameters
intermediateFrequenciesIncludeNatFreqintermediatefrequenciesincludenatfreq
void NXOpen::CAE::LaminateSineEventBuilder::SetIntermediateFrequenciesNumExcitations ( int  intermediateFrequenciesNumExcitations)

Sets the intermediate in between frequencies number of excitations
Created in NX10.0.0.



License requirements : nx_lam_comp_adv ("Laminate Composites Advanced")

Parameters
intermediateFrequenciesNumExcitationsintermediatefrequenciesnumexcitations
void NXOpen::CAE::LaminateSineEventBuilder::SetIntermediateFrequenciesNumIncrements ( int  intermediateFrequenciesNumIncrements)

Sets the intermediate frequencies number of increments for linear and logarithmic options
Created in NX10.0.0.



License requirements : nx_lam_comp_adv ("Laminate Composites Advanced")

Parameters
intermediateFrequenciesNumIncrementsintermediatefrequenciesnumincrements
void NXOpen::CAE::LaminateSineEventBuilder::SetIntermediateFrequenciesOption ( NXOpen::CAE::LaminateSineEventBuilder::IntermediateFrequeciesEnum  intermediateFrequenciesOption)

Sets the intermediate frequencies option
Created in NX10.0.0.



License requirements : nx_lam_comp_adv ("Laminate Composites Advanced")

Parameters
intermediateFrequenciesOptionintermediatefrequenciesoption
void NXOpen::CAE::LaminateSineEventBuilder::SetNaturalFrequenciesChoice ( NXOpen::CAE::LaminateSineEventBuilder::NaturalFrequeciesEnum  naturalFrequenciesChoice)

Sets the natural frequencies selection option
Created in NX10.0.0.



License requirements : nx_lam_comp_adv ("Laminate Composites Advanced")

Parameters
naturalFrequenciesChoicenaturalfrequencieschoice
void NXOpen::CAE::LaminateSineEventBuilder::SetNaturalFrequenciesEnable ( bool  naturalFrequenciesEnable)

Sets the natural frequencies option
Created in NX10.0.0.



License requirements : nx_lam_comp_adv ("Laminate Composites Advanced")

Parameters
naturalFrequenciesEnablenaturalfrequenciesenable

The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.