oaDMTypes.h File Reference

Go to the source code of this file.

Compounds

class  oaDMDataType
class  oaLibDataType

Defines

#define oaDMTypes_P
#define OA_DM_DLL_API
#define OA_DM_DLL_PVT
#define oavNumLibDataTypes   19
#define oavNumNewLibDataTypes   2
#define oavNumVarLibDataTypes   2
#define oavNumDMDataTypes   15
#define oavNumNewDMDataTypes   2
#define oavNumVarDMDataTypes   2
#define oacVCStatusControlled   0x00000001u
#define oacVCStatusEditable   0x00000002u
#define oacVCStatusUpToDate   0x00000004u
#define oacVCStatusAdded   0x00000008u
#define oacVCStatusDeleted   0x00000010u
#define oacVCStatusModified   0x00000020u
#define oacVCStatusLocked   0x00000040u
#define oacVCStatusMerged   0x00000080u
#define oacVCStatusConflict   0x00000100u
#define oacVCStatusMissing   0x00000200u
#define oacVCStatusRemote   0x00000400u
#define oacVCStatusAll   0xFFFFFFFFu

Enumerations

enum  oaLibDataTypeEnum {
  oacLibDataType = UINT_MAX, oacLibAppObjectDataType = UINT_MAX - 1, oacLibPropDataType = 0, oacLibGroupDataType = 1,
  oacLibGroupMemDataType = 2, oacLibAvatarDataType = 3, oacLibValueDataType = 4, oacLibConstraintParamDefDataType = 5,
  oacLibConstraintParamDataType = 6, oacLibConstraintDefDataType = 7, oacLibConstraintDataType = 8, oacLibConstraintGroupDataType = 9,
  oacLibConstraintGroupMemDataType = 10, oacLibConstraintGroupHeaderDataType = 11, oacCellDataType = 12, oacViewDataType = 13,
  oacCellViewDataType = 14, oacDMFileDataType = 15, oacLibFeatureDataType = 16, oacLibFeaturePolicyDataType = 17,
  oacLibGroupDefDataType = 18
}
enum  oaDMDataTypeEnum {
  oacDMDataDataType = UINT_MAX, oacDMAppObjectDataType = UINT_MAX - 1, oacDMPropDataType = 0, oacDMGroupDataType = 1,
  oacDMGroupMemDataType = 2, oacDMAvatarDataType = 3, oacDMValueDataType = 4, oacDMConstraintParamDefDataType = 5,
  oacDMConstraintParamDataType = 6, oacDMConstraintDefDataType = 7, oacDMConstraintDataType = 8, oacDMConstraintGroupDataType = 9,
  oacDMConstraintGroupMemDataType = 10, oacDMConstraintGroupHeaderDataType = 11, oacDMFeatureDataType = 12, oacDMFeaturePolicyDataType = 13,
  oacDMGroupDefDataType = 14
}

Functions

OA_DM_DLL_API void oaDMInit (oaUInt4 apiMajorRev=oacAPIMajorRevNumber, oaUInt4 apiMinorRev=oacAPIMinorRevNumber)
OA_DM_DLL_API void oaDMInit (oaUInt4 apiMajorRev, oaUInt4 apiMinorRev, oaUInt4 dataModelRev)

Define Documentation

#define OA_DM_DLL_API
 

#define OA_DM_DLL_PVT
 

#define oacVCStatusAdded   0x00000008u
 

#define oacVCStatusAll   0xFFFFFFFFu
 

#define oacVCStatusConflict   0x00000100u
 

#define oacVCStatusControlled   0x00000001u
 

#define oacVCStatusDeleted   0x00000010u
 

#define oacVCStatusEditable   0x00000002u
 

#define oacVCStatusLocked   0x00000040u
 

#define oacVCStatusMerged   0x00000080u
 

#define oacVCStatusMissing   0x00000200u
 

#define oacVCStatusModified   0x00000020u
 

#define oacVCStatusRemote   0x00000400u
 

#define oacVCStatusUpToDate   0x00000004u
 

#define oaDMTypes_P
 

#define oavNumDMDataTypes   15
 

#define oavNumLibDataTypes   19
 

#define oavNumNewDMDataTypes   2
 

#define oavNumNewLibDataTypes   2
 

#define oavNumVarDMDataTypes   2
 

#define oavNumVarLibDataTypes   2
 

Enumeration Type Documentation

enum oaDMDataTypeEnum
 

Enumeration values:
oacDMPropDataType  "propDataType"
oacDMGroupDataType  "groupDataType"
oacDMGroupMemDataType  "groupMemDataType"
oacDMFeatureDataType  "featureDataType"
oacDMFeaturePolicyDataType  "featurePolicyDataType"
oacDMGroupDefDataType 

enum oaLibDataTypeEnum
 

Enumeration values:
oacLibPropDataType  "propDataType"
oacLibGroupDataType  "groupDataType"
oacLibGroupMemDataType  "groupMemDataType"
oacLibValueDataType  "valueDataType"
oacLibConstraintParamDefDataType  "constraintParamDefDataType"
oacLibConstraintParamDataType  "constraintParamDataType"
oacLibConstraintDefDataType  "constraintDefDataType"
oacLibConstraintDataType  "constraintDataType"
oacLibConstraintGroupDataType  "constraintGroupDataType"
oacLibConstraintGroupMemDataType  "constraintGroupMemDataType"
oacLibConstraintGroupHeaderDataType  "constraintGroupHeaderDataType"
oacCellDataType  "cellDataType"
oacViewDataType  "viewDataType"
oacCellViewDataType  "cellViewDataType"
oacDMFileDataType  "fileDataType"
oacLibFeatureDataType  "featureDataType"
oacLibFeaturePolicyDataType  "featurePolicyDataType"
oacLibGroupDefDataType  "groupDefData"

Function Documentation

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

This function initializes the DM 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.
Exceptions:
oacInvalidMajorAPIRev The major revision number of the OpenAccess shared libraries that were used to compile the application does not match the major revision number of the OpenAccess shared libraries that the application is running against.
oacInvalidAPIRev The minor revision number of the OpenAccess shared libraries that were used to compile the application is higher than the minor revision number of the OpenAccess shared libraries that the application is running against.
oacInvalidDataModelRev The application revision number passed to this function is higher than the data model supported by the OpenAccess shared libraries that the application is running against.
oacInconsistentDataModelRev The data model revision numbers among the components of the caller's application are not consistent.

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

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

This deprecated function initializes the DM package.

This deprecated version of oaDMInit 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
Exceptions:
oacInvalidMajorAPIRev The major revision number of the OpenAccess shared libraries that were used to compile the application does not match the major revision number of the OpenAccess shared libraries that the application is running against.
oacInvalidAPIRev The minor revision number of the OpenAccess shared libraries that were used to compile the application is higher than the minor revision number of the OpenAccess shared libraries that the application is running against.

Return to top of page




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