Changeset 603 for epicsdf


Ignore:
Timestamp:
Aug 5, 2011 12:25:16 PM (14 years ago)
Author:
jemian
Message:

revise the documentation further and test that it comes up correctly from the SVN repo

Location:
epicsdf
Files:
6 added
6 edited

Legend:

Unmodified
Added
Removed

  • epicsdf/doc/build

    • Property svn:ignore set to
      doctrees

  • TabularUnified epicsdf/doc/build/html/_sources/contents.txt

    r602 r603  
    1 .. $Id: contents.rst 601 2011-08-05 17:01:57Z jemian $
     1.. $Id: contents.rst 602 2011-08-05 17:03:01Z jemian $
    22
    33Contents

  • TabularUnified epicsdf/doc/build/html/searchindex.js

    r602 r603  
    1 Search.setIndex({objects:{"":{epicsdf:[5,0,1]},"epicsdf.epicsdf":{setPeriod:[5,1,1],onAlarmPvChange:[5,1,1],run:[5,1,1],sendMail:[5,1,1],df:[5,1,1],demo:[5,1,1],getDisk:[5,1,1],df2epics:[5,1,1],onMessagePvChange:[5,1,1],isValidPeriod:[5,1,1],caput:[5,1,1],onPeriodPvChange:[5,1,1],caget:[5,1,1],onEmailsPvChange:[5,1,1],wf2str:[5,1,1],onDiskPvChange:[5,1,1],logger:[5,1,1],doPeriodicUpdate:[5,1,1]},epicsdf:{epicsdf:[5,2,1]}},terms:{all:[5,3,1,2],code:[1,2,3,4,5,6],ioc15iddlax:1,inpa:3,inpb:3,epd_deploy:1,prefix:[5,3,1],follow:1,disk:[5,0,3,1,2],children:1,row:1,auto_set:1,ver:1,aug:1,send:[5,3,1,2],apsshar:1,program:1,those:0,under:1,leav:1,doperiodicupd:5,sent:3,sourc:[5,3,4,1,6],everi:[1,2],string:[5,3],email_list:[5,3],candid:5,caput:[5,3],level:1,gui:[1,6],cmd:1,list:[5,3,1],"try":1,item:[5,1],adjust:1,pvname:5,small:3,epd_root:1,df_demo:5,cron:[0,1,2],zero:[5,3],llsv:3,download:1,even:1,index:[5,6],what:1,xor:[1,6],nano:2,sum:1,current:1,version:1,directori:[1,2],"new":[5,3,1],method:5,full:1,behavior:3,gener:3,here:1,wfter:1,subvers:[1,6],address:[3,1],path:[3,1,2],sinc:[5,1],valu:[5,3,1],wait:5,box:3,search:6,sender:1,getdisk:5,step:1,boi:1,amount:0,real:1,implement:0,onmessagepvchang:5,extra:1,modul:[5,4,1,6],iocinit:1,unix:[5,0],"boolean":3,instal:[1,6],total:[5,3],select:1,from:[5,0,4,1,3],describ:1,would:0,memori:1,regist:1,prec:3,next:[5,1],few:1,flnk:3,call:[5,0,1],calc:3,type:[5,3,1,2],minor:3,more:1,sort:1,flaw:1,desir:3,warn:1,xorapp:1,accept:[5,1],examin:5,particular:0,hold:3,cach:5,starter:1,must:[5,1],none:5,word:5,past:2,work:[5,1],det:1,dev:5,cat:1,remain:3,can:[5,3,1],control:[0,1],give:5,process:[5,0,3,1,2],"15iddlaxapp":1,p100:1,indic:[5,0,6],high:3,dbloadrecord:1,liter:5,occur:1,end:1,goal:[3,6],secur:1,ascii:1,write:[0,1],how:1,forest:1,subdirectori:1,verifi:1,hihi:3,css:1,updat:[5,3],stop:[0,1,2],pilatu:[1,6],befor:1,attent:3,date:1,data:[0,1],npp:3,demonstr:[5,3],rhel5:1,obsolet:1,lost:1,egu:3,inform:[5,0,1],maintain:0,environ:2,allow:[5,3,1],enter:[1,2],tty:1,feedback:3,move:1,lsv:3,through:3,hierarchi:1,paramet:[5,3],pyepic:[5,1],style:1,group:1,monitor:[5,0],fit:1,pct:3,mail:[5,1],might:1,epics_host_arch:3,non:3,good:1,"return":5,greater:5,python:[0,1,2,4,5,6],sid:1,now:[3,1],nor:3,name:[5,3,1],trac:6,edit:[3,1,2],simpl:1,sevr:3,mode:1,each:[0,1],found:[3,1],calcout:[5,3],side:3,mean:[3,1],just:1,replac:5,individu:1,procedur:1,"15iddlax":1,connect:5,sion:1,our:[5,1],happen:5,orient:1,out:1,variabl:[5,0,3,1,2],"100k":1,space:[5,0,3,1,2],req:1,lolo:3,reboot:1,content:[0,4,1,6],onalarmpvchang:5,rel:1,print:1,gov:[5,1,6],after:5,sendmail:[5,1],situat:1,wf2str:5,free:[5,0,3],like:1,reason:1,base:3,dictionari:5,"byte":5,bash:2,softioc:3,thread:1,could:[5,3,1],keep:1,length:3,place:1,outsid:5,epics_bas:3,onto:0,localdomain:1,first:1,oper:[3,1],softwar:[3,1],major:3,directli:1,onc:5,arrai:5,misc:1,number:[0,3],mai:3,instruct:[1,6],done:1,messag:[5,3],ring:1,size:0,given:[5,1],script:[0,1,2],top:1,mkdir:1,system:[0,1],construct:5,grow:3,cumul:1,statement:1,termin:1,hhsv:3,includ:1,shell:[0,1,2],consol:0,option:1,wchan:1,tool:[0,1,3],copi:1,specifi:1,task:[0,1,2],necessarili:0,wide:1,conveni:[1,2],keyword:[5,1],whenev:3,charact:3,project:[0,3],str:5,macro:[3,1],minut:[1,2],browser:6,pre:5,sai:1,comput:[0,1,2,3,5,6],anl:[1,6],rh5:1,argument:1,prj:[5,3,1],packag:[4,3,2],sax:1,have:[3,1],tabl:[0,6],need:[5,1,2],built:[3,1],someapp:1,callback:5,test_pyep:1,self:[5,1],srcurrentai:1,note:[5,3,1,2],also:[1,2],exampl:[3,1],build:6,which:[1,2],isvalidperiod:5,detector:[0,1,6],noth:1,singl:[0,1,3],sure:2,distribut:[1,6],deploy:1,previou:3,reach:0,react:0,most:2,larg:0,"class":[5,1],url:1,doc:6,alarm:[5,3,6],request:[3,1],doe:[5,3,1],ondiskpvchang:5,determin:5,show:1,text:[5,0,1],epicsdf:[0,1,2,3,4,5,6],cdt:1,session:1,threshold:0,find:1,help:1,absolut:1,onli:[5,1],locat:2,acquir:0,hopr:3,configur:[3,1],forev:[5,1],should:[5,1],"15id":1,dict:5,local:[5,1,2],info:[5,1],variou:3,get:5,watch:[5,0,3,1,2],nativ:1,drawn:4,report:[5,0,1,2],recalcul:3,restart:[0,1,2],app_base_dir:1,partit:[5,0,3,1,2],contain:1,where:[5,0,1],shm:5,respond:5,arr:5,set:[5,0,3,2],art:1,"float":5,see:[5,3],df2epic:5,result:5,fail:1,dectri:1,statu:1,enthought:[1,6],databas:[5,0,1,3,6],written:1,between:[5,3],"import":[5,1,2],email:[5,3,1,2],altern:5,kei:1,start_ioc:3,numer:1,screen:[3,1],job:[5,0,1,2],tue:1,addit:1,both:[1,2],against:1,instanc:5,context:1,improv:3,col:1,p300:[5,3,1],point:3,schedul:[0,1],period:[5,0,1,3],chmod:1,linux:1,cancel:1,assum:[0,1],hyst:3,quit:[1,2],devic:3,three:5,empti:3,trigger:[5,3],interest:0,imag:1,convert:5,ani:[0,3],logger:5,present:3,replic:5,look:1,defin:[5,3,1],calcul:[3,6],abov:2,error:1,synapps_5_4:1,caget:[5,1],libca:1,bin:[3,1],setperiod:5,suse:1,demo:5,them:5,revis:1,reprogram:3,sever:[5,1],develop:[5,3],author:1,suggest:1,make:[1,2],format:1,same:[3,1,2],check:[5,0,1,2],fragment:3,html:6,iocboot:1,document:[0,4,3,2,6],http:[1,6],x86:1,effect:1,user:[3,1],ioc:[5,0,1,3,6],typic:[0,3],appropri:1,off:5,entri:3,client:[0,1,3,4,5,6],command:[5,3,1,2],thi:[5,0,1,3],epd:1,usual:[3,1],identifi:2,execut:1,"true":1,boot:5,obtain:0,virtual:1,yet:1,makefil:2,except:1,newdisk:5,add:1,other:[5,1],adl:[3,1],save:[1,2],libcom:1,match:1,earli:3,around:1,mayb:1,five:2,know:1,background:[5,0],press:1,bit:1,opi:1,desc:3,insert:1,resid:[5,1],autosav:[3,1],specif:3,docutil:5,onemailspvchang:5,negat:1,either:3,output:[0,1,2],signal:[3,1],www:6,manual:1,some:[5,3,1,2],back:1,percentag:3,intern:5,home:1,successfulli:3,tmp:[5,1],deselect:1,medm:[3,1,6],waveform:[5,3],esc:1,unit:5,condit:3,epic:[0,1,2,3,4,5,6],leader:1,preload:1,database_prefix:1,iocnam:1,run:[5,0,3,1,2],usag:5,host:[5,0,1,2,6],usax:1,hsv:3,src:[5,1],page:[1,6],onperiodpvchang:5,constructor:5,discard:1,luck:1,editor:[1,2],checkup:[1,2],routin:[5,3],consid:1,numpi:5,within:[5,1],been:[0,1,3],ensur:[0,1],chang:[5,3,1],hysteresi:3,storag:1,your:1,span:5,log:[5,0,1,2],area:0,support:[0,1,2,3,5,6],"long":1,avail:[5,0,1,3],start:[0,3,1,2],handler:5,interfac:3,low:[3,1,2],forward:3,ppid:1,"function":5,head:1,properli:1,forc:[5,3],link:[0,3,6],crontab:[1,2],jemian:5,line:[3,1,2],command_lin:1,reset:3,notat:1,made:3,consist:[4,3,2],possibl:5,"default":[5,3,1],displai:5,record:[5,3,2],below:3,limit:0,problem:1,uid:1,creat:[3,1],"int":5,certain:3,dure:[5,1],pid:[0,1,2],repres:5,"char":5,exist:[5,3,1,6],file:[0,3,1,2],trip:3,probabl:1,camonitor:5,when:[5,0,1,3],detail:5,scrape:1,field:3,valid:[5,1],bool:5,test:[3,1],you:[1,2],bcdaext:[1,6],svn:1,anywher:1,propset:1,diskfre:[5,0,4,6],descript:[5,2],eol:1,ignor:1,time:[5,3,1],push:5,escap:1},objtypes:{"0":"py:module","1":"py:method","2":"py:class"},titles:["epicsdf project: documentation","Installation Instructions for Pilatus Detectors","Host computer support documentation","EPICS IOC support documentation","Source code documentation","<tt class=\"docutils literal\"><span class=\"pre\">epicsdf</span></tt>: EPICS diskfree, in python","Contents"],objnames:{"0":"Python module","1":"Python method","2":"Python class"},filenames:["index","installation","host/index","epics/index","src/index","src/epicsdf","contents"]})
     1Search.setIndex({objects:{"":{epicsdf:[5,0,1]},"epicsdf.epicsdf":{setPeriod:[5,1,1],run:[5,1,1],sendMail:[5,1,1],df:[5,1,1],demo:[5,1,1],getDisk:[5,1,1],wf2str:[5,1,1],df2epics:[5,1,1],onMessagePvChange:[5,1,1],isValidPeriod:[5,1,1],caput:[5,1,1],onPeriodPvChange:[5,1,1],caget:[5,1,1],logger:[5,1,1],onAlarmPvChange:[5,1,1],onDiskPvChange:[5,1,1],onEmailsPvChange:[5,1,1],doPeriodicUpdate:[5,1,1]},epicsdf:{epicsdf:[5,2,1]}},terms:{all:[5,3,1,2],code:[1,2,3,4,5,6],ioc15iddlax:1,inpa:3,inpb:3,epd_deploy:1,prefix:[5,3,1],follow:1,disk:[5,0,3,1,2],children:1,row:1,auto_set:1,ver:1,aug:1,send:[5,3,1,2],apsshar:1,program:1,those:0,under:1,esc:1,doperiodicupd:5,sent:3,sourc:[5,3,4,1,6],everi:[1,2],string:[5,3],email_list:[5,3],candid:5,caput:[5,3],level:1,gui:[1,6],cmd:1,list:[5,3,1],"try":1,item:[5,1],adjust:1,pvname:5,small:3,epd_root:1,df_demo:5,cron:[0,1,2],zero:[5,3],llsv:3,download:1,even:1,index:[5,6],what:1,xor:[1,6],nano:2,sum:1,current:1,version:1,"new":[5,3,1],method:5,full:1,behavior:3,gener:3,here:1,wfter:1,subvers:[1,6],address:[3,1],path:[3,1,2],sinc:[5,1],valu:[5,3,1],wait:5,box:3,search:6,sender:1,getdisk:5,step:1,boi:1,amount:0,real:1,implement:0,onmessagepvchang:5,extra:1,modul:[5,4,1,6],iocinit:1,unix:[5,0],"boolean":3,instal:[1,6],total:[5,3],select:1,from:[5,0,4,1,3],describ:1,would:0,memori:1,regist:1,prec:3,next:[5,1],few:1,flnk:3,call:[5,0,1],calc:3,type:[5,3,1,2],minor:3,more:1,sort:1,flaw:1,desir:3,warn:1,xorapp:1,accept:[5,1],examin:5,particular:0,hold:3,cach:5,starter:1,must:[5,1],none:5,word:5,past:2,work:[5,1],det:1,dev:5,cat:1,remain:3,can:[5,3,1],control:[0,1],give:5,process:[5,0,3,1,2],"15iddlaxapp":1,p100:1,indic:[5,0,6],high:3,dbloadrecord:1,liter:5,occur:1,end:1,goal:[3,6],secur:1,ascii:1,write:[0,1],how:1,forest:1,subdirectori:1,verifi:1,hihi:3,css:1,updat:[5,3],stop:[0,1,2],pilatu:[1,6],befor:1,attent:3,date:1,data:[0,1],npp:3,demonstr:[5,3],rhel5:1,ani:[0,3],obsolet:1,lost:1,egu:3,inform:[5,0,1],maintain:0,environ:2,allow:[5,3,1],enter:[1,2],tty:1,feedback:3,move:1,lsv:3,through:3,hierarchi:1,paramet:[5,3],pyepic:[5,1],style:1,group:1,monitor:[5,0],fit:1,pct:3,mail:[5,1],might:1,epics_host_arch:3,non:3,good:1,"return":5,greater:5,python:[0,1,2,4,5,6],sid:1,now:[3,1],nor:3,name:[5,3,1],trac:6,edit:[3,1,2],simpl:1,sevr:3,mode:1,each:[0,1],found:[3,1],calcout:[5,3],side:3,mean:[3,1],just:1,replac:5,individu:1,procedur:1,"15iddlax":1,connect:5,sion:1,our:[5,1],happen:5,orient:1,out:1,variabl:[5,0,3,1,2],"100k":1,space:[5,0,3,1,2],req:1,lolo:3,reboot:1,content:[0,4,1,6],onalarmpvchang:5,rel:1,print:1,gov:[5,1,6],after:5,sendmail:[5,1],situat:1,wf2str:5,free:[5,0,3],like:1,reason:1,base:3,dictionari:5,"byte":5,bash:2,softioc:3,thread:1,could:[5,3,1],keep:1,length:3,place:1,outsid:5,epics_bas:3,onto:0,localdomain:1,first:1,oper:[3,1],softwar:[3,1],major:3,directli:1,onc:5,arrai:5,misc:1,number:[0,3],mai:3,instruct:[1,6],done:1,messag:[5,3],ring:1,size:0,given:[5,1],script:[0,1,2],top:1,mkdir:1,system:[0,1],construct:5,grow:3,cumul:1,statement:1,termin:1,hhsv:3,includ:1,shell:[0,1,2],consol:0,option:1,wchan:1,tool:[0,1,3],copi:1,specifi:1,task:[0,1,2],necessarili:0,wide:1,conveni:[1,2],keyword:[5,1],whenev:3,second:5,charact:3,project:[0,3],str:5,macro:[3,1],minut:[1,2],browser:6,pre:5,sai:1,comput:[0,1,2,3,5,6],anl:[1,6],rh5:1,anywher:1,prj:[5,3,1],packag:[4,3,2],sax:1,have:[3,1],tabl:[0,6],need:[5,1,2],built:[3,1],someapp:1,callback:5,test_pyep:1,self:[5,1],srcurrentai:1,note:[5,3,1,2],also:[1,2],exampl:[3,1],build:6,which:[1,2],isvalidperiod:5,detector:[0,1,6],noth:1,singl:[0,1,3],sure:2,distribut:[1,6],deploy:1,previou:3,reach:0,react:0,most:2,larg:0,"class":[5,1],url:1,doc:6,alarm:[5,3,6],request:[3,1],doe:[5,3,1],ondiskpvchang:5,determin:5,show:1,text:[5,0,1],epicsdf:[0,1,2,3,4,5,6],cdt:1,session:1,threshold:0,find:1,help:1,absolut:1,onli:[5,1],locat:2,acquir:0,hopr:3,configur:[3,1],forev:[5,1],should:[5,1],"15id":1,dict:5,local:[5,1,2],info:[5,1],variou:3,get:5,watch:[5,0,3,1,2],nativ:1,drawn:4,report:[5,0,1,2],recalcul:3,restart:[0,1,2],app_base_dir:1,partit:[5,0,3,1,2],contain:1,where:[5,0,1],shm:5,respond:5,arr:5,set:[5,0,3,2],art:1,"float":5,see:[5,3],df2epic:5,result:5,fail:1,dectri:1,statu:1,enthought:[1,6],databas:[5,0,1,3,6],written:1,between:[5,3],"import":[5,1,2],email:[5,3,1,2],altern:5,kei:1,start_ioc:3,numer:1,screen:[3,1],job:[5,0,1,2],tue:1,addit:1,both:[1,2],against:1,instanc:5,context:1,improv:3,col:1,p300:[5,3,1],point:3,schedul:[0,1],period:[5,0,1,3],chmod:1,linux:1,cancel:1,assum:[0,1],hyst:3,quit:[1,2],devic:3,three:5,empti:3,trigger:[5,3],interest:0,imag:1,convert:5,argument:[5,1],logger:5,present:3,replic:5,look:1,defin:[5,3,1],calcul:[3,6],abov:2,error:1,synapps_5_4:1,caget:[5,1],libca:1,bin:[3,1],setperiod:5,suse:1,demo:5,them:5,revis:1,reprogram:3,sever:[5,1],develop:[5,3],author:1,suggest:1,make:[1,2],format:1,same:[3,1,2],check:[5,0,1,2],fragment:3,html:6,iocboot:1,document:[0,4,3,2,6],http:[1,6],x86:1,effect:1,user:[3,1],ioc:[5,0,1,3,6],typic:[0,3],appropri:1,off:5,entri:3,client:[0,1,3,4,5,6],command:[5,3,1,2],thi:[5,0,1,3],epd:1,usual:[3,1],identifi:2,execut:1,"true":1,boot:5,obtain:0,virtual:1,yet:1,makefil:2,except:1,newdisk:5,add:1,other:[5,1],adl:[3,1],save:[1,2],libcom:1,match:1,earli:3,around:1,mayb:1,five:2,know:1,background:[5,0],press:1,bit:1,opi:1,desc:3,insert:1,resid:[5,1],autosav:[3,1],specif:3,docutil:5,onemailspvchang:5,negat:1,either:3,output:[0,1,2],signal:[3,1],www:6,manual:1,some:[5,3,1,2],back:1,percentag:3,intern:5,home:1,successfulli:3,tmp:[5,1],deselect:1,medm:[3,1,6],waveform:[5,3],leav:1,unit:5,condit:3,epic:[0,1,2,3,4,5,6],leader:1,preload:1,database_prefix:1,iocnam:1,run:[5,0,3,1,2],usag:5,host:[5,0,1,2,6],usax:1,hsv:3,src:[5,1],page:[1,6],onperiodpvchang:5,constructor:5,discard:1,luck:1,editor:[1,2],checkup:[1,2],routin:[5,3],consid:1,numpi:5,within:[5,1],been:[0,1,3],ensur:[0,1],chang:[5,3,1],hysteresi:3,storag:1,your:1,span:5,log:[5,0,1,2],area:0,support:[0,1,2,3,5,6],"long":1,avail:[5,0,1,3],start:[0,3,1,2],handler:5,interfac:3,low:[3,1,2],forward:3,ppid:1,"function":5,head:1,properli:1,forc:[5,3],link:[0,3,6],crontab:[1,2],jemian:5,line:[3,1,2],command_lin:1,reset:3,notat:1,made:3,consist:[4,3,2],possibl:5,"default":[5,3,1],displai:5,record:[5,3,2],below:3,limit:0,problem:1,uid:1,creat:[3,1],"int":5,certain:3,dure:[5,1],pid:[0,1,2],repres:5,"char":5,exist:[5,3,1,6],file:[0,3,1,2],trip:3,probabl:1,camonitor:5,when:[5,0,1,3],detail:5,scrape:1,field:3,valid:[5,1],bool:5,test:[3,1],you:[1,2],ndarrai:5,bcdaext:[1,6],svn:1,directori:[1,2],propset:1,diskfre:[5,0,4,6],descript:[5,2],eol:1,ignor:1,time:[5,3,1],push:5,escap:1},objtypes:{"0":"py:module","1":"py:method","2":"py:class"},titles:["epicsdf project: documentation","Installation Instructions for Pilatus Detectors","Host computer support documentation","EPICS IOC support documentation","Source code documentation","<tt class=\"docutils literal\"><span class=\"pre\">epicsdf</span></tt>: EPICS diskfree, in python","Contents"],objnames:{"0":"Python module","1":"Python method","2":"Python class"},filenames:["index","installation","host/index","epics/index","src/index","src/epicsdf","contents"]})

  • TabularUnified epicsdf/doc/build/html/src/epicsdf.html

    r597 r603  
    223223<tr><td>%free</td>
    224224<td>%</td>
    225 <td><ol class="first last arabic simple" start="100">
    226 <li><ul class="first">
    227 <li>free / total</li>
    228 </ul>
    229 </li>
    230 </ol>
    231 </td>
     225<td><img src="../_images\mathmpl/math-e604e1119d.png" style="position: relative; bottom: -8px"/></td>
    232226</tr>
    233227<tr><td>%avail</td>
    234228<td>%</td>
    235 <td><ol class="first last arabic simple" start="100">
    236 <li><ul class="first">
    237 <li>avail / total</li>
    238 </ul>
    239 </li>
    240 </ol>
    241 </td>
     229<td><img src="../_images\mathmpl/math-6e9acb7536.png" style="position: relative; bottom: -8px"/></td>
    242230</tr>
    243231<tr><td>%used</td>
    244232<td>%</td>
    245 <td><ol class="first last arabic simple" start="100">
    246 <li><ul class="first">
    247 <li>%avail</li>
    248 </ul>
    249 </li>
    250 </ol>
    251 </td>
     233<td><img src="../_images\mathmpl/math-a2c104dbc9.png" style="position: relative; bottom: -4px"/></td>
    252234</tr>
    253235</tbody>
    … …  
    264246<col class="field-body" />
    265247<tbody valign="top">
    266 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">dictionary with df information or None</td>
     248<tr class="field"><th class="field-name">Returns:</th><td class="field-body">dictionary from <a class="reference internal" href="#epicsdf.epicsdf.df" title="epicsdf.epicsdf.df"><tt class="xref py py-meth docutils literal"><span class="pre">df()</span></tt></a> or None</td>
    267249</tr>
    268250<tr class="field"><th class="field-name">Return type:</th><td class="field-body">dict</td>
    … …  
    276258<tt class="descname">doPeriodicUpdate</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/epicsdf.html#epicsdf.doPeriodicUpdate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#epicsdf.epicsdf.doPeriodicUpdate" title="Permalink to this definition">¶</a></dt>
    277259<dd><p>Do the work of the periodic update,
    278 getting the results of df(partition)
     260getting the results of <a class="reference internal" href="#epicsdf.epicsdf.df" title="epicsdf.epicsdf.df"><tt class="xref py py-meth docutils literal"><span class="pre">df()</span></tt></a>
     261(with <tt class="docutils literal"><span class="pre">self.disk</span></tt> as the argument)
    279262and pushing the values up to the EPICS PVs.
    280263Then, set the time of the next update.</p>
    … …  
    463446<dt id="epicsdf.epicsdf.setPeriod">
    464447<tt class="descname">setPeriod</tt><big>(</big><em>value=10.0</em><big>)</big><a class="reference internal" href="../_modules/epicsdf.html#epicsdf.setPeriod"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#epicsdf.epicsdf.setPeriod" title="Permalink to this definition">¶</a></dt>
    465 <dd><p>define the waiting period between updates, s</p>
     448<dd><p>define the waiting period between updates (units = seconds)</p>
    466449<table class="docutils field-list" frame="void" rules="none">
    467450<col class="field-name" />
    … …  
    484467<col class="field-body" />
    485468<tbody valign="top">
    486 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>arr</strong> (<em>numpy array</em>) &#8211; array of char from waveform record</td>
     469<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>arr</strong> (<em>numpy.ndarray</em>) &#8211; NumPy array of char from EPICS waveform record</td>
    487470</tr>
    488471<tr class="field"><th class="field-name">Returns:</th><td class="field-body">string as represented by arr</td>

  • TabularUnified epicsdf/src/epicsdf.py

    r591 r603  
    113113        EPICS waveform record to a python string
    114114       
    115         :param arr: array of char from waveform record
    116         :type arr: numpy array
     115        :param arr: NumPy array of char from EPICS waveform record
     116        :type arr: numpy.ndarray
    117117        :return: string as represented by arr
    118118        :rtype: str
    … …  
    120120        string = ""
    121121        for item in arr:
     122          # TODO: this check must be better before code is used
     123          #if type(item) != type(0):
     124          #  raise TypeError("waveform must be of CHAR type")
    122125          if item == 0: break
    123126          string += "%c" % item
    … …  
    134137    def setPeriod(self, value = 10.0):
    135138        '''
    136         define the waiting period between updates, s
     139        define the waiting period between updates (units = seconds)
    137140
    138141        :param value: candidate value of period (default = 10.0),
    … …  
    161164        avail        bytes    available space
    162165        used         bytes    total - avail
    163         %free        %        100. * free / total
    164         %avail       %        100. * avail / total
    165         %used        %        100. - %avail
     166        %free        %        :math:`100. * free / total`
     167        %avail       %        :math:`100. * avail / total`
     168        %used        %        :math:`100. - {\%}avail`
    166169        ============ =======  ===============================
    167170        '''
    … …  
    232235        Get the partition name from the EPICS database.
    233236
    234         :return: dictionary with df information or None
     237        :return: dictionary from :meth:`df` or None
    235238        :rtype: dict
    236239        '''
    … …  
    288291        '''
    289292        Do the work of the periodic update,
    290         getting the results of df(partition)
     293        getting the results of :meth:`df`
     294        (with ``self.disk`` as the argument)
    291295        and pushing the values up to the EPICS PVs.
    292296        Then, set the time of the next update.
Note: See TracChangeset for help on using the changeset viewer.