CATStrUseItf Interface CATIStrUseCollar
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIStrUseCollar
Interface representing Collar object.
A collar is created, deleted and retrieved using the CATIStrUseCollarMngt
interface, which is implemented for the slot object.
- See also:
-
Method Index
- o
GetMaterial(CATUnicodeString&)
- Gets the Collar Material.
- o
GetMaterialThrowOrientation(CATStrCollarThrowOrientation&)
- Gets the collar Material Throw Orientation.
- o
GetParameters(CATLISTV(CATICkeParm_var)&)
- Gets the Public Parameters of Collar.
- o
GetThickness(CATICkeParm_var&)
- Gets the Collar Thickness.
- o
SetMaterial(CATUnicodeString)
- Sets the Collar Material.
- o
SetMaterialThrowOrientation(CATStrCollarThrowOrientation)
- Sets the collar Material Throw Orientation.
Methods
o GetMaterial
| public virtual GetMaterial( | | oMaterial) |
-
Gets the Collar Material.
- Parameters:
-
- oMaterial
- User name of the material.
Gets the Material.
- Returns:
- HRESULT Return code of function.
S_OK if everything ran ok.
E_FAIL if something went wrong.
o GetMaterialThrowOrientation
| public virtual GetMaterialThrowOrientation( | | oMaterialThrowOrientation) |
-
Gets the collar Material Throw Orientation. (@see CATStrCollarThrowOrientation)
- Parameters:
-
- oMaterialThrowOrientation
- CATStrCollarThrowOrientation enum for material throw orientation.
- Returns:
- HRESULT Return code of function.
S_OK if everything ran ok.
E_FAIL if something went wrong.
o GetParameters
| public virtual GetParameters( | | ospListOfParameters) |
-
Gets the Public Parameters of Collar. Valuate these parameters as per required. (@see CATICkeParm)
- Parameters:
-
- ospListOfParameters
- List Of Public Parameters
- Returns:
- HRESULT Return code of function.
S_OK if everything ran ok.
E_FAIL if something went wrong.
o GetThickness
| public virtual GetThickness( | | ospThickness) |
-
Gets the Collar Thickness. (@see CATICkeParm)
- Parameters:
-
- ospThickness
- Thickness of Collar as CATICkeParm.
Valuate the Collar Thickness as per required.
- Returns:
- HRESULT Return code of function.
S_OK if everything ran ok.
E_FAIL if something went wrong.
o SetMaterial
| public virtual SetMaterial( | const | iMaterial) |
-
Sets the Collar Material.
- Parameters:
-
- iMaterial
- User name of the material.
Sets the Material.
- Returns:
- HRESULT Return code of function.
S_OK if everything ran ok.
E_FAIL if something went wrong.
E_INVALIDARG if an incorrect material name is inputted.
o SetMaterialThrowOrientation
| public virtual SetMaterialThrowOrientation( | const | iMaterialThrowOrientation) |
-
Sets the collar Material Throw Orientation. (@see CATStrCollarThrowOrientation)
- Parameters:
-
- iMaterialThrowOrientation
- CATStrCollarThrowOrientation enum for material throw orientation.
iMaterialThrowOrientation -> 0 - catStrCollarThrowOrientationInvert
iMaterialThrowOrientation -> 1 - catStrCollarThrowOrientationNormal
iMaterialThrowOrientation -> 2 - catStrCollarThrowOrientationCentered
- Returns:
- HRESULT Return code of function.
S_OK if everything ran ok.
E_FAIL if something went wrong.
E_INVALIDARG if an incorrect material name is inputted.
This object is included in the file: CATIStrUseCollar.h
If needed, your Imakefile.mk should include the module: CATStrUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.