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

Represents a NXOpen::Features::SectionInertiaAnalysis builder
To create a new instance of this class, use NXOpen::Features::FeatureCollection::CreateSectionInertiaAnalysisBuilder
Default values. More...

Inheritance diagram for NXOpen::Features::SectionInertiaAnalysisBuilder:
NXOpen::Features::FeatureBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  CoordSys { CoordSysAbsolute, CoordSysCurrentWCS }
 The coordinate system associated with the analysis. More...
 
enum  PropertyType { PropertyTypeHollow, PropertyTypeSolid }
 Type of Analysis property. More...
 
enum  SampleMethod { SampleMethodByDistance, SampleMethodByNumber }
 Type of sampling method to be used in sections along curve type of analysis. More...
 
enum  SectionAxisNormal { SectionAxisNormalXc, SectionAxisNormalYc, SectionAxisNormalZc }
 Slice direction in case of parallel section type of analysis. More...
 
enum  Types { TypesParallelSections, TypesSectionsAlongCurve, TypesExistingSection }
 The type of Section Inertia Analysis to be performed. More...
 

Public Member Functions

int AnnoLayer ()
 Returns the anno layer
Created in NX5.0.0. More...
 
bool CenterOfGravity ()
 Returns the center of gravity
Created in NX5.0.0. More...
 
NXOpen::Features::SectionInertiaAnalysisBuilder::CoordSys CSys ()
 Returns the c sys
Created in NX5.0.0. More...
 
NXOpen::SectionCurveCollector ()
 Returns the curve collector
Created in NX5.0.0. More...
 
int DatumPlaneLayer ()
 Returns the datum plane layer
Created in NX5.0.0. More...
 
bool DatumPlanes ()
 Returns the datum planes
Created in NX5.0.0. More...
 
NXOpen::ExpressionDistance ()
 Returns the distance
Created in NX5.0.0. More...
 
NXOpen::ScCollectorFaceCollector ()
 Returns the face collector
Created in NX5.0.0. More...
 
std::vector
< NXOpen::Annotations::PmiNote * > 
GetAnnotation ()
 The annotations generated can be accessed using this method. More...
 
bool IsTempGraphics ()
 The function checks if temporary graphics was generated. More...
 
NXOpen::Features::SectionInertiaAnalysisBuilder::PropertyType MassPropertyType ()
 Returns the mass property type
Created in NX5.0.0. More...
 
int NSection ()
 Returns the n section
Created in NX5.0.0. More...
 
NXOpen::SectionPathCollector ()
 Returns the path collector
Created in NX5.0.0. More...
 
bool PrincipalAxes ()
 Returns the principal axes
Created in NX5.0.0. More...
 
int RectangleLayer ()
 Returns the rectangle layer
Created in NX5.0.0. More...
 
bool RectangularSection ()
 Returns the rectangular section
Created in NX5.0.0. More...
 
void RefreshScreen ()
 The function refreshes the graphic screen if any temporary graphics was previously generated by this command. More...
 
bool SecondPrincipleMi ()
 Returns the second principle mi
Created in NX5.0.0. More...
 
bool SectionArea ()
 Returns the section area
Created in NX5.0.0. More...
 
NXOpen::Features::SectionInertiaAnalysisBuilder::SampleMethod SectioningMethod ()
 Returns the sectioning method
Created in NX5.0.0. More...
 
int SectionLayer ()
 Returns the section layer
Created in NX5.0.0. More...
 
bool SectionLength ()
 Returns the section length
Created in NX5.0.0. More...
 
NXOpen::Features::SectionInertiaAnalysisBuilder::SectionAxisNormal SectionNormal ()
 Returns the section normal
Created in NX5.0.0. More...
 
bool Sections ()
 Returns the sections
Created in NX5.0.0. More...
 
void SetAnnoLayer (int annoLayer)
 Sets the anno layer
Created in NX5.0.0. More...
 
void SetCenterOfGravity (bool centerOfGravity)
 Sets the center of gravity
Created in NX5.0.0. More...
 
void SetCSys (NXOpen::Features::SectionInertiaAnalysisBuilder::CoordSys csys)
 Sets the c sys
Created in NX5.0.0. More...
 
void SetDatumPlaneLayer (int datumPlaneLayer)
 Sets the datum plane layer
Created in NX5.0.0. More...
 
void SetDatumPlanes (bool datumPlanes)
 Sets the datum planes
Created in NX5.0.0. More...
 
void SetMassPropertyType (NXOpen::Features::SectionInertiaAnalysisBuilder::PropertyType massPropertyType)
 Sets the mass property type
Created in NX5.0.0. More...
 
void SetNSection (int nSection)
 Sets the n section
Created in NX5.0.0. More...
 
void SetPrincipalAxes (bool principalAxes)
 Sets the principal axes
Created in NX5.0.0. More...
 
void SetRectangleLayer (int rectangleLayer)
 Sets the rectangle layer
Created in NX5.0.0. More...
 
void SetRectangularSection (bool rectangularSection)
 Sets the rectangular section
Created in NX5.0.0. More...
 
void SetSecondPrincipleMi (bool secondPrincipleMI)
 Sets the second principle mi
Created in NX5.0.0. More...
 
void SetSectionArea (bool sectionArea)
 Sets the section area
Created in NX5.0.0. More...
 
void SetSectioningMethod (NXOpen::Features::SectionInertiaAnalysisBuilder::SampleMethod sectioningMethod)
 Sets the sectioning method
Created in NX5.0.0. More...
 
void SetSectionLayer (int sectionLayer)
 Sets the section layer
Created in NX5.0.0. More...
 
void SetSectionLength (bool sectionLength)
 Sets the section length
Created in NX5.0.0. More...
 
void SetSectionNormal (NXOpen::Features::SectionInertiaAnalysisBuilder::SectionAxisNormal sectionNormal)
 Sets the section normal
Created in NX5.0.0. More...
 
void SetSections (bool sections)
 Sets the sections
Created in NX5.0.0. More...
 
void SetShearCenter (bool shearCenter)
 Sets the shear center
Created in NX5.0.0. More...
 
void SetType (NXOpen::Features::SectionInertiaAnalysisBuilder::Types type)
 Sets the analysis
Created in NX5.0.0. More...
 
void SetUnits (int units)
 Sets the units for calculations
Created in NX5.0.0. More...
 
void SetValidityFlag (bool validityFlag)
 Sets the validity flag. More...
 
bool ShearCenter ()
 Returns the shear center
Created in NX5.0.0. More...
 
void ShowInfo ()
 The function displays the information box with information about the section intertia analysis performed. More...
 
NXOpen::ExpressionThickness ()
 Returns the thickness. More...
 
NXOpen::Features::SectionInertiaAnalysisBuilder::Types Type ()
 Returns the analysis
Created in NX5.0.0. More...
 
int Units ()
 Returns the units for calculations
Created in NX5.0.0. More...
 
bool ValidityFlag ()
 Returns the validity flag. More...
 
- Public Member Functions inherited from NXOpen::Features::FeatureBuilder
NXOpen::Features::FeatureCommitFeature ()
 Commits the feature parameters and creates the feature. More...
 
NXOpen::Features::FeatureGetFeature ()
 Returns the feature currently being edited by this builder. More...
 
void HideInternalParentFeatureAfterEdit (NXOpen::Features::Feature *parentFeature)
 Re-suppress an internal parent feature (a slave feature) after it has been edited. More...
 
bool ParentFeatureInternal ()
 Returns whether or not the latest timestamped parent feature of this feature should be made internal
Created in NX5.0.0. More...
 
bool PatchSolutionFlag ()
 Returns the patch solution flag
Created in NX8.0.1. More...
 
NXString PatchSurfaceFilename ()
 Returns the patch surface filename
Created in NX8.0.1. More...
 
void SetParentFeatureInternal (NXOpen::Features::Feature *parentFeature)
 Set the parent features which would be internal or slaves to the feature being created or commited
Created in NX6.0.0. More...
 
void SetParentFeatureInternal (bool isInternal)
 Sets whether or not the latest timestamped parent feature of this feature should be made internal
Created in NX5.0.0. More...
 
void SetPatchSolutionFlag (bool optionValue)
 Sets the patch solution flag
Created in NX8.0.1. More...
 
void SetPatchSurfaceFilename (const NXString &surfaceFilename)
 Sets the patch surface filename
Created in NX8.0.1. More...
 
void SetPatchSurfaceFilename (const char *surfaceFilename)
 Sets the patch surface filename
Created in NX8.0.1. More...
 
void SetSurroundingPatchSurfaceFilename (const NXString &surroundingSurfaceFilename)
 Sets the surrounding patch surface filename
Created in NX8.0.1. More...
 
void SetSurroundingPatchSurfaceFilename (const char *surroundingSurfaceFilename)
 Sets the surrounding patch surface filename
Created in NX8.0.1. More...
 
void ShowInternalParentFeatureForEdit (NXOpen::Features::Feature *parentFeature)
 Unsuppress an internal parent feature (a slave feature) so it can be edited. More...
 
NXString SurroundingPatchSurfaceFilename ()
 Returns the surrounding patch surface filename
Created in NX8.0.1. More...
 
void UnsetParentFeatureInternal (NXOpen::Features::Feature *parentFeature)
 Set the internal parent feature of the feature being edited to external
Created in NX6.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 NXOpen::Features::SectionInertiaAnalysis builder
To create a new instance of this class, use NXOpen::Features::FeatureCollection::CreateSectionInertiaAnalysisBuilder
Default values.

Property Value

AnnoLayer

101

CenterOfGravity

True

DatumPlaneLayer

101

DatumPlanes

False

NSection

5

PrincipalAxes

False

RectangleLayer

101

RectangularSection

False

SecondPrincipleMi

True

SectionArea

True

SectionLayer

101

SectionLength

True

Sections

False

ShearCenter

False


Created in NX5.0.0.

Member Enumeration Documentation

The coordinate system associated with the analysis.

Enumerator
CoordSysAbsolute 

Absolute Coordinate System.

CoordSysCurrentWCS 

World Coordinate System.

Type of Analysis property.

Enumerator
PropertyTypeHollow 

Hollow analysis.

PropertyTypeSolid 

Solid analysis.

Type of sampling method to be used in sections along curve type of analysis.

Enumerator
SampleMethodByDistance 

Sample according to Distance.

SampleMethodByNumber 

Sample according to Number of slices.

Slice direction in case of parallel section type of analysis.

Enumerator
SectionAxisNormalXc 

Along X Axis.

SectionAxisNormalYc 

Along Y Axis.

SectionAxisNormalZc 

Along Z Axis.

The type of Section Inertia Analysis to be performed.

Enumerator
TypesParallelSections 

Parallel Sections Type.

TypesSectionsAlongCurve 

Sections Along Path Type.

TypesExistingSection 

Existing Section Type.

Member Function Documentation

int NXOpen::Features::SectionInertiaAnalysisBuilder::AnnoLayer ( )

Returns the anno layer
Created in NX5.0.0.



License requirements : None

bool NXOpen::Features::SectionInertiaAnalysisBuilder::CenterOfGravity ( )

Returns the center of gravity
Created in NX5.0.0.



License requirements : None

NXOpen::Features::SectionInertiaAnalysisBuilder::CoordSys NXOpen::Features::SectionInertiaAnalysisBuilder::CSys ( )

Returns the c sys
Created in NX5.0.0.



License requirements : None

NXOpen::Section* NXOpen::Features::SectionInertiaAnalysisBuilder::CurveCollector ( )

Returns the curve collector
Created in NX5.0.0.



License requirements : None

int NXOpen::Features::SectionInertiaAnalysisBuilder::DatumPlaneLayer ( )

Returns the datum plane layer
Created in NX5.0.0.



License requirements : None

bool NXOpen::Features::SectionInertiaAnalysisBuilder::DatumPlanes ( )

Returns the datum planes
Created in NX5.0.0.



License requirements : None

NXOpen::Expression* NXOpen::Features::SectionInertiaAnalysisBuilder::Distance ( )

Returns the distance
Created in NX5.0.0.



License requirements : None

NXOpen::ScCollector* NXOpen::Features::SectionInertiaAnalysisBuilder::FaceCollector ( )

Returns the face collector
Created in NX5.0.0.



License requirements : None

std::vector<NXOpen::Annotations::PmiNote *> NXOpen::Features::SectionInertiaAnalysisBuilder::GetAnnotation ( )

The annotations generated can be accessed using this method.

Returns
The annotation notes created. Pass NULL to get only the number.
Created in NX5.0.0.

License requirements : None
bool NXOpen::Features::SectionInertiaAnalysisBuilder::IsTempGraphics ( )

The function checks if temporary graphics was generated.

Returns

Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")
NXOpen::Features::SectionInertiaAnalysisBuilder::PropertyType NXOpen::Features::SectionInertiaAnalysisBuilder::MassPropertyType ( )

Returns the mass property type
Created in NX5.0.0.



License requirements : None

int NXOpen::Features::SectionInertiaAnalysisBuilder::NSection ( )

Returns the n section
Created in NX5.0.0.



License requirements : None

NXOpen::Section* NXOpen::Features::SectionInertiaAnalysisBuilder::PathCollector ( )

Returns the path collector
Created in NX5.0.0.



License requirements : None

bool NXOpen::Features::SectionInertiaAnalysisBuilder::PrincipalAxes ( )

Returns the principal axes
Created in NX5.0.0.



License requirements : None

int NXOpen::Features::SectionInertiaAnalysisBuilder::RectangleLayer ( )

Returns the rectangle layer
Created in NX5.0.0.



License requirements : None

bool NXOpen::Features::SectionInertiaAnalysisBuilder::RectangularSection ( )

Returns the rectangular section
Created in NX5.0.0.



License requirements : None

void NXOpen::Features::SectionInertiaAnalysisBuilder::RefreshScreen ( )

The function refreshes the graphic screen if any temporary graphics was previously generated by this command.


Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

bool NXOpen::Features::SectionInertiaAnalysisBuilder::SecondPrincipleMi ( )

Returns the second principle mi
Created in NX5.0.0.



License requirements : None

bool NXOpen::Features::SectionInertiaAnalysisBuilder::SectionArea ( )

Returns the section area
Created in NX5.0.0.



License requirements : None

NXOpen::Features::SectionInertiaAnalysisBuilder::SampleMethod NXOpen::Features::SectionInertiaAnalysisBuilder::SectioningMethod ( )

Returns the sectioning method
Created in NX5.0.0.



License requirements : None

int NXOpen::Features::SectionInertiaAnalysisBuilder::SectionLayer ( )

Returns the section layer
Created in NX5.0.0.



License requirements : None

bool NXOpen::Features::SectionInertiaAnalysisBuilder::SectionLength ( )

Returns the section length
Created in NX5.0.0.



License requirements : None

NXOpen::Features::SectionInertiaAnalysisBuilder::SectionAxisNormal NXOpen::Features::SectionInertiaAnalysisBuilder::SectionNormal ( )

Returns the section normal
Created in NX5.0.0.



License requirements : None

bool NXOpen::Features::SectionInertiaAnalysisBuilder::Sections ( )

Returns the sections
Created in NX5.0.0.



License requirements : None

void NXOpen::Features::SectionInertiaAnalysisBuilder::SetAnnoLayer ( int  annoLayer)

Sets the anno layer
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
annoLayerannolayer
void NXOpen::Features::SectionInertiaAnalysisBuilder::SetCenterOfGravity ( bool  centerOfGravity)

Sets the center of gravity
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
centerOfGravitycenterofgravity
void NXOpen::Features::SectionInertiaAnalysisBuilder::SetCSys ( NXOpen::Features::SectionInertiaAnalysisBuilder::CoordSys  csys)

Sets the c sys
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
csyscsys
void NXOpen::Features::SectionInertiaAnalysisBuilder::SetDatumPlaneLayer ( int  datumPlaneLayer)

Sets the datum plane layer
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
datumPlaneLayerdatumplanelayer
void NXOpen::Features::SectionInertiaAnalysisBuilder::SetDatumPlanes ( bool  datumPlanes)

Sets the datum planes
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
datumPlanesdatumplanes
void NXOpen::Features::SectionInertiaAnalysisBuilder::SetMassPropertyType ( NXOpen::Features::SectionInertiaAnalysisBuilder::PropertyType  massPropertyType)

Sets the mass property type
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
massPropertyTypemasspropertytype
void NXOpen::Features::SectionInertiaAnalysisBuilder::SetNSection ( int  nSection)

Sets the n section
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
nSectionnsection
void NXOpen::Features::SectionInertiaAnalysisBuilder::SetPrincipalAxes ( bool  principalAxes)

Sets the principal axes
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
principalAxesprincipalaxes
void NXOpen::Features::SectionInertiaAnalysisBuilder::SetRectangleLayer ( int  rectangleLayer)

Sets the rectangle layer
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
rectangleLayerrectanglelayer
void NXOpen::Features::SectionInertiaAnalysisBuilder::SetRectangularSection ( bool  rectangularSection)

Sets the rectangular section
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
rectangularSectionrectangularsection
void NXOpen::Features::SectionInertiaAnalysisBuilder::SetSecondPrincipleMi ( bool  secondPrincipleMI)

Sets the second principle mi
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
secondPrincipleMIsecondprinciplemi
void NXOpen::Features::SectionInertiaAnalysisBuilder::SetSectionArea ( bool  sectionArea)

Sets the section area
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
sectionAreasectionarea
void NXOpen::Features::SectionInertiaAnalysisBuilder::SetSectioningMethod ( NXOpen::Features::SectionInertiaAnalysisBuilder::SampleMethod  sectioningMethod)

Sets the sectioning method
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
sectioningMethodsectioningmethod
void NXOpen::Features::SectionInertiaAnalysisBuilder::SetSectionLayer ( int  sectionLayer)

Sets the section layer
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
sectionLayersectionlayer
void NXOpen::Features::SectionInertiaAnalysisBuilder::SetSectionLength ( bool  sectionLength)

Sets the section length
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
sectionLengthsectionlength
void NXOpen::Features::SectionInertiaAnalysisBuilder::SetSectionNormal ( NXOpen::Features::SectionInertiaAnalysisBuilder::SectionAxisNormal  sectionNormal)

Sets the section normal
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
sectionNormalsectionnormal
void NXOpen::Features::SectionInertiaAnalysisBuilder::SetSections ( bool  sections)

Sets the sections
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
sectionssections
void NXOpen::Features::SectionInertiaAnalysisBuilder::SetShearCenter ( bool  shearCenter)

Sets the shear center
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
shearCentershearcenter
void NXOpen::Features::SectionInertiaAnalysisBuilder::SetType ( NXOpen::Features::SectionInertiaAnalysisBuilder::Types  type)

Sets the analysis
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
typetype
void NXOpen::Features::SectionInertiaAnalysisBuilder::SetUnits ( int  units)

Sets the units for calculations
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
unitsunits
void NXOpen::Features::SectionInertiaAnalysisBuilder::SetValidityFlag ( bool  validityFlag)

Sets the validity flag.

If the flag is set to false, properties will be recomputed.
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
validityFlagvalidity flag
bool NXOpen::Features::SectionInertiaAnalysisBuilder::ShearCenter ( )

Returns the shear center
Created in NX5.0.0.



License requirements : None

void NXOpen::Features::SectionInertiaAnalysisBuilder::ShowInfo ( )

The function displays the information box with information about the section intertia analysis performed.


Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

NXOpen::Expression* NXOpen::Features::SectionInertiaAnalysisBuilder::Thickness ( )

Returns the thickness.

This attribute is always used in hollow analysis while it is used in solid analysis if any of the loops is open.
Created in NX5.0.0.

License requirements : None

NXOpen::Features::SectionInertiaAnalysisBuilder::Types NXOpen::Features::SectionInertiaAnalysisBuilder::Type ( )

Returns the analysis
Created in NX5.0.0.



License requirements : None

int NXOpen::Features::SectionInertiaAnalysisBuilder::Units ( )

Returns the units for calculations
Created in NX5.0.0.



License requirements : None

bool NXOpen::Features::SectionInertiaAnalysisBuilder::ValidityFlag ( )

Returns the validity flag.

If the flag is set to false, properties will be recomputed.
Created in NX5.0.0.

License requirements : None


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