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

Represents a Motion::AnalyticalContactProperty builder
To create a new instance of this class, use NXOpen::Motion::AnalyticalContactPropertyCollection::CreateAnalyticalContactPropertyBuilder
Default values. More...

Inheritance diagram for NXOpen::Motion::AnalyticalContactPropertyBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  DampingType {
  DampingTypeExpression, DampingTypeFunction, DampingTypeProfile, DampingTypeExpressionAndFunction,
  DampingTypeExpressionAndProfile
}
 Damping Type. More...
 
enum  FrictionCoefficientType { FrictionCoefficientTypeExpression, FrictionCoefficientTypeFunction, FrictionCoefficientTypeProfile }
 Friction Coefficient Type. More...
 
enum  StiffnessType {
  StiffnessTypeExpression, StiffnessTypeFunction, StiffnessTypeProfile, StiffnessTypeExpressionAndFunction,
  StiffnessTypeExpressionAndProfile
}
 Stiffness Type. More...
 

Public Member Functions

NXOpen::Motion::MotionFunctionDampingCurve ()
 Returns the damping function
Created in NX12.0.0. More...
 
NXOpen::Motion::AnalyticalContactPropertyBuilder::DampingType DampingOption ()
 Returns the damping type. More...
 
NXOpen::Motion::SelectFieldDataDampingProfile ()
 Returns the damping Profile. More...
 
NXOpen::ExpressionDampingValue ()
 Returns the damping value
Created in NX12.0.0. More...
 
NXOpen::Motion::CustomizedMaterialBuilderFirstCustomizedMaterial ()
 Returns the first customized material
Created in NX12.0.0. More...
 
NXOpen::Motion::MotionFunctionFrictionCoefficientCurve ()
 Returns the friction coefficient function
Created in NX12.0.0. More...
 
NXOpen::Motion::AnalyticalContactPropertyBuilder::FrictionCoefficientType FrictionCoefficientOption ()
 Returns the friction coefficient option
Created in NX12.0.0. More...
 
NXOpen::Motion::SelectFieldDataFrictionCoefficientProfile ()
 Returns the friction coefficient Profile. More...
 
NXOpen::ExpressionFrictionCoefficientValue ()
 Returns the friction coefficient value
Created in NX12.0.0. More...
 
NXString Name ()
 Returns the name
Created in NX12.0.0. More...
 
NXOpen::ExpressionRestitutionCoefficient ()
 Returns the restitution coefficient
Created in NX12.0.0. More...
 
NXOpen::Motion::CustomizedMaterialBuilderSecondCustomizedMaterial ()
 Returns the second customized material
Created in NX12.0.0. More...
 
void SetDampingCurve (NXOpen::Motion::MotionFunction *dampingCurve)
 Sets the damping function
Created in NX12.0.0. More...
 
void SetDampingOption (NXOpen::Motion::AnalyticalContactPropertyBuilder::DampingType type)
 Sets the damping type. More...
 
void SetFrictionCoefficientCurve (NXOpen::Motion::MotionFunction *frictionCoefficient)
 Sets the friction coefficient function
Created in NX12.0.0. More...
 
void SetFrictionCoefficientOption (NXOpen::Motion::AnalyticalContactPropertyBuilder::FrictionCoefficientType frictionCoefficient)
 Sets the friction coefficient option
Created in NX12.0.0. More...
 
void SetName (const NXString &name)
 Sets the name
Created in NX12.0.0. More...
 
void SetName (const char *name)
 Sets the name
Created in NX12.0.0. More...
 
void SetStiffnessCurve (NXOpen::Motion::MotionFunction *stiffnessCurve)
 Sets the stiffness function
Created in NX12.0.0. More...
 
void SetStiffnessOption (NXOpen::Motion::AnalyticalContactPropertyBuilder::StiffnessType type)
 Sets the stiffness type. More...
 
NXOpen::Motion::MotionFunctionStiffnessCurve ()
 Returns the stiffness function
Created in NX12.0.0. More...
 
NXOpen::Motion::AnalyticalContactPropertyBuilder::StiffnessType StiffnessOption ()
 Returns the stiffness type. More...
 
NXOpen::Motion::SelectFieldDataStiffnessProfile ()
 Returns the stiffness Profile. More...
 
NXOpen::ExpressionStiffnessValue ()
 Returns the stiffness value
Created in NX12.0.0. More...
 
NXOpen::ExpressionTransitionVelocity ()
 Returns the transition velocity
Created in NX12.0.0. 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 Motion::AnalyticalContactProperty builder
To create a new instance of this class, use NXOpen::Motion::AnalyticalContactPropertyCollection::CreateAnalyticalContactPropertyBuilder
Default values.

Property Value

DampingValue.Value

0 (millimeters part), 0 (inches part)

FirstCustomizedMaterial.Density.Value

7.8e-6 (millimeters part), 7.3e-4 (inches part)

FirstCustomizedMaterial.PoissonRatio.Value

0.3

FirstCustomizedMaterial.YoungModulus.Value

2e+8 (millimeters part), 2.9e+7 (inches part)

FrictionCoefficientOption

Expression

FrictionCoefficientValue.Value

0

RestitutionCoefficient.Value

1

StiffnessValue.Value

0 (millimeters part), 0 (inches part)

TransitionVelocity.Value

10 (millimeters part), 0.393701 (inches part)


Created in NX12.0.0.

Member Enumeration Documentation

Damping Type.

Enumerator
DampingTypeExpression 

expression

DampingTypeFunction 

function

DampingTypeProfile 

profile

DampingTypeExpressionAndFunction 

expression and function

DampingTypeExpressionAndProfile 

expression and profile

Friction Coefficient Type.

Enumerator
FrictionCoefficientTypeExpression 

expression

FrictionCoefficientTypeFunction 

function

FrictionCoefficientTypeProfile 

profile

Stiffness Type.

Enumerator
StiffnessTypeExpression 

expression

StiffnessTypeFunction 

function

StiffnessTypeProfile 

profile

StiffnessTypeExpressionAndFunction 

expression and function

StiffnessTypeExpressionAndProfile 

expression and profile

Member Function Documentation

NXOpen::Motion::MotionFunction* NXOpen::Motion::AnalyticalContactPropertyBuilder::DampingCurve ( )

Returns the damping function
Created in NX12.0.0.



License requirements : None

NXOpen::Motion::AnalyticalContactPropertyBuilder::DampingType NXOpen::Motion::AnalyticalContactPropertyBuilder::DampingOption ( )

Returns the damping type.


Created in NX12.0.0.

License requirements : None

NXOpen::Motion::SelectFieldData* NXOpen::Motion::AnalyticalContactPropertyBuilder::DampingProfile ( )

Returns the damping Profile.


Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::AnalyticalContactPropertyBuilder::DampingValue ( )

Returns the damping value
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::CustomizedMaterialBuilder* NXOpen::Motion::AnalyticalContactPropertyBuilder::FirstCustomizedMaterial ( )

Returns the first customized material
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::MotionFunction* NXOpen::Motion::AnalyticalContactPropertyBuilder::FrictionCoefficientCurve ( )

Returns the friction coefficient function
Created in NX12.0.0.



License requirements : None

NXOpen::Motion::AnalyticalContactPropertyBuilder::FrictionCoefficientType NXOpen::Motion::AnalyticalContactPropertyBuilder::FrictionCoefficientOption ( )

Returns the friction coefficient option
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::SelectFieldData* NXOpen::Motion::AnalyticalContactPropertyBuilder::FrictionCoefficientProfile ( )

Returns the friction coefficient Profile.


Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::AnalyticalContactPropertyBuilder::FrictionCoefficientValue ( )

Returns the friction coefficient value
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

NXString NXOpen::Motion::AnalyticalContactPropertyBuilder::Name ( )

Returns the name
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::AnalyticalContactPropertyBuilder::RestitutionCoefficient ( )

Returns the restitution coefficient
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::CustomizedMaterialBuilder* NXOpen::Motion::AnalyticalContactPropertyBuilder::SecondCustomizedMaterial ( )

Returns the second customized material
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

void NXOpen::Motion::AnalyticalContactPropertyBuilder::SetDampingCurve ( NXOpen::Motion::MotionFunction dampingCurve)

Sets the damping function
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
dampingCurvedampingcurve
void NXOpen::Motion::AnalyticalContactPropertyBuilder::SetDampingOption ( NXOpen::Motion::AnalyticalContactPropertyBuilder::DampingType  type)

Sets the damping type.


Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
typetype
void NXOpen::Motion::AnalyticalContactPropertyBuilder::SetFrictionCoefficientCurve ( NXOpen::Motion::MotionFunction frictionCoefficient)

Sets the friction coefficient function
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
frictionCoefficientfrictioncoefficient
void NXOpen::Motion::AnalyticalContactPropertyBuilder::SetFrictionCoefficientOption ( NXOpen::Motion::AnalyticalContactPropertyBuilder::FrictionCoefficientType  frictionCoefficient)

Sets the friction coefficient option
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
frictionCoefficientfrictioncoefficient
void NXOpen::Motion::AnalyticalContactPropertyBuilder::SetName ( const NXString name)

Sets the name
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
namename
void NXOpen::Motion::AnalyticalContactPropertyBuilder::SetName ( const char *  name)

Sets the name
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
namename
void NXOpen::Motion::AnalyticalContactPropertyBuilder::SetStiffnessCurve ( NXOpen::Motion::MotionFunction stiffnessCurve)

Sets the stiffness function
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
stiffnessCurvestiffnesscurve
void NXOpen::Motion::AnalyticalContactPropertyBuilder::SetStiffnessOption ( NXOpen::Motion::AnalyticalContactPropertyBuilder::StiffnessType  type)

Sets the stiffness type.


Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
typetype
NXOpen::Motion::MotionFunction* NXOpen::Motion::AnalyticalContactPropertyBuilder::StiffnessCurve ( )

Returns the stiffness function
Created in NX12.0.0.



License requirements : None

NXOpen::Motion::AnalyticalContactPropertyBuilder::StiffnessType NXOpen::Motion::AnalyticalContactPropertyBuilder::StiffnessOption ( )

Returns the stiffness type.


Created in NX12.0.0.

License requirements : None

NXOpen::Motion::SelectFieldData* NXOpen::Motion::AnalyticalContactPropertyBuilder::StiffnessProfile ( )

Returns the stiffness Profile.


Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::AnalyticalContactPropertyBuilder::StiffnessValue ( )

Returns the stiffness value
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::AnalyticalContactPropertyBuilder::TransitionVelocity ( )

Returns the transition velocity
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")


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