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

Represents a NXOpen::CAE::LaminateImportedLayupBuilder builder
To create a new instance of this class, use NXOpen::CAE::LaminateGlobalLayupMgr::CreateLaminateImportedLayupBuilder
Default values. More...

Inheritance diagram for NXOpen::CAE::LaminateImportedLayupBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  ApiTypeEnum { ApiTypeEnumFiberSim }
 Type of external API supported. More...
 
enum  FileEnum { FileEnumFiberSimXml, FileEnumFiberSimH5, FileEnumSimulaytLayup, FileEnumFiberSimPart }
 Type of external file to be imported. More...
 
enum  ImportMethodEnum { ImportMethodEnumExternalFile, ImportMethodEnumExternalApi }
 Import method type. More...
 

Public Member Functions

NXOpen::CAE::LaminateImportedLayupBuilder::ApiTypeEnum ApiType ()
 Returns the external api selected for layup import
Created in NX8.0.0. More...
 
NXString FileName ()
 Returns the full name and path of the file to be imported
Created in NX6.0.4. More...
 
NXOpen::CAE::LaminateImportedLayupBuilder::FileEnum FileType ()
 Returns the type of file to be imported
Created in NX6.0.4. More...
 
bool ImportMaterials ()
 Returns the material import option
Created in NX8.5.0. More...
 
NXOpen::CAE::LaminateImportedLayupBuilder::ImportMethodEnum ImportMethod ()
 Returns the import method
Created in NX6.0.4. More...
 
NXString LayupName ()
 Returns the user defined layup name
Created in NX6.0.4. More...
 
bool NameOverride ()
 Returns the option to override the fibersim layup name with a user defined name
Created in NX6.0.4. More...
 
bool OmitPartiallyMapped ()
 Returns the omit partially mapped face option. More...
 
bool OverwriteMaterials ()
 Returns the material import overwrite option
Created in NX8.5.0. More...
 
NXOpen::CAE::LaminateSelectEntitiesBuilderSelection ()
 Returns the geometric face(s) and element face(s) on which to assign the material orientation
Created in NX8.0.1. More...
 
void SelectLaminate (const NXString &laminate)
 Selects a laminate for import
Created in NX8.0.0. More...
 
void SelectLaminate (const char *laminate)
 Selects a laminate for import
Created in NX8.0.0. More...
 
void SetApiType (NXOpen::CAE::LaminateImportedLayupBuilder::ApiTypeEnum apiType)
 Sets the external api selected for layup import
Created in NX8.0.0. More...
 
void SetFileName (const NXString &filename)
 Sets the full name and path of the file to be imported
Created in NX6.0.4. More...
 
void SetFileName (const char *filename)
 Sets the full name and path of the file to be imported
Created in NX6.0.4. More...
 
void SetFileType (NXOpen::CAE::LaminateImportedLayupBuilder::FileEnum fileType)
 Sets the type of file to be imported
Created in NX6.0.4. More...
 
void SetImportMaterials (bool importMaterials)
 Sets the material import option
Created in NX8.5.0. More...
 
void SetImportMethod (NXOpen::CAE::LaminateImportedLayupBuilder::ImportMethodEnum importMethod)
 Sets the import method
Created in NX6.0.4. More...
 
void SetLayupName (const NXString &layupName)
 Sets the user defined layup name
Created in NX6.0.4. More...
 
void SetLayupName (const char *layupName)
 Sets the user defined layup name
Created in NX6.0.4. More...
 
void SetNameOverride (bool nameOverride)
 Sets the option to override the fibersim layup name with a user defined name
Created in NX6.0.4. More...
 
void SetOmitPartiallyMapped (bool omitPartiallyMapped)
 Sets the omit partially mapped face option. More...
 
void SetOverwriteMaterials (bool overwriteMaterials)
 Sets the material import overwrite option
Created in NX8.5.0. More...
 
void SetUnmappedFaceThreshold (double unmappedFaceThreshold)
 Sets the unmapped face threshold value (%). More...
 
NXOpen::ExpressionTolerance ()
 Returns the tolerance used to localize each FEM element layup information
Created in NX6.0.4. More...
 
double UnmappedFaceThreshold ()
 Returns the unmapped face threshold value (%). More...
 
void UpdateApiLaminateList ()
 Updates the list of available laminates in the API
Created in NX8.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::CAE::LaminateImportedLayupBuilder builder
To create a new instance of this class, use NXOpen::CAE::LaminateGlobalLayupMgr::CreateLaminateImportedLayupBuilder
Default values.

Property Value

FileType

FiberSimXml

ImportMethod

ExternalFile

NameOverride

0

Tolerance.Value

0 (millimeters part), 0 (inches part)


Created in NX6.0.4.

Member Enumeration Documentation

Type of external API supported.

Only FiberSim API for now.

Enumerator
ApiTypeEnumFiberSim 

FiberSIM layup XML file.

Type of external file to be imported.

Only FiberSim layup XML file supported for now.

Enumerator
FileEnumFiberSimXml 

FiberSIM layup XML file.

FileEnumFiberSimH5 

FiberSIM layup HDF5 file.

FileEnumSimulaytLayup 

Simulayt Layup File.

FileEnumFiberSimPart 

Use the FiberSim data in the current part.

Import method type.

External file or API.

Enumerator
ImportMethodEnumExternalFile 

External file.

ImportMethodEnumExternalApi 

External API.

Member Function Documentation

NXOpen::CAE::LaminateImportedLayupBuilder::ApiTypeEnum NXOpen::CAE::LaminateImportedLayupBuilder::ApiType ( )

Returns the external api selected for layup import
Created in NX8.0.0.



License requirements : None

NXString NXOpen::CAE::LaminateImportedLayupBuilder::FileName ( )

Returns the full name and path of the file to be imported
Created in NX6.0.4.



License requirements : None

NXOpen::CAE::LaminateImportedLayupBuilder::FileEnum NXOpen::CAE::LaminateImportedLayupBuilder::FileType ( )

Returns the type of file to be imported
Created in NX6.0.4.



License requirements : None

bool NXOpen::CAE::LaminateImportedLayupBuilder::ImportMaterials ( )

Returns the material import option
Created in NX8.5.0.



License requirements : None

NXOpen::CAE::LaminateImportedLayupBuilder::ImportMethodEnum NXOpen::CAE::LaminateImportedLayupBuilder::ImportMethod ( )

Returns the import method
Created in NX6.0.4.



License requirements : None

NXString NXOpen::CAE::LaminateImportedLayupBuilder::LayupName ( )

Returns the user defined layup name
Created in NX6.0.4.



License requirements : None

bool NXOpen::CAE::LaminateImportedLayupBuilder::NameOverride ( )

Returns the option to override the fibersim layup name with a user defined name
Created in NX6.0.4.



License requirements : None

bool NXOpen::CAE::LaminateImportedLayupBuilder::OmitPartiallyMapped ( )

Returns the omit partially mapped face option.

When on, face(s) for which the number of elements successfully mapped in the FiberSim XML mesh is under a certain ratio, will be discarded.
Created in NX8.0.0.

License requirements : None

bool NXOpen::CAE::LaminateImportedLayupBuilder::OverwriteMaterials ( )

Returns the material import overwrite option
Created in NX8.5.0.



License requirements : None

NXOpen::CAE::LaminateSelectEntitiesBuilder* NXOpen::CAE::LaminateImportedLayupBuilder::Selection ( )

Returns the geometric face(s) and element face(s) on which to assign the material orientation
Created in NX8.0.1.



License requirements : nx_lam_comp_adv ("Laminate Composites Advanced")

void NXOpen::CAE::LaminateImportedLayupBuilder::SelectLaminate ( const NXString laminate)

Selects a laminate for import
Created in NX8.0.0.



License requirements : nx_lam_comp_adv ("Laminate Composites Advanced")

Parameters
laminate
NOTE: The full Unicode character set is not supported for this parameter.
void NXOpen::CAE::LaminateImportedLayupBuilder::SelectLaminate ( const char *  laminate)

Selects a laminate for import
Created in NX8.0.0.



License requirements : nx_lam_comp_adv ("Laminate Composites Advanced")

Parameters
laminate
NOTE: The full Unicode character set is not supported for this parameter.
void NXOpen::CAE::LaminateImportedLayupBuilder::SetApiType ( NXOpen::CAE::LaminateImportedLayupBuilder::ApiTypeEnum  apiType)

Sets the external api selected for layup import
Created in NX8.0.0.



License requirements : nx_lam_comp_adv ("Laminate Composites Advanced")

Parameters
apiTypeapitype
void NXOpen::CAE::LaminateImportedLayupBuilder::SetFileName ( const NXString filename)

Sets the full name and path of the file to be imported
Created in NX6.0.4.



License requirements : nx_lam_comp_adv ("Laminate Composites Advanced")

Parameters
filenamefilename
void NXOpen::CAE::LaminateImportedLayupBuilder::SetFileName ( const char *  filename)

Sets the full name and path of the file to be imported
Created in NX6.0.4.



License requirements : nx_lam_comp_adv ("Laminate Composites Advanced")

Parameters
filenamefilename
void NXOpen::CAE::LaminateImportedLayupBuilder::SetFileType ( NXOpen::CAE::LaminateImportedLayupBuilder::FileEnum  fileType)

Sets the type of file to be imported
Created in NX6.0.4.



License requirements : nx_lam_comp_adv ("Laminate Composites Advanced")

Parameters
fileTypefiletype
void NXOpen::CAE::LaminateImportedLayupBuilder::SetImportMaterials ( bool  importMaterials)

Sets the material import option
Created in NX8.5.0.



License requirements : nx_lam_comp_adv ("Laminate Composites Advanced")

Parameters
importMaterialsimportmaterials
void NXOpen::CAE::LaminateImportedLayupBuilder::SetImportMethod ( NXOpen::CAE::LaminateImportedLayupBuilder::ImportMethodEnum  importMethod)

Sets the import method
Created in NX6.0.4.



License requirements : nx_lam_comp_adv ("Laminate Composites Advanced")

Parameters
importMethodimportmethod
void NXOpen::CAE::LaminateImportedLayupBuilder::SetLayupName ( const NXString layupName)

Sets the user defined layup name
Created in NX6.0.4.



License requirements : nx_lam_comp_adv ("Laminate Composites Advanced")

Parameters
layupNamelayupname
void NXOpen::CAE::LaminateImportedLayupBuilder::SetLayupName ( const char *  layupName)

Sets the user defined layup name
Created in NX6.0.4.



License requirements : nx_lam_comp_adv ("Laminate Composites Advanced")

Parameters
layupNamelayupname
void NXOpen::CAE::LaminateImportedLayupBuilder::SetNameOverride ( bool  nameOverride)

Sets the option to override the fibersim layup name with a user defined name
Created in NX6.0.4.



License requirements : nx_lam_comp_adv ("Laminate Composites Advanced")

Parameters
nameOverridenameoverride
void NXOpen::CAE::LaminateImportedLayupBuilder::SetOmitPartiallyMapped ( bool  omitPartiallyMapped)

Sets the omit partially mapped face option.

When on, face(s) for which the number of elements successfully mapped in the FiberSim XML mesh is under a certain ratio, will be discarded.
Created in NX8.0.0.

License requirements : nx_lam_comp_adv ("Laminate Composites Advanced")

Parameters
omitPartiallyMappedomitpartiallymapped
void NXOpen::CAE::LaminateImportedLayupBuilder::SetOverwriteMaterials ( bool  overwriteMaterials)

Sets the material import overwrite option
Created in NX8.5.0.



License requirements : nx_lam_comp_adv ("Laminate Composites Advanced")

Parameters
overwriteMaterialsoverwritematerials
void NXOpen::CAE::LaminateImportedLayupBuilder::SetUnmappedFaceThreshold ( double  unmappedFaceThreshold)

Sets the unmapped face threshold value (%).

When the OmitPartiallyMapped option is on, the percentage is used to determine which face(s) will be discarded during import.
Created in NX8.0.0.

License requirements : nx_lam_comp_adv ("Laminate Composites Advanced")

Parameters
unmappedFaceThresholdunmappedfacethreshold
NXOpen::Expression* NXOpen::CAE::LaminateImportedLayupBuilder::Tolerance ( )

Returns the tolerance used to localize each FEM element layup information
Created in NX6.0.4.



License requirements : None

double NXOpen::CAE::LaminateImportedLayupBuilder::UnmappedFaceThreshold ( )

Returns the unmapped face threshold value (%).

When the OmitPartiallyMapped option is on, the percentage is used to determine which face(s) will be discarded during import.
Created in NX8.0.0.

License requirements : None

void NXOpen::CAE::LaminateImportedLayupBuilder::UpdateApiLaminateList ( )

Updates the list of available laminates in the API
Created in NX8.0.0.



License requirements : nx_lam_comp_adv ("Laminate Composites Advanced")


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