Public View Protected View Private View

All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATSimRepInterfaces Interface CATISimObjectInContext

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

interface CATISimObjectInContext

Interface to manage an object representing a link.

Method Index

o GetLink(CATOmbObjectInContext*&): Retrieves the link.
o GetLinkStatus(CATSimLoadingMode&,CATUnicodeString&): Retrieves the loading mode.
o GetOrientation(CATSimOrientationMode&): Retrieves the orientation, if orientable.
o GetTarget(CATBaseUnknown*&,int): Retrieves the target.
o IsOrientable(CATBoolean&): Retrieves the orientability.
o SetOrientation(CATSimOrientationMode): Sets the orientation of a connector.
o SwitchOrientation(): Switches the orientation of a connector.

Methods

o GetLink

public virtual GetLink( oLink)

Retrieves the link.

Parameters:

oLink: The link.
Lifecycle rules deviation: No AddRef is done on oLink.

Returns:

An HRESULT.

o GetLinkStatus

public virtual GetLinkStatus(		`oStatus`,
	const	`iAttributeName`	`= ""` )

Retrieves the loading mode.

Parameters:

oStatus: The loading mode.
iAttributeName: An attribute name.

Returns:

An HRESULT.

o GetOrientation

public virtual GetOrientation( oOrientation)

Retrieves the orientation, if orientable.

Parameters:

oOrientation: The orientation.

Returns:

An HRESULT.
Legal values:

S_OK: The orientation was retrieved
S_FALSE: Not orientable. oOrientation is set to CATSimOrientationMode_Unspecified
E_FAIL: The retrieval failed. oOrientation is set to CATSimOrientationMode_Unspecified

o GetTarget

public virtual GetTarget(		`oTarget`,
		`iType`	`= 0` )

Retrieves the target.
Role: In case of ports :

iType = 0: the service returns the publication.
iType = 1: the service returns the object pointed by the publication.

Parameters:

oTarget: The target.
Lifecycle rules deviation: No AddRef is done on oTarget.
iType: The type.

Returns:

An HRESULT.

o IsOrientable

public virtual IsOrientable( oIsOrientable)

Retrieves the orientability.
Role: Note that this method can be bypassed with by checking that GetOrientation returns S_OK.

Parameters:

oIsOrientable: The orientability.

Returns:

An HRESULT.
Legal values:

S_OK: The retrieval is successful
E_FAIL: The retrieval failed. oIsOrientable is set to FALSE

o SetOrientation

public virtual SetOrientation( iOrientation = CATSimOrientationMode_Unspecified)

Sets the orientation of a connector.
Role: This method will fail if the connector is not orientable and iOrientation is not CATSimOrientationMode_None.

Parameters:

iOrientation: The input orientation.

Returns:

An HRESULT.
Legal values:

S_OK
E_FAIL

o SwitchOrientation

public virtual SwitchOrientation(

)

Switches the orientation of a connector.
Role: Convenience function. 3 possibilities:

CATSimOrientationMode_Unspecified -> E_FAIL
CATSimOrientationMode_Normal <-> CATSimOrientationMode_Reversed
CATSimOrientationMode_Both <-> CATSimOrientationMode_Both

Returns:

An HRESULT.
Legal values:

S_OK: The switch went fine
E_FAIL: otherwise

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