All Frameworks  Class Hierarchy  This Framework  Previous  Indexes

Drafting2DLInterfaces Class CAT2DLayoutServices

CAT2DLayoutServices
 

Usage: you must use this class as is. You should never derive it.


public class CAT2DLayoutServices

This toolbox purposes services to create or Retrieve a 2D Layout Root from a Mechanical Part.

Role: A 2D Layout Root is the root for the 2D Layout for 3D Design application.


Method Index


o CreateLayout2DL(CATIPrtPart*,CATUnicodeString&,CATUnicodeString&,CATI2DLayoutLayout**,int)
Creates a 2D Layout Root from a Mechanical Part.
o GetAvailable2DLayoutStandards(CATListOfCATUnicodeString&)
Gets list of available 2D Layout standards.
o GetLayout2DL(CATIPrtPart*,CATI2DLayoutLayout**)
Gets the 2D Layout Root Object From a Mechanical Part.
o GetListOfSheetStyles(CATUnicodeString,CATListOfCATUnicodeString&)
Gets list of available sheet styles for a defined standard.

Methods


o CreateLayout2DL
public static HRESULT CreateLayout2DL(CATIPrtPart* ipiPrtPart,
const CATUnicodeString& i2DLStandardName,
const CATUnicodeString& i2DLSheetStyle,
CATI2DLayoutLayout** opi2DLayoutRoot,
int iSheetOrient= 0)
Creates a 2D Layout Root from a Mechanical Part.
Role: This method creates a 2D Layour Root from a Mechanical Part. A standard and a sheet style must be informed.
Parameters:
i2DLStandardName
[in] The 2DL standard name.
i2DLSheetStyleName
[in] The Style of the 2DL sheet
opi2DLRoot
[out, CATBaseUnknown#Release] The 2DL Root.
iSheetOrient
[in] To override the sheet orientation defined in the sheet style. Note: The override may be not performed if the sheet orientation parameter is locked by the sheet style.
Legal values are:
= 0
The sheet orientation defined by the sheet style (Default value).
= 1
Portrait orientation. .
= 2
Landscape orientation.
Returns:
S_OK
if the 2D Layout Root is created.
E_FAIL
if the operation failed.
o GetAvailable2DLayoutStandards
public static HRESULT GetAvailable2DLayoutStandards(CATListOfCATUnicodeString& oListOfStandards)
Gets list of available 2D Layout standards.
Role: This method returns the list of available 2D Layout standard.
Parameters:
oListOfStandards
[out] The list of the available standards
Returns:
S_OK
if the list of standard is defined.
E_FAIL
if the operation failed.
o GetLayout2DL
public static HRESULT GetLayout2DL(CATIPrtPart* ipiPrtPart,
CATI2DLayoutLayout** opi2DLayoutRoot)
Gets the 2D Layout Root Object From a Mechanical Part.
Parameters:
ipiPrtPart
[in] The Mechanical Part.
opi2DLayoutRoot
[out, CATBaseUnknown#Release] The "2D Layout Root.
Returns:
S_OK
if the 2DL Layout Root is found.
S_FALSE
if the 2DL Layout Root is not found.
E_FAIL
if the operation failed.
o GetListOfSheetStyles
public static HRESULT GetListOfSheetStyles(CATUnicodeString iStandardName,
CATListOfCATUnicodeString& oListOfSheetStyles)
Gets list of available sheet styles for a defined standard.
Role: This method returns the list of available sheet styles for the given standard.
Parameters:
iStandardName[in]
The Standard name.
oListOfSheetStyles
[out] The list of sheet styles
Returns:
S_OK
if the list of standard is defined.
E_FAIL
if the operation failed.
E_INVALIDARG
if the standard does not exist.

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

Copyright © 2003, Dassault Systèmes. All rights reserved.