oaTechDBTypes.h File Reference

Go to the source code of this file.

Compounds

class  oaTechDataType

Defines

#define oaTechDBTypes_P
#define OA_TECH_DLL_API
#define OA_TECH_DLL_PVT
#define oacAnyLayerNum   oacNullIndex
#define oavNumTechDataTypes   33
#define oavNumNewTechDataTypes   14

Typedefs

typedef unsigned int oaLayerNum
typedef unsigned int oaPurposeNum

Enumerations

enum  oaTechDataTypeEnum {
  oacTechDataType = UINT_MAX, oacTechAppObjectDataType = UINT_MAX - 1, oacTechPropDataType = 0, oacTechGroupDataType = 1,
  oacTechGroupMemDataType = 2, oacTechAvatarDataType = 3, oacTechValueDataType = 4, oacTechConstraintParamDefDataType = 5,
  oacTechConstraintParamDataType = 6, oacTechConstraintDefDataType = 7, oacTechConstraintDataType = 8, oacTechConstraintGroupDataType = 9,
  oacTechConstraintGroupMemDataType = 10, oacTechConstraintGroupHeaderDataType = 11, oacLayerDataType = 12, oacPurposeDataType = 13,
  oacSiteDefDataType = 14, oacViaDefDataType = 15, oacOpPointDataType = 16, oacAnalysisLibDataType = 17,
  oacViaSpecDataType = 18, oacTechFeatureDataType = 19, oacTechFeaturePolicyDataType = 20, oacTechHeaderDataType = 21,
  oacTechLayerHeaderDataType = 22, oacTechViaDefHeaderDataType = 23, oacTechDerivedLayerParamDefDataType = 24, oacTechDerivedLayerParamDataType = 25,
  oacTechDerivedLayerDefDataType = 26, oacTechGroupDefDataType = 27, oacTechConstraintGroupDefDataType = 28, oacTechParamDataType = 29,
  oacTechViaVariantDataType = 30, oacTechViaVariantHeaderDataType = 31, oacTechViaParamDataType = 32
}

Functions

OA_TECH_DLL_API void oaTechInit (oaUInt4 apiMajorRev=oacAPIMajorRevNumber, oaUInt4 apiMinorRev=oacAPIMinorRevNumber)
OA_TECH_DLL_API void oaTechInit (oaUInt4 apiMajorRev, oaUInt4 apiMinorRev, oaUInt4 dataModelRev)


Define Documentation

#define OA_TECH_DLL_API
 

#define OA_TECH_DLL_PVT
 

#define oacAnyLayerNum   oacNullIndex
 

#define oaTechDBTypes_P
 

#define oavNumNewTechDataTypes   14
 

#define oavNumTechDataTypes   33
 


Typedef Documentation

typedef unsigned int oaLayerNum
 

typedef unsigned int oaPurposeNum
 


Enumeration Type Documentation

enum oaTechDataTypeEnum
 

Enumeration values:
oacTechDataType  "techDataType"
oacTechAppObjectDataType  "appObjectDataType"
oacTechPropDataType  "propDataType"
oacTechGroupDataType  "groupDataType"
oacTechGroupMemDataType  "groupMemDataType"
oacTechValueDataType  "valueDataType"
oacTechConstraintParamDefDataType  "constraintParamDefDataType"
oacTechConstraintParamDataType  "constraintParamDataType"
oacTechConstraintDefDataType  "constraintDefDataType"
oacTechConstraintDataType  "constraintDataType"
oacTechConstraintGroupDataType  "constraintGroupDataType"
oacTechConstraintGroupMemDataType  "constraintGroupMemDataType"
oacTechConstraintGroupHeaderDataType  "constraintGroupHeaderDataType"
oacLayerDataType  "layerDataType"
oacPurposeDataType  "purposeDataType"
oacSiteDefDataType  "siteDefDataType"
oacViaDefDataType  "viaDefDataType"
oacOpPointDataType  "opPointDataType"
oacAnalysisLibDataType  "analysisLibDataType"
oacViaSpecDataType  "viaSpecDataType"
oacTechFeatureDataType  "featureDataType"
oacTechFeaturePolicyDataType  "featurePolicyDataType"
oacTechHeaderDataType  "headerDataType"
oacTechLayerHeaderDataType  "layerHeaderDataType"
oacTechViaDefHeaderDataType  "viaDefHeaderDataType"
oacTechDerivedLayerParamDefDataType  "derivedLayerParamDefDataType"
oacTechDerivedLayerParamDataType  "derivedLayerParamDataType"
oacTechDerivedLayerDefDataType  "derivedLayerDefDataType"
oacTechGroupDefDataType  "groupDefDataType"
oacTechConstraintGroupDefDataType  "constraintGroupDefDataType"
oacTechParamDataType  "paramDataType"
oacTechViaVariantDataType  "viaVariantDataType"
oacTechViaVariantHeaderDataType  "viaVariantHeaderDataType"
oacTechViaParamDataType  "viaParamDataType"


Function Documentation

void oaTechInit oaUInt4    apiMajorRev,
oaUInt4    apiMinorRev,
oaUInt4    dataModelRev
 

This function initializes the Tech package. It also initializes the DM package on which it depends. If your application only accesses the technology database, use the initialization call oaTechInit.

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 oaTechInit oaUInt4    apiMajorRev = oacAPIMajorRevNumber,
oaUInt4    apiMinorRev = oacAPIMinorRevNumber
 

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

This deprecated function initializes the Tech package. It also initializes the DM package on which it depends. If your application only accesses the technology database, use the initialization call oaTechInit.

This deprecated version of oaTechInit 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.

Return to top of page