NX Open C++ Reference Guide
Classes | Public Types | Public Member Functions
NXOpen::Preferences::PartFlexiblePrintedCircuitDesign Class Reference

Represents the Flexible Printed Circuit Design preferences applicable to part
Preferences are in control of the part. More...

List of all members.

Classes

struct  FlatPatternCalloutTypeDisplay
 The members of the following structure are the display data for a callout in a flat pattern drawing member view. More...
struct  FlatPatternObjectTypeDisplay
 The members of the following structure are the display data for an object in a flat pattern drawing member view. More...

Public Types

enum  FlatPatternObjectType {
  FlatPatternObjectTypeBendCenterLine, FlatPatternObjectTypeBendUpCenterLine, FlatPatternObjectTypeBendDownCenterLine, FlatPatternObjectTypeBendTangentLine,
  FlatPatternObjectTypeOuterMoldLine, FlatPatternObjectTypeInnerMoldLine, FlatPatternObjectTypeExteriorCurves, FlatPatternObjectTypeInteriorCurves,
  FlatPatternObjectTypeInteriorCutoutCurves, FlatPatternObjectTypeInteriorFeatureCurves, FlatPatternObjectTypeLighteningHoleCenter, FlatPatternObjectTypeJoggleLine,
  FlatPatternObjectTypeAddedTopGeometry, FlatPatternObjectTypeAddedBottomGeometry, FlatPatternObjectTypeToolMarker
}
 The members of the following enumerated type are used to identify object types to the FlatPattern API. More...
enum  FlexibleCableContactFaceOptions { FlexibleCableContactFaceOptionsTopFace, FlexibleCableContactFaceOptionsBottomFace }
 This enum represents the face that is the contact face of the Flexible Cable. More...

Public Member Functions

void Commit ()
 Commits and applies all the settings done with set_callout_type_display and set_object_type_display.
NXOpen::ExpressionGetBendRadius ()
 Returns the bend radius expression.
NXOpen::ExpressionGetBendReliefDepth ()
 Returns the bend relief depth.
NXOpen::ExpressionGetBendReliefWidth ()
 Returns the bend relief width.
double GetDeviationalToleranceInFlatSolid ()
 Returns the deviational tolerance during Flat Solid simplification.
void GetFlatPatternAllCalloutTypeDisplay (std::vector< NXOpen::Preferences::PartFlexiblePrintedCircuitDesign::FlatPatternCalloutTypeDisplay > &displayData)
 Returns the dialog names, identifiers, and enabled status for all the available callout types.
void GetFlatPatternAllObjectTypeDisplay (std::vector< NXOpen::Preferences::PartFlexiblePrintedCircuitDesign::FlatPatternObjectTypeDisplay > &displayData)
 Returns the types, colors, fonts, widths, and enabled status for all the the available object types.
NXOpen::Preferences::PartFlexiblePrintedCircuitDesign::FlatPatternCalloutTypeDisplay GetFlatPatternCalloutTypeDisplay (const NXString &calloutType)
 Returns the display data for a callout type.
NXOpen::Preferences::PartFlexiblePrintedCircuitDesign::FlatPatternObjectTypeDisplay GetFlatPatternObjectTypeDisplay (NXOpen::Preferences::PartFlexiblePrintedCircuitDesign::FlatPatternObjectType objectType)
 Returns the display data for a flat pattern object type.
NXOpen::NXColorGetFlexibleCableBottomFaceColor ()
 Returns the bottom face color.
NXOpen::ExpressionGetFlexibleCableConductorSpacing ()
 Returns the conductor spacing expression.
NXOpen::ExpressionGetFlexibleCableConductorWidth ()
 Returns the conductor width expression.
NXOpen::Preferences::PartFlexiblePrintedCircuitDesign::FlexibleCableContactFaceOptions GetFlexibleCableContactFace ()
 Returns the contact face.
NXOpen::ExpressionGetFlexibleCableStrippingLength ()
 Returns the stripping length expression.
NXOpen::NXColorGetFlexibleCableTopFaceColor ()
 Returns the top face color.
NXOpen::Features::SheetMetal::FeatureProperty GetInnerCornerTreatmentType ()
 Returns the inner corner treatment type in Flat as Solid operation.
NXOpen::ExpressionGetInnerCornerTreatmentValue ()
 Returns the inner corner treatment value for Flat as Solid operations.
bool GetIsBsplineSimplifiedInFlatSolid ()
 Returns the flag indicating whether B-Splines are simplified as part of the Flat Solid creation.
bool GetIsSystemGeneratedBendReliefRemovedInFlatSolid ()
 Returns the flag indicating whether or not system generated bend releifs are removed as part of the Flat Solid creation.
NXString GetMaterial ()
 Returns the material name saved with the part.
std::vector< NXStringGetMaterialNames ()
 Returns the material names defined in the material standards table.
std::vector< NXStringGetMaterialProperties (const NXString &materialName, std::vector< NXString > &propertyNames)
 Returns the material name saved with the part.
double GetMinimumArcToleranceInFlatSolid ()
 Returns the minimum arc tolerance during Flat Solid simplification.
NXOpen::ExpressionGetNeutralFactor ()
 Returns the neutral factor.
NXOpen::Features::SheetMetal::FeatureProperty GetOuterCornerTreatmentType ()
 Returns the outer corner treatment type in Flat as Solid operation.
NXOpen::ExpressionGetOuterCornerTreatmentValue ()
 Returns the out corner treatment value for Flat as Solid operations.
NXOpen::ExpressionGetThickness ()
 Returns the thickness expression.
void SetBendRadius (bool updateModel, const NXString &bendRadius)
 Sets the bend radius value
Created in NX4.0.0.
void SetBendReliefDepth (bool updateModel, const NXString &bendReliefDepth)
 Sets the bend relief depth value
Created in NX4.0.0.
void SetBendReliefWidth (bool updateModel, const NXString &bendReliefWidth)
 Sets the bend relief depth value
Created in NX4.0.0.
void SetDeviationalToleranceInFlatSolid (bool updateModel, double deviationalToleranceInFlatSolid)
 Sets the deviational tolerance during Flat Solid simplification
Created in NX4.0.0.
void SetFlatPatternCalloutTypeDisplay (const NXString &calloutType, const NXOpen::Preferences::PartFlexiblePrintedCircuitDesign::FlatPatternCalloutTypeDisplay &displayData)
 Sets the display data for a callout type.
void SetFlatPatternObjectTypeDisplay (bool updateModel, NXOpen::Preferences::PartFlexiblePrintedCircuitDesign::FlatPatternObjectType objectType, const NXOpen::Preferences::PartFlexiblePrintedCircuitDesign::FlatPatternObjectTypeDisplay &displayData)
 Sets the display data for a flat pattern object type.
void SetFlexibleCableBottomFaceColor (NXOpen::NXColor *bottomFaceColor)
 Sets the bottom face color.
void SetFlexibleCableConductorSpacing (const NXString &conductorSpacing)
 Sets the conductor spacing value string.
void SetFlexibleCableConductorWidth (const NXString &conductorWidth)
 Sets the conductor width value string.
void SetFlexibleCableContactFace (NXOpen::Preferences::PartFlexiblePrintedCircuitDesign::FlexibleCableContactFaceOptions faceOption)
 Sets the contact face.
void SetFlexibleCableStrippingLength (const NXString &strippingLength)
 Sets the stripping length value string.
void SetFlexibleCableTopFaceColor (NXOpen::NXColor *topFaceColor)
 Sets the top face color.
void SetInnerCornerTreatmentType (bool updateModel, NXOpen::Features::SheetMetal::FeatureProperty innerCornerTreatmentType)
 Sets the inner corner treatment type in Flat as Solid operation
Created in NX4.0.0.
void SetInnerCornerTreatmentValue (bool updateModel, const NXString &innerCornerTreatment)
 Sets the the inner corner treatment value for Flat as Solid operations
Created in NX4.0.0.
void SetIsBsplineSimplifiedInFlatSolid (bool updateModel, bool isBsplineSimplifiedInFlatSolid)
 Sets the flag indicating whether or not B-Splines are simplified as part of the Flat Solid creation
Created in NX4.0.0.
void SetIsSystemGeneratedBendReliefRemovedInFlatSolid (bool updateModel, bool isSystemGeneratedBendReliefRemoved)
 Sets the flag indicating whether or not system generated bend releifs are removed as part of the Flat Solid creation
Created in NX4.0.0.
void SetMaterial (bool updateModel, const NXString &standardName)
 Sets the material standard
Created in NX4.0.0.
void SetMinimumArcToleranceInFlatSolid (bool updateModel, double minimumArcToleranceInFlatSolid)
 Sets the minimum arc tolerance during Flat Solid simplification
Created in NX4.0.0.
void SetNeutralFactor (bool updateModel, const NXString &neutralFactor)
 Sets the bend relief depth value
Created in NX4.0.0.
void SetOuterCornerTreatmentType (bool updateModel, NXOpen::Features::SheetMetal::FeatureProperty outerCornerTreatmentType)
 Sets the the outer corner treatment type in Flat as Solid operation
Created in NX4.0.0.
void SetOuterCornerTreatmentValue (bool updateModel, const NXString &outerCornerTreatment)
 Sets the outer corner treatment value for Flat as Solid operations
Created in NX4.0.0.
void SetThickness (bool updateModel, const NXString &thickness)
 Sets the thickness value string
Created in NX4.0.0.
tag_t Tag () const
 Returns the tag of this object.

Detailed Description

Represents the Flexible Printed Circuit Design preferences applicable to part
Preferences are in control of the part.

They can not be created but can only be changed.

Created in NX4.0.0.


Member Enumeration Documentation

The members of the following enumerated type are used to identify object types to the FlatPattern API.

These are not the usual NX object types; they are ordinary NX objects that are known to the flat pattern feature for the type of outline they provide to a bend region, joggle region, or lightening hole.

Enumerator:
FlatPatternObjectTypeBendCenterLine 

Deprecated.

FlatPatternObjectTypeBendUpCenterLine 

bend up center line

FlatPatternObjectTypeBendDownCenterLine 

bend down center line

FlatPatternObjectTypeBendTangentLine 

bend tangent line

FlatPatternObjectTypeOuterMoldLine 

outer mold line

FlatPatternObjectTypeInnerMoldLine 

inner mold line

FlatPatternObjectTypeExteriorCurves 

exterior curves

FlatPatternObjectTypeInteriorCurves 

Deprecated.

FlatPatternObjectTypeInteriorCutoutCurves 

interior cutout curves

FlatPatternObjectTypeInteriorFeatureCurves 

interior feature curves

FlatPatternObjectTypeLighteningHoleCenter 

lightening hole center

FlatPatternObjectTypeJoggleLine 

joggle line

FlatPatternObjectTypeAddedTopGeometry 

added top geometry

FlatPatternObjectTypeAddedBottomGeometry 

added bottom geometry

FlatPatternObjectTypeToolMarker 

tool marker

This enum represents the face that is the contact face of the Flexible Cable.

Enumerator:
FlexibleCableContactFaceOptionsTopFace 

Top face.

FlexibleCableContactFaceOptionsBottomFace 

Bottom face.


Member Function Documentation

Commits and applies all the settings done with set_callout_type_display and set_object_type_display.

It must be called after a sequence of calls to those methods to cause the view to update.
Created in NX5.0.0.

License requirements : nx_flexible_pcb ("NX Flexible PCB")

Returns the bend radius expression.

Returns:
expression object for radius of bend faces
Created in NX4.0.0.

License requirements : nx_flexible_pcb ("NX Flexible PCB")

Returns the bend relief depth.

Returns:
expression object for depth of bend relief
Created in NX4.0.0.

License requirements : nx_flexible_pcb ("NX Flexible PCB")

Returns the bend relief width.

Returns:
expression object for width of bend relief
Created in NX4.0.0.

License requirements : nx_flexible_pcb ("NX Flexible PCB")

Returns the deviational tolerance during Flat Solid simplification.

Returns:
flag
Created in NX4.0.0.

License requirements : nx_flexible_pcb ("NX Flexible PCB")

Returns the dialog names, identifiers, and enabled status for all the available callout types.


Created in NX5.0.0.

License requirements : nx_flexible_pcb ("NX Flexible PCB")

Parameters:
displayDataArray of structures with the callout type display data.

Returns the types, colors, fonts, widths, and enabled status for all the the available object types.


Created in NX5.0.0.

License requirements : nx_flexible_pcb ("NX Flexible PCB")

Parameters:
displayDataArray of structures with the object type display data.

Returns the display data for a callout type.

The name member of the Preferences::PartFlexiblePrintedCircuitDesign::FlatPatternCalloutTypeDisplay is separately allocated from the callout_type argument string. In some cases the new string will contain an extended form of the callout_type passed in, and that form should be used for subsequent JA calls, without modification.

Returns:
The display data for the callout type.
Created in NX5.0.0.

License requirements : nx_flexible_pcb ("NX Flexible PCB")
Parameters:
calloutTypeThe name of the callout type for which to get the display data.

Returns the display data for a flat pattern object type.

Returns:
The display data for the flat pattern object type.
Created in NX5.0.0.

License requirements : nx_flexible_pcb ("NX Flexible PCB")
Parameters:
objectTypeThe object type for which to return the display data.

Returns the bottom face color.

Returns:

Created in NX7.5.0.

License requirements : nx_flexible_pcb ("NX Flexible PCB")

Returns the conductor spacing expression.

Returns:
expression object for flexible cable conductor width.
Created in NX7.5.0.

License requirements : nx_flexible_pcb ("NX Flexible PCB")

Returns the conductor width expression.

Returns:
expression object for flexible cable conductor width.
Created in NX7.5.0.

License requirements : nx_flexible_pcb ("NX Flexible PCB")

Returns the contact face.

Returns:

Created in NX7.5.0.

License requirements : nx_flexible_pcb ("NX Flexible PCB")

Returns the stripping length expression.

Returns:
expression object for flexible cable conductor width.
Created in NX7.5.0.

License requirements : nx_flexible_pcb ("NX Flexible PCB")

Returns the top face color.

Returns:

Created in NX7.5.0.

License requirements : nx_flexible_pcb ("NX Flexible PCB")

Returns the inner corner treatment type in Flat as Solid operation.

Returns:
outer corner treatment type
Created in NX4.0.0.

License requirements : nx_flexible_pcb ("NX Flexible PCB")

Returns the inner corner treatment value for Flat as Solid operations.

Returns:
expression object for inner corner treatment value
Created in NX4.0.0.

License requirements : nx_flexible_pcb ("NX Flexible PCB")

Returns the flag indicating whether B-Splines are simplified as part of the Flat Solid creation.

Returns:
flag
Created in NX4.0.0.

License requirements : nx_flexible_pcb ("NX Flexible PCB")

Returns the flag indicating whether or not system generated bend releifs are removed as part of the Flat Solid creation.

Returns:
flag
Created in NX4.0.0.

License requirements : nx_flexible_pcb ("NX Flexible PCB")

Returns the material name saved with the part.

Returns:
The name of the material saved with the part
Created in NX4.0.0.

License requirements : nx_flexible_pcb ("NX Flexible PCB")

Returns the material names defined in the material standards table.

Returns:

Created in NX4.0.0.

License requirements : nx_flexible_pcb ("NX Flexible PCB")
std::vector<NXString> NXOpen::Preferences::PartFlexiblePrintedCircuitDesign::GetMaterialProperties ( const NXString materialName,
std::vector< NXString > &  propertyNames 
)

Returns the material name saved with the part.

Returns:
property Values
Created in NX4.0.0.

License requirements : nx_flexible_pcb ("NX Flexible PCB")
Parameters:
materialNamematerial Name
propertyNamesproperties

Returns the minimum arc tolerance during Flat Solid simplification.

Returns:
flag
Created in NX4.0.0.

License requirements : nx_flexible_pcb ("NX Flexible PCB")

Returns the neutral factor.

Returns:
expression object for neutral factor of bend areas
Created in NX4.0.0.

License requirements : nx_flexible_pcb ("NX Flexible PCB")

Returns the outer corner treatment type in Flat as Solid operation.

Returns:
outer corner treatment type
Created in NX4.0.0.

License requirements : nx_flexible_pcb ("NX Flexible PCB")

Returns the out corner treatment value for Flat as Solid operations.

Returns:
expression object for out corner treatment value
Created in NX4.0.0.

License requirements : nx_flexible_pcb ("NX Flexible PCB")

Returns the thickness expression.

Returns:
expression object for sheet thickness
Created in NX4.0.0.

License requirements : nx_flexible_pcb ("NX Flexible PCB")
void NXOpen::Preferences::PartFlexiblePrintedCircuitDesign::SetBendRadius ( bool  updateModel,
const NXString bendRadius 
)

Sets the bend radius value
Created in NX4.0.0.



License requirements : nx_flexible_pcb ("NX Flexible PCB")

Parameters:
updateModelSpecifies whether the solid model be recomputed immediately
bendRadiusdefault bend radius value for bend faces
NOTE: The full Unicode character set is not supported for this parameter.
void NXOpen::Preferences::PartFlexiblePrintedCircuitDesign::SetBendReliefDepth ( bool  updateModel,
const NXString bendReliefDepth 
)

Sets the bend relief depth value
Created in NX4.0.0.



License requirements : nx_flexible_pcb ("NX Flexible PCB")

Parameters:
updateModelSpecifies whether the solid model be recomputed immediately
bendReliefDepthdefault depth value for bend relief
NOTE: The full Unicode character set is not supported for this parameter.
void NXOpen::Preferences::PartFlexiblePrintedCircuitDesign::SetBendReliefWidth ( bool  updateModel,
const NXString bendReliefWidth 
)

Sets the bend relief depth value
Created in NX4.0.0.



License requirements : nx_flexible_pcb ("NX Flexible PCB")

Parameters:
updateModelSpecifies whether the solid model be recomputed immediately
bendReliefWidthdefault width value for bend relief
NOTE: The full Unicode character set is not supported for this parameter.
void NXOpen::Preferences::PartFlexiblePrintedCircuitDesign::SetDeviationalToleranceInFlatSolid ( bool  updateModel,
double  deviationalToleranceInFlatSolid 
)

Sets the deviational tolerance during Flat Solid simplification
Created in NX4.0.0.



License requirements : nx_flexible_pcb ("NX Flexible PCB")

Parameters:
updateModelSpecifies whether the solid model be recomputed immediately
deviationalToleranceInFlatSolidflag

Sets the display data for a callout type.


Created in NX5.0.0.

License requirements : nx_flexible_pcb ("NX Flexible PCB")

Parameters:
calloutTypeThe name of the callout type for which to set the display data.
displayDataThe display data for the callout type.

Sets the display data for a flat pattern object type.


Created in NX5.0.0.

License requirements : nx_flexible_pcb ("NX Flexible PCB")

Parameters:
updateModelSpecifies whether the solid model be recomputed immediately.
objectTypeThe object type for which to get the display data.
displayDataThe display data for the flat pattern object type.

Sets the bottom face color.


Created in NX7.5.0.

License requirements : nx_flexible_pcb ("NX Flexible PCB")

Parameters:
bottomFaceColorBottom face color.

Sets the conductor spacing value string.


Created in NX7.5.0.

License requirements : nx_flexible_pcb ("NX Flexible PCB")

Parameters:
conductorSpacingDefault conductor spacing value for the flexible cable.
NOTE: The full Unicode character set is not supported for this parameter.

Sets the conductor width value string.


Created in NX7.5.0.

License requirements : nx_flexible_pcb ("NX Flexible PCB")

Parameters:
conductorWidthDefault conductor width value for the flexible cable.
NOTE: The full Unicode character set is not supported for this parameter.

Sets the contact face.


Created in NX7.5.0.

License requirements : nx_flexible_pcb ("NX Flexible PCB")

Parameters:
faceOptionContact face options.

Sets the stripping length value string.


Created in NX7.5.0.

License requirements : nx_flexible_pcb ("NX Flexible PCB")

Parameters:
strippingLengthDefault stripping length value for the flexible cable.
NOTE: The full Unicode character set is not supported for this parameter.

Sets the top face color.


Created in NX7.5.0.

License requirements : nx_flexible_pcb ("NX Flexible PCB")

Parameters:
topFaceColorTop face color.

Sets the inner corner treatment type in Flat as Solid operation
Created in NX4.0.0.



License requirements : nx_flexible_pcb ("NX Flexible PCB")

Parameters:
updateModelSpecifies whether the solid model be recomputed immediately
innerCornerTreatmentTypeouter corner treatment type
void NXOpen::Preferences::PartFlexiblePrintedCircuitDesign::SetInnerCornerTreatmentValue ( bool  updateModel,
const NXString innerCornerTreatment 
)

Sets the the inner corner treatment value for Flat as Solid operations
Created in NX4.0.0.



License requirements : nx_flexible_pcb ("NX Flexible PCB")

Parameters:
updateModelSpecifies whether the solid model be recomputed immediately
innerCornerTreatmentdefault value for inner corner treatment
NOTE: The full Unicode character set is not supported for this parameter.
void NXOpen::Preferences::PartFlexiblePrintedCircuitDesign::SetIsBsplineSimplifiedInFlatSolid ( bool  updateModel,
bool  isBsplineSimplifiedInFlatSolid 
)

Sets the flag indicating whether or not B-Splines are simplified as part of the Flat Solid creation
Created in NX4.0.0.



License requirements : nx_flexible_pcb ("NX Flexible PCB")

Parameters:
updateModelSpecifies whether the solid model be recomputed immediately
isBsplineSimplifiedInFlatSolidflag
void NXOpen::Preferences::PartFlexiblePrintedCircuitDesign::SetIsSystemGeneratedBendReliefRemovedInFlatSolid ( bool  updateModel,
bool  isSystemGeneratedBendReliefRemoved 
)

Sets the flag indicating whether or not system generated bend releifs are removed as part of the Flat Solid creation
Created in NX4.0.0.



License requirements : nx_flexible_pcb ("NX Flexible PCB")

Parameters:
updateModelSpecifies whether the solid model be recomputed immediately
isSystemGeneratedBendReliefRemovedflag
void NXOpen::Preferences::PartFlexiblePrintedCircuitDesign::SetMaterial ( bool  updateModel,
const NXString standardName 
)

Sets the material standard
Created in NX4.0.0.



License requirements : nx_flexible_pcb ("NX Flexible PCB")

Parameters:
updateModelSpecifies whether the solid model be recomputed immediately
standardNameThe name of a material from the material standards file
void NXOpen::Preferences::PartFlexiblePrintedCircuitDesign::SetMinimumArcToleranceInFlatSolid ( bool  updateModel,
double  minimumArcToleranceInFlatSolid 
)

Sets the minimum arc tolerance during Flat Solid simplification
Created in NX4.0.0.



License requirements : nx_flexible_pcb ("NX Flexible PCB")

Parameters:
updateModelSpecifies whether the solid model be recomputed immediately
minimumArcToleranceInFlatSolidflag
void NXOpen::Preferences::PartFlexiblePrintedCircuitDesign::SetNeutralFactor ( bool  updateModel,
const NXString neutralFactor 
)

Sets the bend relief depth value
Created in NX4.0.0.



License requirements : nx_flexible_pcb ("NX Flexible PCB")

Parameters:
updateModelSpecifies whether the solid model be recomputed immediately
neutralFactordefault neutral factor value for bend relief
NOTE: The full Unicode character set is not supported for this parameter.

Sets the the outer corner treatment type in Flat as Solid operation
Created in NX4.0.0.



License requirements : nx_flexible_pcb ("NX Flexible PCB")

Parameters:
updateModelSpecifies whether the solid model be recomputed immediately
outerCornerTreatmentTypeouter corner treatment type
void NXOpen::Preferences::PartFlexiblePrintedCircuitDesign::SetOuterCornerTreatmentValue ( bool  updateModel,
const NXString outerCornerTreatment 
)

Sets the outer corner treatment value for Flat as Solid operations
Created in NX4.0.0.



License requirements : nx_flexible_pcb ("NX Flexible PCB")

Parameters:
updateModelSpecifies whether the solid model be recomputed immediately
outerCornerTreatmentdefault value for out corner treatment
NOTE: The full Unicode character set is not supported for this parameter.
void NXOpen::Preferences::PartFlexiblePrintedCircuitDesign::SetThickness ( bool  updateModel,
const NXString thickness 
)

Sets the thickness value string
Created in NX4.0.0.



License requirements : nx_flexible_pcb ("NX Flexible PCB")

Parameters:
updateModelSpecifies whether the solid model be recomputed immediately
thicknessdefault thickness value for NX Sheetmetal solids
NOTE: The full Unicode character set is not supported for this parameter.

Returns the tag of this object.


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