ProductStructureInterfaces Interface CATIPrdRepositionableDefinition

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

interface CATIPrdRepositionableDefinition

Interface used to manage the "Flexible" status of a VPMReference.

Method Index

o IsFlexible(): Check the Flexible status of a VPMReference.
o LisRepositionables(CATLISTP(CATOmbObjectInContext)&): Returns the list of VPMInstance or VPMOccurrence declared as Repositionable for this flexible VPMReference.
o SetFlexible(): Sets a VPMReference as "Flexible".
o UnsetFlexible(): Unsets the "Flexible" status of the VPMReference.

Methods

o IsFlexible

public virtual IsFlexible(

)

Check the Flexible status of a VPMReference.

Returns:

A CATBoolean value.
Legal values:

TRUE: VPMReference is Flexible.
FALSE : VPMReference is not Flexible.

o LisRepositionables

public virtual LisRepositionables( oListOfRepositionables)

Returns the list of VPMInstance or VPMOccurrence declared as Repositionable for this flexible VPMReference.

Parameters:

oListOfRepositionables: The list of Repositionables VPMInstance or VPMOccurrence described in an CATOmbObjectInContext Structure.

Returns:

An HRESULT value.
Legal values:

S_OK: Repositionables were retrieved successfully.
E_FAIL : VPMReference is not Flexible or An Unexpected Error Occurs.

o SetFlexible

public virtual SetFlexible(

)

Sets a VPMReference as "Flexible".

Returns:

An HRESULT value.
Legal values:

S_OK: Flexible status was successfully set.
E_FAIL : Could not set the Flexible status, or an Unexpected Error occurs.

o UnsetFlexible

public virtual UnsetFlexible(

)

Unsets the "Flexible" status of the VPMReference.

Returns:

An HRESULT value.
Legal values:

S_OK: Flexible status was successfully unset.
E_FAIL : Could not unset the Flexible status, or an Unexpected Error occurs.

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