NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | List of all members
NXOpen.CAE.AcousticsAndVibrationTblModelParametersAccessor Class Reference

Builds a NXOpen.CAE.AcousticsAndVibrationTblModelParametersAccessor object which allow TBL Model definition. More...

Inheritance diagram for NXOpen.CAE.AcousticsAndVibrationTblModelParametersAccessor:
NXOpen.NXObject NXOpen.TaggedObject NXOpen.INXObject NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  AsType {
  RobertCorcos, Efimtsov, Goody, Smolyakov,
  CockburnRobertson, SmolyakovTkachenko, ChaseHowe, UserDefined
}
 Auto-spectrum type More...
 
enum  CsType { Corcos, Efimtsov, Chase, UserDefined }
 Correlation spectrum type More...
 
- Public Types inherited from NXOpen.NXObject
enum  AttributeType {
  Invalid, Null, Boolean, Integer,
  Real, String, Time, Reference,
  Any = 100
}
 Specifies attribute type. More...
 
enum  DateAndTimeFormat { Numeric, Textual }
 Specifies the format of the date and time attribute. More...
 

Public Member Functions

unsafe void GetNthUserDefinedExpression (int expressionIndex, out string expressionName, out NXOpen.Expression userExpression)
 The nth user defined expressions from the provided DLL. More...
 
unsafe int GetNumUserDefinedExpressions ()
 The number of user defined expressions when a user defined DLL is provided. More...
 
unsafe void LoadUserDefinedDll ()
 Load the user defined DLL that provides custom parameters for the TBL Model More...
 
- Public Member Functions inherited from NXOpen.NXObject
unsafe NXOpen.AttributeIterator CreateAttributeIterator ()
 Create an attribute iterator More...
 
unsafe void DeleteAllAttributesByType (NXOpen.NXObject.AttributeType type)
 Deletes all attributes of a specific type. More...
 
unsafe void DeleteAllAttributesByType (NXOpen.NXObject.AttributeType type, NXOpen.Update.Option option)
 Deletes all attributes of a specific type with the option to update or not. More...
 
unsafe void DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title)
 Deletes an attribute by type and title. More...
 
unsafe void DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title, NXOpen.Update.Option option)
 Deletes an attribute by type and title with the option to update or not. More...
 
unsafe void DeleteUserAttribute (NXOpen.NXObject.AttributeType type, string title, bool deleteEntireArray, NXOpen.Update.Option option)
 Deletes the first attribute encountered with the given Type, Title. More...
 
unsafe void DeleteUserAttributes (NXOpen.AttributeIterator iterator, NXOpen.Update.Option option)
 Deletes the attributes on the object, if any, that satisfy the given iterator More...
 
unsafe void DeleteUserAttributes (NXOpen.NXObject.AttributeType type, NXOpen.Update.Option option)
 Deletes the attributes encountered with the given Type with option to update or not. More...
 
unsafe NXOpen.INXObject FindObject (string journalIdentifier)
 Finds the NXOpen.NXObject with the given identifier as recorded in a journal. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetAttributeTitlesByType (NXOpen.NXObject.AttributeType type)
 Gets all the attribute titles of a specific type. More...
 
unsafe bool GetBooleanUserAttribute (string title, int index)
 Gets a boolean attribute by Title and array Index. More...
 
unsafe
NXOpen.NXObject.ComputationalTime 
GetComputationalTimeUserAttribute (string title, int index)
 Gets a time attribute by Title and array Index. More...
 
unsafe int GetIntegerAttribute (string title)
 Gets an integer attribute by title. More...
 
unsafe int GetIntegerUserAttribute (string title, int index)
 Gets an integer attribute by Title and array Index. More...
 
unsafe bool GetNextUserAttribute (NXOpen.AttributeIterator iterator, out NXOpen.NXObject.AttributeInformation info)
 Gets the next attribute encountered on the object, if any, that satisfies the given iterator. More...
 
unsafe string GetPdmReferenceAttributeValue (string attributeTitle)
 Gets the value of PDM Reference attribute for given object. More...
 
unsafe double GetRealAttribute (string title)
 Gets a real attribute by title. More...
 
unsafe double GetRealUserAttribute (string title, int index)
 Gets a real attribute by Title and array Index. More...
 
unsafe string GetReferenceAttribute (string title)
 Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More...
 
unsafe string GetStringAttribute (string title)
 Gets a string attribute value by title. More...
 
unsafe string GetStringUserAttribute (string title, int index)
 Gets a string attribute by Title and array Index. More...
 
unsafe string GetTimeAttribute (NXOpen.NXObject.DateAndTimeFormat format, string title)
 Gets a time attribute by title. More...
 
unsafe string GetTimeUserAttribute (string title, int index)
 Gets a time attribute by Title and array Index. More...
 
unsafe
NXOpen.NXObject.AttributeInformation 
GetUserAttribute (string title, NXOpen.NXObject.AttributeType type, int index)
 Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttribute (string title, bool includeUnset, bool addStringValues, NXOpen.NXObject.AttributeType type)
 Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More...
 
unsafe string GetUserAttributeAsString (string title, NXOpen.NXObject.AttributeType type, int index)
 Gets the first attribute encountered on the object, if any, with a given title, type and array index. More...
 
unsafe int GetUserAttributeCount (NXOpen.AttributeIterator iterator)
 Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...
 
unsafe int GetUserAttributeCount (NXOpen.AttributeIterator iterator, bool countArrayAsOneAttribute)
 Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...
 
unsafe int GetUserAttributeCount (NXOpen.NXObject.AttributeType type)
 Gets the count of set attributes on the object, if any, of the given type. More...
 
unsafe int GetUserAttributeCount (NXOpen.NXObject.AttributeType type, bool includeUnset, bool countArrayAsOneAttribute)
 Gets the count of attributes on the object, if any, of the given type. More...
 
unsafe bool GetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type)
 Determine the lock of the given attribute. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttributes (NXOpen.AttributeIterator iterator)
 Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttributes ()
 Gets all the attributes that have been set on the given object. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttributes (bool includeUnset)
 Gets all the attributes of the given object. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttributes (bool includeUnset, bool addStringValues)
 Gets all the attributes of the given object. More...
 
unsafe string[] GetUserAttributesAsStrings ()
 Gets all the attributes that have been set on the given object. More...
 
unsafe int GetUserAttributeSize (string title, NXOpen.NXObject.AttributeType type)
 Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More...
 
unsafe NXOpen.NXObject[] GetUserAttributeSourceObjects ()
 Returns an array of objects from which this object presents attributes. More...
 
unsafe bool HasUserAttribute (NXOpen.AttributeIterator iterator)
 Determines if an attribute exists on the object, that satisfies the given iterator More...
 
unsafe bool HasUserAttribute (string title, NXOpen.NXObject.AttributeType type, int index)
 Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More...
 
unsafe void Print ()
 Prints a representation of this object to the system log file. More...
 
unsafe void SetAttribute (string title, int value)
 Creates or modifies an integer attribute. More...
 
unsafe void SetAttribute (string title, int value, NXOpen.Update.Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
unsafe void SetAttribute (string title, double value)
 Creates or modifies a real attribute. More...
 
unsafe void SetAttribute (string title, double value, NXOpen.Update.Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
unsafe void SetAttribute (string title, string value)
 Creates or modifies a string attribute. More...
 
unsafe void SetAttribute (string title, string value, NXOpen.Update.Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
unsafe void SetAttribute (string title)
 Creates or modifies a null attribute which is an attribute with a title and no value. More...
 
unsafe void SetAttribute (string title, NXOpen.Update.Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
unsafe void SetBooleanUserAttribute (string title, int index, bool value, NXOpen.Update.Option option)
 Creates or modifies a boolean attribute with the option to update or not. More...
 
unsafe void SetName (string name)
 Sets the custom name of the object. More...
 
unsafe void SetPdmReferenceAttribute (string attributeTitle, string attributeValue)
 Sets the value of PDM Reference attribute on the object. More...
 
unsafe void SetReferenceAttribute (string title, string value)
 Creates or modifies a string attribute which uses a reference string. More...
 
unsafe void SetReferenceAttribute (string title, string value, NXOpen.Update.Option option)
 Creates or modifies a string attribute which uses a reference string, with the option to update or not. More...
 
unsafe void SetTimeAttribute (string title, string value)
 Creates or modifies a time attribute. More...
 
unsafe void SetTimeAttribute (string title, string value, NXOpen.Update.Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
unsafe void SetTimeUserAttribute (string title, int index, string value, NXOpen.Update.Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
unsafe void SetTimeUserAttribute (string title, int index, NXOpen.NXObject.ComputationalTime value, NXOpen.Update.Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (NXOpen.NXObject.AttributeInformation info, NXOpen.Update.Option option)
 Creates or modifies an attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (string title, int index, int value, NXOpen.Update.Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (string title, int index, double value, NXOpen.Update.Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (string title, int index, string value, NXOpen.Update.Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (string title, int index, NXOpen.Update.Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
unsafe void SetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type, bool @lock)
 Lock or unlock the given attribute. More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

unsafe NXOpen.Fields.FieldWrapper AutoSpectrumField [get, set]
 Returns or sets the auto spectrum field More...
 
unsafe
NXOpen.CAE.AcousticsAndVibrationTblModelParametersAccessor.AsType 
AutoSpectrumType [get, set]
 Returns or sets the auto spectrum More...
 
unsafe NXOpen.Expression BoundaryLayerThicknessParam [get]
 Returns the boundary layer thickness parameter More...
 
unsafe NXOpen.Expression ConvectiveVelocityXParam [get]
 Returns the convective velocity X parameter More...
 
unsafe NXOpen.Expression ConvectiveVelocityYParam [get]
 Returns the convective velocity Y parameter More...
 
unsafe NXOpen.Expression ConvectiveVelocityZParam [get]
 Returns the convective velocity Z parameter More...
 
unsafe NXOpen.Expression CorrelationDecayRateAlphaParam [get]
 Returns the correlation decay rate (alpha) parameter More...
 
unsafe NXOpen.Expression CorrelationDecayRateBetaParam [get]
 Returns the correlation decay rate (beta) parameter More...
 
unsafe
NXOpen.CAE.AcousticsAndVibrationTblModelParametersAccessor.CsType 
CorrelationSpectrumType [get, set]
 Returns or sets the correlation spectrum More...
 
unsafe string CorrelationSpectrumUserDLL [get, set]
 Returns or sets the correlation spectrum user dll More...
 
unsafe NXOpen.Expression DisplacementThicknessParam [get]
 Returns the displacement thickness parameter More...
 
unsafe NXOpen.Expression FluidDensityParam [get]
 Returns the fluid density parameter More...
 
unsafe NXOpen.Expression FluidOuterVelocityParam [get]
 Returns the fluid outer velocity parameter More...
 
unsafe NXOpen.Expression FluidViscosityParam [get]
 Returns the fluid viscosity parameter More...
 
unsafe NXOpen.Expression MomentumThicknessParam [get]
 Returns the momentum thickness parameter More...
 
unsafe NXOpen.Expression SoundSpeedParam [get]
 Returns the sound speed parameter More...
 
unsafe NXOpen.Expression WallFrictionVelocityParam [get]
 Returns the wall friction velocity parameter More...
 
unsafe NXOpen.Expression WallShearStressParam [get]
 Returns the wall shear stress parameter More...
 
- Properties inherited from NXOpen.NXObject
unsafe bool IsOccurrence [get]
 Returns whether this object is an occurrence or not. More...
 
unsafe string JournalIdentifier [get]
 Returns the identifier that would be recorded in a journal for this object. More...
 
unsafe string Name [get]
 Returns the custom name of the object. More...
 
unsafe NXOpen.Assemblies.Component OwningComponent [get]
 Returns the owning component, if this object is an occurrence. More...
 
unsafe NXOpen.BasePart OwningPart [get]
 Returns the owning part of this object More...
 
unsafe NXOpen.INXObject Prototype [get]
 Returns the prototype of this object if it is an occurrence. More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 
- Properties inherited from NXOpen.INXObject
bool IsOccurrence [get]
 Returns whether this object is an occurrence or not. More...
 
string JournalIdentifier [get]
 Returns the identifier that would be recorded in a journal for this object. More...
 
string Name [get]
 Returns the custom name of the object. More...
 
NXOpen.Assemblies.Component OwningComponent [get]
 Returns the owning component, if this object is an occurrence. More...
 
NXOpen.BasePart OwningPart [get]
 Returns the owning part of this object More...
 
NXOpen.INXObject Prototype [get]
 Returns the prototype of this object if it is an occurrence. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

Builds a NXOpen.CAE.AcousticsAndVibrationTblModelParametersAccessor object which allow TBL Model definition.

There is no kf creator for this.

Created in NX1872.0.0

Member Enumeration Documentation

Auto-spectrum type

Enumerator
RobertCorcos 
Efimtsov 
Goody 
Smolyakov 
CockburnRobertson 
SmolyakovTkachenko 
ChaseHowe 
UserDefined 

Correlation spectrum type

Enumerator
Corcos 
Efimtsov 
Chase 
UserDefined 

Member Function Documentation

unsafe void NXOpen.CAE.AcousticsAndVibrationTblModelParametersAccessor.GetNthUserDefinedExpression ( int  expressionIndex,
out string  expressionName,
out NXOpen.Expression  userExpression 
)
inline

The nth user defined expressions from the provided DLL.

If there is no provided DLL or the expresson index is out of range then a NULL expressions is provided.

Created in NX1872.0.0

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

Parameters
expressionIndex
expressionName
userExpression
unsafe int NXOpen.CAE.AcousticsAndVibrationTblModelParametersAccessor.GetNumUserDefinedExpressions ( )
inline

The number of user defined expressions when a user defined DLL is provided.

If there is no user defined DLL then this returns 0.

Created in NX1872.0.0

License requirements: None.

Returns
unsafe void NXOpen.CAE.AcousticsAndVibrationTblModelParametersAccessor.LoadUserDefinedDll ( )
inline

Load the user defined DLL that provides custom parameters for the TBL Model

Created in NX1872.0.0

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

Property Documentation

unsafe NXOpen.Fields.FieldWrapper NXOpen.CAE.AcousticsAndVibrationTblModelParametersAccessor.AutoSpectrumField
getset

Returns or sets the auto spectrum field

Created in NX1872.0.0

License requirements to get this property: None.

License requirements to set this property: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

unsafe NXOpen.CAE.AcousticsAndVibrationTblModelParametersAccessor.AsType NXOpen.CAE.AcousticsAndVibrationTblModelParametersAccessor.AutoSpectrumType
getset

Returns or sets the auto spectrum

Created in NX1872.0.0

License requirements to get this property: None.

License requirements to set this property: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

unsafe NXOpen.Expression NXOpen.CAE.AcousticsAndVibrationTblModelParametersAccessor.BoundaryLayerThicknessParam
get

Returns the boundary layer thickness parameter

Created in NX1872.0.0

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

unsafe NXOpen.Expression NXOpen.CAE.AcousticsAndVibrationTblModelParametersAccessor.ConvectiveVelocityXParam
get

Returns the convective velocity X parameter

Created in NX1872.0.0

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

unsafe NXOpen.Expression NXOpen.CAE.AcousticsAndVibrationTblModelParametersAccessor.ConvectiveVelocityYParam
get

Returns the convective velocity Y parameter

Created in NX1872.0.0

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

unsafe NXOpen.Expression NXOpen.CAE.AcousticsAndVibrationTblModelParametersAccessor.ConvectiveVelocityZParam
get

Returns the convective velocity Z parameter

Created in NX1872.0.0

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

unsafe NXOpen.Expression NXOpen.CAE.AcousticsAndVibrationTblModelParametersAccessor.CorrelationDecayRateAlphaParam
get

Returns the correlation decay rate (alpha) parameter

Created in NX1872.0.0

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

unsafe NXOpen.Expression NXOpen.CAE.AcousticsAndVibrationTblModelParametersAccessor.CorrelationDecayRateBetaParam
get

Returns the correlation decay rate (beta) parameter

Created in NX1872.0.0

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

unsafe NXOpen.CAE.AcousticsAndVibrationTblModelParametersAccessor.CsType NXOpen.CAE.AcousticsAndVibrationTblModelParametersAccessor.CorrelationSpectrumType
getset

Returns or sets the correlation spectrum

Created in NX1872.0.0

License requirements to get this property: None.

License requirements to set this property: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

unsafe string NXOpen.CAE.AcousticsAndVibrationTblModelParametersAccessor.CorrelationSpectrumUserDLL
getset

Returns or sets the correlation spectrum user dll

Created in NX1872.0.0

License requirements to get this property: None.

License requirements to set this property: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

unsafe NXOpen.Expression NXOpen.CAE.AcousticsAndVibrationTblModelParametersAccessor.DisplacementThicknessParam
get

Returns the displacement thickness parameter

Created in NX1872.0.0

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

unsafe NXOpen.Expression NXOpen.CAE.AcousticsAndVibrationTblModelParametersAccessor.FluidDensityParam
get

Returns the fluid density parameter

Created in NX1872.0.0

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

unsafe NXOpen.Expression NXOpen.CAE.AcousticsAndVibrationTblModelParametersAccessor.FluidOuterVelocityParam
get

Returns the fluid outer velocity parameter

Created in NX1872.0.0

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

unsafe NXOpen.Expression NXOpen.CAE.AcousticsAndVibrationTblModelParametersAccessor.FluidViscosityParam
get

Returns the fluid viscosity parameter

Created in NX1872.0.0

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

unsafe NXOpen.Expression NXOpen.CAE.AcousticsAndVibrationTblModelParametersAccessor.MomentumThicknessParam
get

Returns the momentum thickness parameter

Created in NX1872.0.0

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

unsafe NXOpen.Expression NXOpen.CAE.AcousticsAndVibrationTblModelParametersAccessor.SoundSpeedParam
get

Returns the sound speed parameter

Created in NX1872.0.0

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

unsafe NXOpen.Expression NXOpen.CAE.AcousticsAndVibrationTblModelParametersAccessor.WallFrictionVelocityParam
get

Returns the wall friction velocity parameter

Created in NX1872.0.0

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

unsafe NXOpen.Expression NXOpen.CAE.AcousticsAndVibrationTblModelParametersAccessor.WallShearStressParam
get

Returns the wall shear stress parameter

Created in NX1872.0.0

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


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