All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATTPSBaseUseItf Interface CATITPSTTRSServices

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

interface CATITPSTTRSServices

Interface that support some services around the TTRS modeler.
There is no context. The methods signatures give the object.

Method Index

o GetComponentsList(CATITTRS*,CATTPSScanComponentsMode,CATIUnknownList**,CATIUnknownList**): Retrieves the Components of a TTRS.
o GetConstructedGeomFromTTRS(CATITTRS*,CATBaseUnknown**): Get the constructed geometry from a TTRS that is created on it level.
o GetEGRLinkedToGeom(CATBaseUnknown*,CATIUnknownList**): Retrieves the EGRs of the TTRSs which uses iGeom as final component or as EGRs.
o GetGeomLinkedToEGR(CATBaseUnknown*,CATIUnknownList**): Retrieves the Geometry referenced by the TTRS of iEGR.
o GetNLSClass(CATITTRS*,CATUnicodeString&): Retrieves the NLS class of a TTRS.
o GetNLSType(CATITTRS*,CATUnicodeString&): Retrieves the NLS type of a TTRS.
o GetPointingTTRS(CATIRGE*,CATITTRSList**): Retrieves TTRS which reference the iRGE.
o GetRepresentingTTRS(CATITTRS*,int,CATITTRSList**,CATBoolean): Retrieves direct and/or indirect representing TTRSs as far as represented link is concerned.
o GetTPSLinkedToGeom(CATBaseUnknown*,CATITPSList**,CATBaseUnknown*,CATListOfInt*): Retrieves the TPS which TTRS uses iGeom as component.
o GetTPSLinkedToTTRS(CATITTRS*,CATITPSList**,CATBaseUnknown*): Retrieves the TPSs which reference the iTTRS.
o GetTTRSComposedOfTTRS(CATITTRS*,CATITTRSList**): Retrieves the TTRS which uses iTTRS as a component.
o GetTTRSLinkedToGeom(CATBaseUnknown*,CATTPSScanComposedOfMode,CATITTRSList**,CATBaseUnknown*,CATListOfInt*): Retrieves the TTRS which uses iGeom as final component.
o GetUserTPSs(CATITTRS*,CATITPSList**): Retrieves the TPSs which reference the iTTRS for a user point of view.
o RemoveTTRSIfPossible(CATITTRS*): Removes the iTTRS from the document if no TPS references it.
o RetrieveParentTTRS(CATITTRS*,CATITTRSList**,CATBoolean): Retrieves the parents of a TTRS.

Methods

o GetComponentsList

public virtual GetComponentsList(	`iTTRS`,
	`iMode`,
	`oList`,
	`oBodyList`	`= NULL`)

Retrieves the Components of a TTRS. The iTTRS is not included in the oList. The *oList must be initialize to NULL if a new list is required; In other case, *oList has been already allocated, all found TTRS are append to the content of this list.

o GetConstructedGeomFromTTRS

public virtual GetConstructedGeomFromTTRS(		`ipiTTRS`,
		`opiGeometry`)

Get the constructed geometry from a TTRS that is created on it level.

Parameters:

ipiTTRS: the TTRS that is created on the constructed geometry.
opiGeometry: the constructed geometry.

o GetEGRLinkedToGeom

public virtual GetEGRLinkedToGeom(		`iGeom`,
		`oList`)

Retrieves the EGRs of the TTRSs which uses iGeom as final component or as EGRs. Except TTRSs which results of a Reference Frame construction which are not returned. The *oList must be initialize to NULL if a new list is required.

o GetGeomLinkedToEGR

public virtual GetGeomLinkedToEGR(		`iEGR`,
		`oList`)

Retrieves the Geometry referenced by the TTRS of iEGR. The *oList must be initialize to NULL if a new list is required.

o GetNLSClass

public virtual GetNLSClass(	const	`iTTRS`,
		`oClass`)

Retrieves the NLS class of a TTRS.

o GetNLSType

public virtual GetNLSType(	const	`iTTRS`,
		`oType`)

Retrieves the NLS type of a TTRS.

o GetPointingTTRS

public virtual GetPointingTTRS(		`iRGE`,
		`oOutput`)

Retrieves TTRS which reference the iRGE. Remark:: V5 use since you can'thave V4 RGE except from its TTRS. The *oTTRSList must be initialize to NULL if a new list is required.

o GetRepresentingTTRS

public virtual GetRepresentingTTRS(	`ipiTTRS`,
	`iMode`,
	`opiOutput`,
	`ibAvoidUserOfComp`	`= FALSE`)

Retrieves direct and/or indirect representing TTRSs as far as represented link is concerned. Usage: iMode depends on CATTPSScanRepresentingMode CATTPSScanDirect => Get direct representing TTRSs. CATTPSScanIndirect => Get indirect representing TTRSs. CATTPSScanDirectComponents => Get direct representing of TTRS components. CATTPSScanIndirectComponents => Get indirect representing of TTRS components. ibAvoidUserOfComp will lock search on direct and indirect representing for elements and sub-elements using the context (composed of).

o GetTPSLinkedToGeom

public virtual GetTPSLinkedToGeom(	`iGeom`,
	`oOutput`,
	`ipiContext`	`= NULL`,
	`ipIdList`	`= NULL`)

Retrieves the TPS which TTRS uses iGeom as component. The *oOutput must be initialize to NULL if a new list is required.

o GetTPSLinkedToTTRS

public virtual GetTPSLinkedToTTRS(	`iTTRS`,
	`oOutput`,
	`ipiContext`	`= NULL`)

Retrieves the TPSs which reference the iTTRS. The *oOutput must be initialize to NULL if a new list is required.

o GetTTRSComposedOfTTRS

public virtual GetTTRSComposedOfTTRS(		`iTTRS`,
		`oOutput`)

Retrieves the TTRS which uses iTTRS as a component. Be Careful : Only at the first level. The *oOutput must be initialize to NULL if a new list is required.

o GetTTRSLinkedToGeom

public virtual GetTTRSLinkedToGeom(	`iGeom`,
	`iMode`,
	`oOutput`,
	`ipiContext`	`= NULL`,
	`ipIdList`	`= NULL`)

Retrieves the TTRS which uses iGeom as final component. The *oOutput must be initialize to NULL if a new list is required.

o GetUserTPSs

public virtual GetUserTPSs(	const	`iTTRS`,
		`oOutput`)

Retrieves the TPSs which reference the iTTRS for a user point of view. That is to say the same result as GetTPSLinkedToTTRS, except in the case of semantic TPSs which are linked to datums. In this case the TPSs are returned by the TTRS of the positionned surface. The *oOutput must be initialize to NULL if a new list is required.

o RemoveTTRSIfPossible

public virtual RemoveTTRSIfPossible( iTTRS)

Removes the iTTRS from the document if no TPS references it.

o RetrieveParentTTRS

public virtual RetrieveParentTTRS(		`iTTRS`,
		`oOutput`,
	const	`iAddInList`	`= TRUE`)

Retrieves the parents of a TTRS. the iTTRS is included in the oList if boolean iAddInList is TRUE (Default case); otherwise, iTTRS is skipped in the returned list. The *oList must be initialize to NULL if a new list is required. In other case, *oList has been already allocated, all found TTRS are append to the content of this list.

This object is included in the file: CATITPSTTRSServices.h