Uporaba dokumentacije SOLIDWORKS API Help

Odgovori
caddy
Prispevkov: 420
Pridružen: 03 Mar 2014, 12:55

Uporaba dokumentacije SOLIDWORKS API Help

Odgovor Napisal/-a caddy » 23 Jun 2014, 10:05

Kaj lahko najdemo v SOLIDWORKS API Help dokumentaciji in kako nam lahko pomaga pri API programiranju?
rplevel
Prispevkov: 12
Pridružen: 28 Feb 2014, 09:13

Re: Uporaba dokumentacije SOLIDWORKS API Help

Odgovor Napisal/-a rplevel » 23 Jun 2014, 10:28

SOLIDWORKS API Help je obsežna dokumentacija o API objektih in funkcijah ter za večino teh vsebuje tudi primere uporabe. Ponuja informacije o vseh komponentah znotraj API-ja in omogoča boljše razumevanje API objektnega modela.

Informacije znotraj API Help dokumenta najlažje pridobimo s pomočjo iskanja. Iščemo lahko po specifičnih objektih ali metodah, ki smo jih opazili na primer med snemanjem makrojev in bi želeli izvedeti dodatne informacije. Lahko pa problem opišemo in preko rezultatov najdemo primeren objekt, metodo ali kar celoten primer, ki ta problem reši.

Ko najdete članek, ki bi lahko bil uporaben je pomembno vedeti v katero kategorijo spada:
  • 1. Interface (vmesnik oz. objekt)
Če je tema članka opisana kot vmesnik (Interface), lahko to razumete kot objekt, ki mora biti implementiran v kodo, da lahko dostopamo do metod, ki jih vsebuje. V vsakem »Interface« članku se nahaja sekcija »Accessors«, ki pove kako ustvariti instanco tega vmesnika.

Vmesnik IModelDoc2 navaja »ISldWorks::ActiveDoc« kot enega njegovih predhodnikov (»Accessor«). To pomeni, da se v vmesniku ISldWorks nahaja metoda ActiveDoc, ki vrne objekt tipa ModelDoc2.
Vsak članek tipa »Interface« vsebuje povezavo »Members«, ki navaja vse lastnosti in metode do katerih lahko preko vmesnika dostopamo.
  • 2. Method (metoda / funkcija)
Metode (ali tudi funkcije) so elementi, ki izvedejo neko operacijo znotraj programa SOLIDWORKS. Vsebujejo lahko enega ali več parametrov, ki morajo biti definirani, da se metoda izvede pravilno. Metoda FeatureExtrusion3 ima na primer 23 parametrov, kateri morajo biti vsi definirani da se iztiskanje pravilno izvede. SOLIDWORKS API Help datoteka vsebuje njihov opis, kaj pomenijo, kateri podatkovni tip potrebujejo (Integer, String, Boolean, itd.) in tudi kaj metoda vrne, ko se uspešno izvede.
  • 3. Example (primeri)
API Help datoteka vsebuje uporabne primere v različnih programskih jezikih (VBA, C#, C++), ki vas lahko vodijo v pravo smer. Primeri navadno uporabljajo eno ali dve glavni funkciji, da lažje razumete kje in kako se jih uporablja znotraj konteksta.
Ko preiskujete API Help datoteko bodite pozorni na sporočila »Obsolete. Superseded by ...«. To so zastarele metode, ki še vedno delujejo, vendar so bolj omejene in lahko pride tudi do nepričakovanih napak, ki so v novejših verzijah že odpravljene.
api-help-forum.png
Odgovori