ILibDef Class Reference

Inheritance diagram for ILibDef:

IBase


Public Methods

virtual oa::oaLibDefList * open ()=0
virtual oa::oaLibDefList * open (const oa::oaString &filePath, oa::oaBoolean openReferences)=0
virtual void save (const oa::oaLibDefList *libList)=0
virtual void saveAs (const oa::oaLibDefList *libList, const oa::oaString &path)=0
virtual void getDefaultPath (oa::oaString &defaultPath)=0
virtual void getDefaultFileName (oa::oaString &filename)=0
virtual oa::oaBoolean hasPath () const=0
virtual oa::oaBoolean hasWritePath () const=0
virtual void getLibPath (const oa::oaLibDef *libDef, oa::oaString &libPath)=0
virtual void getLibWritePath (const oa::oaLibDef *libDef, oa::oaString &libWritepath)=0
virtual void init (ILibDefAccess *libDefAccess)=0

Static Public Methods

const Guid & getId ()

Detailed Description

This is an abstract class that specifies the interface through which a library definition file plug-in and OpenAccess interact.

Member Function Documentation

void ILibDef::getDefaultFileName (  oa::oaString &    filename )  [pure virtual]
 

The function queries for the default file name for the library definition file in the current session.

The plug-in is responsible for providing the default file name.

Parameters:
filename The default file name for the library definition file.

void ILibDef::getDefaultPath (  oa::oaString &    defaultPath )  [pure virtual]
 

This function queries for the default path for the library definition file in the current session. If none exists, an empty string is returned.

The plug-in is responsible for providing the default path.

Parameters:
defaultPath The full path for the default library definition file, including the file name.

const Guid & ILibDef::getId (    )  [inline, static]
 

This function returns a 128-bit ID value that is used to uniquely identify interfaces in the OpenAccess plug-in system.

void ILibDef::getLibPath (  const oa::oaLibDef *    libDef,
oa::oaString &    libPath
)  [pure virtual]
 

This function fills in a specific library path that a plug-in might define. Defining a special library path by the plug-in is optional. If a plug-in does not define and use a special library path for oaLibDef objects then the ILibDef::hasPath() should return false and OpenAccess will not call this function.

Parameters:
libDef A pointer to an oaLibDef object for which to get the path.
libPath The returned library path.

void ILibDef::getLibWritePath (  const oa::oaLibDef *    libDef,
oa::oaString &    libWritepath
)  [pure virtual]
 

This function fills in a specific library write path that a plug-in might define. Defining a special library write path by the plug-in is optional. If a plug-in does not define and use a special library write path for oaLibDef objects then the ILibDef::hasWritePath() should return false and OpenAccess will not call this function.

Parameters:
libDef A pointer to the oaLibDef object defining the library for which to get the writePath.
libWritepath The returned write path for the library.

oa::oaBoolean ILibDef::hasPath (    )  const [pure virtual]
 

The function returns true if the LibDef plug-in has a particular lib path for oaLibDef objects.

oa::oaBoolean ILibDef::hasWritePath (    )  const [pure virtual]
 

This function returns true if the library definition file plug-in has a particular lib write path for oaLibDef objects.

See also:
oaLibDef::getLibWritePath

void ILibDef::init (  ILibDefAccess *    libDefAccess )  [pure virtual]
 

This function initializes the library definition file plug-in and provides a pointer to an access object that allows a plug-in to call back to OpenAccess.

The plug-in should store the libDefAccess object pointer to be able to call back to OpenAccess when needed.

Parameters:
libDefAccess A pointer to an access object that allows a plug-in to to call back to OpenAccess.
See also:
ILibDefAccess::warn

virtual oa::oaLibDefList* ILibDef::open (  const oa::oaString &    filePath,
oa::oaBoolean    openReferences
)  [pure virtual]
 

oaLibDefList * ILibDef::open (    )  [pure virtual]
 

This function opens the default library definition file.

The plug-in is responsible for reading the library definition files and creating the corresponding oaLibDefList and oaLibDefListMem objects. If the library definition file was read successfully the function returns a pointer to the oaLibDefList object corresponding to the default library definition file. The default plug-in policy is used whether or not referenced library definition files are recursively opened.

void ILibDef::save (  const oa::oaLibDefList *    libList )  [pure virtual]
 

This function saves the specified oaLibDefList object.

The plug-in is responsible for writing the library definitions into the file.

Parameters:
libList A pointer to the oaLibDefList object to save.

void ILibDef::saveAs (  const oa::oaLibDefList *    libList,
const oa::oaString &    path
)  [pure virtual]
 

This function saves the oaLibDefObject to a file on disk in the specified path.

Parameters:
libList A pointer to the oaLibDefList object to save.
path The full path for the library definition file, including the file name.

The documentation for this class was generated from the following files:

Return to top of page




Copyright © 2002 - 2010 Cadence Design Systems, Inc.
All Rights Reserved.