All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATLogicalModelerUseItf Interface CATILogTypeReference

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

interface CATILogTypeReference

Interface dedicated to Logical Type Reference.

Role: This interface designates a Logical Type Reference and provides means to manage its subtypes (Logical Type Instances collection aggregated by this Logical Type Reference).

Method Index

o AddSubType(CATILogTypeReference*,CATListValCATICkeParm_var&,CATILogTypeInstance*&): Adds a (Logical) Subtype to this Logical Type.
o CountSubTypes(int&): Retrieves the number of subtypes.
o ListSubTypes(CATListValCATILogTypeInstance_var&): Lists the subtypes of this Logical Type.
o RemoveSubType(CATILogTypeInstance*): Removes a subtype from this Logical Type.

Methods

o AddSubType

public virtual AddSubType(		`ipLogicalTypeReference`,
		`iLFctAttributesValues`,
		`opLogicalTypeInstance`)

Adds a (Logical) Subtype to this Logical Type.
Role: This method adds a subtype to this type by instantiating a given Logical Type Reference under this Logical Type Reference.

This API invokes the following Business Logic Openness:

PLMInstanceAggregationCheck
PLMIdentificationInitialization

For any information about Business Logic Openness, refer to the CAA Encyclopedia documentation: Reference \ Business Logic Openness section.

Parameters:

ipLogicalTypeReference: A Logical Type Reference.
Input Parameter.
This parameter MUST NOT be provided by caller as NULL. This method returns an error otherwise.
iLFctAttributesValues: A list of functional attributes values (of the logical type instance to create).
The compliancy of attributes values will be checked relatively to their definition in metadata (mandatory, size, type).
Input Parameter.
This list MUST contain V_Identifier attribute.
opLogicalTypeInstance: [out, CATBaseUnknown#Release]
The created Logical Type Instance.
Output parameter.
This parameter MUST be provided by caller as NULL. This method returns an error otherwise.
This parameter is returned to caller as NULL if method fails.
This parameter is valuated if method succeeds.

Returns:

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

o CountSubTypes

public virtual CountSubTypes( oSize)

Retrieves the number of subtypes.

Parameters:

oSize: The number of subtypes.

Returns:

S_OK The method succeeds and the number of subtypes is retrieved.
E_FAIL otherwise.

o ListSubTypes

public virtual ListSubTypes( oLSubTypes)

Lists the subtypes of this Logical Type.

Parameters:

oLSubTypes: A list of Logical Type Instances.
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 and the subtypes of this Logical Type (if exist) are retrieved.
E_INVALIDARG if parameters provided are unexpected.
E_FAIL otherwise.

o RemoveSubType

public virtual RemoveSubType( ipLogicalTypeInstanceToRemove)

Removes a subtype from this Logical Type.
Role: This method removes and deletes the given instance from the instances aggregated by the Logical Reference.
The given instance must be aggregated by this Logical Type Reference.

Parameters:

ipLogicalTypeInstanceToRemove: The subtype to remove (identified by its Logical Type Instance).
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 and the subtype has been removed.
E_INVALIDARG if parameters provided are unexpected.
E_FAIL otherwise.

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