NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::PhysicalMaterial Class Reference

Represents Physical Material
Created in NX5.0.0. More...

Inheritance diagram for NXOpen::PhysicalMaterial:
NXOpen::Material NXOpen::NXObject NXOpen::TaggedObject NXOpen::INXObject

List of all members.

Public Types

enum  Category {
  CategoryMetals, CategoryPlastics, CategoryPolymers, CategoryCeramics,
  CategoryOther
}
 The different categories of materials. More...
enum  Type {
  TypeIsotropic, TypeOrthotropic, TypeAnisotropic, TypeFluid = 4,
  TypeGeneralHyperelastic, TypeMooneyrivlin, TypeMooneyrivlintestdata, TypePolynomial,
  TypeReducedpolynomial, TypeOgden, TypeOgdentestdata, TypeFoam,
  TypeFoamtestdata, TypeBlatz, TypeArrudaboyce, TypeArrudaboycetestdata,
  TypeNeohooke, TypeNeohooketestdata, TypeMarlow, TypeVanderwaals,
  TypeYeoh, TypeYeohtestdata, TypeGent, TypeGasket,
  TypeGasketbehavior, TypeShapememoryalloy, TypeSussmanbathe
}
 The different types of materials. More...

Public Member Functions

void AssignObjects (const std::vector< NXOpen::NXObject * > &objects)
 Assigns the material to solid bodies.
void AssignToAllBodies ()
 Assigns the material to all solid bodies.
void AssignToBodiesNotUsingPreferredMaterial ()
 Assigns the material to all solid bodies not using the preferred material.
void AssignToBodiesWithoutMaterials ()
 Assigns the material to all solid bodies without a material already assigned.
NXOpen::PhysicalMaterialCopy (NXOpen::NXObject *partObject)
 Creates new (copied) material with same properties as the original material.
NXOpen::PhysicalMaterialCopyLibMatlToPart (NXOpen::NXObject *partObject)
 Copies a library material to a part.
void Delete ()
 Deletes a material from the part.
NXString GetCategory ()
 Returns the material category.
NXString GetDescription ()
 Returns the material description.
int GetId ()
 Returns the material id.
NXString GetLibraryName ()
 Returns the library name if the material was loaded from a library.
NXOpen::PhysicalMaterial::Type GetMaterialType ()
 Returns the material type.
NXOpen::CAE::PropertyTableGetPropTable ()
 Returns the property table that contains the properties for this material.
NXString GetTeamcenterMaterialItem ()
 Returns the Teamcenter item if the material was loaded from Teamcenter.
void GetUsage (std::vector< NXOpen::NXObject * > &objects)
 Finds the objects using this material.
NXString GetVersion ()
 Returns the material version.
void InfoMaterial ()
 Displays the property values for the material in the information window.
void InfoMaterialToFile (bool bOverride, const NXString &pcFileName)
 Writes the property values for the material to a file.
bool IsLoadedLibraryMaterial ()
 Returns true if the material is loaded from a library (not Teamcenter)
bool IsLoadedTeamcenterMaterialItem ()
 Returns true if the material is loaded from Teamcenter.
bool IsNonlibraryMaterial ()
 Returns true if the material is locally defined (not a library/Teamcenter material)
void ResyncWithLibraryDefinition ()
 Re-synchronizes a loaded library material to match its latest library definition.
void SetCategory (const NXString &materialCategory)
 Sets the material category.
void SetDescription (const NXString &materialDescription)
 Sets the material description.
void SetId (int materialId)
 Sets the material id.
void UnassignAllObjects ()
 Removes the material assignment from all the objects that has it currently assigned.

Detailed Description

Represents Physical Material
Created in NX5.0.0.



Member Enumeration Documentation

The different categories of materials.

The material list generated will be filtered based on the category

Enumerator:
CategoryMetals 

Metals.

CategoryPlastics 

Plastics.

CategoryPolymers 

Polymers.

CategoryCeramics 

Ceramics.

CategoryOther 

Other (Not metal, plastic, etc.)

The different types of materials.

The material list generated will be filtered based on the material type chosen

Enumerator:
TypeIsotropic 

Isotropic.

TypeOrthotropic 

Orthotropic.

TypeAnisotropic 

Anisotropic.

TypeGeneralHyperelastic 

Hyperelastic - General.

TypeMooneyrivlin 

Mooney Rivlin.

TypeMooneyrivlintestdata 

Mooney Rivlin - test data option.

TypePolynomial 

Polynomial.

TypeReducedpolynomial 

Reduced Polynomial.

TypeOgden 

Ogden.

TypeOgdentestdata 

Ogden - test data option.

TypeFoam 

Foam.

TypeFoamtestdata 

Foam - test data option.

TypeBlatz 

Blatz-Ko.

TypeArrudaboyce 

Arruda-Boyce.

TypeArrudaboycetestdata 

Arruda-Boyce - test data option.

TypeNeohooke 

Neo Hooke.

TypeNeohooketestdata 

Neo Hooke - test data option.

TypeMarlow 

Marlow.

TypeVanderwaals 

Van Der Waals.

TypeYeoh 

Yeoh.

TypeYeohtestdata 

Yeoh - test data option.

TypeGent 

Gent.

TypeGasket 

Gasket.

TypeGasketbehavior 

Gasket Behavior.

TypeShapememoryalloy 

Shape Memory Alloy.

TypeSussmanbathe 

Sussman-Bathe hyperelastic material.


Member Function Documentation

void NXOpen::PhysicalMaterial::AssignObjects ( const std::vector< NXOpen::NXObject * > &  objects)

Assigns the material to solid bodies.


Created in NX6.0.0.

License requirements : None

Parameters:
objectsobjects to assign this material to

Assigns the material to all solid bodies.


Created in NX7.5.3.

License requirements : None

Assigns the material to all solid bodies not using the preferred material.


Created in NX7.5.3.

License requirements : None

Assigns the material to all solid bodies without a material already assigned.


Created in NX7.5.3.

License requirements : None

Creates new (copied) material with same properties as the original material.

The name of the new (copied) material will be unique and based on the name of the original material.

Returns:
the new material copied from this material
Created in NX6.0.0.

License requirements : None
Parameters:
partObjectobject in part where to copy material to

Copies a library material to a part.

The copied (local) material, unlike a loaded library, material, can be modified.

Returns:
the new material copied from this material
Created in NX6.0.2.

License requirements : None
Parameters:
partObjectobject in part where to copy material to

Deletes a material from the part.


Created in NX6.0.0.

License requirements : None

Returns the material category.

Returns:
the category for the material
Created in NX6.0.0.

License requirements : None

Returns the material description.

Returns:
the description for the material
Created in NX6.0.0.

License requirements : None

Returns the material id.

Returns:
the id for the material
Created in NX7.5.0.

License requirements : None

Returns the library name if the material was loaded from a library.

Returns:
the name of the library or NULL for nonlibrary materials
Created in NX7.5.3.

License requirements : None

Returns the material type.

Returns:
the type for the material
Created in NX6.0.0.

License requirements : None

Returns the property table that contains the properties for this material.

Returns:

Created in NX7.5.3.

License requirements : None

Returns the Teamcenter item if the material was loaded from Teamcenter.

Returns:
the Teamcenter item or NULL for non-Teamcenter materials
Created in NX7.5.3.

License requirements : None
void NXOpen::PhysicalMaterial::GetUsage ( std::vector< NXOpen::NXObject * > &  objects)

Finds the objects using this material.


Created in NX6.0.0.

License requirements : None

Parameters:
objectsthe objects using the material

Returns the material version.

Returns:
the material version or NULL for non-versioned materials
Created in NX7.5.3.

License requirements : None

Displays the property values for the material in the information window.


Created in NX7.5.3.

License requirements : None

void NXOpen::PhysicalMaterial::InfoMaterialToFile ( bool  bOverride,
const NXString pcFileName 
)

Writes the property values for the material to a file.


Created in NX7.5.3.

License requirements : None

Parameters:
bOverrideif the file already exists, true override the file, false append to the file
pcFileNamethe full path including filename of file where the information should be written
NOTE: The full Unicode character set is not supported for this parameter.

Returns true if the material is loaded from a library (not Teamcenter)

Returns:
true if it a loaded library material and false if it is a local material or a Teamcenter item revision
Created in NX7.5.3.

License requirements : None

Returns true if the material is loaded from Teamcenter.

Returns:
true if it a loaded Teamcenter material and false if it is a local material or a loaded library material
Created in NX7.5.3.

License requirements : None

Returns true if the material is locally defined (not a library/Teamcenter material)

Returns:
true if it is a locally defined material and false if it is a loaded library material or Teamcenter item revision
Created in NX7.5.3.

License requirements : None

Re-synchronizes a loaded library material to match its latest library definition.


Created in NX7.5.2.

License requirements : None

void NXOpen::PhysicalMaterial::SetCategory ( const NXString materialCategory)

Sets the material category.


Created in NX6.0.0.

License requirements : None

Parameters:
materialCategorythe category for the material
NOTE: The full Unicode character set is not supported for this parameter.
void NXOpen::PhysicalMaterial::SetDescription ( const NXString materialDescription)

Sets the material description.


Created in NX6.0.0.

License requirements : None

Parameters:
materialDescriptionthe description for the material
void NXOpen::PhysicalMaterial::SetId ( int  materialId)

Sets the material id.


Created in NX7.5.0.

License requirements : None

Parameters:
materialIdthe id for the material

Removes the material assignment from all the objects that has it currently assigned.


Created in NX6.0.0.

License requirements : None


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