Interface Material
package com.ptc.pfc.pfcPart;
public interface Material
extends com.ptc.pfc.pfcModelItem.ParameterOwner,
com.ptc.pfc.pfcObject.Child
Description
This class provides information about a material.
Direct Known Subclasses:
User Guide References:
Parent_Child_Relationships_Between_Creo_Object_TOOLKIT_Java_Objects:Material, Materials:Material, Accessing Material Types:Material, Accessing Material Properties:Material, Accessing User-defined Material Properties:Material, Assembly Components:Material, Export Instructions:Material, Export Instructions Table:Material, Creo Object TOOLKIT Java Classes:Material
Methods Inherited from Interface com.ptc.pfc.pfcBase.ActionSource :
Methods Inherited from Interface com.ptc.pfc.pfcObject.Parent :
Methods Inherited from Interface com.ptc.pfc.pfcModelItem.ParameterOwner :
Methods Inherited from Interface com.ptc.pfc.pfcObject.Child :
Method Summary
void | Delete () |
Deletes the material from the part's database. | |
String | GetBendTable () |
Get method for attribute "BendTable" The bend table | |
String | GetCondition () |
Get method for attribute "Condition" The condition | |
/*optional*/ String | |
Get method for attribute "CrossHatchFile" The name of the cross-hatching file used in detailing for this material. | |
/*optional*/ String | |
Get method for attribute "Description" The material description string. | |
double | |
Get method for attribute "Emissivity" The emissivity | |
/*optional*/ String | |
Get method for attribute "FailureCriterion" The failure criterion. | |
/*optional*/ String | |
Get method for attribute "FatigueMaterialFinish" The fatigue material finish. | |
/*optional*/ String | |
Get method for attribute "FatigueMaterialType" The fatigue material type. | |
/*optional*/ String | |
Get method for attribute "FatigueType" The fatigue type. | |
Get method for attribute "FluidMaterialType" The material type for the fluid properties. | |
double | GetHardness () |
Get method for attribute "Hardness" The hardness | |
/*optional*/ String | |
Get method for attribute "HardnessType" The hardness type. | |
int | GetId () |
Get method for attribute "Id" The id of the material | |
double | |
Get method for attribute "InitBendYFactor" The initial bend Y-factor | |
double | |
Get method for attribute "MassDensity" The mass density | |
/*optional*/ String | |
Get method for attribute "MaterialModel" The type of hyperelastic material model. | |
/*optional*/ Boolean | |
Get method for attribute "ModelDefByTests" Specifies whether the selected hyperelastic material model is defined using test data. | |
String | GetName () |
Get method for attribute "Name" The name of the material | |
Get method for attribute "PermittedFailureCriteria" A list of the permitted string values for the material failure criterion. | |
Get method for attribute "PermittedFatigueMaterialFinishes" A list of the permitted string values for the material fatigue material finish. | |
Get method for attribute "PermittedFatigueMaterialTypes" A list of the permitted string values for the material fatigue material type. | |
Get method for attribute "PermittedFatigueTypes" A list of the permitted string values for the material fatigue type. | |
Get method for attribute "PermittedMaterialModels" A list of the permitted string values for the material model. | |
Get method for attribute "PermittedSubTypes" A list of the permitted string values for the material sub type. | |
double | |
Get method for attribute "PoissonRatio" The isotropic Poisson's ratio | |
/*optional*/ MaterialProperty | |
Returns the value and units for a material property. | |
double | |
Get method for attribute "ShearModulus" The isotropic shear modulus | |
double | |
Get method for attribute "SpecificHeat" The specific heat | |
double | |
Get method for attribute "StressLimCompress" The isotropic compression ultimate stress. | |
double | |
Get method for attribute "StressLimShear" The shear ultimate stress. | |
double | |
Get method for attribute "StressLimTension" The isotropic tensile ultimate stress. | |
double | |
Get method for attribute "StructDampCoef" The structural damping coefficient | |
Get method for attribute "StructuralMaterialType" The material type for the structural properties. | |
/*optional*/ String | GetSubType () |
Get method for attribute "SubType" The isotropic material type's sub type. | |
Get method for attribute "ThermalMaterialType" The material type for the thermal properties. | |
double | |
Get method for attribute "ThermConductivity" The isotropic thermal conductivity | |
double | |
Get method for attribute "ThermExpCoef" The isotropic thermal expansion coefficient | |
double | |
Get method for attribute "ThermExpRefTemp" The thermal expansion reference temperature | |
double | |
Get method for attribute "YoungModulus" The isotropic Young's modulus | |
void | |
Removes a material property. | |
void | Save (String FileName) |
Writes the specified part material to a file. | |
void | SetBendTable (String value) |
Set method for attribute "BendTable" The bend table | |
void | SetCondition (String value) |
Set method for attribute "Condition" The condition | |
void | SetCrossHatchFile ( /*optional*/ String value) |
Set method for attribute "CrossHatchFile" The name of the cross-hatching file used in detailing for this material. | |
void | SetCurrent () |
Sets the current material to its owner part. | |
void | SetDescription ( /*optional*/ String value) |
Set method for attribute "Description" The material description string. | |
void | SetEmissivity (double value) |
Set method for attribute "Emissivity" The emissivity | |
void | SetFailureCriterion ( /*optional*/ String value) |
Set method for attribute "FailureCriterion" The failure criterion. | |
void | SetFatigueMaterialFinish ( /*optional*/ String value) |
Set method for attribute "FatigueMaterialFinish" The fatigue material finish. | |
void | SetFatigueMaterialType ( /*optional*/ String value) |
Set method for attribute "FatigueMaterialType" The fatigue material type. | |
void | SetFatigueType ( /*optional*/ String value) |
Set method for attribute "FatigueType" The fatigue type. | |
void | |
Set method for attribute "FluidMaterialType" The material type for the fluid properties. | |
void | SetHardness (double value) |
Set method for attribute "Hardness" The hardness | |
void | SetHardnessType ( /*optional*/ String value) |
Set method for attribute "HardnessType" The hardness type. | |
void | SetInitBendYFactor (double value) |
Set method for attribute "InitBendYFactor" The initial bend Y-factor | |
void | SetMassDensity (double value) |
Set method for attribute "MassDensity" The mass density | |
void | SetMaterialModel ( /*optional*/ String value) |
Set method for attribute "MaterialModel" The type of hyperelastic material model. | |
void | SetModelDefByTests ( /*optional*/ Boolean value) |
Set method for attribute "ModelDefByTests" Specifies whether the selected hyperelastic material model is defined using test data. | |
void | SetPoissonRatio (double value) |
Set method for attribute "PoissonRatio" The isotropic Poisson's ratio | |
void | |
Sets the units for a material property. | |
void | |
Sets the value and units for a material property. | |
void | SetShearModulus (double value) |
Set method for attribute "ShearModulus" The isotropic shear modulus | |
void | SetSpecificHeat (double value) |
Set method for attribute "SpecificHeat" The specific heat | |
void | SetStressLimCompress (double value) |
Set method for attribute "StressLimCompress" The isotropic compression ultimate stress. | |
void | SetStressLimShear (double value) |
Set method for attribute "StressLimShear" The shear ultimate stress. | |
void | SetStressLimTension (double value) |
Set method for attribute "StressLimTension" The isotropic tensile ultimate stress. | |
void | SetStructDampCoef (double value) |
Set method for attribute "StructDampCoef" The structural damping coefficient | |
void | |
Set method for attribute "StructuralMaterialType" The material type for the structural properties. | |
void | SetSubType ( /*optional*/ String value) |
Set method for attribute "SubType" The isotropic material type's sub type. | |
void | |
Set method for attribute "ThermalMaterialType" The material type for the thermal properties. | |
void | SetThermConductivity (double value) |
Set method for attribute "ThermConductivity" The isotropic thermal conductivity | |
void | SetThermExpCoef (double value) |
Set method for attribute "ThermExpCoef" The isotropic thermal expansion coefficient | |
void | SetThermExpRefTemp (double value) |
Set method for attribute "ThermExpRefTemp" The thermal expansion reference temperature | |
void | SetYoungModulus (double value) |
Set method for attribute "YoungModulus" The isotropic Young's modulus |
Method Detail
GetName | ||
String | GetName | () |
The name of the material
GetId | ||
int | GetId | () |
The id of the material
GetStructuralMaterialType | ||
GetStructuralMaterialType | () | |
SetStructuralMaterialType | ||
void | SetStructuralMaterialType |
The material type for the structural properties.
User Guide References:
GetThermalMaterialType | ||
GetThermalMaterialType | () | |
SetThermalMaterialType | ||
void | SetThermalMaterialType |
The material type for the thermal properties.
User Guide References:
GetFluidMaterialType | ||
GetFluidMaterialType | () | |
SetFluidMaterialType | ||
void | SetFluidMaterialType |
The material type for the fluid properties.
User Guide References:
GetDescription | ||
/*optional*/ String | GetDescription | () |
SetDescription | ||
void | SetDescription | ( /*optional*/ String value) |
The material description string.
User Guide References:
GetCondition | ||
String | GetCondition | () |
SetCondition | ||
void | SetCondition | (String value) |
The condition
If this property is not set on the material, an attempt to retrieve it will throw a XToolkitNotFound exception.
User Guide References:
GetBendTable | ||
String | GetBendTable | () |
SetBendTable | ||
void | SetBendTable | (String value) |
The bend table
If this property is not set on the material, an attempt to retrieve it will throw a XToolkitNotFound exception.
User Guide References:
GetHardnessType | ||
/*optional*/ String | GetHardnessType | () |
SetHardnessType | ||
void | SetHardnessType | ( /*optional*/ String value) |
The hardness type.
User Guide References:
GetCrossHatchFile | ||
/*optional*/ String | GetCrossHatchFile | () |
SetCrossHatchFile | ||
void | SetCrossHatchFile | ( /*optional*/ String value) |
The name of the cross-hatching file used in detailing for this material.
User Guide References:
GetMaterialModel | ||
/*optional*/ String | GetMaterialModel | () |
SetMaterialModel | ||
void | SetMaterialModel | ( /*optional*/ String value) |
The type of hyperelastic material model.
Must be one of the members of Material.GetPermittedMaterialModels()
User Guide References:
GetPermittedMaterialModels | ||
GetPermittedMaterialModels | () |
A list of the permitted string values for the material model.
User Guide References:
GetSubType | ||
/*optional*/ String | GetSubType | () |
SetSubType | ||
void | SetSubType | ( /*optional*/ String value) |
The isotropic material type's sub type.
Must be one of the members of Material.GetPermittedSubTypes()
User Guide References:
GetPermittedSubTypes | ||
GetPermittedSubTypes | () |
A list of the permitted string values for the material sub type.
User Guide References:
GetModelDefByTests | ||
/*optional*/ Boolean | GetModelDefByTests | () |
SetModelDefByTests | ||
void | SetModelDefByTests | ( /*optional*/ Boolean value) |
Specifies whether the selected hyperelastic material model is defined using test data.
User Guide References:
GetFatigueType | ||
/*optional*/ String | GetFatigueType | () |
SetFatigueType | ||
void | SetFatigueType | ( /*optional*/ String value) |
The fatigue type.
Must be one of the members of Material.GetPermittedFatigueTypes()
User Guide References:
GetFatigueMaterialType | ||
/*optional*/ String | GetFatigueMaterialType | () |
SetFatigueMaterialType | ||
void | SetFatigueMaterialType | ( /*optional*/ String value) |
The fatigue material type.
Must be one of the members of Material.GetPermittedFatigueMaterialTypes()
User Guide References:
GetFatigueMaterialFinish | ||
/*optional*/ String | GetFatigueMaterialFinish | () |
SetFatigueMaterialFinish | ||
void | SetFatigueMaterialFinish | ( /*optional*/ String value) |
The fatigue material finish.
Must be one of the members of Material.GetPermittedFatigueMaterialFinishes()
User Guide References:
GetPermittedFatigueTypes | ||
GetPermittedFatigueTypes | () |
A list of the permitted string values for the material fatigue type.
User Guide References:
GetPermittedFatigueMaterialTypes | ||
GetPermittedFatigueMaterialTypes | () |
A list of the permitted string values for the material fatigue material type.
User Guide References:
GetPermittedFatigueMaterialFinishes | ||
GetPermittedFatigueMaterialFinishes | () |
A list of the permitted string values for the material fatigue material finish.
User Guide References:
GetFailureCriterion | ||
/*optional*/ String | GetFailureCriterion | () |
SetFailureCriterion | ||
void | SetFailureCriterion | ( /*optional*/ String value) |
The failure criterion.
Must be one of the members of Material.GetPermittedFailureCriteria()
User Guide References:
GetPermittedFailureCriteria | ||
GetPermittedFailureCriteria | () |
A list of the permitted string values for the material failure criterion.
User Guide References:
GetPropertyValue | ||
/*optional*/ MaterialProperty | GetPropertyValue |
Returns the value and units for a material property.
Exceptions thrown (but not limited to):
XToolkitNotFound - This means either:
• The material property unit type was not recognized, OR
• The material does not have this property assigned.
User Guide References:
Parameters:
Type
The type of property to retrieve.
Returns:
The value and units, or null, if the property is not set on the material.
SetPropertyValue | ||
void | SetPropertyValue |
Sets the value and units for a material property.
If the property doesn't exist on the material, this method creates it.
Exceptions thrown (but not limited to):
XToolkitBadContext - This property cannot be created on the material (because other properties assigned to the material already do not permit it).
XToolkitNotValid - The new value for the property lies outside the permitted ranges for the property.
XToolkitInvalidType - The new units for the property are not correct for this property type.
XToolkitCantModify - Cannot change the value of the property because it is driven by a parameter, relation or function.
See Also:
User Guide References:
Parameters:
Type
The type of property to set.
Value
The value and units to use for the property
Returns:
SetPropertyUnits | ||
void | SetPropertyUnits |
Sets the units for a material property.
Exceptions thrown (but not limited to):
XToolkitBadContext - This property cannot be created on the material (because other properties assigned to the material already do not permit it).
XToolkitNotValid - The new value for the property lies outside the permitted ranges for the property.
XToolkitInvalidType - The new units for the property are not correct for this property type.
XToolkitCantModify - Cannot change the value of the property because it is driven by a parameter, relation or function.
User Guide References:
Parameters:
Type
The type of property to set.
Units
The units to use for the property.
Convert
true to convert the property value to the new units. false or null to interpret the current value in the new units.
Returns:
RemoveProperty | ||
void | RemoveProperty |
Removes a material property.
Exceptions thrown (but not limited to):
XToolkitNotFound - This property does not exist on the material.
XToolkitBadContext - This property cannot be deleted on the material (because other properties assigned to the material already do not permit it).
User Guide References:
Parameters:
Type
The type of property to remove.
Returns:
GetYoungModulus | ||
double | GetYoungModulus | () |
SetYoungModulus | ||
void | SetYoungModulus | (double value) |
The isotropic Young's modulus
• This accesses the property value in the units of the model that owns this material. To access the value using its assigned units as you would find in the user interface, use Material.GetPropertyValue(MaterialPropertyType) and Material.SetPropertyValue(MaterialPropertyType, MaterialProperty).
• If this property is not set on the material, an attempt to retrieve it will throw a XToolkitNotFound exception.
GetPoissonRatio | ||
double | GetPoissonRatio | () |
SetPoissonRatio | ||
void | SetPoissonRatio | (double value) |
The isotropic Poisson's ratio
If this property is not set on the material, an attempt to retrieve it will throw a XToolkitNotFound exception.
GetShearModulus | ||
double | GetShearModulus | () |
SetShearModulus | ||
void | SetShearModulus | (double value) |
The isotropic shear modulus
• This accesses the property value in the units of the model that owns this material. To access the value using its assigned units as you would find in the user interface, use Material.GetPropertyValue(MaterialPropertyType) and Material.SetPropertyValue(MaterialPropertyType, MaterialProperty).
• If this property is not set on the material, an attempt to retrieve it will throw a XToolkitNotFound exception.
GetMassDensity | ||
double | GetMassDensity | () |
SetMassDensity | ||
void | SetMassDensity | (double value) |
The mass density
This accesses the property value in the units of the model that owns this material. To access the value using its assigned units as you would find in the user interface, use Material.GetPropertyValue(MaterialPropertyType) and Material.SetPropertyValue(MaterialPropertyType, MaterialProperty).
GetThermExpCoef | ||
double | GetThermExpCoef | () |
SetThermExpCoef | ||
void | SetThermExpCoef | (double value) |
The isotropic thermal expansion coefficient
• This accesses the property value in the units of the model that owns this material. To access the value using its assigned units as you would find in the user interface, use Material.GetPropertyValue(MaterialPropertyType) and Material.SetPropertyValue(MaterialPropertyType, MaterialProperty).
• If this property is not set on the material, an attempt to retrieve it will throw a XToolkitNotFound exception.
GetThermExpRefTemp | ||
double | GetThermExpRefTemp | () |
SetThermExpRefTemp | ||
void | SetThermExpRefTemp | (double value) |
The thermal expansion reference temperature
• This accesses the property value in the units of the model that owns this material. To access the value using its assigned units as you would find in the user interface, use Material.GetPropertyValue(MaterialPropertyType) and Material.SetPropertyValue(MaterialPropertyType, MaterialProperty).
• If this property is not set on the material, an attempt to retrieve it will throw a XToolkitNotFound exception.
GetStructDampCoef | ||
double | GetStructDampCoef | () |
SetStructDampCoef | ||
void | SetStructDampCoef | (double value) |
The structural damping coefficient
• This accesses the property value in the units of the model that owns this material. To access the value using its assigned units as you would find in the user interface, use Material.GetPropertyValue(MaterialPropertyType) and Material.SetPropertyValue(MaterialPropertyType, MaterialProperty).
• If this property is not set on the material, an attempt to retrieve it will throw a XToolkitNotFound exception.
GetStressLimTension | ||
double | GetStressLimTension | () |
SetStressLimTension | ||
void | SetStressLimTension | (double value) |
The isotropic tensile ultimate stress.
• This accesses the property value in the units of the model that owns this material. To access the value using its assigned units as you would find in the user interface, use Material.GetPropertyValue(MaterialPropertyType) and Material.SetPropertyValue(MaterialPropertyType, MaterialProperty).
• If this property is not set on the material, an attempt to retrieve it will throw a XToolkitNotFound exception.
• If the current material failure criterion doesn't accept this type, an attempt to set it will throw a XToolkitBadContext exception.
GetStressLimCompress | ||
double | GetStressLimCompress | () |
SetStressLimCompress | ||
void | SetStressLimCompress | (double value) |
The isotropic compression ultimate stress.
• This accesses the property value in the units of the model that owns this material. To access the value using its assigned units as you would find in the user interface, use Material.GetPropertyValue(MaterialPropertyType) and Material.SetPropertyValue(MaterialPropertyType, MaterialProperty).
• If this property is not set on the material, an attempt to retrieve it will throw a XToolkitNotFound exception.
• Compression stress values must be negative.
• If the current material failure criterion doesn't accept this type, an attempt to set it will throw a XToolkitBadContext exception.
GetStressLimShear | ||
double | GetStressLimShear | () |
SetStressLimShear | ||
void | SetStressLimShear | (double value) |
The shear ultimate stress.
• This accesses the property value in the units of the model that owns this material. To access the value using its assigned units as you would find in the user interface, use Material.GetPropertyValue(MaterialPropertyType) and Material.SetPropertyValue(MaterialPropertyType, MaterialProperty).
• If this property is not set on the material, an attempt to retrieve it will throw a XToolkitNotFound exception.
• If the current material failure criterion doesn't accept this type, an attempt to set it will throw a XToolkitBadContext exception.
GetThermConductivity | ||
double | GetThermConductivity | () |
SetThermConductivity | ||
void | SetThermConductivity | (double value) |
The isotropic thermal conductivity
• This accesses the property value in the units of the model that owns this material. To access the value using its assigned units as you would find in the user interface, use Material.GetPropertyValue(MaterialPropertyType) and Material.SetPropertyValue(MaterialPropertyType, MaterialProperty).
• If this property is not set on the material, an attempt to retrieve it will throw a XToolkitNotFound exception.
GetEmissivity | ||
double | GetEmissivity | () |
SetEmissivity | ||
void | SetEmissivity | (double value) |
The emissivity
If this property is not set on the material, an attempt to retrieve it will throw a XToolkitNotFound exception.
GetSpecificHeat | ||
double | GetSpecificHeat | () |
SetSpecificHeat | ||
void | SetSpecificHeat | (double value) |
The specific heat
• This accesses the property value in the units of the model that owns this material. To access the value using its assigned units as you would find in the user interface, use Material.GetPropertyValue(MaterialPropertyType) and Material.SetPropertyValue(MaterialPropertyType, MaterialProperty).
• If this property is not set on the material, an attempt to retrieve it will throw a XToolkitNotFound exception.
GetHardness | ||
double | GetHardness | () |
SetHardness | ||
void | SetHardness | (double value) |
The hardness
If this property is not set on the material, an attempt to retrieve it will throw a XToolkitNotFound exception.
User Guide References:
GetInitBendYFactor | ||
double | GetInitBendYFactor | () |
SetInitBendYFactor | ||
void | SetInitBendYFactor | (double value) |
The initial bend Y-factor
If this property is not set on the material, an attempt to retrieve it will throw a XToolkitNotFound exception.
Delete | ||
void | Delete | () |
Deletes the material from the part's database.
User Guide References:
Returns:
Save | ||
void | Save | (String FileName) |
Writes the specified part material to a file.
Exceptions thrown (but not limited to):
XToolkitBadContext - The function is not available in Design Test Mode.
User Guide References:
Parameters:
FileName
The name of the output material file
Returns:
SetCurrent | ||
void | SetCurrent | () |
Sets the current material to its owner part.
Returns: