All Frameworks  Class Hierarchy  This Framework  Indexes   

CATSchPlatformInterfaces Interface CATISchAppCmdInfo

Usage: you can reimplement this interface by deriving the supplied CATEASchAppCmdInfo adapter class.


interface CATISchAppCmdInfo

Interface to manage the definition of command information that is application specific (such as defaults directory paths, Tools+Options, etc.
) and that is needed by various Schematic functions. Role: To retrieve various types of schematic command information.

BOA information: this interface CANNOT be implemented using the BOA (Basic Object Adapter). To know more about the BOA, refer to the CAA Encyclopedia home page. Click Middleware at the bottom left, then click the Object Modeler tab page. Several articles deal with the BOA.


Method Index


o GetAnnotationBreakCatalogDoc(CATDocument*&)
Use the Annotation Break Symbols catalog resource as defined through Project management and load the document associated with this resource.
o GetAnnotationBreakCatalogPath(char**)
Get the default Annotation Break Symbols catalog path.
o GetAnnotationSymbolsCatalogDoc(CATDocument*&)
Use the Annotation Symbols catalog resource as defined through Project management and load the document associated with this resource.
o GetAnnotationSymbolsCatalogPath(char**)
Get the default Annotation Symbols catalog path.
o GetComponentCatalogDoc(CATDocument*&)
Use the component catalog resource as defined through Project management and load the document associated with this resource.
o GetComponentCatalogPath(char**)
Get the default component catalog path.
o GetGraphicNamesPath(char**)
Get the path where the graphic names .
o GetLineListsCatalogPath(char*,char**)
Get the default LineLists catalog path.
o GetOnOffSheetCatalogDoc(CATDocument*&)
Use the OnOffSheet catalog resource as defined through Project management and load the document associated with this resource.
o GetOnOffSheetCatalogPath(char**)
Get the default OnOffSheet catalog path.
o GetPartSelectionInCompPlace(int*)
Return a flag indicating if Part Selection function should be added to the Place Component command.

Methods


o GetAnnotationBreakCatalogDoc
public virtual GetAnnotationBreakCatalogDoc( opDocument)
Use the Annotation Break Symbols catalog resource as defined through Project management and load the document associated with this resource.
Parameters:
opDocument
The loaded Annotation Break Symbols catalog document.
o GetAnnotationBreakCatalogPath
public virtual GetAnnotationBreakCatalogPath( oCatalogPath)
Get the default Annotation Break Symbols catalog path.
Parameters:
oCatalogPath
The default Annotation Break Symbols catalog path.
o GetAnnotationSymbolsCatalogDoc
public virtual GetAnnotationSymbolsCatalogDoc( opDocument)
Use the Annotation Symbols catalog resource as defined through Project management and load the document associated with this resource.
Parameters:
opDocument
The loaded Annotation Symbols catalog document.
o GetAnnotationSymbolsCatalogPath
public virtual GetAnnotationSymbolsCatalogPath( oCatalogPath)
Get the default Annotation Symbols catalog path.
Parameters:
oCatalogPath
The default Annotation Symbols catalog path.
o GetComponentCatalogDoc
public virtual GetComponentCatalogDoc( opDocument)
Use the component catalog resource as defined through Project management and load the document associated with this resource.
Parameters:
opDocument
The loaded component catalog document.
o GetComponentCatalogPath
public virtual GetComponentCatalogPath( oCatalogPath)
Get the default component catalog path.
Parameters:
oCatalogPath
The default component catalog path.
o GetGraphicNamesPath
public virtual GetGraphicNamesPath( oGraphicNamesPath)
Get the path where the graphic names .txt files can be found.
Parameters:
oGraphicNamesPath
The graphic names path.
o GetLineListsCatalogPath
public virtual GetLineListsCatalogPath( const iLineType,
oCatalogPath)
Get the default LineLists catalog path.
Parameters:
iLineType
The class of the Line ID for which you want the catalog path. For example: CATPspPipingLine, CATPspICLoop, CATPspHVACLine.
oCatalogPath
The default LineLists catalog path for the input class of Line ID.
o GetOnOffSheetCatalogDoc
public virtual GetOnOffSheetCatalogDoc( opDocument)
Use the OnOffSheet catalog resource as defined through Project management and load the document associated with this resource.
Parameters:
opDocument
The loaded OnOffSheet catalog document.
o GetOnOffSheetCatalogPath
public virtual GetOnOffSheetCatalogPath( oCatalogPath)
Get the default OnOffSheet catalog path.
Parameters:
oCatalogPath
The default OnOffSheet catalog path.
o GetPartSelectionInCompPlace
public virtual GetPartSelectionInCompPlace( oFlag)
Return a flag indicating if Part Selection function should be added to the Place Component command.
Parameters:
oFlag
Flag indicating if Part Selection function should be added to the Place Component command. 0 means don't add it. 1 means add it.

This object is included in the file: CATISchAppCmdInfo.h

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