Public View Protected View Private View

All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATMatInterfaces Interface CATMaterialTools

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATMaterialTools

Class method to provide services on Material.
Role: Class designed to provide information about the Material.

Method Index

o GetDomain(CATIMaterialDomainContent*,CATIMaterialDomain*&): Retrieves the domain from its applicative data.
o GetDomainCompositesType(CATIType_var&): Get the CATIType associated to composite domains.
o GetDomainDraftingType(CATIType_var&): Get the CATIType associated to drafting domains.
o GetDomainInstance(CATIMaterialDomain*,CATIPLMNavEntity*&): Retrieves the domain instance from a domain.
o GetDomainLinearElasticType(CATIType_var&)
o GetDomainRenderingType(CATIType_var&): Get the CATIType associated to rendering domains.
o GetDomainSimulationType(CATIType_var&): Get the CATIType associated to simulation domains.
o GetMaterialCoreType(CATIType_var&): Get the CATIType associated to material Core.
o GetMaterialCoveringType(CATIType_var&): Get the CATIType associated to material Covering.
o GetMaterialFactory(CATIMaterialReferenceFactory*&): Retrieves a Factory to create new material.

Methods

o GetDomain

public static GetDomain(		`ipiCont`,
		`opiDom`)

Retrieves the domain from its applicative data.
In the case of domain based on V5SimuRep.

Parameters:

ipiCont: The applicative data which belong to a given Domain.
opiDom: [out , CATBaseUnknown#Release] The domain owner of ipiFeat.
You have to release the pointer after use.

Returns:

An HRESULT
Legal values:

S_OK: The domain was successfully retrieved.
E_FAIL: The operation failed. Nothing returned.

o GetDomainCompositesType

public static GetDomainCompositesType( ospDomCompositesType)

Get the CATIType associated to composite domains.
Returns the root type. If those types have been derived use the Knowledge APIs to retrieve it.
Use if you want to retrieve the type.

Parameters:

ospDomCompositesType: A smart pointer to the type.

Returns:

An HRESULT
Legal values:

S_OK: The type was successfully returned.
E_FAIL: The operation failed. Nothing returned.

o GetDomainDraftingType

public static GetDomainDraftingType( ospDomDraftingType)

Get the CATIType associated to drafting domains.
Returns the root type. If those types have been derived use the Knowledge APIs to retrieve it.
Use if you want to retrieve the type.

Parameters:

ospDomDraftingType: A smart pointer to the type.

Returns:

An HRESULT
Legal values:

S_OK: The type was successfully returned.
E_FAIL: The operation failed. Nothing returned.

o GetDomainInstance

public static GetDomainInstance(		`ipiDom`,
		`opiDomInst`)

Retrieves the domain instance from a domain. It is unique as specified in metadata (once instantiable).

Parameters:

ipiDom: A material domain in session.
opiDomInst[out: , CATBaseUnknown#Release] The domain instance.
You have to release the pointer after use.

Returns:

An HRESULT
Legal values:

S_OK: The domain instance is successfully returned.
E_INVALIDARG: ipiDom is NULL.
E_FAIL: The operation failed. The domain is loaded in session without its material.

o GetDomainLinearElasticType

public static GetDomainLinearElasticType( ospDomLinearElasticType)

Deprecated:

R417 Use GetDomainSimulationType to retrieve Simulation Domain instead Get the CATIType associated to linear elastic domains.
Returns the root type. If those types have been derived use the Knowledge APIs to retrieve it.
Use if you want to retrieve the type.

Parameters:

ospDomLinearElasticType: A smart pointer to the type.

Returns:

An HRESULT
Legal values:

S_OK: The type was successfully returned.
E_FAIL: The operation failed. Nothing returned.

o GetDomainRenderingType

public static GetDomainRenderingType( ospDomRenderingType)

Get the CATIType associated to rendering domains.
Returns the root type. If those types have been derived use the Knowledge APIs to retrieve it.
Use if you want to retrieve the type.

Parameters:

ospDomRenderingType: A smart pointer to the type.

Returns:

An HRESULT
Legal values:

S_OK: The type was successfully returned.
E_FAIL: The operation failed. Nothing returned.

o GetDomainSimulationType

public static GetDomainSimulationType( ospDomSimulationType)

Get the CATIType associated to simulation domains.
Returns the root type. If those types have been derived use the Knowledge APIs to retrieve it.
Use if you want to retrieve the type.

Parameters:

ospDomSimulationType: A smart pointer to the type.

Returns:

An HRESULT
Legal values:

S_OK: The type was successfully returned.
E_FAIL: The operation failed. Nothing returned.

o GetMaterialCoreType

public static GetMaterialCoreType( ospMatCoreType)

Get the CATIType associated to material Core.
Returns the root type. If those types have been derived use the Knowledge APIs to retrieve it.
Use if you want to retrieve the type.

Parameters:

ospMatCoreType: A smart pointer to the type.

Returns:

An HRESULT
Legal values:

S_OK: The type was successfully returned.
E_FAIL: The operation failed. Nothing returned.

o GetMaterialCoveringType

public static GetMaterialCoveringType( ospMatCoveringType)

Get the CATIType associated to material Covering.
Returns the root type. If those types have been derived use the Knowledge APIs to retrieve it.
Use if you want to retrieve the type.

Parameters:

ospMatCoveringType: A smart pointer to the type.

Returns:

An HRESULT
Legal values:

S_OK: The type was successfully returned.
E_FAIL: The operation failed. Nothing returned.

o GetMaterialFactory

public static GetMaterialFactory( opiFact)

Retrieves a Factory to create new material.

Parameters:

opiFact: [out, CATBaseUnknown#Release] A pointer to the created factory .
You have to release the pointer after use.

Returns:

An HRESULT
Legal values:

S_OK: The factory is successfully returned.
E_FAIL: The operation failed. Nothing returned.

This object is included in the file: CATMaterialTools.h
If needed, your Imakefile.mk should include the module: CATMatIntfServices