NX Open C++ Reference Guide
Classes | Public Member Functions
NXOpen::PhysicalMaterialCollection Class Reference

Represents the collection of all PhysicalMaterial objects in this Part. More...

Inheritance diagram for NXOpen::PhysicalMaterialCollection:
NXOpen::TaggedObjectCollection

List of all members.

Classes

class  iterator
 Iterator for accessing the contents of the collection. More...

Public Member Functions

bool AnyBodiesWithoutMaterial ()
 Returns true if there are bodies in the specified part that do not have a material assigned to them; false if all bodies in the part have a material assigned.
bool AnyBodiesWithoutPreferredMaterial ()
 Returns true if there are bodies that do not have the preferred material assigned to them and false if all bodies are assigned the preferred material.
iterator begin ()
 Returns an iterator addressing the first element.
NXOpen::PhysicalMaterialCopyMaterialFromLibrary (const NXString &libraryName, const NXString &libraryReference)
 Creates an editable material (copy) in the part from a library material definition.
NXOpen::PhysicalMaterialCopyMaterialItemRevision (const NXString &pcMatlItem, const NXString &pcRevisionID)
 Creates an editable material (copy) in the part from a Teamcenter material item revision.
NXOpen::PhysMat::PhysicalMaterialListBuilderCreateListBlockBuilder ()
 Creates a PhysMat::PhysicalMaterialListBuilder that controls the physical materials list UI block look and feel as well as capturing the interactions so the values/settings can be journaled.
NXOpen::PhysMat::PhysicalMaterialAssignBuilderCreateMaterialAssignBuilder ()
 Creates a PhysMat.MaterialAssignBuilder that is used to control/set the material assign UI as well as to assign materials to bodies.
NXOpen::PhysMat::PhysicalMaterialLibMgrBuilderCreateMaterialLibmgrBuilder ()
 Creates a PhysMat.PhysicalMaterialLibMgrBuilder used by the material library manager UI to control the look and feel as well as capturing the interactions so the values/settings can be journaled.
NXOpen::PhysicalMaterialBuilderCreatePhysicalMaterialBuilder (NXOpen::PhysicalMaterial::Type materialType)
 Creates a PhysMat.PhysicalMaterialBuilder used to create a physical materials of a given type.
NXOpen::PhysicalMaterialBuilderCreatePhysicalMaterialEditBuilder (NXOpen::PhysicalMaterial *physicalMaterial)
 Creates a PhysMat.PhysicalMaterialBuilder used to edit physical materials.
NXOpen::PhysicalMaterialBuilderCreatePhysicalMaterialInspectBuilder (NXOpen::PhysicalMaterial *physicalMaterial)
 Creates a PhysMat.PhysicalMaterialBuilder used to inspect physical materials.
void DeleteMaterialsFromLibrary (std::vector< NXString > &pMatlNames, const NXString &pcLibName)
 Deletes the materials from a material library file.
iterator end ()
 Returns an iterator addressing one past the last element.
void ExportMaterialsToLibrary (std::vector< NXString > &pcMatlNames, std::vector< NXString > &pcLibNames, const NXString &pcExportedLibName, bool bUpdateLibraryReference)
 Writes out materials to a material library file.
void FindBodiesWithoutMaterial (std::vector< NXOpen::TaggedObject * > &objects)
 Returns the bodies that don't have a material assigned.
void FindBodiesWithoutPreferredMaterial (std::vector< NXOpen::TaggedObject * > &objects)
 Returns the bodies that are not using the preferred material (either no material assigned or the non-preferred a different material assigned).
NXOpen::MaterialFindObject (const NXString &journalIdentifier)
 Finds the PhysicalMaterial with the given identifier as recorded in a journal.
NXOpen::PhysicalMaterialGetLoadedLibraryMaterial (const NXString &pcLibName, const NXString &pcMatlName)
 Checks if a library material is loaded into a part file or not.
NXOpen::PhysicalMaterialGetLoadedMaterialItemRevision (const NXString &pcMatlItem, const NXString &pcRevisionID)
 Checks if a Teamcenter material item revision is loaded into a part file or not.
std::vector
< NXOpen::PhysicalMaterial * > 
GetUsedMaterials ()
 Returns the materials used in the part.
void InfoItemRevision (const NXString &pcMaterialItem, const NXString &pcRevision)
 Displays the property values for the specified Teamcenter Material Item Revision in the information window.
void InfoItemRevisionToFile (const NXString &pcMaterialItem, const NXString &pcRevision, bool bOverride, const NXString &pcFileName)
 Writes the property values for the specified Teamcenter Material Item Revision to a file.
void InfoLibraryMaterial (const NXString &pcLibAr, const NXString &pcMatlNameAr)
 Displays the property values for the specified library material in the information window.
void InfoLibraryMaterialToFile (const NXString &pcLibAr, const NXString &pcMatlNameAr, bool bOverride, const NXString &pcFileName)
 Writes the property values for the specified library material to a file.
NXOpen::PhysicalMaterialLoadFromLegacynxlibrary (const NXString &libraryReference)
 Creates a non-editable material in the part from the legacy (phys_material.dat) material library definition.
NXOpen::PhysicalMaterialLoadFromLibrary (const NXString &pcLibName, const NXString &pcMatlName)
 Creates a non-editable material in the part from a material library name.
NXOpen::PhysicalMaterialLoadFromMatmlLibrary (const NXString &libraryName, const NXString &materialName)
 Creates a non-editable material in the part from a MatML file definition.
NXOpen::PhysicalMaterialLoadFromNxlibrary (const NXString &libraryReference)
 Creates a non-editable material in the part from a NX Material Library definition.
NXOpen::PhysicalMaterialLoadFromNxmatmllibrary (const NXString &materialName)
 Creates a non-editable material in the part from a NX MatML material definition.
NXOpen::PhysicalMaterialLoadMaterialItemRevision (const NXString &pcMatlItem, const NXString &pcRevisionID)
 Creates a non-editable material in the part from a Teamcenter material item revision.
void OutputMaterialsToLibrary (std::vector< NXString > &pcMatlNames, std::vector< NXString > &pcLibNames, const NXString &pcExportedLibName)
 Writes out materials to a material library file.
tag_t Tag () const
 Returns the tag of this object.
void UpdateMaterialsInLibrary (const std::vector< NXOpen::PhysicalMaterial * > &tEditedMatl, std::vector< NXString > &pMatlNames, const NXString &pcLibName)
 Updates the materials in a material library file.

Detailed Description

Represents the collection of all PhysicalMaterial objects in this Part.


To obtain an instance of this class, refer to MaterialManager

Created in NX5.0.0.


Member Function Documentation

Returns true if there are bodies in the specified part that do not have a material assigned to them; false if all bodies in the part have a material assigned.

Returns:

Created in NX7.5.2.

License requirements : None

Returns true if there are bodies that do not have the preferred material assigned to them and false if all bodies are assigned the preferred material.

If there is not a preferred material specified, the return value is true.

Returns:

Created in NX7.5.3.

License requirements : None

Returns an iterator addressing the first element.

Creates an editable material (copy) in the part from a library material definition.

Returns:
the copied material
Created in NX6.0.4.

License requirements : None
Parameters:
libraryNamethe fully qualified library name or if the leaf it will use the current directory, followed by the user and site directories set up in the customer defaults
NOTE: The full Unicode character set is not supported for this parameter.
libraryReferencethe material name/identifier
NOTE: The full Unicode character set is not supported for this parameter.

Creates an editable material (copy) in the part from a Teamcenter material item revision.

Returns:
the copied material
Created in NX7.5.3.

License requirements : None
Parameters:
pcMatlItemthe material item
NOTE: The full Unicode character set is not supported for this parameter.
pcRevisionIDthe revision identifier
NOTE: The full Unicode character set is not supported for this parameter.

Creates a PhysMat::PhysicalMaterialListBuilder that controls the physical materials list UI block look and feel as well as capturing the interactions so the values/settings can be journaled.

Returns:
created PhysMat::PhysicalMaterialListBuilder
Created in NX6.0.0.

License requirements : None

Creates a PhysMat.MaterialAssignBuilder that is used to control/set the material assign UI as well as to assign materials to bodies.

Returns:
created PhysMat::PhysicalMaterialAssignBuilder
Created in NX6.0.0.

License requirements : None

Creates a PhysMat.PhysicalMaterialLibMgrBuilder used by the material library manager UI to control the look and feel as well as capturing the interactions so the values/settings can be journaled.

Returns:
created PhysMat::PhysicalMaterialLibMgrBuilder
Created in NX6.0.2.

License requirements : None

Creates a PhysMat.PhysicalMaterialBuilder used to create a physical materials of a given type.

Returns:
created PhysicalMaterialBuilder
Created in NX6.0.0.

License requirements : None
Parameters:
materialTypeType of PhysicalMaterial to be created

Creates a PhysMat.PhysicalMaterialBuilder used to edit physical materials.

Returns:
created PhysicalMaterialBuilder
Created in NX6.0.0.

License requirements : None
Parameters:
physicalMaterialPhysicalMaterial to be edited

Creates a PhysMat.PhysicalMaterialBuilder used to inspect physical materials.

Returns:
created PhysicalMaterialBuilder
Created in NX7.5.0.

License requirements : None
Parameters:
physicalMaterialPhysicalMaterial to be inspected
void NXOpen::PhysicalMaterialCollection::DeleteMaterialsFromLibrary ( std::vector< NXString > &  pMatlNames,
const NXString pcLibName 
)

Deletes the materials from a material library file.

Write access is needed for this operation.


Created in NX6.0.2.

License requirements : None

Parameters:
pMatlNamesArrays of identifiers of the materials to be deleted from the library
NOTE: The full Unicode character set is not supported for this parameter.
pcLibNameLibrary to modify
NOTE: The full Unicode character set is not supported for this parameter.

Returns an iterator addressing one past the last element.

void NXOpen::PhysicalMaterialCollection::ExportMaterialsToLibrary ( std::vector< NXString > &  pcMatlNames,
std::vector< NXString > &  pcLibNames,
const NXString pcExportedLibName,
bool  bUpdateLibraryReference 
)

Writes out materials to a material library file.

These materials can be local material definitions or material definitions from other material libraries. The combination of the material name and library name identify a material definition. If the material definition is for a local material, the name is specified and the library name is specified as "". Write access is needed for the Exported library. If the bUpdateLibraryReferences is set to true, the NX model is updated to reflect the exported library as the library the material is now referenced in.


Created in NX7.5.2.

License requirements : None

Parameters:
pcMatlNamesArray of identifiers of the materials to be exported
NOTE: The full Unicode character set is not supported for this parameter.
pcLibNamesArray of library names corresponding to the material names
NOTE: The full Unicode character set is not supported for this parameter.
pcExportedLibNameThe library to write the material definitions to
NOTE: The full Unicode character set is not supported for this parameter.
bUpdateLibraryReferencetrue indicates that the library reference of loaded/local materials should now refer to the exported library, false indicates the library reference should remain unchanged

Returns the bodies that don't have a material assigned.


Created in NX7.5.2.

License requirements : None

Parameters:
objectsthe array of bodies without a material

Returns the bodies that are not using the preferred material (either no material assigned or the non-preferred a different material assigned).


Created in NX7.5.2.

License requirements : None

Parameters:
objectsthe array of bodies not using preferred material

Finds the PhysicalMaterial with the given identifier as recorded in a journal.

An exception will be thrown if no object can be found with the given journal identifier.

Returns:
material found
Created in NX5.0.0.

License requirements : None
Parameters:
journalIdentifierIdentifier to be found

Checks if a library material is loaded into a part file or not.

If it is, the loaded material is returned.

Returns:
the loaded material
Created in NX7.5.3.

License requirements : None
Parameters:
pcLibNamethe fully qualified library name or if the leaf it will use the current directory, followed by the user and site directories set up in the customer defaults
NOTE: The full Unicode character set is not supported for this parameter.
pcMatlNamethe material name
NOTE: The full Unicode character set is not supported for this parameter.

Checks if a Teamcenter material item revision is loaded into a part file or not.

If it is, the loaded material is returned.

Returns:
the loaded material
Created in NX7.5.3.

License requirements : None
Parameters:
pcMatlItemthe material item
NOTE: The full Unicode character set is not supported for this parameter.
pcRevisionIDthe revision identifier
NOTE: The full Unicode character set is not supported for this parameter.

Returns the materials used in the part.

Returns:
Materials used
Created in NX8.0.1.

License requirements : None
void NXOpen::PhysicalMaterialCollection::InfoItemRevision ( const NXString pcMaterialItem,
const NXString pcRevision 
)

Displays the property values for the specified Teamcenter Material Item Revision in the information window.


Created in NX7.5.3.

License requirements : None

Parameters:
pcMaterialItemthe material item
NOTE: The full Unicode character set is not supported for this parameter.
pcRevisionthe revision identifier
NOTE: The full Unicode character set is not supported for this parameter.
void NXOpen::PhysicalMaterialCollection::InfoItemRevisionToFile ( const NXString pcMaterialItem,
const NXString pcRevision,
bool  bOverride,
const NXString pcFileName 
)

Writes the property values for the specified Teamcenter Material Item Revision to a file.


Created in NX7.5.3.

License requirements : None

Parameters:
pcMaterialItemthe material item
NOTE: The full Unicode character set is not supported for this parameter.
pcRevisionthe revision identifier
NOTE: The full Unicode character set is not supported for this parameter.
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.
void NXOpen::PhysicalMaterialCollection::InfoLibraryMaterial ( const NXString pcLibAr,
const NXString pcMatlNameAr 
)

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


Created in NX7.5.3.

License requirements : None

Parameters:
pcLibArthe library name
NOTE: The full Unicode character set is not supported for this parameter.
pcMatlNameArthe material name
NOTE: The full Unicode character set is not supported for this parameter.
void NXOpen::PhysicalMaterialCollection::InfoLibraryMaterialToFile ( const NXString pcLibAr,
const NXString pcMatlNameAr,
bool  bOverride,
const NXString pcFileName 
)

Writes the property values for the specified library material to a file.


Created in NX7.5.3.

License requirements : None

Parameters:
pcLibArthe library name
NOTE: The full Unicode character set is not supported for this parameter.
pcMatlNameArthe material name
NOTE: The full Unicode character set is not supported for this parameter.
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.

Creates a non-editable material in the part from the legacy (phys_material.dat) material library definition.

The material is identified by the unique material identifier in the phys_material.dat file.

Returns:
the loaded material
Created in NX7.5.0.

License requirements : None
Parameters:
libraryReferencethe unique library reference for a material in this Library
NOTE: The full Unicode character set is not supported for this parameter.

Creates a non-editable material in the part from a material library name.

Returns:
the loaded material
Created in NX7.5.3.

License requirements : None
Parameters:
pcLibNamethe fully qualified library name or if the leaf it will use the current directory, followed by the user and site directories set up in the customer defaults
NOTE: The full Unicode character set is not supported for this parameter.
pcMatlNamethe material name
NOTE: The full Unicode character set is not supported for this parameter.

Creates a non-editable material in the part from a MatML file definition.

The material is identified by the library name and the unique material name. If the library name is not fully qualified, it will attempt to find a MatML library with this name in the current directory, followed by the specified customer defaults values for the user and site MatML libraries. If the customer defaults are using the file format, it will look in the directory where the specified file is located.

Returns:
the loaded material
Created in NX6.0.2.

License requirements : None
Parameters:
libraryNamethe fully qualified library name or if the leaf it will use the current directory, followed by the user and site directories set up in the customer defaults
NOTE: The full Unicode character set is not supported for this parameter.
materialNamethe material name
NOTE: The full Unicode character set is not supported for this parameter.

Creates a non-editable material in the part from a NX Material Library definition.

It is preferable to use either NX MatML or NX Legacy library versions as they will have better performance.

Returns:
the loaded material
Created in NX6.0.0.

License requirements : None
Parameters:
libraryReferencethe unique library reference for a material in this Library
NOTE: The full Unicode character set is not supported for this parameter.

Creates a non-editable material in the part from a NX MatML material definition.

Returns:
the loaded material
Created in NX7.5.0.

License requirements : None
Parameters:
materialNamethe unique material name from within this Library
NOTE: The full Unicode character set is not supported for this parameter.

Creates a non-editable material in the part from a Teamcenter material item revision.

Returns:
the loaded material
Created in NX7.5.3.

License requirements : None
Parameters:
pcMatlItemthe material item
NOTE: The full Unicode character set is not supported for this parameter.
pcRevisionIDthe revision identifier
NOTE: The full Unicode character set is not supported for this parameter.
void NXOpen::PhysicalMaterialCollection::OutputMaterialsToLibrary ( std::vector< NXString > &  pcMatlNames,
std::vector< NXString > &  pcLibNames,
const NXString pcExportedLibName 
)

Writes out materials to a material library file.

These materials can be local material definitions or material definitions from other material libraries. The combination of the material name and library name identify a material definition. If the material definition is for a local material, the name is specified and the library name is specified as "". Write access is needed for the Exported library.
Created in NX6.0.2.

License requirements : None

Parameters:
pcMatlNamesArray of identifiers of the materials to be exported
NOTE: The full Unicode character set is not supported for this parameter.
pcLibNamesArray of library names corresponding to the material names
NOTE: The full Unicode character set is not supported for this parameter.
pcExportedLibNameThe library to write the material definitions to
NOTE: The full Unicode character set is not supported for this parameter.

Returns the tag of this object.

void NXOpen::PhysicalMaterialCollection::UpdateMaterialsInLibrary ( const std::vector< NXOpen::PhysicalMaterial * > &  tEditedMatl,
std::vector< NXString > &  pMatlNames,
const NXString pcLibName 
)

Updates the materials in a material library file.

Write access is needed for this operation.


Created in NX6.0.2.

License requirements : None

Parameters:
tEditedMatlArray of loaded material tags
pMatlNamesArray of the material names which match the name in the library that should take the properties of the corresponding material (tEditedMatl)
NOTE: The full Unicode character set is not supported for this parameter.
pcLibNameLibrary to modify
NOTE: The full Unicode character set is not supported for this parameter.

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