All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATFunctionalModelerUseItf Interface CATIFctFlowExpositionInstance

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

interface CATIFctFlowExpositionInstance

Interface dedicated to Functional Flow Exposition instance management.

Role: This interface handles Flow Exposition instance.

Method Index

o GetDirection(CATFctDirection::FctDirection&): Retrieves the instance direction.
o GetFlowReference(CATIFctFlowReference*&): Returns the flow reference which the flow instance comes from.
o GetIdentifier(CATUnicodeString&): Retrieves the instance identifier.
o GetOwner(CATIFctReference*&): Retrieves the reference which aggregates the instance.
o SetDirection(CATFctDirection::FctDirection): Sets the instance direction.

Methods

o GetDirection

public virtual GetDirection( oDirection)

Retrieves the instance direction.

Parameters:

oDirection: In, Out (Note: InOut & NoDirection are not valid on Functional) Output parameter.

Returns:

S_OK if the method succeeds.
E_FAIL otherwise.

o GetFlowReference

public virtual GetFlowReference( opFlowReference)

Returns the flow reference which the flow instance comes from.

Parameters:

opFlowReference: [CATBaseUnknown#Release] The flow reference.
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 input parameters are unexpected.
E_FAIL otherwise.

o GetIdentifier

public virtual GetIdentifier( oIdentifier)

Retrieves the instance identifier.

Parameters:

oIdentifier: Output parameter.

Returns:

S_OK if the method succeeds.
E_FAIL otherwise.

o GetOwner

public virtual GetOwner( opReference)

Retrieves the reference which aggregates the instance.

Parameters:

opReference: [CATBaseUnknown#Release] The reference aggregating this 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 input parameters are unexpected.
E_FAIL otherwise.

o SetDirection

public virtual SetDirection( iDirection)

Sets the instance direction.

Parameters:

iDirection: In, Out (Note: InOut & NoDirection are not valid on Functional) Input parameter.

Returns:

S_OK if the method succeeds.
E_INVALIDARG if input parameter is unexpected.
E_FAIL otherwise.

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