NXOpen .NET Reference  12.0.0
Classes | Public Member Functions | List of all members
NXOpen.Features.FlatSolid Class Reference

Represents a Flat Solid feature More...

Inheritance diagram for NXOpen.Features.FlatSolid:
NXOpen.Features.Feature NXOpen.NXObject NXOpen.IProfile NXOpen.IFitTo NXOpen.INXObject NXOpen.INXObject NXOpen.INXObject

Classes

struct  _ObjectDataCsys
 Structure used to return the objects of a flat solid.
 
struct  ObjectDataCsys
 Structure used to return the objects of a flat solid. More...
 

Public Member Functions

unsafe void GetToolMarkers (out NXOpen.Features.FlatSolid.ObjectDataCsys[] objects)
 Returns an array of all the tool marker points assocated with the flat solid. More...
 
unsafe NXOpen.ScalarMatrixValue GetComponentTransformation (NXOpen.TaggedObject component)
 Returns a 4x4 transformation matrix for the given PCB component or restriction area on the flat solid. More...
 
unsafe void MapInputGeomToFlattenedGeom (NXOpen.TaggedObject input, out NXOpen.TaggedObject[] flatGeom)
 Returns output component or array of curves on flat solid for the given PCB component or restriction area or additional geometry. More...
 
unsafe NXOpen.TaggedObject MapFlattenedGeomToInputGeom (NXOpen.TaggedObject flatGeom)
 Returns PCB component or restriction area or additional geometry for the given component or curve on flat solid. More...
 
unsafe NXOpen.TaggedObject GetEntityOnFlat (NXOpen.TaggedObject entity)
 Returns face or edge on flat solid body corresponding to face or edge on formed body. More...
 
unsafe NXOpen.ScalarMatrixValue GetFaceTransformation (NXOpen.TaggedObject face)
 Returns a 4x4 transformation matrix for the given SM planar face on flat solid body. More...
 
- Public Member Functions inherited from NXOpen.Features.Feature
unsafe NXOpen.Expression[] GetExpressions ()
 Returns the expressions created by the feature. More...
 
unsafe NXOpen.Features.Feature[] GetParents ()
 Returns the immediate parent features. More...
 
unsafe NXOpen.Features.Feature[] GetChildren ()
 Returns the immediate child features. More...
 
unsafe NXOpen.Features.Feature[] GetAllChildren ()
 Returns all immediate child features. More...
 
unsafe void Highlight ()
 Highlight the body created by the feature More...
 
unsafe void Unhighlight ()
 Unhighlight the body created by the feature More...
 
unsafe void MakeCurrentFeature ()
 Make current feature More...
 
unsafe void ShowBody (bool moveCurves)
 Show the body created by the feature. More...
 
unsafe void ShowParents (bool moveCurves)
 Show the body created by the parent feature. More...
 
unsafe void HideBody ()
 Hide the body created by the feature More...
 
unsafe void HideParents ()
 Hide the body created by the parent feature More...
 
unsafe void Suppress ()
 Suppress the feature More...
 
unsafe void Unsuppress ()
 Unsuppress the feature More...
 
unsafe NXOpen.NXObject[] GetEntities ()
 Returns the entities created by the feature. More...
 
unsafe string[] GetFeatureErrorMessages ()
 Returns the feature error messages. More...
 
unsafe string[] GetFeatureInformationalMessages ()
 Returns the feature informational messages. More...
 
unsafe void DeleteInformationalAlerts ()
 Delete all informational alerts from the features More...
 
unsafe void DeleteWarningAlerts ()
 Delete all warning alerts from the features More...
 
unsafe string[] GetFeatureWarningMessages ()
 Returns the feature warning messages. More...
 
unsafe string[] GetFeatureClueMessages ()
 Returns the feature clue messages. More...
 
unsafe void DeleteClueAlerts ()
 Delete all clue alerts from the features More...
 
unsafe string[] GetFeatureClueHintMessages ()
 Returns both clue and hint messages of the feature. More...
 
unsafe string[] GetFeatureHintMessages ()
 Returns the feature hint messages. More...
 
unsafe void DeleteHintAlerts ()
 Delete all clue alerts from the features More...
 
unsafe void MakeSketchInternal ()
 Make the parent sketch internal if referenced only by this feature. More...
 
unsafe void MakeSketchExternal ()
 Make the parent sketch external for reuse by other features. More...
 
unsafe void RemoveForEdit (bool dependent)
 Remove all the feature faces before a NoHistory mode edit. More...
 
unsafe void RemoveParameters ()
 Remove Local feature parameters in history free mode. More...
 
unsafe void ShowDimensions ()
 Show all feature dimensions of a feature. More...
 
unsafe string GetFeatureName ()
 Returns the displayed name of the feature. More...
 
unsafe NXOpen.Section[] GetSections ()
 Queries a feature for list of its sections. More...
 
unsafe void SetGroupActive (bool active)
 Set a feature group as active group. More...
 
unsafe void LogDiagnostic (int errorCode, string message, NXOpen.Features.Feature.DiagnosticType diagnosticType)
 Log a diagnostic alert for this feature More...
 
unsafe void ChangeBooleanType ()
 Change Boolean Type More...
 
unsafe NXOpen.NXColor GetFeatureColor ()
 The feature color More...
 
unsafe bool BreakWaveLink ()
 Break Wave Link Feature More...
 
- Public Member Functions inherited from NXOpen.NXObject
unsafe void SetUserAttribute (NXOpen.NXObject.AttributeInformation info, NXOpen.Update.Option option)
 Creates or modifies an attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (string title, int index, int value, NXOpen.Update.Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (string title, int index, double value, NXOpen.Update.Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (string title, int index, string value, NXOpen.Update.Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (string title, int index, NXOpen.Update.Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
unsafe void SetTimeUserAttribute (string title, int index, string value, NXOpen.Update.Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
unsafe void SetTimeUserAttribute (string title, int index, NXOpen.NXObject.ComputationalTime value, NXOpen.Update.Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
unsafe void SetBooleanUserAttribute (string title, int index, bool value, NXOpen.Update.Option option)
 Creates or modifies a boolean attribute with the option to update or not. More...
 
unsafe NXOpen.AttributeIterator CreateAttributeIterator ()
 Create an attribute iterator More...
 
unsafe bool HasUserAttribute (NXOpen.AttributeIterator iterator)
 Determines if an attribute exists on the object, that satisfies the given iterator More...
 
unsafe bool HasUserAttribute (string title, NXOpen.NXObject.AttributeType type, int index)
 Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More...
 
unsafe int GetUserAttributeCount (NXOpen.AttributeIterator iterator)
 Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...
 
unsafe int GetUserAttributeCount (NXOpen.AttributeIterator iterator, bool countArrayAsOneAttribute)
 Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...
 
unsafe int GetUserAttributeCount (NXOpen.NXObject.AttributeType type)
 Gets the count of set attributes on the object, if any, of the given type. More...
 
unsafe int GetUserAttributeCount (NXOpen.NXObject.AttributeType type, bool includeUnset, bool countArrayAsOneAttribute)
 Gets the count of attributes on the object, if any, of the given type. More...
 
unsafe int GetUserAttributeSize (string title, NXOpen.NXObject.AttributeType type)
 Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More...
 
unsafe bool GetNextUserAttribute (NXOpen.AttributeIterator iterator, out NXOpen.NXObject.AttributeInformation info)
 Gets the next attribute encountered on the object, if any, that satisfies the given iterator. More...
 
unsafe
NXOpen.NXObject.AttributeInformation 
GetUserAttribute (string title, NXOpen.NXObject.AttributeType type, int index)
 Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. More...
 
unsafe bool GetBooleanUserAttribute (string title, int index)
 Gets a boolean attribute by Title and array Index. More...
 
unsafe int GetIntegerUserAttribute (string title, int index)
 Gets an integer attribute by Title and array Index. More...
 
unsafe double GetRealUserAttribute (string title, int index)
 Gets a real attribute by Title and array Index. More...
 
unsafe string GetStringUserAttribute (string title, int index)
 Gets a string attribute by Title and array Index. More...
 
unsafe string GetTimeUserAttribute (string title, int index)
 Gets a time attribute by Title and array Index. More...
 
unsafe
NXOpen.NXObject.ComputationalTime 
GetComputationalTimeUserAttribute (string title, int index)
 Gets a time attribute by Title and array Index. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttributes (NXOpen.AttributeIterator iterator)
 Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttributes ()
 Gets all the attributes that have been set on the given object. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttributes (bool includeUnset)
 Gets all the attributes of the given object. More...
 
unsafe string GetUserAttributeAsString (string title, NXOpen.NXObject.AttributeType type, int index)
 Gets the first attribute encountered on the object, if any, with a given title, type and array index. More...
 
unsafe void DeleteUserAttributes (NXOpen.AttributeIterator iterator, NXOpen.Update.Option option)
 Deletes the attributes on the object, if any, that satisfy the given iterator More...
 
unsafe void DeleteUserAttribute (NXOpen.NXObject.AttributeType type, string title, bool deleteEntireArray, NXOpen.Update.Option option)
 Deletes the first attribute encountered with the given Type, Title. More...
 
unsafe void DeleteUserAttributes (NXOpen.NXObject.AttributeType type, NXOpen.Update.Option option)
 Deletes the attributes encountered with the given Type with option to update or not. More...
 
unsafe void SetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type, bool @lock)
 Lock or unlock the given attribute. More...
 
unsafe bool GetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type)
 Determine the lock of the given attribute. More...
 
unsafe NXOpen.NXObject[] GetUserAttributeSourceObjects ()
 Returns an array of objects from which this object presents attributes. More...
 
unsafe void SetPdmReferenceAttribute (string attributeTitle, string attributeValue)
 Sets the value of PDM Reference attribute on the object. More...
 
unsafe string GetPdmReferenceAttributeValue (string attributeTitle)
 Gets the value of PDM Reference attribute for given object. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttribute (string title, bool includeUnset, bool addStringValues, NXOpen.NXObject.AttributeType type)
 Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttributes (bool includeUnset, bool addStringValues)
 Gets all the attributes of the given object. More...
 
unsafe void DeleteAllAttributesByType (NXOpen.NXObject.AttributeType type)
 Deletes all attributes of a specific type. More...
 
unsafe void DeleteAllAttributesByType (NXOpen.NXObject.AttributeType type, NXOpen.Update.Option option)
 Deletes all attributes of a specific type with the option to update or not. More...
 
unsafe void SetAttribute (string title, int value)
 Creates or modifies an integer attribute. More...
 
unsafe void SetAttribute (string title, int value, NXOpen.Update.Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
unsafe void SetAttribute (string title, double value)
 Creates or modifies a real attribute. More...
 
unsafe void SetAttribute (string title, double value, NXOpen.Update.Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
unsafe void SetAttribute (string title, string value)
 Creates or modifies a string attribute. More...
 
unsafe void SetAttribute (string title, string value, NXOpen.Update.Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
unsafe void SetAttribute (string title)
 Creates or modifies a null attribute which is an attribute with a title and no value. More...
 
unsafe void SetAttribute (string title, NXOpen.Update.Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
unsafe void SetTimeAttribute (string title, string value)
 Creates or modifies a time attribute. More...
 
unsafe void SetTimeAttribute (string title, string value, NXOpen.Update.Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
unsafe int GetIntegerAttribute (string title)
 Gets an integer attribute by title. More...
 
unsafe double GetRealAttribute (string title)
 Gets a real attribute by title. More...
 
unsafe string GetStringAttribute (string title)
 Gets a string attribute value by title. More...
 
unsafe string GetTimeAttribute (NXOpen.NXObject.DateAndTimeFormat format, string title)
 Gets a time attribute by title. More...
 
unsafe string GetReferenceAttribute (string title)
 Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More...
 
unsafe void DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title)
 Deletes an attribute by type and title. More...
 
unsafe void DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title, NXOpen.Update.Option option)
 Deletes an attribute by type and title with the option to update or not. More...
 
unsafe void SetReferenceAttribute (string title, string value)
 Creates or modifies a string attribute which uses a reference string. More...
 
unsafe void SetReferenceAttribute (string title, string value, NXOpen.Update.Option option)
 Creates or modifies a string attribute which uses a reference string, with the option to update or not. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetAttributeTitlesByType (NXOpen.NXObject.AttributeType type)
 Gets all the attribute titles of a specific type. More...
 
unsafe string[] GetUserAttributesAsStrings ()
 Gets all the attributes that have been set on the given object. More...
 
unsafe NXOpen.INXObject FindObject (string journalIdentifier)
 Finds the NXOpen.NXObject with the given identifier as recorded in a journal. More...
 
unsafe void Print ()
 Prints a representation of this object to the system log file. More...
 
unsafe void SetName (string name)
 Sets the custom name of the object. More...
 

Additional Inherited Members

- Public Types inherited from NXOpen.Features.Feature
enum  BooleanType {
  Create, Unite, Subtract, Intersect,
  EmbossNormalSide = 8, EmbossOppositeNormalSide
}
 Boolean operation type. More...
 
enum  DiagnosticType { Information = 1, Warning }
 Diagnostic type More...
 
- Properties inherited from NXOpen.Features.Feature
unsafe int AlgorithmVersion [get]
 Returns the algorithm version of the feature More...
 
unsafe
NXOpen.Features.IContainerFeature 
ContainerFeature [get]
 Returns the container feature for this feature. More...
 
unsafe string FeatureType [get]
 Returns the feature type More...
 
unsafe bool IsContainedFeature [get]
 Returns true if the feature is a contained feature. More...
 
unsafe bool IsInternal [get]
 Returns true if the feature is internal. More...
 
unsafe NXOpen.Point3d Location [get]
 Returns the location of the feature More...
 
unsafe bool Suppressed [get]
 Returns the suppression status of the feature More...
 
unsafe int Timestamp [get]
 Returns the timestamp of the feature More...
 

Detailed Description

Represents a Flat Solid feature

To create or edit an instance of this class, use NXOpen.Features.SheetMetal.FlatSolidBuilder

Created in NX5.0.0

Member Function Documentation

unsafe NXOpen.ScalarMatrixValue NXOpen.Features.FlatSolid.GetComponentTransformation ( NXOpen.TaggedObject  component)

Returns a 4x4 transformation matrix for the given PCB component or restriction area on the flat solid.

The matrix will be in parasolid format.

Created in NX10.0.0

License requirements: nx_flexible_pcb ("NX Flexible PCB")

Parameters
componentNXOpen object representing PCB component or restriction area
Returns
a 4x4 transformation matrix.
unsafe NXOpen.TaggedObject NXOpen.Features.FlatSolid.GetEntityOnFlat ( NXOpen.TaggedObject  entity)

Returns face or edge on flat solid body corresponding to face or edge on formed body.

The output of this API may be inconsistent or unsuitable in case of split or consumed entities.

Created in NX10.0.0

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

Parameters
entityNXOpen object representing face or edge on the formed body
Returns
NXOpen object representing corresponding face or edge on flat body
unsafe NXOpen.ScalarMatrixValue NXOpen.Features.FlatSolid.GetFaceTransformation ( NXOpen.TaggedObject  face)

Returns a 4x4 transformation matrix for the given SM planar face on flat solid body.

The matrix will be in parasolid format. The output of this API may be inconsistent or unsuitable if for non-planar or deform face is given as input.

Created in NX10.0.0

License requirements: nx_flexible_pcb ("NX Flexible PCB")

Parameters
faceNXOpen object representing face on flat body
Returns
a 4x4 transformation matrix.
unsafe void NXOpen.Features.FlatSolid.GetToolMarkers ( out NXOpen.Features.FlatSolid.ObjectDataCsys[]  objects)

Returns an array of all the tool marker points assocated with the flat solid.

The flat_solid_object is the CSYS associated with the flat solid. The formed_body_object is the datum CSYS feature that is on the formed body.

Created in NX6.0.3

License requirements: nx_sheet_metal ("NX Sheet Metal")

Parameters
objectsArray of structures reporting associated object data for tool markers
unsafe NXOpen.TaggedObject NXOpen.Features.FlatSolid.MapFlattenedGeomToInputGeom ( NXOpen.TaggedObject  flatGeom)

Returns PCB component or restriction area or additional geometry for the given component or curve on flat solid.

Created in NX10.0.0

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

Parameters
flatGeomNXOpen object representing PCB component or restriction area or additional geometry on flat solid
Returns
Corresponding NXOpen object for input PCB component or restriction area or additional geometry
unsafe void NXOpen.Features.FlatSolid.MapInputGeomToFlattenedGeom ( NXOpen.TaggedObject  input,
out NXOpen.TaggedObject[]  flatGeom 
)

Returns output component or array of curves on flat solid for the given PCB component or restriction area or additional geometry.

Created in NX10.0.0

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

Parameters
inputNXOpen object representing input PCB component or restriction area or additional geometry
flatGeomCorresponding array of curves or component on flat solid

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