All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATStrUseItf Interface CATIStrUseUserConnection

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

interface CATIStrUseUserConnection

Interface to manage UserConnection Role: Interface to manage UserConnection.
Feature implementing this interface: UserConnection.

Method Index

o AddConnectedObject(CATIMmiMechanicalFeature_var&): Add an object to ConnectedObject List
o GetConnectedObjects(CATLISTV(CATIMmiMechanicalFeature_var)&): Get list of ConnectedObject
o GetIntersectingElement(CATIMmiMechanicalFeature_var&): Get an intersecting element, it is used for calculating intersection point bewteen reference element and the intersecting element.
o GetReferenceElement(CATIMmiMechanicalFeature_var&): Get Reference Object.
o RemoveConnectedObject(CATIMmiMechanicalFeature_var&): Remove an object from ConnectedObject List
o SetIntersectingElement(CATIMmiMechanicalFeature_var&): Set an intersecting element, it is used for calculating intersection point bewteen reference element and the intersecting element.
o SetReferenceElement(CATIMmiMechanicalFeature_var&): Set Reference Object.

Methods

o AddConnectedObject

public virtual AddConnectedObject( const ispConnectedObj)

Add an object to ConnectedObject List

Parameters:

ispConnectedObj: Connected Object.

o GetConnectedObjects

public virtual GetConnectedObjects( oListOfUserConnections)

Get list of ConnectedObject

Parameters:

oListOfUserConnections: Connected Object List.

o GetIntersectingElement

public virtual GetIntersectingElement( ospIntersectingElem)

Get an intersecting element, it is used for calculating intersection point bewteen reference element and the intersecting element. Intersecting point can be a middle point of a minimum distance of two elements when there are not intersected.

Parameters:

ospIntersectingElement: Intersecting Element.

o GetReferenceElement

public virtual GetReferenceElement( ospRefElem)

Get Reference Object. The referece object is a father of UserConnection

Parameters:

ospRefElem: Reference Object.

o RemoveConnectedObject

public virtual RemoveConnectedObject( const ispConnectedObj)

Remove an object from ConnectedObject List

Parameters:

ispConnectedObj: Connected Object.

o SetIntersectingElement

public virtual SetIntersectingElement( const ispIntersectingElem)

Set an intersecting element, it is used for calculating intersection point bewteen reference element and the intersecting element. Intersecting point can be a middle point of a minimum distance of two elements when there are not intersected.

Parameters:

ispIntersectingElement: Intersecting Element.

o SetReferenceElement

public virtual SetReferenceElement( const ispRefElem)

Set Reference Object. The referece object is a father of UserConnection

Parameters:

ispRefElem: Reference Object.

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