Represents a Jog feature builder. More...

Inheritance diagram for NXOpen::Features::SheetMetal::JogBuilder:

Public Types
enum	BendLocationOptions { BendLocationOptionsMaterialInside, BendLocationOptionsMaterialOutside, BendLocationOptionsBendOutside }
	Represents the bend location type. More...

enum	DimensionTypeOptions { DimensionTypeOptionsOffset, DimensionTypeOptionsFull }
	the Dimension options for jog. More...

enum	DirectionTypeOptions { DirectionTypeOptionsSectionNormalSide, DirectionTypeOptionsSectionReverseNormalSide }
	this enum represents the direction for the Jog. More...

enum	FixedSideOptions { FixedSideOptionsSectionSideLeft, FixedSideOptionsSectionSideRight }
	The "left" option represents the side to the left of a person who is walking along the section in the direction of its curves when the section normal is pointing up. More...

Public Member Functions
NXOpen::Features::SheetMetal::JogBuilder::BendLocationOptions	BendLocation ()
	Returns Created in NX5.0.0.

NXOpen::Features::SheetMetal::BendOptions *	BendOptions ()
	Returns the bend options Created in NX5.0.0.

NXOpen::Features::SheetMetal::JogBuilder::DimensionTypeOptions	DimensionType ()
	Returns the Offset Dimension The actual extent distance of the Jog will be determined by the active dimension option.

NXOpen::Features::SheetMetal::JogBuilder::DirectionTypeOptions	DirectionType ()
	Returns Created in NX5.0.0.

bool	ExtendProfile ()
	Returns Created in NX5.0.0.

NXOpen::Features::SheetMetal::JogBuilder::FixedSideOptions	FixedSide ()
	Returns Created in NX5.0.0.

NXOpen::Expression *	GetHeight ()
	Height of the Jog.

NXOpen::Section *	Section ()
	Returns Created in NX5.0.0.

void	SetBendLocation (NXOpen::Features::SheetMetal::JogBuilder::BendLocationOptions bendLocation)
	Sets Created in NX5.0.0.

void	SetDimensionType (NXOpen::Features::SheetMetal::JogBuilder::DimensionTypeOptions dimensionType)
	Sets the Offset Dimension The actual extent distance of the Jog will be determined by the active dimension option.

void	SetDirectionType (NXOpen::Features::SheetMetal::JogBuilder::DirectionTypeOptions directionType)
	Sets Created in NX5.0.0.

void	SetExtendProfile (bool extendOption)
	Sets Created in NX5.0.0.

void	SetFixedSide (NXOpen::Features::SheetMetal::JogBuilder::FixedSideOptions sectionSide)
	Sets Created in NX5.0.0.

void	SetHeight (const NXString &height)
	Created in NX5.0.0.

void	SetHeight (const char *height)
	Created in NX5.0.0.

void	SetSection (NXOpen::Section *section)
	Sets Created in NX5.0.0.

void	SetSketch (NXOpen::Features::SketchFeature *sketch)
	Sets Created in NX5.0.0.

NXOpen::Features::SketchFeature *	Sketch ()
	Returns Created in NX5.0.0.

int	ValidateBuilderData ()
	Verify whether the builder data is valid for creating a jog or not.

Public Member Functions inherited from NXOpen::Features::SheetMetal::SheetmetalBaseBuilder
NXOpen::Features::SheetMetal::ApplicationContext	GetApplicationContext ()
	Get the application context.

void	SetApplicationContext (NXOpen::Features::SheetMetal::ApplicationContext appContext)
	Set the application context.

Public Member Functions inherited from NXOpen::Features::FeatureBuilder
NXOpen::Features::Feature *	CommitFeature ()
	Commits the feature parameters and creates the feature.

NXOpen::Features::Feature *	GetFeature ()
	Returns the feature currently being edited by this builder.

void	HideInternalParentFeatureAfterEdit (NXOpen::Features::Feature *parentFeature)
	Re-suppress an internal parent feature (a slave feature) after it has been edited.

bool	ParentFeatureInternal ()
	Returns whether or not the latest timestamped parent feature of this feature should be made internal Created in NX5.0.0.

bool	PatchSolutionFlag ()
	Returns the patch solution flag Created in NX8.0.1.

NXString	PatchSurfaceFilename ()
	Returns the patch surface filename Created in NX8.0.1.

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.

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.

void	SetPatchSolutionFlag (bool optionValue)
	Sets the patch solution flag Created in NX8.0.1.

void	SetPatchSurfaceFilename (const NXString &surfaceFilename)
	Sets the patch surface filename Created in NX8.0.1.

void	SetPatchSurfaceFilename (const char *surfaceFilename)
	Sets the patch surface filename Created in NX8.0.1.

void	SetSurroundingPatchSurfaceFilename (const NXString &surroundingSurfaceFilename)
	Sets the surrounding patch surface filename Created in NX8.0.1.

void	SetSurroundingPatchSurfaceFilename (const char *surroundingSurfaceFilename)
	Sets the surrounding patch surface filename Created in NX8.0.1.

void	ShowInternalParentFeatureForEdit (NXOpen::Features::Feature *parentFeature)
	Unsuppress an internal parent feature (a slave feature) so it can be edited.

NXString	SurroundingPatchSurfaceFilename ()
	Returns the surrounding patch surface filename Created in NX8.0.1.

void	UnsetParentFeatureInternal (NXOpen::Features::Feature *parentFeature)
	Set the internal parent feature of the feature being edited to external Created in NX6.0.0.

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Represents a Jog feature builder.

To create a new instance of this class, use Features::SheetMetal::SheetmetalManager::CreateJogFeatureBuilder

Created in NX5.0.0.

Member Enumeration Documentation

enum NXOpen::Features::SheetMetal::JogBuilder::BendLocationOptions

Represents the bend location type.

Enumerator:

BendLocationOptionsMaterialInside	material inside
BendLocationOptionsMaterialOutside	material outside
BendLocationOptionsBendOutside	bend outside

enum NXOpen::Features::SheetMetal::JogBuilder::DimensionTypeOptions

the Dimension options for jog.

This specifies whether the Jog's depth must be measured from the plane to which the section is attached or from the

Enumerator:

DimensionTypeOptionsOffset	the actual depth will be depth plus the thickness of sheet.
DimensionTypeOptionsFull	the actual extent distance will be the value specified as depth.

enum NXOpen::Features::SheetMetal::JogBuilder::DirectionTypeOptions

this enum represents the direction for the Jog.

Enumerator:

DirectionTypeOptionsSectionNormalSide	jog created on the side of the section normal.
DirectionTypeOptionsSectionReverseNormalSide	jog created on the side opposite to that of the section normal

enum NXOpen::Features::SheetMetal::JogBuilder::FixedSideOptions

The "left" option represents the side to the left of a person who is walking along the section in the direction of its curves when the section normal is pointing up.

The "right" option represents the person's right hand side. This interpretation is the same regardless of whether the section is open or closed. The "right" side at any point along the section can also be represented by the vector resulting from the cross product of the curve tangent (of the section curve at that point) and the section normal. The "left" side is the opposite.

Enumerator:

FixedSideOptionsSectionSideLeft	Side pointed to by the inverse of the tangent cross normal vector.
FixedSideOptionsSectionSideRight	Side pointed to by the tangent cross normal vector.

Member Function Documentation

NXOpen::Features::SheetMetal::JogBuilder::BendLocationOptions NXOpen::Features::SheetMetal::JogBuilder::BendLocation ( )

Returns
Created in NX5.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal") OR nx_flexible_pcb ("NX Flexible PCB")

NXOpen::Features::SheetMetal::BendOptions* NXOpen::Features::SheetMetal::JogBuilder::BendOptions ( )

Returns the bend options
Created in NX5.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal") OR nx_flexible_pcb ("NX Flexible PCB")

NXOpen::Features::SheetMetal::JogBuilder::DimensionTypeOptions NXOpen::Features::SheetMetal::JogBuilder::DimensionType ( )

Returns the Offset Dimension
The actual extent distance of the Jog will be determined by the active dimension option.

           In case of @link Features::SheetMetal::JogBuilder::DimensionTypeOptionsOffset Features::SheetMetal::JogBuilder::DimensionTypeOptionsOffset@endlink  the actual extent distance will be offset dimension distance plus the thickness of sheet.
           In case of @link Features::SheetMetal::JogBuilder::DimensionTypeOptionsFull Features::SheetMetal::JogBuilder::DimensionTypeOptionsFull@endlink  the actual extent distance will be the Full dimension distance.
        <br>

Created in NX5.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal") OR nx_flexible_pcb ("NX Flexible PCB")

NXOpen::Features::SheetMetal::JogBuilder::DirectionTypeOptions NXOpen::Features::SheetMetal::JogBuilder::DirectionType ( )

Returns
Created in NX5.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal") OR nx_flexible_pcb ("NX Flexible PCB")

bool NXOpen::Features::SheetMetal::JogBuilder::ExtendProfile ( )

Returns
Created in NX5.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal") OR nx_flexible_pcb ("NX Flexible PCB")

NXOpen::Features::SheetMetal::JogBuilder::FixedSideOptions NXOpen::Features::SheetMetal::JogBuilder::FixedSide ( )

Returns
Created in NX5.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal") OR nx_flexible_pcb ("NX Flexible PCB")

NXOpen::Expression* NXOpen::Features::SheetMetal::JogBuilder::GetHeight ( )

Height of the Jog.

Returns: Created in NX5.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal") OR nx_flexible_pcb ("NX Flexible PCB")

NXOpen::Section* NXOpen::Features::SheetMetal::JogBuilder::Section ( )

Returns
Created in NX5.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal") OR nx_flexible_pcb ("NX Flexible PCB")

void NXOpen::Features::SheetMetal::JogBuilder::SetBendLocation ( NXOpen::Features::SheetMetal::JogBuilder::BendLocationOptions bendLocation )

Sets
Created in NX5.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal") OR nx_flexible_pcb ("NX Flexible PCB")

Parameters

bendLocation bend location

void NXOpen::Features::SheetMetal::JogBuilder::SetDimensionType ( NXOpen::Features::SheetMetal::JogBuilder::DimensionTypeOptions dimensionType )

Sets the Offset Dimension
The actual extent distance of the Jog will be determined by the active dimension option.

           In case of @link Features::SheetMetal::JogBuilder::DimensionTypeOptionsOffset Features::SheetMetal::JogBuilder::DimensionTypeOptionsOffset@endlink  the actual extent distance will be offset dimension distance plus the thickness of sheet.
           In case of @link Features::SheetMetal::JogBuilder::DimensionTypeOptionsFull Features::SheetMetal::JogBuilder::DimensionTypeOptionsFull@endlink  the actual extent distance will be the Full dimension distance.
        <br>

Created in NX5.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal") OR nx_flexible_pcb ("NX Flexible PCB")

Parameters

dimensionType dimension type

void NXOpen::Features::SheetMetal::JogBuilder::SetDirectionType ( NXOpen::Features::SheetMetal::JogBuilder::DirectionTypeOptions directionType )

Sets
Created in NX5.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal") OR nx_flexible_pcb ("NX Flexible PCB")

Parameters

directionType direction type

void NXOpen::Features::SheetMetal::JogBuilder::SetExtendProfile ( bool extendOption )

Sets
Created in NX5.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal") OR nx_flexible_pcb ("NX Flexible PCB")

Parameters

extendOption extend option

void NXOpen::Features::SheetMetal::JogBuilder::SetFixedSide ( NXOpen::Features::SheetMetal::JogBuilder::FixedSideOptions sectionSide )

Sets
Created in NX5.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal") OR nx_flexible_pcb ("NX Flexible PCB")

Parameters

sectionSide section side

void NXOpen::Features::SheetMetal::JogBuilder::SetHeight ( const NXString & height )

Created in NX5.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal") OR nx_flexible_pcb ("NX Flexible PCB")

Parameters

height NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::Features::SheetMetal::JogBuilder::SetHeight ( const char * height )

Created in NX5.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal") OR nx_flexible_pcb ("NX Flexible PCB")

Parameters

height NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::Features::SheetMetal::JogBuilder::SetSection ( NXOpen::Section * section )

Sets
Created in NX5.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal") OR nx_flexible_pcb ("NX Flexible PCB")

Parameters

section section

void NXOpen::Features::SheetMetal::JogBuilder::SetSketch ( NXOpen::Features::SketchFeature * sketch )

Sets
Created in NX5.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal") OR nx_flexible_pcb ("NX Flexible PCB")

Parameters

sketch sketch

NXOpen::Features::SketchFeature* NXOpen::Features::SheetMetal::JogBuilder::Sketch ( )

Returns
Created in NX5.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal") OR nx_flexible_pcb ("NX Flexible PCB")

int NXOpen::Features::SheetMetal::JogBuilder::ValidateBuilderData ( )

Verify whether the builder data is valid for creating a jog or not.

        <br> 
            If the Builder data is valid, returned value shall be 0

        <br> 
    @return  Data Validity Flag.

Created in NX5.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal") OR nx_flexible_pcb ("NX Flexible PCB")

The documentation for this class was generated from the following file:

Features_SheetMetal_JogBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation