All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATCompositesUseItf Interface CATICciPhysicalEntity

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

interface CATICciPhysicalEntity

Interface to manage a Composite physical entity.
Role: Allows you to access data of Ply, Core, CutPiece or Tape feature

Method Index

o GetDirection(CATICkeParm_var&): Gets the direction of the physical entity as Knowledge parameter.
o GetExtendedRosette(CATICciRosette_var&): Returns the extended rosette of the physical entity.
o GetListOfProducibility(CATLISTV(CATICciProducibility_var)&,CATCciProducibilityFilter): Gets the list of producibility of the physical entity (multiproducibility infrastructure).
o GetMaterialCache(CATICciMaterialCache_var&): Gets the cache material of the physical entity.
o GetName(CATUnicodeString&): Gets the name of the physical entity.
o GetProducibility(CATICciProducibility_var&): Gets the producibility of the physical entity (not available for Core).
o GetRosette(CATIMf3DAxisSystem_var&)
o GetType(CATCciPhysicalEntityType&): Gets the type of the physical entity as
o SetDirection(CATICkeParm_var&): Sets the direction of the physical entity.
o SetExtendedRosette(CATICciRosette_var&): Sets the extended rosette of the physical entity.
o SetMaterial(CATICciMaterialCache_var&): Sets the cache material of the physical entity (not available for CutPiece or Tape).
o SetName(CATUnicodeString&): Sets the name of the physical entity.
o SetRosette(CATIMf3DAxisSystem*)

Methods

o GetDirection

public virtual GetDirection( oDirection)

Gets the direction of the physical entity as Knowledge parameter.
WARNING: Only available for models created since V5R15

Parameters:

oDirection: The direction knowledge parameter.

o GetExtendedRosette

public virtual GetExtendedRosette( ospRosette)

Returns the extended rosette of the physical entity.

Parameters:

ospRosette: The CATICciRosette corresponding to the rosette.

o GetListOfProducibility

public virtual GetListOfProducibility(		`oProducibilityList`,
		`Prodfilter`	`= CATCciProducibilityAll`)

Gets the list of producibility of the physical entity (multiproducibility infrastructure).
Note: by default, producibility APIs and Composites UI manage only one producibility under a physical entity (Ply or CutPiece). With multiproducibility infrastructure several producibility can be stored under the physical entity in order to have and illustrate several producibility scenario at enginneering design phase

Parameters:

oListOfProducibility: producibility List features under Ply or CutPiece .
(Note: For additionnal informations on multiproducibility infrastructure, please contact DS support to access to this mode).

o GetMaterialCache

public virtual GetMaterialCache( oMaterialCache)

Gets the cache material of the physical entity.
WARNING: Only available for models created since V5R18

Parameters:

oMaterial: The cache material feature.

o GetName

public virtual GetName( oName)

Gets the name of the physical entity.
WARNING: Only available for models created since V5R15.

Parameters:

oName: The physical entity name.

o GetProducibility

public virtual GetProducibility( oProducibility)

Gets the producibility of the physical entity (not available for Core).
WARNING: Only available for models created since V5R15
REMARK: returns the producibility under the physical entity. For multiproducibility infrastructure mode, the "so called" "active" producibility under Ply or CutPiece is retrieved.

Parameters:

oProducibility: The producibility feature.
(Note: For additionnal informations on multiproducibility infrastructure, please contact DS support to access to this mode).

o GetRosette

public virtual GetRosette( oRosette)

Deprecated:

R417 Please use: CATICciRosette_var spRosette; pPhysicalEntity->GetExtendedRosette (spRosette); if(NULL_var != spRosette) spRosette->GetMainAxis (CATIMf3DAxisSystem_var& ospGeometricalRosette); ... Gets the rosette of the physical entity as CATIMf3DAxisSystem.
WARNING: Only available for models created since V5R15

Parameters:

oRosette: The rosette as CATIMf3DAxisSystem.

o GetType

public virtual GetType( oType)

Gets the type of the physical entity as enumerate value.
WARNING: Only available for models created since V5R15.

Parameters:

oType: The physical entity type.

o SetDirection

public virtual SetDirection( const iDirection)

Sets the direction of the physical entity.
WARNING: Only available for models created since V5R15

Parameters:

iDirection: The direction knowledge parameter value.

o SetExtendedRosette

public virtual SetExtendedRosette( const ispRosette)

Sets the extended rosette of the physical entity.

Parameters:

ispRosette: The feature CATICciRosette to the rosette.

o SetMaterial

public virtual SetMaterial( const iMaterial)

Sets the cache material of the physical entity (not available for CutPiece or Tape).
WARNING: Only available for models created since V5R18

Parameters:

iMaterial: The cache material feature.

o SetName

public virtual SetName( const iName)

Sets the name of the physical entity.
WARNING: Only available for models created since V5R15

Parameters:

iName: The physical entity name.

o SetRosette

public virtual SetRosette( iRosette)

Deprecated:

R417 NOT USE FOR MODEL MIGRATED TO EXTENDED ROSETTE Behavior for model migrated to extended rosette: If an extended rosette exists with the axis system ispRosette in cartesian mode, it is setted to the grid panel, else a new extended rosette is created and setted. Please use: CATICciRosette_var spRosette; pPhysicalEntity->GetExtendedRosette (spRosette); if(NULL_var != spRosette) spRosette->SetMainAxis (CATIMf3DAxisSystem_var& ospGeometricalRosette); ... Sets the rosette of the physical entity.

Parameters:

iRosette: The rosette as CATIMf3DAxisSystem. The input rosette pointer, must adhere to CATIMf3DAxisSystem interface.

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