All Frameworks  Class Hierarchy  This Framework  Indexes   

ENOVDDManager Interface CATIEnovSheetManager

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


interface CATIEnovSheetManager

Interface for CATIEnovSheetManager.
Role: This interface provides methods to manipulate multi-sheets documents. It is implemented in ENOVDDManager/VX0DDUtil.m.


Method Index


o CreateTOC(CATUnicodeString,CATUnicodeString,ENOVITOCMaster_var&,ENOVITOCVersion_var&)
Create a TOC master and TOC version.
o GetAllSheetsInTOCWithIndex(CORBAAny&,CATListOfObjectVersion&)
Retrieves all the sheets (include Index sheet) in TOC.
o GetAllSheetsInTOCWithIndex(CATIAVPMObjectVersion_var&,CATListOfObjectVersion&)
Retrieves all sheets (include Index sheet) in TOC by TOC object.
o GetAllSheetsInTOC(CORBAAny&,CATListOfObjectVersion&)
Retrieves all the sheets in TOC.
o GetAllSheetsInTOC(CATIAVPMObjectVersion_var&,CATListOfObjectVersion&)
Retrieves all sheets in TOC by TOC object.
o IsATOC(CATIAVPMObjectVersion_var&,long&)
Determines if the input version object is a TOC.
o createNewTOCVer(ENOVITOCMaster_var,ENOVITOCVersion_var,ENOVITOCVersion_var&)
Create a new TOC version.
o deleteTOC(ENOVITOCVersion_var&)
Deletes a TOC version (and its master too if it is the last version).
o getTOCFromSheet(CATIVpmFactoryObject_var,ENOVITOCMaster_var&,ENOVITOCVersion_var&)
Retrieves TOC from a sheet.

Methods


o CreateTOC
public virtual CreateTOC( iTOCID,
iDescription,
oTOCMaster,
oTOCVersion)
Create a TOC master and TOC version.
Parameters:
iTOCID
The TOC master ID
iDescription
The TOC version description
oTOCMaster
The TOC master
oTOCVersion
The TOC version
Returns:
S_OK in case of success, E_FAIL in case of error.
o GetAllSheetsInTOCWithIndex
public virtual GetAllSheetsInTOCWithIndex( const iTOCUuid,
oSheets)
Retrieves all the sheets (include Index sheet) in TOC.
Parameters:
iTOCUuid
The TOC Uuid
oSheets
The list of all the sheets
Returns:
S_OK in case of success, E_FAIL in case of error.
o GetAllSheetsInTOCWithIndex
public virtual GetAllSheetsInTOCWithIndex( const iTOC,
oSheets)
Retrieves all sheets (include Index sheet) in TOC by TOC object.
Parameters:
iTOC
The TOC object
oSheets
The list of all the sheets
Returns:
S_OK in case of success, E_FAIL in case of error.
o GetAllSheetsInTOC
public virtual GetAllSheetsInTOC( const iTOCUuid,
oSheets)
Retrieves all the sheets in TOC.
Parameters:
iTOCUuid
The TOC Uuid
oSheets
The list of all the sheets
Returns:
S_OK in case of success, E_FAIL in case of error.
o GetAllSheetsInTOC
public virtual GetAllSheetsInTOC( const iTOC,
oSheets)
Retrieves all sheets in TOC by TOC object.
Parameters:
iTOC
The TOC object
oSheets
The list of all the sheets
Returns:
S_OK in case of success, E_FAIL in case of error.
o IsATOC
public virtual IsATOC( const iVersionObj,
oAnswer)
Determines if the input version object is a TOC.
Parameters:
iVersionObj
The version object
oAnswer
The result (1 if is a TOC, or 0 if it is not a TOC)
Returns:
S_OK in case of success, E_FAIL in case of error.
o createNewTOCVer
public virtual createNewTOCVer( iTOCMaster,
iTOCVersion,
oTOCVersion)
Create a new TOC version.
Parameters:
iTOCMaster
The TOC master
iTOCVersion
The TOC version
oTOCVersion
The new TOC version
Returns:
S_OK in case of success, E_FAIL in case of error.
o deleteTOC
public virtual deleteTOC( iTOCVersion)
Deletes a TOC version (and its master too if it is the last version).
Parameters:
iTOCVersion
The TOC version to be deleted.
Returns:
S_OK in case of success, E_FAIL in case of error.
o getTOCFromSheet
public virtual getTOCFromSheet( iSheet,
oTOCMaster,
oTOCVersion)
Retrieves TOC from a sheet.
Parameters:
iSheet
The sheet object
oTOCMaster
The TOC master retrieved
oTOCVersion
The TOC version retrieved.
Returns:
S_OK in case of success, E_FAIL in case of error.

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

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