All Frameworks  Object Hierarchy  This Framework  Indexes

AnalysisEntity (Object)

Represent the analysis entity object.
This class provides services to describe a analysis entity. It represents some preprocessing activities.
It agregates descriptive sub-entities named Basic Components, and Analysis Supports.
The basic component represent the physical data and the support the localisation.

AnalysisImages: Returns the analysis images collection associated with an analysis entity.
AnalysisLocalEntities: Returns the analysis local entity collection associated with an analysis entity.
AnalysisSupports: Returns the list of Analysis Supports.
BasicComponents: Returns the basic components collection associated with an analysis entity.
Type: Returns the type of the analysis entity.

AddSupportFromConstraint: Creates a new support and add it to the description of the Analysis Entity.
AddSupportFromPart: Creates a new support and add it to the description of the Analysis Entity.
AddSupportFromProduct: Creates a new support and add it to the description of the Analysis Entity.
AddSupportFromPublication: Creates a new support and add it to the description of the Analysis Entity.
AddSupportFromReference: Creates a new support and add it to the description of the Analysis Entity.
GetReference: Returns the reference corresponding to the given component.
GetValue: Returns the value corresponding to the given component.
SetReference: Sets the reference corresponding to the given component.
SetValue: Sets the value corresponding to the given component.

Properties

o Property AnalysisImages(

) As (Read Only)

Returns the analysis images collection associated with an analysis entity.

Example:

This example retrieves analysisimages collection .

 Dim MyEntity As AnalysisEntity
 Dim analysisimages As AnalysisImages
 Set analysisimages = MyEntity.AnalysisImages

o Property AnalysisLocalEntities(

) As (Read Only)

Returns the analysis local entity collection associated with an analysis entity.

Example:

This example retrieves analysislocalEntity collection .

 Dim MyEntity As AnalysisEntity
 Dim analysislocalEntity As AnalysisLocalEntities
 Set analysislocalEntity = MyEntity.AnalysisLocalEntities

o Property AnalysisSupports(

) As (Read Only)

Returns the list of Analysis Supports. The support defines the area on which the analysis is applied on.

o Property BasicComponents(

) As (Read Only)

Returns the basic components collection associated with an analysis entity.

Example:

This example retrieves basiccomponents collection .

 Dim MyEntity As AnalysisEntity
 Dim basiccomponents As BasicComponents 
 Set basiccomponents = MyEntity.BasicComponents

o Property Type(

) As (Read Only)

Returns the type of the analysis entity.

Example:

The following example returns TypeofEntity of MyEntity.

 Dim MyEntity As AnalysisEntity
 Dim TypeofEntity As CATBSTR
 Set TypeofEntity = MyEntity.Type

Methods

o Sub AddSupportFromConstraint(		`iConstraintProduct`,
		`iConstraint`)

Creates a new support and add it to the description of the Analysis Entity.

Parameters:

iConstraintProduct: the CATIA Product of the Constraint.
iConstraint: the CATIA Constraint that represent the object to linked.

See also:

Reference, Part

o Sub AddSupportFromPart(		`iPartProduct`,
		`iPart`)

Creates a new support and add it to the description of the Analysis Entity.

Parameters:

iPartProduct: the CATIA Product of the part.
iPart: the CATIA Part that represent the object to linked.

See also:

Reference, Part

o Sub AddSupportFromProduct(		`iProduct`,
		`iSupport`)

Creates a new support and add it to the description of the Analysis Entity.

Parameters:

iProduct: the CATIA Product that represent the object to linked.
iSupport: the CATIA Reference that represent the object to linked.

See also:

Reference, Product

o Sub AddSupportFromPublication(		`iProduct`,
		`iPublication`)

Creates a new support and add it to the description of the Analysis Entity.

Parameters:

iProduct: the CATIA Product that represent the object to linked.
iPublication: the CATIA Publication that represent the object to linked.

See also:

Publication, Product

o Sub AddSupportFromReference(		`iReference`,
		`iSupport`)

Creates a new support and add it to the description of the Analysis Entity.

Parameters:

iReference: the CATIA Reference that represent the object to linked. This identification, may locate the instance of the object
iSupport: the CATIA Reference that represent the object to linked.

See also:

Reference

o Func GetReference(		`iComponent`,
		`iLabel`,
		`iLineIndex`,
		`iColumnIndex`,
		`iLayerIndex`) As

Returns the reference corresponding to the given component.

Parameters:

iComponent: The identifier if the basic component.
iLabel: The label of the block containing the value.
iLineIndex: The line index of the value.
iColumnIndex: The column index of the value.
iLayerIndex: The layer index of the value.

o Func GetValue(		`iComponent`,
		`iLabel`,
		`iLineIndex`,
		`iColumnIndex`,
		`iLayerIndex`) As

Returns the value corresponding to the given component.

Parameters:

iComponent: The identifier if the basic component.
iLabel: The label of the block containing the value.
iLineIndex: The line index of the value.
iColumnIndex: The column index of the value.
iLayerIndex: The layer index of the value.

o Sub SetReference(		`iComponent`,
		`iLabel`,
		`iLineIndex`,
		`iColumnIndex`,
		`iLayerIndex`,
		`iValue`)

Sets the reference corresponding to the given component.

Parameters:

iComponent: The identifier if the basic component.
iLabel: The label of the block containing the value.
iLineIndex: The line index of the value.
iColumnIndex: The column index of the value.
iLayerIndex: The layer index of the value.
If the the component has a single value, assign 0 to the 3 parameters.

o Sub SetValue(		`iComponent`,
		`iLabel`,
		`iLineIndex`,
		`iColumnIndex`,
		`iLayerIndex`,
		`iValue`)

Sets the value corresponding to the given component.

Parameters:

iComponent

The identifier if the basic component.

iLabel

The label of the block containing the value.

iLineIndex

The line index of the value.

iColumnIndex

The column index of the value.

iLayerIndex

The layer index of the value.
If the the component has a single value, assign 0 to the 3 parameters. This example create ThisAnalysisEntity in the analysisEntities collection
The entity to create is supposed to be a pressure defined in a load set. We
will valuate the basic component that contain the pressure data "SAMPressureMag".

 Dim analysisEntities As CATIAAnalysisEntities
 Dim ThisAnalysisEntity As AnalysisEntity
 Set ThisAnalysisEntity = analysisEntities.Add("SAMPressure")
 ThisAnalysisEntity.SetValue("SAMPressureMag"," ",0,0,0,100)

AnalysisEntity (Object)

Property Index

Method Index

Properties

Methods