All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATLogicalModelerUseItf Interface CATILog2DPictures

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

interface CATILog2DPictures

Interface dedicated to Logical 2D Pictures collection management.

Role: This interface provides means to manage the collection of Logical 2D Pictures Representations associated to this Logical Reference.

Method Index

o Associate2DPicture(CATILog2DPictureRepReference*): Associates a 2D Picture to a Logical Reference.
o CountAssociated2DPictures(int&): Retrieves the number of 2D Pictures associated to this Logical Reference.
o GetAssociated2DPictures(CATListValCATILog2DPictureRepReference_var&): Retrieves the collection of 2D Pictures associated to this Logical Reference.
o RemoveAssociated2DPicture(CATILog2DPictureRepReference*): Removes a 2D Picture that is associated to this Logical Reference.

Methods

o Associate2DPicture

public virtual Associate2DPicture( ip2DPictureRepReference)

Associates a 2D Picture to a Logical Reference. Role: This method associates a 2D Picture Representation Reference to a Logical Reference.
A given 2D Picture can only be associated once to a Logical Reference.
Associate a 2D Picture Representation Reference will instantiate it under a Logical Reference.

Parameters:

ip2DPictureRepReference: The 2D Picture Representation Reference to associate to this Logical Reference. Input Parameter.
This parameter MUST NOT be provided by caller as NULL. This method returns an error otherwise.

Returns:

S_OK if the method succeeds.
S_FALSE if the specified 2D Picture is already associated to the Logical Reference.
E_INVALIDARG if parameters provided are unexpected.
E_FAIL otherwise.

o CountAssociated2DPictures

public virtual CountAssociated2DPictures( oSize)

Retrieves the number of 2D Pictures associated to this Logical Reference.

Parameters:

oSize: The number of associated 2D Pictures.

Returns:

S_OK The method succeeds and the number of associated 2D Pictures is retrieved.
E_FAIL otherwise.

o GetAssociated2DPictures

public virtual GetAssociated2DPictures( oL2DPictureRepReferences)

Retrieves the collection of 2D Pictures associated to this Logical Reference.

Parameters:

oL2DPictureRepReferences: A list of 2D Picture Representation References.
Output parameter.
This parameter MUST be provided by caller as empty. This method returns an error otherwise.
This parameter is valuated if method succeeds.

Returns:

S_OK if the method succeeds.
S_FALSE if the method succeeds but in session there is no 2D Pictures associated to this Logical Reference.
E_INVALIDARG if parameters provided are unexpected.
E_FAIL otherwise.

o RemoveAssociated2DPicture

public virtual RemoveAssociated2DPicture( ip2DPictureRepReference)

Removes a 2D Picture that is associated to this Logical Reference.
Role: This method breaks the association of a 2D Picture Representation Reference with a Logical Reference.
It only breaks the association but does not delete the 2D Picture Representation Reference.
The given 2D Picture Representation Reference must be associated to this Logical Reference.

Parameters:

ip2DPictureRepReference: The 2D Picture to must not associated anymore to this Logical Reference.
Input Parameter.
This parameter MUST NOT be provided by caller as NULL. This method returns an error otherwise.

Returns:

S_OK if the method succeeds.
E_INVALIDARG if parameters provided are unexpected.
E_FAIL otherwise.

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