DraftingUseItf CATDftDrawingPLMServices
Usage: you must use this class as is. You should never derive it.
public class CATDftDrawingPLMServices
This toolbox purposes services to create a Drawing representation reference and to navigate between the
representation reference and the Drawing root.
In order to load 3D Data from an existing Drawing representation reference, use
Method Index
- o
CreateDrawingRepReference(CATIPsiRepresentationReference**,CATUnicodeString&,CATUnicodeString&,int,CATIType*,CATIAdpEnvironment*)
- Creates a complete Drawing representation reference.
- o
GetAvailableDrawingStandards(CATListOfCATUnicodeString&)
- Gets list of available drawing standards.
- o
GetDrawingRepresentation(CATIDftDrawing*,CATIPsiRepresentationReference**)
- Gets the Drawing representation from Drawing root.
- o
GetDrawingRoot(CATIPsiRepresentationReference*,CATIDftDrawing**)
- Gets the Drawing root from Drawing representation.
- o
GetListOfSheetStyles(CATUnicodeString,CATListOfCATUnicodeString&)
- Gets list of available sheet styles for a defined standard.
Methods
o CreateDrawingRepReference
public static CreateDrawingRepReference( | | opiDrawingRepRef, |
| | iDrwStandardName, |
| | iDrwSheetStyleName, |
| | iSheetOrient | = 0, |
| | iDrwType | = NULL, |
| | ipAdpEnv | = NULL) |
-
Creates a complete Drawing representation reference.
Role: This method creates a Drawing representation with a specific format and a specific standard.
- Parameters:
-
- opiDrawingRepRef
- [out, CATBaseUnknown#Release] The drawing representation.
- iDrwStandardName
- [in] The drawing standard name.
- iDrwSheetStyleName
- [in] The Style of the drawing sheet
- 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.
- iDrwType
- [in] The type of the Drawing representation. Must be a specialization of the original Drawing type.
If the argument is NULL, the original Drawing type is used.
- ipAdpEnv
- [in] The environment defining the project.
The project determines the deployment type to associate (or not) to the new PLM Object.
If the argument is NULL, the current environment is used.
- Returns:
-
- S_OK
- if the representation is created.
- E_FAIL
- if the operation failed.
- E_INVALIDARG
- Illegal arguments.
o GetAvailableDrawingStandards
public static GetAvailableDrawingStandards( | | oListOfStandards) |
-
Gets list of available drawing standards.
Role: This method returns the list of available drawing 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 GetDrawingRepresentation
public static GetDrawingRepresentation( | | ipiDftDrawing, |
| | opiDrawingRepresentation) |
-
Gets the Drawing representation from Drawing root.
- Parameters:
-
- ipiDftDrawing
- [in] The Drawing root.
- opiDrawingRepresentation
- [out, CATBaseUnknown#Release] The Drawing representation.
- Returns:
-
- S_OK
- if the drawing representation is found.
- E_INVALIDARG
- .if argument is not valid.
- E_FAIL
- if the operation failed.
o GetDrawingRoot
public static GetDrawingRoot( | | ipiDrawingRepRef, |
| | opiDftDrawing) |
-
Gets the Drawing root from Drawing representation.
- Parameters:
-
- ipiDrawingRepRef
- [in] The Drawing representation.
- opiDftDrawing
- [out] The Drawing root.
- Returns:
-
- S_OK
- if the drawing root is found.
- E_INVALIDARG
- .if argument is not valid: The Representation reference is either null or not a Drawing representation reference.
- E_FAIL
- if the operation failed.
o GetListOfSheetStyles
public static GetListOfSheetStyles( | | iStandardName, |
| | 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: CATDftDrawingPLMServices.h
If needed, your Imakefile.mk should include the module: CATDraftingUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.