oaCMBaseTypes.h File Reference

Go to the source code of this file.

Defines

#define oaCMBaseTypes_P
#define OA_CM_DLL_API
#define OA_CM_DLL_PVT
#define OA_CM_DLL_EXPORT

Functions

BEGIN_OA_NAMESPACE OA_CM_DLL_API void oaCMInit (oaUInt4 apiMajorRev=oacAPIMajorRevNumber, oaUInt4 apiMinorRev=oacAPIMinorRevNumber)
OA_CM_DLL_API void oaCMInit (oaUInt4 apiMajorRev, oaUInt4 apiMinorRev, oaUInt4 dataModelRev)

Define Documentation

#define OA_CM_DLL_API
 

#define OA_CM_DLL_EXPORT
 

#define OA_CM_DLL_PVT
 

#define oaCMBaseTypes_P
 

Function Documentation

void oaCMInit (  oaUInt4    apiMajorRev,
oaUInt4    apiMinorRev,
oaUInt4    dataModelRev
) 
 

This function initializes the oaCM package.

This function lets calling functions specify the API revisions and the data model revision that they support. Refer to Compatibility for OpenAccess Applications and Data in the Programmers Guide for more information about API revisions and data model revisions.

Parameters:
apiMajorRev Specifies the major revision of the OpenAccess shared libraries that were used to compile the application. Typically, this should be set to 
oacAPIMajorRevNumber
to indicate that the application uses the version number from the current version of OpenAccess.
apiMinorRev Specifies the minor revision of the OpenAccess shared libraries that were used to compile the application. Typically, this should be set to 
oacAPIMinorRevNumber
to indicate that the application uses the version number from the current version of OpenAccess.
dataModelRev Specifies the version of the OpenAccess data model that is supported. Applications should explicitly specify this argument to indicate the OpenAccess features that they support. For information about the OpenAccess features that are available in a particular dataModelRev, refer to the OpenAccess 2.2 Feature List.

void oaCMInit (  oaUInt4    apiMajorRev = oacAPIMajorRevNumber,
oaUInt4    apiMinorRev = oacAPIMinorRevNumber
) 
 

Important: This function is deprecated and is retained to ensure compatibility with previous versions of OpenAccess. Use the oaCMInit overload that accepts the dataModelRev argument instead.

This deprecated function initializes the oaCM package.

This deprecated version of oaCMInit does not include the dataModelRev argument, which lets an application specify the data model revision that it supports. Refer to Feature-Based Data Compatibility in Compatibility for OpenAccess Applications and Data in the Programmers Guide for details about how OpenAccess handles this deprecated function.

Parameters:
apiMajorRev Do not supply -- defaulted by compiler
apiMinorRev Do not supply -- defaulted by compiler

Return to top of page




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