CIP Visual Basic.NET documentation for interface "IpfcMaterial"

Interface IpfcMaterial

Description

This class provides information about a material.

Direct Parent Classes:: IpfcParameterOwner, IpfcChild

Property Summary


`Property`	`BendTable`	`as String`
	The bend table

`Property`	`Condition`	`as String`
	The condition

`Property`	`CrossHatchFile`	`as String [optional]`
	The name of the cross-hatching file used in detailing for this material.

`Property`	`Description`	`as String [optional]`
	The material description string.

`Property`	`Emissivity`	`as Double`
	The emissivity

`Property`	`FailureCriterion`	`as String [optional]`
	The failure criterion.

`Property`	`FatigueMaterialFinish`	`as String [optional]`
	The fatigue material finish.

`Property`	`FatigueMaterialType`	`as String [optional]`
	The fatigue material type.

`Property`	`FatigueType`	`as String [optional]`
	The fatigue type.

`Property`	`FluidMaterialType`	`as IpfcMaterialType`
	The material type for the fluid properties.

`Property`	`Hardness`	`as Double`
	The hardness

`Property`	`HardnessType`	`as String [optional]`
	The hardness type.

`Property`	`Id`	`as Long`
	The id of the material

`Property`	`InitBendYFactor`	`as Double`
	The initial bend Y-factor

`Property`	`MassDensity`	`as Double`
	The mass density

`Property`	`MaterialModel`	`as String [optional]`
	The type of hyperelastic material model.

`Property`	`ModelDefByTests`	`as Boolean [optional]`
	Specifies whether the selected hyperelastic material model is defined using test data.

`Property`	`Name`	`as String`
	The name of the material

`Property`	`PermittedFailureCriteria`	`as Istringseq`
	A list of the permitted string values for the material failure criterion.

`Property`	`PermittedFatigueMaterialFinishes`	`as Istringseq`
	A list of the permitted string values for the material fatigue material finish.

`Property`	`PermittedFatigueMaterialTypes`	`as Istringseq`
	A list of the permitted string values for the material fatigue material type.

`Property`	`PermittedFatigueTypes`	`as Istringseq`
	A list of the permitted string values for the material fatigue type.

`Property`	`PermittedMaterialModels`	`as Istringseq`
	A list of the permitted string values for the material model.

`Property`	`PermittedSubTypes`	`as Istringseq`
	A list of the permitted string values for the material sub type.

`Property`	`PoissonRatio`	`as Double`
	The isotropic Poisson's ratio

`Property`	`ShearModulus`	`as Double`
	The isotropic shear modulus

`Property`	`SpecificHeat`	`as Double`
	The specific heat

`Property`	`StressLimCompress`	`as Double`
	The isotropic compression ultimate stress.

`Property`	`StressLimShear`	`as Double`
	The shear ultimate stress.

`Property`	`StressLimTension`	`as Double`
	The isotropic tensile ultimate stress.

`Property`	`StructDampCoef`	`as Double`
	The structural damping coefficient

`Property`	`StructuralMaterialType`	`as IpfcMaterialType`
	The material type for the structural properties.

`Property`	`SubType`	`as String [optional]`
	The isotropic material type's sub type.

`Property`	`ThermalMaterialType`	`as IpfcMaterialType`
	The material type for the thermal properties.

`Property`	`ThermConductivity`	`as Double`
	The isotropic thermal conductivity

`Property`	`ThermExpCoef`	`as Double`
	The isotropic thermal expansion coefficient

`Property`	`ThermExpRefTemp`	`as Double`
	The thermal expansion reference temperature

`Property`	`YoungModulus`	`as Double`
	The isotropic Young's modulus

Method Summary


`Sub`	`Delete ()`
	Deletes the material from the part's database.

`Function`	`GetPropertyValue (Type as IpfcMaterialPropertyType) as IpfcMaterialProperty [optional]`
	Returns the value and units for a material property.

`Sub`	`RemoveProperty (Type as IpfcMaterialPropertyType)`
	Removes a material property.

`Sub`	`Save (FileName as String)`
	Writes the specified part material to a file.

`Sub`	`SetCurrent ()`
	Sets the current material to its owner part.

`Sub`	`SetPropertyUnits (Type as IpfcMaterialPropertyType, Units as String, Convert as Boolean [optional])`
	Sets the units for a material property.

`Sub`	`SetPropertyValue (Type as IpfcMaterialPropertyType, Value as IpfcMaterialProperty)`
	Sets the value and units for a material property.

Property Detail

Property BendTable as String

The bend table

If this property is not set on the material, an attempt to retrieve it will throw a IpfcXToolkitNotFound exception.

Property Condition as String

The condition

If this property is not set on the material, an attempt to retrieve it will throw a IpfcXToolkitNotFound exception.

Property CrossHatchFile as String [optional]

The name of the cross-hatching file used in detailing for this material.

Property Description as String [optional]

The material description string.

Property Emissivity as Double

The emissivity

If this property is not set on the material, an attempt to retrieve it will throw a IpfcXToolkitNotFound exception.

Property FailureCriterion as String [optional]

The failure criterion.

Must be one of the members of IpfcMaterial.PermittedFailureCriteria

Property FatigueMaterialFinish as String [optional]

The fatigue material finish.

Must be one of the members of IpfcMaterial.PermittedFatigueMaterialFinishes

Property FatigueMaterialType as String [optional]

The fatigue material type.

Must be one of the members of IpfcMaterial.PermittedFatigueMaterialTypes

Property FatigueType as String [optional]

The fatigue type.

Must be one of the members of IpfcMaterial.PermittedFatigueTypes

Property FluidMaterialType as IpfcMaterialType

The material type for the fluid properties.

Property Hardness as Double

The hardness

If this property is not set on the material, an attempt to retrieve it will throw a IpfcXToolkitNotFound exception.

Property HardnessType as String [optional]

The hardness type.

Property Id as Long

The id of the material

Property InitBendYFactor as Double

The initial bend Y-factor

If this property is not set on the material, an attempt to retrieve it will throw a IpfcXToolkitNotFound exception.

Property MassDensity as Double

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 IpfcMaterial.GetPropertyValue() and IpfcMaterial.SetPropertyValue().

Property MaterialModel as String [optional]

The type of hyperelastic material model.

Must be one of the members of IpfcMaterial.PermittedMaterialModels

Property ModelDefByTests as Boolean [optional]

Specifies whether the selected hyperelastic material model is defined using test data.

Property Name as String

The name of the material

Property PermittedFailureCriteria as Istringseq

A list of the permitted string values for the material failure criterion.

Property PermittedFatigueMaterialFinishes as Istringseq

A list of the permitted string values for the material fatigue material finish.

Property PermittedFatigueMaterialTypes as Istringseq

A list of the permitted string values for the material fatigue material type.

Property PermittedFatigueTypes as Istringseq

A list of the permitted string values for the material fatigue type.

Property PermittedMaterialModels as Istringseq

A list of the permitted string values for the material model.

Property PermittedSubTypes as Istringseq

A list of the permitted string values for the material sub type.

Property PoissonRatio as Double

The isotropic Poisson's ratio

If this property is not set on the material, an attempt to retrieve it will throw a IpfcXToolkitNotFound exception.

Property ShearModulus as Double

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 IpfcMaterial.GetPropertyValue() and IpfcMaterial.SetPropertyValue().
If this property is not set on the material, an attempt to retrieve it will throw a IpfcXToolkitNotFound exception.

Property SpecificHeat as Double

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 IpfcMaterial.GetPropertyValue() and IpfcMaterial.SetPropertyValue().
If this property is not set on the material, an attempt to retrieve it will throw a IpfcXToolkitNotFound exception.

Property StressLimCompress as Double

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 IpfcMaterial.GetPropertyValue() and IpfcMaterial.SetPropertyValue().
If this property is not set on the material, an attempt to retrieve it will throw a IpfcXToolkitNotFound 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 IpfcXToolkitBadContext exception.

Property StressLimShear as Double

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 IpfcMaterial.GetPropertyValue() and IpfcMaterial.SetPropertyValue().
If this property is not set on the material, an attempt to retrieve it will throw a IpfcXToolkitNotFound exception.
If the current material failure criterion doesn't accept this type, an attempt to set it will throw a IpfcXToolkitBadContext exception.

Property StressLimTension as Double

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 IpfcMaterial.GetPropertyValue() and IpfcMaterial.SetPropertyValue().
If this property is not set on the material, an attempt to retrieve it will throw a IpfcXToolkitNotFound exception.
If the current material failure criterion doesn't accept this type, an attempt to set it will throw a IpfcXToolkitBadContext exception.

Property StructDampCoef as Double

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 IpfcMaterial.GetPropertyValue() and IpfcMaterial.SetPropertyValue().
If this property is not set on the material, an attempt to retrieve it will throw a IpfcXToolkitNotFound exception.

Property StructuralMaterialType as IpfcMaterialType

The material type for the structural properties.

Property SubType as String [optional]

The isotropic material type's sub type.

Must be one of the members of IpfcMaterial.PermittedSubTypes

Property ThermalMaterialType as IpfcMaterialType

The material type for the thermal properties.

Property ThermConductivity as Double

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 IpfcMaterial.GetPropertyValue() and IpfcMaterial.SetPropertyValue().
If this property is not set on the material, an attempt to retrieve it will throw a IpfcXToolkitNotFound exception.

Property ThermExpCoef as Double

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 IpfcMaterial.GetPropertyValue() and IpfcMaterial.SetPropertyValue().
If this property is not set on the material, an attempt to retrieve it will throw a IpfcXToolkitNotFound exception.

Property ThermExpRefTemp as Double

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 IpfcMaterial.GetPropertyValue() and IpfcMaterial.SetPropertyValue().
If this property is not set on the material, an attempt to retrieve it will throw a IpfcXToolkitNotFound exception.

Property YoungModulus as Double

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 IpfcMaterial.GetPropertyValue() and IpfcMaterial.SetPropertyValue().
If this property is not set on the material, an attempt to retrieve it will throw a IpfcXToolkitNotFound exception.

Method Detail

Sub Delete ()

Deletes the material from the part's database.

Function GetPropertyValue (Type as IpfcMaterialPropertyType) as IpfcMaterialProperty [optional]

Returns the value and units for a material property.

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - This means either:

The material property unit type was not recognized, OR
The material does not have this property assigned.

Parameters:

Type: The type of property to retrieve.

Returns:: The value and units, or null, if the property is not set on the material.

Sub RemoveProperty (Type as IpfcMaterialPropertyType)

Removes a material property.

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - This property does not exist on the material.

IpfcXToolkitBadContext - This property cannot be deleted on the material (because other properties assigned to the material already do not permit it).

Parameters:

Type: The type of property to remove.

Sub Save (FileName as String)

Writes the specified part material to a file.

Exceptions thrown (but not limited to):

IpfcXToolkitBadContext - The function is not available in Design Test Mode.

Parameters:

FileName: The name of the output material file

Sub SetCurrent ()

Sets the current material to its owner part.

Sub SetPropertyUnits (Type as IpfcMaterialPropertyType, Units as String, Convert as Boolean [optional])

Sets the units for a material property.

Exceptions thrown (but not limited to):

IpfcXToolkitBadContext - This property cannot be created on the material (because other properties assigned to the material already do not permit it).

IpfcXToolkitNotValid - The new value for the property lies outside the permitted ranges for the property.

IpfcXToolkitInvalidType - The new units for the property are not correct for this property type.

IpfcXToolkitCantModify - Cannot change the value of the property because it is driven by a parameter, relation or function.

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.

Sub SetPropertyValue (Type as IpfcMaterialPropertyType, Value as IpfcMaterialProperty)

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):

IpfcXToolkitBadContext - This property cannot be created on the material (because other properties assigned to the material already do not permit it).

IpfcXToolkitNotValid - The new value for the property lies outside the permitted ranges for the property.

IpfcXToolkitInvalidType - The new units for the property are not correct for this property type.

IpfcXToolkitCantModify - Cannot change the value of the property because it is driven by a parameter, relation or function.

See Also:: IpfcMaterialProperty.Create()

Parameters:

Type: The type of property to set.
Value: The value and units to use for the property