NXOpen C++ Reference Guide
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | List of all members
NXOpen::GeometricUtilities::UnitCellBuilder Class Reference

Represents a GeometricUtilities.UnitCellBuilder
Created in NX1847.0.0. More...

Inheritance diagram for NXOpen::GeometricUtilities::UnitCellBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

NXString CellTypeName ()
 Returns. More...
 
NXString CustomUnitCellFile ()
 Returns the native file browser0
Created in NX1847.0.0. More...
 
NXOpen::ExpressionEdgeLength ()
 Returns the edge length of the unit cell bounding box, and effective only when the bounding box is a uniform cube
Created in NX1847.0.0. More...
 
bool IsUniformCube ()
 Returns whether the unit cell bounding box is a uniform cube
Created in NX1847.0.0. More...
 
void SetCellTypeName (const NXString &cellTypeName)
 Sets. More...
 
void SetCellTypeName (const char *cellTypeName)
 Sets. More...
 
void SetCustomUnitCellFile (const NXString &filename)
 Sets the native file browser0
Created in NX1847.0.0. More...
 
void SetCustomUnitCellFile (const char *filename)
 Sets the native file browser0
Created in NX1847.0.0. More...
 
void SetUniformCube (bool uniformCube)
 Sets whether the unit cell bounding box is a uniform cube
Created in NX1847.0.0. More...
 
NXOpen::ExpressionSizeX ()
 Returns the size of the unit cell bounding box in x axis, and effective only when the bounding box is not a uniform cube
Created in NX1847.0.0. More...
 
NXOpen::ExpressionSizeY ()
 Returns the size of the unit cell bounding box in y axis, and effective only when the bounding box is not a uniform cube
Created in NX1847.0.0. More...
 
NXOpen::ExpressionSizeZ ()
 Returns the size of the unit cell bounding box in z axis, and effective only when the bounding box is not a uniform cube
Created in NX1847.0.0. 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 GeometricUtilities.UnitCellBuilder
Created in NX1847.0.0.


Member Function Documentation

NXString NXOpen::GeometricUtilities::UnitCellBuilder::CellTypeName ( )

Returns.

the name of the unit cell type.

Currently there are 15 valid unit cells that are supported in NX. Their name strings are:

  • BiTriangle
  • Cubeplex
  • Dodecahedron
  • HexStar
  • HexVase
  • HexVaseMod
  • Octapeak
  • Octahedroid
  • PseudoSierpinski
  • QuadDiametral
  • QuadDiametralCross
  • QuadDiametralLine
  • Star
  • TriDiametral
  • TriDiametralChevron


Created in NX1847.0.0.

License requirements : None

NXString NXOpen::GeometricUtilities::UnitCellBuilder::CustomUnitCellFile ( )

Returns the native file browser0
Created in NX1847.0.0.



License requirements : None

NXOpen::Expression* NXOpen::GeometricUtilities::UnitCellBuilder::EdgeLength ( )

Returns the edge length of the unit cell bounding box, and effective only when the bounding box is a uniform cube
Created in NX1847.0.0.



License requirements : None

bool NXOpen::GeometricUtilities::UnitCellBuilder::IsUniformCube ( )

Returns whether the unit cell bounding box is a uniform cube
Created in NX1847.0.0.



License requirements : None

void NXOpen::GeometricUtilities::UnitCellBuilder::SetCellTypeName ( const NXString cellTypeName)

Sets.

the name of the unit cell type.

Currently there are 15 valid unit cells that are supported in NX. Their name strings are:

  • BiTriangle
  • Cubeplex
  • Dodecahedron
  • HexStar
  • HexVase
  • HexVaseMod
  • Octapeak
  • Octahedroid
  • PseudoSierpinski
  • QuadDiametral
  • QuadDiametralCross
  • QuadDiametralLine
  • Star
  • TriDiametral
  • TriDiametralChevron


Created in NX1847.0.0.

License requirements : nx_lattice_base (" NX Lattice Base")

Parameters
cellTypeNamecelltypename
void NXOpen::GeometricUtilities::UnitCellBuilder::SetCellTypeName ( const char *  cellTypeName)

Sets.

the name of the unit cell type.

Currently there are 15 valid unit cells that are supported in NX. Their name strings are:

  • BiTriangle
  • Cubeplex
  • Dodecahedron
  • HexStar
  • HexVase
  • HexVaseMod
  • Octapeak
  • Octahedroid
  • PseudoSierpinski
  • QuadDiametral
  • QuadDiametralCross
  • QuadDiametralLine
  • Star
  • TriDiametral
  • TriDiametralChevron


Created in NX1847.0.0.

License requirements : nx_lattice_base (" NX Lattice Base")

Parameters
cellTypeNamecelltypename
void NXOpen::GeometricUtilities::UnitCellBuilder::SetCustomUnitCellFile ( const NXString filename)

Sets the native file browser0
Created in NX1847.0.0.



License requirements : nx_lattice_base (" NX Lattice Base")

Parameters
filenamefilename
void NXOpen::GeometricUtilities::UnitCellBuilder::SetCustomUnitCellFile ( const char *  filename)

Sets the native file browser0
Created in NX1847.0.0.



License requirements : nx_lattice_base (" NX Lattice Base")

Parameters
filenamefilename
void NXOpen::GeometricUtilities::UnitCellBuilder::SetUniformCube ( bool  uniformCube)

Sets whether the unit cell bounding box is a uniform cube
Created in NX1847.0.0.



License requirements : nx_lattice_base (" NX Lattice Base")

Parameters
uniformCubeuniformcube
NXOpen::Expression* NXOpen::GeometricUtilities::UnitCellBuilder::SizeX ( )

Returns the size of the unit cell bounding box in x axis, and effective only when the bounding box is not a uniform cube
Created in NX1847.0.0.



License requirements : None

NXOpen::Expression* NXOpen::GeometricUtilities::UnitCellBuilder::SizeY ( )

Returns the size of the unit cell bounding box in y axis, and effective only when the bounding box is not a uniform cube
Created in NX1847.0.0.



License requirements : None

NXOpen::Expression* NXOpen::GeometricUtilities::UnitCellBuilder::SizeZ ( )

Returns the size of the unit cell bounding box in z axis, and effective only when the bounding box is not a uniform cube
Created in NX1847.0.0.



License requirements : None

virtual bool NXOpen::GeometricUtilities::UnitCellBuilder::Validate ( )
virtual

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 2019 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.