CATStrUseItf Interface CATIStrUseRefOffset

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

interface CATIStrUseRefOffset

Interface for managing Reference Offset.

Method Index

o GetOffsetParm(CATICkeParm_var&): Get the Offset parameter.
o GetRelevantSide(CATStrOrientation&): Get the Relevant Side Orientation.
o SetRelevantSide(CATStrOrientation): Set the Relevant Side Orientation.

Methods

o GetOffsetParm

public virtual GetOffsetParm( ospOffsetParm)

Get the Offset parameter. The Offset parameter defines the offset distance, in the direction of the Relevant Side orientation, for the reference surface (from the surface selected from the specification object - see SetRelevantSide). Use this function to get the parameter so you can get or set the value.

Parameters:

ospOffsetParm: The Offset parameter.

Returns:

Error code of function.

o GetRelevantSide

public virtual GetRelevantSide( oStrOrientation)

Get the Relevant Side Orientation. The Relevant Side Orientation is the nominal orientation (outward) used to define the positive direction for offsetting the reference surface by the distance specified in the Offset parameter. If the reference element is a solid (e.g. plate or thick surface), the Relevant Side Orientation is also used to select which face of the solid is used as the reference surface.

Parameters:

oStrOrientation: The nominal Relevant Side Orientation.

Returns:

Error code of function.

o SetRelevantSide

public virtual SetRelevantSide( const iStrOrientation)

Set the Relevant Side Orientation. The Relevant Side Orientation is the nominal orientation (outward) used to define the positive direction for offsetting the reference surface by the distance specified in the Offset parameter. If the reference element is a solid (e.g. plate or thick surface), the Relevant Side Orientation is also used to select which face of the solid is used as the reference surface.

Parameters:

iStrOrientation: The nominal Relevant Side Orientation.

Returns:

Error code of function.

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