All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATCompositesUseItf Interface CATICciCompositesParameters

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

interface CATICciCompositesParameters

Interface of Composites parameters.
Role: Allows to access data of Composites parameter feature, that enables to manage available materials and fiber directions.

Method Index

o AddDirection(CATICkeParm_var&,int,int,int): Adds a direction at the end of the list of directions.
o AddMaterialCache(CATIMaterialReference_var&): Adds a Material cache feature at the end of the list of Material cache.
o CreateRosette(CATICciRosette_var&): Creates a new rosette.
o GetDirection(int,CATICkeParm_var&,int&,int&,int&): Gets a direction and its corresponding name, value and color.
o GetListOfRosettes(CATLISTV(CATICciRosette_var)&): Gets the list of rosettes.
o GetMaterialCache(int,CATICciMaterialCache_var&): Gets the Material cache feature of index iMatCacheIndex.
o GetNumberOfDirections(int&): Gets the number of directions.
o GetNumberOfMaterialCache(int&): Gets the number of Material cache features.
o RemoveDirection(int): Removes a direction from the list of directions.
o RemoveMaterialCache(CATICciMaterialCache_var&): Removes a Material cache feature.
o RemoveRosette(CATICciRosette_var&): Removes a rosette.

Methods

o AddDirection

public virtual AddDirection(	const	`iNameAndValue`,
		`iColorRed`,
		`iColorGreen`,
		`iColorBlue`)

Adds a direction at the end of the list of directions.

Parameters:

iNameAndValue: Knowledgeware parameter containing the name and the value of the direction
iColorRed: Red value of the direction color
iColorGreen: Green value of the direction color
iColorBlue: Blue value of the direction color

o AddMaterialCache

public virtual AddMaterialCache( const iMaterial)

Adds a Material cache feature at the end of the list of Material cache.

Parameters:

iMaterial: The material to attach with added Material cache feature.

o CreateRosette

public virtual CreateRosette( ospRosette)

Creates a new rosette.

Parameters:

ospRosette: The new rosette which was created

o GetDirection

public virtual GetDirection(		`iDirIndex`,
		`oNameAndValue`,
		`oColorRed`,
		`oColorGreen`,
		`oColorBlue`)

Gets a direction and its corresponding name, value and color.

Parameters:

iDirIndex: Index of the direction wanted 1 <= iDirIndex <= Number of directions
oNameAndValue: Knowledgeware parameter containing the name and the value of the direction
oColorRed: Red value of the direction color
oColorGreen: Green value of the direction color
oColorBlue: Blue value of the direction color

o GetListOfRosettes

public virtual GetListOfRosettes( oRosetteList)

Gets the list of rosettes.

Parameters:

oRosetteList: List of Rosettes

o GetMaterialCache

public virtual GetMaterialCache(		`iMatCacheIndex`,
		`oMatCache`)

Gets the Material cache feature of index iMatCacheIndex.

Parameters:

iMatCacheIndex: The index of querried Material cache feature. 1 <= iDirIndex <= Number of Material cache.
oMatCache: The Material cache feature.

o GetNumberOfDirections

public virtual GetNumberOfDirections( oNbDirections)

Gets the number of directions.

Parameters:

oNbDirections: Number of directions available in the composites parameters

o GetNumberOfMaterialCache

public virtual GetNumberOfMaterialCache( oNbMatCache)

Gets the number of Material cache features.

Parameters:

oNbMatCache: Number of Material cache features available in the composites parameters

o RemoveDirection

public virtual RemoveDirection( iDirIndex)

Removes a direction from the list of directions.

Parameters:

iDirIndex: Index of the direction to remove

o RemoveMaterialCache

public virtual RemoveMaterialCache( iMatCache)

Removes a Material cache feature.

Parameters:

iMatCache: The Material cache feature to remove.

o RemoveRosette

public virtual RemoveRosette( const ispRosette)

Removes a rosette.

Parameters:

ispRosette: Rosette to be deleted

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