The Integrated Library API Datafile Interfaces Reference includes the following sections and content: IModelDatafileType Methods

Transcription

1 IntLib API Datafile Interfaces Old Content - visit altium.com/documentation Modified by Admin on Sep 13, 2017 Parent page: Technical Reference - Integrated API Integrated API: Datafile Interfaces The Integrated API Datafile Interfaces Reference includes the following sections and content: IData Interface IData Methods IData Properties IDatafileType Interface IDatafileType Methods IData Interface Overview The IDatafile interface represents the data file (external file) that is associated with a model. Each model can have multiple data files (different representations of the same model type). This interface is used within the IServer interface. IData Methods and Properties Table IDatafile methods FullPath EntityCount EntityName AddEntity IDatafile properties EntityNames s\scripts\delphiscript Scripts\DXP_Scripts\ folder of Altium Designer installation IData Methods EntityName method (IDatafile interface)

2 Function EntityName (AnIndex : Integer) : WideString; The function returns the indexed entityname for the datafile related to the model. IDatafile interface EntityCount method EntityCount method (IDatafile interface) Function EntityCount : Integer; This function returns the number of entities for the data file related to the model. IDatafile interface EntityName method AddEntity method (IDatafile interface) Procedure AddEntity (AName : WideString); This procedure adds a new entity for the datafile. IDatafile interface FullPath method (IDatafile interface) Function FullPath : WideString; This procedure fetches the full path of the data file part of the model. IDatafile interface IData Properties EntityNames Property (IDatafile interface) Property EntityNames[AnIndex : Integer] : WideString Read EntityName; This Entitynames property returns the indexed entity name for the datafile related to the model. This property is supported by the Entitynames method. IDatafile interface

3 EntityNames method. IDatafileType Interface Overview The represents the data file type for the specified model. ulation has three model types and thus three data files, PCB LIB has one model type and one data file, PCB3DLib has one model type and one data file and SI has one model type and one data file. The is used by the ITypeManager IDatafileType Methods and Properties Table IDatafileType methods Kind ExtensionFilter EntityType Type IDatafileType properties ReportIntLibData script from the s\scripts\delphiscript Scripts\DXP_Scripts\ folder of Altium Designer installation IDatafileType Methods method () Function : PChar; This function returns the description string for this IDatafiletype interface depending on the model s data file type. Since Altium Designer supports four models and six model types: Type (Kind) ExtensionFilter DatafileType MDL *.MDL SIPin

4 PCBLIB *.PCBLIB Protel PCB3DLIB *.PCB3DLib For I := 0 To TypeMan.DatafileTypeCount - 1 do DatafileType.Kind + #13 + DatafileType. + #13 + BooleanToStr(DatafileType.)); EntityType method () Function EntityType : PChar; This function returns the Entity type string for this IDatafiletype interface depending on the model s data file type. Since Altium Designer supports four models and six model types: Type (Kind) ExtensionFilter DatafileType MDL *.MDL SIPin PCBLIB *.PCBLIB Protel PCB3DLIB *.PCB3DLib

5 For I := 0 To TypeMan.DatafileTypeCount - 1 do DatafileType.Kind + #13 + DatafileType. + #13 + BooleanToStr(DatafileType.)); ExtensionFilter method () Function ExtensionFilter : PChar; This function returns the extension filter string for this IDatafiletype interface depending on the model s data file type. Since Altium Designer supports four models and six model types: Type (Kind) ExtensionFilter DatafileType MDL *.MDL SIPin PCBLIB *.PCBLIB Protel PCB3DLIB *.PCB3DLib For I := 0 To TypeMan.DatafileTypeCount - 1 do DatafileType.Kind + #13 + DatafileType. + #13 +

6 BooleanToStr(DatafileType.)); Kind method () Function Kind : PChar; This function returns the Kind string for this IDatafiletype interface depending on the model s data file type. Since Altium Designer supports four models and six model types: Type (Kind) ExtensionFilter DatafileType MDL *.MDL SIPin PCBLIB *.PCBLIB Protel PCB3DLIB *.PCB3DLib For I := 0 To TypeMan.DatafileTypeCount - 1 do DatafileType.Kind + #13 + DatafileType. + #13 + BooleanToStr(DatafileType.));

7 Type method () Function Type : IType; This function returns the Type string for this IDatafiletype interface depending on the model s data file type. Since Altium Designer supports four models and six model types: Type (Kind) ExtensionFilter DatafileType MDL *.MDL SIPin PCBLIB *.PCBLIB Protel PCB3DLIB *.PCB3DLib For I := 0 To TypeMan.DatafileTypeCount - 1 do DatafileType.Kind + #13 + DatafileType. + #13 + BooleanToStr(DatafileType.)); method () Function : Boolean;

8 This function returns the Boolean value for this IDatafiletype interface depending on the model s data file type. Since Altium Designer supports four models and six model types: Type (Kind) ExtensionFilter DatafileType MDL *.MDL SIPin PCBLIB *.PCBLIB Protel PCB3DLIB *.PCB3DLib For I := 0 To TypeMan.DatafileTypeCount - 1 do DatafileType.Kind + #13 + DatafileType. + #13 + BooleanToStr(DatafileType.)); Source URL: