NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Features::SheetMetal::SMBoundaryConditionBuilder Class Reference

Represents a Boundary condition object for Metaform. More...

Inheritance diagram for NXOpen::Features::SheetMetal::SMBoundaryConditionBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Public Types

enum  ConstraintTypes { ConstraintTypesPointToPoint, ConstraintTypesPointAlongCurve, ConstraintTypesCurveToCurve, ConstraintTypesCurveAlongCurve }
 Types of Boundary condition constraints. More...

Public Member Functions

NXString ConstraintName ()
 Returns the constraint name.
NXOpen::Features::SheetMetal::SMBoundaryConditionBuilder::ConstraintTypes ConstraintType ()
 Returns the constraint type
Created in NX7.5.0.
NXOpen::ScCollectorEndRegionCurve ()
 Returns the end region curve This input is required if the Constraint Type is NOT Features::SheetMetal::SMBoundaryConditionBuilder::ConstraintTypesPointToPoint .
NXOpen::PointEndRegionPoint ()
 Returns the end region point This input is required only if the Constraint Type is Features::SheetMetal::SMBoundaryConditionBuilder::ConstraintTypesPointToPoint .
void SetConstraintName (const NXString &constraintName)
 Sets the constraint name.
void SetConstraintType (NXOpen::Features::SheetMetal::SMBoundaryConditionBuilder::ConstraintTypes constraintType)
 Sets the constraint type
Created in NX7.5.0.
void SetEndRegionPoint (NXOpen::Point *endRegionPoint)
 Sets the end region point This input is required only if the Constraint Type is Features::SheetMetal::SMBoundaryConditionBuilder::ConstraintTypesPointToPoint .
void SetStartRegionPoint (NXOpen::Point *startRegionPoint)
 Sets the start region point.
NXOpen::ScCollectorStartRegionCurve ()
 Returns the start region curve This input is required only if the Constraint Type is Features::SheetMetal::SMBoundaryConditionBuilder::ConstraintTypesCurveToCurve or Features::SheetMetal::SMBoundaryConditionBuilder::ConstraintTypesCurveAlongCurve .
NXOpen::PointStartRegionPoint ()
 Returns the start region point.
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called.

Detailed Description

Represents a Boundary condition object for Metaform.

A Metaform feature can have one or more boundary conditions and each condition determines how the mapped geometry will be locked.
To create a new instance of this class, use Features::SheetMetal::MetaformBuilder::CreateSMBoundaryCondition

Created in NX7.5.0.


Member Enumeration Documentation

Types of Boundary condition constraints.

Enumerator:
ConstraintTypesPointToPoint 

point to point

ConstraintTypesPointAlongCurve 

point along curve

ConstraintTypesCurveToCurve 

curve to curve

ConstraintTypesCurveAlongCurve 

curve along curve


Member Function Documentation

Returns the constraint name.

If a constraint is added interactively, an automatic name will be generated for the users which can be edited. Each of the constraint name must be unique.
Created in NX7.5.0.

License requirements : None

Returns the constraint type
Created in NX7.5.0.



License requirements : None

Returns the end region curve This input is required if the Constraint Type is NOT Features::SheetMetal::SMBoundaryConditionBuilder::ConstraintTypesPointToPoint .


Created in NX7.5.0.

License requirements : None

Returns the end region point This input is required only if the Constraint Type is Features::SheetMetal::SMBoundaryConditionBuilder::ConstraintTypesPointToPoint .


Created in NX7.5.0.

License requirements : None

Sets the constraint name.

If a constraint is added interactively, an automatic name will be generated for the users which can be edited. Each of the constraint name must be unique.
Created in NX7.5.0.

License requirements : adv_sheet_metal_dsgn ("ADVANCED SHEET METAL DESIGN")

Parameters:
constraintNameconstraintname

Sets the constraint type
Created in NX7.5.0.



License requirements : adv_sheet_metal_dsgn ("ADVANCED SHEET METAL DESIGN")

Parameters:
constraintTypeconstrainttype

Sets the end region point This input is required only if the Constraint Type is Features::SheetMetal::SMBoundaryConditionBuilder::ConstraintTypesPointToPoint .


Created in NX7.5.0.

License requirements : adv_sheet_metal_dsgn ("ADVANCED SHEET METAL DESIGN")

Parameters:
endRegionPointendregionpoint

Sets the start region point.

This input is required only if the Constraint Type is Features::SheetMetal::SMBoundaryConditionBuilder::ConstraintTypesPointToPoint or Features::SheetMetal::SMBoundaryConditionBuilder::ConstraintTypesPointAlongCurve .
Created in NX7.5.0.

License requirements : adv_sheet_metal_dsgn ("ADVANCED SHEET METAL DESIGN")

Parameters:
startRegionPointstartregionpoint

Returns the start region curve This input is required only if the Constraint Type is Features::SheetMetal::SMBoundaryConditionBuilder::ConstraintTypesCurveToCurve or Features::SheetMetal::SMBoundaryConditionBuilder::ConstraintTypesCurveAlongCurve .


Created in NX7.5.0.

License requirements : None

Returns the start region point.

This input is required only if the Constraint Type is Features::SheetMetal::SMBoundaryConditionBuilder::ConstraintTypesPointToPoint or Features::SheetMetal::SMBoundaryConditionBuilder::ConstraintTypesPointAlongCurve .
Created in NX7.5.0.

License requirements : None

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven't set it. This method throws a not-yet-implemented NXException for some components.

Returns:
Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.


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