|
+ - isReadable() (deviceaccess.GeneralRegisterAccessor method)
+
- isReadOnly() (deviceaccess.GeneralRegisterAccessor method)
- isWriteable() (deviceaccess.GeneralRegisterAccessor method)
diff --git a/ChimeraTK-DeviceAccess-PythonBindings/head/html/objects.inv b/ChimeraTK-DeviceAccess-PythonBindings/head/html/objects.inv
index 186fa97af72..17fdc4eddbb 100644
Binary files a/ChimeraTK-DeviceAccess-PythonBindings/head/html/objects.inv and b/ChimeraTK-DeviceAccess-PythonBindings/head/html/objects.inv differ
diff --git a/ChimeraTK-DeviceAccess-PythonBindings/head/html/searchindex.js b/ChimeraTK-DeviceAccess-PythonBindings/head/html/searchindex.js
index 14f4cf0f328..48e40e76982 100644
--- a/ChimeraTK-DeviceAccess-PythonBindings/head/html/searchindex.js
+++ b/ChimeraTK-DeviceAccess-PythonBindings/head/html/searchindex.js
@@ -1 +1 @@
-Search.setIndex({docnames:["deviceaccess","index","mtca4u"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,"sphinx.ext.todo":1,"sphinx.ext.viewcode":1,sphinx:55},filenames:["deviceaccess.rst","index.rst","mtca4u.rst"],objects:{"":{deviceaccess:[0,0,0,"-"],mtca4u:[2,0,0,"-"]},"deviceaccess.Device":{activateAsyncRead:[0,2,1,""],close:[0,2,1,""],getCatalogueMetadata:[0,2,1,""],getOneDRegisterAccessor:[0,2,1,""],getRegisterCatalogue:[0,2,1,""],getScalarRegisterAccessor:[0,2,1,""],getTwoDRegisterAccessor:[0,2,1,""],getVoidRegisterAccessor:[0,2,1,""],open:[0,2,1,""],read:[0,2,1,""],write:[0,2,1,""]},"deviceaccess.GeneralRegisterAccessor":{dataValidity:[0,2,1,""],getAccessModeFlags:[0,2,1,""],getDescription:[0,2,1,""],getId:[0,2,1,""],getName:[0,2,1,""],getUnit:[0,2,1,""],getValueType:[0,2,1,""],getVersionNumber:[0,2,1,""],isInitialised:[0,2,1,""],isReadOnly:[0,2,1,""],isReadable:[0,2,1,""],isWriteable:[0,2,1,""],read:[0,2,1,""],readLatest:[0,2,1,""],readNonBlocking:[0,2,1,""],setDataValidity:[0,2,1,""],write:[0,2,1,""],writeDestructively:[0,2,1,""]},"deviceaccess.NumpyGeneralRegisterAccessor":{read:[0,2,1,""],readLatest:[0,2,1,""],readNonBlocking:[0,2,1,""],set:[0,2,1,""],write:[0,2,1,""],writeDestructively:[0,2,1,""]},"deviceaccess.OneDRegisterAccessor":{getNElements:[0,2,1,""]},"deviceaccess.ScalarRegisterAccessor":{readAndGet:[0,2,1,""],setAndWrite:[0,2,1,""],writeIfDifferent:[0,2,1,""]},"deviceaccess.TwoDRegisterAccessor":{getNChannels:[0,2,1,""],getNElementsPerChannel:[0,2,1,""]},"deviceaccess.VoidRegisterAccessor":{read:[0,2,1,""],readLatest:[0,2,1,""],readNonBlocking:[0,2,1,""],write:[0,2,1,""],writeDestructively:[0,2,1,""]},"mtca4u.Device":{getCatalogueMetadata:[2,2,1,""],read:[2,2,1,""],read_dma_raw:[2,2,1,""],read_raw:[2,2,1,""],read_sequences:[2,2,1,""],write:[2,2,1,""],write_raw:[2,2,1,""]},deviceaccess:{Device:[0,1,1,""],GeneralRegisterAccessor:[0,1,1,""],NumpyGeneralRegisterAccessor:[0,1,1,""],OneDRegisterAccessor:[0,1,1,""],ScalarRegisterAccessor:[0,1,1,""],TwoDRegisterAccessor:[0,1,1,""],VoidRegisterAccessor:[0,1,1,""],getDMapFilePath:[0,3,1,""],setDMapFilePath:[0,3,1,""]},mtca4u:{Device:[2,1,1,""],get_dmap_location:[2,3,1,""],get_info:[2,3,1,""],set_dmap_location:[2,3,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:function"},terms:{"0x7f5298a8f400":0,"0x7f52b5f8a740":0,"0x7f862f7e2520":0,"0x7f862fbc7fa0":0,"0x7f8630c94730":0,"0x7f8630c94d00":0,"0x7f8630cc65b0":0,"2darrayofvalu":2,"abstract":0,"boolean":0,"case":0,"class":[0,2],"default":[0,2],"float":[0,2],"function":0,"import":[0,2],"int":[0,2],"long":[0,2],"new":[0,2],"return":[0,2],"short":0,"super":0,"throw":0,"true":[0,2],"try":0,"void":0,"while":0,One:0,The:[0,2],There:0,Use:2,Will:0,_da_python_bind:0,_datatowrit:2,_io:2,_mockobject:0,abc:0,about:2,abov:0,absolut:0,acc:0,access:0,accessmod:0,accessmodeflag:0,accessor:0,action:0,activ:0,activateasyncread:0,actual:0,adc0_valu:2,adc1_valu:2,adc3_valu:2,adc:0,after:0,again:2,against:2,alia:[0,2],aliasnam:0,all:[0,2],allow:0,alreadi:0,also:[0,2],alwai:0,ani:0,appli:2,applic:[0,2],arbitari:2,area:2,area_dma_via_dma:2,area_multiplexed_sequence_dma:2,arg:2,argument:0,arr1to10:0,arrai:[0,2],arrayofrawvalu:2,arriv:0,associ:0,assum:2,asynchron:0,attribut:0,autodoc:0,avail:[0,2],avoid:0,awar:2,backend:[0,2],base:[0,2],been:0,befor:0,begin:0,behaviour:0,belong:2,below:0,between:0,binari:2,bit:[0,2],block:[0,2],board:[0,2],boardwithmodul:2,bool:0,both:2,buffer:0,call:0,can:[0,2],card:2,card_with_modul:0,catalogu:[0,2],chang:0,channel:0,check:[0,2],chimeratk:[0,2],client:0,close:0,code:0,column:2,combin:0,come:2,commenc:2,common:0,compat:0,complet:0,concern:0,connect:0,construct:[0,2],constructor:[0,2],contain:[0,2],content:[0,1],contentthat:0,control:0,conveni:0,convent:0,convers:[0,2],convert:[0,2],copi:[0,2],correspond:2,coulum:2,creat:[0,2],creation:0,current:[0,2],data:[0,2],datatowrit:[0,2],datatyp:2,datavalid:0,dda:0,deactiv:0,deciv:2,defin:[0,2],demultiplex:2,depend:[0,2],deprec:2,descript:0,desir:2,destroi:0,detail:[0,2],dev:0,devic:[0,2],device_nam:2,deviceaccess:[1,2],deviceaccess_vers:2,deviceexcept:0,deviceinform:0,differ:0,dimension:[0,2],direct:2,directori:0,discard:0,dma:[0,2],dmap:[0,2],dmap_path:0,dmapfileloc:2,dmapfilepath:0,dmappath:2,dmaregisternam:2,document:0,doe:0,doubl:[0,2],dtype:[0,2],due:0,dummy_interrupt_2:0,duplic:0,dure:0,each:[0,2],effect:0,either:2,element:[0,2],elementindexinregist:[0,2],elementsoffset:0,elementsperchannel:0,elemnt:2,empti:2,enabl:0,encod:2,engin:0,equal:2,error:0,even:0,everi:[0,2],exampl:[0,2],examplecr:0,exce:[0,2],except:0,exist:0,expect:[0,2],ext:0,extract:2,fals:0,faulti:0,fetch:2,file:[0,2],first:[0,2],fit:2,fix:[0,2],flag:0,float32:[0,2],float64:[0,2],form:2,found:0,fraction:2,framework:0,free:0,from:[0,2],generalregisteraccessor:0,get:[0,2],get_dmap_loc:2,get_info:2,getaccessmodeflag:0,getcataloguemetadata:[0,2],getdescript:0,getdmapfilepath:0,getid:0,getnam:0,getnchannel:0,getnel:0,getnelementsperchannel:0,getonedregisteraccessor:0,getregistercatalogu:0,getscalarregisteraccessor:0,gettwodregisteraccessor:0,getunit:0,getvaluetyp:0,getversionnumb:0,getvoidregisteraccessor:0,github:0,give:0,given:[0,2],guarante:0,handl:0,happen:0,hardwar:[0,2],has:[0,2],have:[0,2],henc:0,hold:2,ident:0,identifi:0,ignor:[0,2],immedi:0,implement:0,includ:[0,2],index:[0,1,2],indic:0,individu:2,induvidu:2,ineffici:0,inform:[0,2],inherit:0,initi:0,input:[0,2],instanc:0,instead:2,int16:0,int32:[0,2],int64:0,int8:0,integ:0,intend:2,interest:0,interfac:0,intern:[0,2],interrupt:0,interruptacc:0,isinitialis:0,isread:0,isreadonli:0,iswrit:0,its:[0,2],just:0,kept:0,last:[0,2],latest:0,lead:0,left:0,length:2,librari:[0,2],lifetim:2,like:0,link:2,list:[0,2],locat:[0,2],lock:0,look:[0,2],lookup:[0,2],lost:0,made:2,mai:2,make:2,map:[0,2],mapfil:2,mapfile_revis:0,mapp:0,match:0,mathemat:0,matrix:2,maximm:0,mean:0,memori:2,metadata:[0,2],metadatavalu:2,metatag:0,method:[0,2],might:0,minu:0,mismatch:0,mode:[0,2],modul:1,module1:[0,2],modulenam:2,more:0,mtca4upi:2,multiplex:2,must:0,my_card:2,my_example_dmap_fil:2,name:[0,2],ndarrai:0,need:0,never:0,newvalu:0,next:0,non:0,none:[0,2],not_impl:0,now:0,number:[0,2],numberofchannel:0,numberofel:0,numberofelementstoread:2,numberofword:0,numericaddressedbackend:2,numpi:[0,2],numpygeneralregisteraccessor:0,object:[0,2],obtain:[0,2],offer:0,offset:[0,2],old:0,omit:0,ommit:2,onc:2,oneacc:0,onedregisteraccessor:0,onli:[0,2],open:[0,2],oper:0,operand:0,option:[0,2],origin:0,originacc:0,other:0,otheracc:0,otherwis:0,out:[0,2],outputstream:2,over:2,overflow:0,page:1,paramet:[0,2],parameternam:2,pars:0,part:2,pass:0,passes:2,path:[0,2],per:0,persist:0,placehold:0,pleas:0,point:[0,2],pointer:0,posit:[0,2],possibl:0,preced:2,present:0,previous:0,print:[0,2],process:0,processarrai:0,program:2,project:0,properli:0,provid:[0,2],purpos:2,push:0,put:2,python:0,queri:2,quickli:0,rais:0,rang:0,raw:[0,2],read:[0,2],read__raw:2,read_dma_raw:2,read_raw:2,read_sequ:2,readabl:0,readacc:0,readandget:0,readinrawvalu:2,readlatest:0,readnonblock:0,readonli:0,readoutvalu:2,receiv:0,refer:0,reg_valu:0,region:[0,2],regionnam:2,regist:[0,2],registernam:2,registerpath:[0,2],registerpathnam:0,reject:0,rel:0,repres:2,represent:[0,2],representaion:2,requir:0,resp:0,respect:0,restrict:0,result:0,resultacc:0,right:0,same:[0,2],sampl:0,scalar:0,scalarregisteraccessor:0,scalarregisterobject:0,search:1,second:0,see:0,select:[0,2],send:0,sequenc:[0,2],set:[0,2],set_dmap_loc:2,setandwrit:0,setdatavalid:0,setdmapfilepath:0,shallow:0,shape:0,share:0,shared_raw_devic:0,should:[0,2],sign:0,simimlar:0,sinc:[0,2],singl:2,size:[0,2],slice:0,slicedacc:0,sourc:[0,2],specifi:[0,2],sphinx:0,start:[0,2],statement:0,statu:0,stdout:2,still:0,storag:0,str:[0,2],string:[0,2],suppli:0,support:0,sys:2,system:0,tag:0,take:[0,2],test_area:0,test_area_push:0,textiowrapp:2,thei:0,thi:[0,2],though:0,through:2,time:0,touch:0,transfer:0,transferel:0,transferelementid:0,transpar:0,trigger:0,two:0,twodregisteraccessor:0,type:[0,2],uint16:0,uint32:0,uint64:0,uint8:0,unbuff:0,undefin:0,understood:0,union:0,uniqu:0,unit:0,unsign:0,until:[0,2],updat:0,uppercas:0,upto:[0,2],usag:0,use:2,used:[0,2],user:[0,2],usertyp:0,uses:[0,2],using:[0,2],usual:0,utf:2,v02:2,valid:0,valu:[0,2],variabl:0,vaue:2,vector:0,veri:0,version:0,versionmnumb:0,versionnumb:0,view:2,voidregisteraccessor:0,wai:2,wait:0,wait_for_new_data:0,well:[0,2],were:0,when:[0,2],where:0,whether:0,which:[0,2],whole:2,width:[0,2],within:2,without:[0,2],word_clk_cnt:0,word_clk_cnt_1:0,word_clk_mux:[0,2],word_statu:[0,2],wordoffsetinregist:0,would:[0,2],write:[0,2],write_raw:2,writeabl:0,writeacc:0,writeaccreg:0,writedestruct:0,writeifdiffer:0,written:[0,2],you:0,zero:[0,2]},titles:["deviceaccess module","mtca4u Python Bindings Doucmentation","mtca4u module"],titleterms:{bind:1,deviceaccess:0,doucment:1,indic:1,modul:[0,2],mtca4u:[1,2],python:1,tabl:1}})
\ No newline at end of file
+Search.setIndex({docnames:["deviceaccess","index","mtca4u"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,"sphinx.ext.todo":1,"sphinx.ext.viewcode":1,sphinx:55},filenames:["deviceaccess.rst","index.rst","mtca4u.rst"],objects:{"":{deviceaccess:[0,0,0,"-"],mtca4u:[2,0,0,"-"]},"deviceaccess.Device":{activateAsyncRead:[0,2,1,""],close:[0,2,1,""],getCatalogueMetadata:[0,2,1,""],getOneDRegisterAccessor:[0,2,1,""],getRegisterCatalogue:[0,2,1,""],getScalarRegisterAccessor:[0,2,1,""],getTwoDRegisterAccessor:[0,2,1,""],getVoidRegisterAccessor:[0,2,1,""],open:[0,2,1,""],read:[0,2,1,""],write:[0,2,1,""]},"deviceaccess.GeneralRegisterAccessor":{dataValidity:[0,2,1,""],getAccessModeFlags:[0,2,1,""],getDescription:[0,2,1,""],getId:[0,2,1,""],getName:[0,2,1,""],getUnit:[0,2,1,""],getValueType:[0,2,1,""],getVersionNumber:[0,2,1,""],interrupt:[0,2,1,""],isInitialised:[0,2,1,""],isReadOnly:[0,2,1,""],isReadable:[0,2,1,""],isWriteable:[0,2,1,""],read:[0,2,1,""],readLatest:[0,2,1,""],readNonBlocking:[0,2,1,""],setDataValidity:[0,2,1,""],write:[0,2,1,""],writeDestructively:[0,2,1,""]},"deviceaccess.NumpyGeneralRegisterAccessor":{read:[0,2,1,""],readLatest:[0,2,1,""],readNonBlocking:[0,2,1,""],set:[0,2,1,""],write:[0,2,1,""],writeDestructively:[0,2,1,""]},"deviceaccess.OneDRegisterAccessor":{getNElements:[0,2,1,""]},"deviceaccess.ScalarRegisterAccessor":{readAndGet:[0,2,1,""],setAndWrite:[0,2,1,""],writeIfDifferent:[0,2,1,""]},"deviceaccess.TwoDRegisterAccessor":{getNChannels:[0,2,1,""],getNElementsPerChannel:[0,2,1,""]},"deviceaccess.VoidRegisterAccessor":{read:[0,2,1,""],readLatest:[0,2,1,""],readNonBlocking:[0,2,1,""],write:[0,2,1,""],writeDestructively:[0,2,1,""]},"mtca4u.Device":{getCatalogueMetadata:[2,2,1,""],read:[2,2,1,""],read_dma_raw:[2,2,1,""],read_raw:[2,2,1,""],read_sequences:[2,2,1,""],write:[2,2,1,""],write_raw:[2,2,1,""]},deviceaccess:{Device:[0,1,1,""],GeneralRegisterAccessor:[0,1,1,""],NumpyGeneralRegisterAccessor:[0,1,1,""],OneDRegisterAccessor:[0,1,1,""],ScalarRegisterAccessor:[0,1,1,""],TwoDRegisterAccessor:[0,1,1,""],VoidRegisterAccessor:[0,1,1,""],getDMapFilePath:[0,3,1,""],setDMapFilePath:[0,3,1,""]},mtca4u:{Device:[2,1,1,""],get_dmap_location:[2,3,1,""],get_info:[2,3,1,""],set_dmap_location:[2,3,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:function"},terms:{"0x7efe595f2580":0,"0x7efe599ddf10":0,"0x7efe5aa9a730":0,"0x7efe5aa9ad00":0,"0x7efe5aad4610":0,"0x7f5298a8f400":0,"0x7f52b5f8a740":0,"2darrayofvalu":2,"abstract":0,"boolean":0,"case":0,"class":[0,2],"default":[0,2],"float":[0,2],"function":0,"import":[0,2],"int":[0,2],"long":[0,2],"new":[0,2],"return":[0,2],"short":0,"super":0,"throw":0,"true":[0,2],"try":0,"void":0,"while":0,One:0,The:[0,2],There:0,Use:2,Will:0,_da_python_bind:0,_datatowrit:2,_io:2,_mockobject:0,abc:0,about:2,abov:0,absolut:0,acc:0,access:0,accessmod:0,accessmodeflag:0,accessor:0,action:0,activ:0,activateasyncread:0,actual:0,adc0_valu:2,adc1_valu:2,adc3_valu:2,adc:0,after:0,again:2,against:2,alia:[0,2],aliasnam:0,all:[0,2],allow:0,alreadi:0,also:[0,2],alwai:0,ani:0,appli:2,applic:[0,2],arbitari:2,area:2,area_dma_via_dma:2,area_multiplexed_sequence_dma:2,arg:2,argument:0,arr1to10:0,arrai:[0,2],arrayofrawvalu:2,arriv:0,associ:0,assum:2,asynchron:0,attribut:0,autodoc:0,avail:[0,2],avoid:0,awar:2,backend:[0,2],base:[0,2],been:0,befor:0,begin:0,behaviour:0,belong:2,below:0,between:0,binari:2,bit:[0,2],block:[0,2],board:[0,2],boardwithmodul:2,bool:0,both:2,buffer:0,call:0,can:[0,2],card:2,card_with_modul:0,catalogu:[0,2],chang:0,channel:0,check:[0,2],chimeratk:[0,2],client:0,close:0,code:0,column:2,combin:0,come:2,commenc:2,common:0,compat:0,complet:0,concern:0,connect:0,construct:[0,2],constructor:[0,2],contain:[0,2],content:[0,1],contentthat:0,control:0,conveni:0,convent:0,convers:[0,2],convert:[0,2],copi:[0,2],correspond:2,coulum:2,creat:[0,2],creation:0,current:[0,2],data:[0,2],datatowrit:[0,2],datatyp:2,datavalid:0,dda:0,deactiv:0,deciv:2,defin:[0,2],demultiplex:2,depend:[0,2],deprec:2,descript:0,desir:2,destroi:0,detail:[0,2],dev:0,devic:[0,2],device_nam:2,deviceaccess:[1,2],deviceaccess_vers:2,deviceexcept:0,deviceinform:0,differ:0,dimension:[0,2],direct:2,directori:0,discard:0,dma:[0,2],dmap:[0,2],dmap_path:0,dmapfileloc:2,dmapfilepath:0,dmappath:2,dmaregisternam:2,document:0,doe:0,doubl:[0,2],dtype:[0,2],due:0,dummy_interrupt_2:0,duplic:0,dure:0,each:[0,2],effect:0,either:2,element:[0,2],elementindexinregist:[0,2],elementsoffset:0,elementsperchannel:0,elemnt:2,empti:2,enabl:0,encod:2,engin:0,equal:2,error:0,even:0,everi:[0,2],exampl:[0,2],examplecr:0,exce:[0,2],except:0,exist:0,expect:[0,2],ext:0,extract:2,fals:0,faulti:0,fetch:2,file:[0,2],first:[0,2],fit:2,fix:[0,2],flag:0,float32:[0,2],float64:[0,2],form:2,found:0,fraction:2,framework:0,free:0,from:[0,2],generalregisteraccessor:0,get:[0,2],get_dmap_loc:2,get_info:2,getaccessmodeflag:0,getcataloguemetadata:[0,2],getdescript:0,getdmapfilepath:0,getid:0,getnam:0,getnchannel:0,getnel:0,getnelementsperchannel:0,getonedregisteraccessor:0,getregistercatalogu:0,getscalarregisteraccessor:0,gettwodregisteraccessor:0,getunit:0,getvaluetyp:0,getversionnumb:0,getvoidregisteraccessor:0,github:0,give:0,given:[0,2],guarante:0,handl:0,happen:0,hardwar:[0,2],has:[0,2],have:[0,2],henc:0,hold:2,ident:0,identifi:0,ignor:[0,2],immedi:0,implement:0,includ:[0,2],index:[0,1,2],indic:0,individu:2,induvidu:2,ineffici:0,inform:[0,2],inherit:0,initi:0,input:[0,2],instanc:0,instead:2,int16:0,int32:[0,2],int64:0,int8:0,integ:0,intend:2,interest:0,interfac:0,intern:[0,2],interrupt:0,interruptacc:0,isinitialis:0,isread:0,isreadonli:0,iswrit:0,its:[0,2],just:0,kept:0,last:[0,2],latest:0,lead:0,left:0,length:2,librari:[0,2],lifetim:2,like:0,link:2,list:[0,2],locat:[0,2],lock:0,look:[0,2],lookup:[0,2],lost:0,made:2,mai:[0,2],make:2,map:[0,2],mapfil:2,mapfile_revis:0,mapp:0,match:0,mathemat:0,matrix:2,maximm:0,mean:0,memori:2,metadata:[0,2],metadatavalu:2,metatag:0,method:[0,2],might:0,minu:0,mismatch:0,mode:[0,2],modul:1,module1:[0,2],modulenam:2,more:0,mtca4upi:2,multiplex:2,must:0,my_card:2,my_example_dmap_fil:2,name:[0,2],ndarrai:0,need:0,never:0,newvalu:0,next:0,non:0,none:[0,2],not_impl:0,now:0,number:[0,2],numberofchannel:0,numberofel:0,numberofelementstoread:2,numberofword:0,numericaddressedbackend:2,numpi:[0,2],numpygeneralregisteraccessor:0,object:[0,2],obtain:[0,2],offer:0,offset:[0,2],old:0,omit:0,ommit:2,onc:2,oneacc:0,onedregisteraccessor:0,onli:[0,2],open:[0,2],oper:0,operand:0,option:[0,2],origin:0,originacc:0,other:0,otheracc:0,otherwis:0,out:[0,2],outputstream:2,over:2,overflow:0,page:1,paramet:[0,2],parameternam:2,pars:0,part:2,pass:0,passes:2,path:[0,2],per:0,persist:0,place:0,placehold:0,pleas:0,point:[0,2],pointer:0,posit:[0,2],possibl:0,preced:2,present:0,previous:0,print:[0,2],process:0,processarrai:0,program:2,project:0,properli:0,provid:[0,2],purpos:2,push:0,put:2,python:0,queri:2,queue:0,quickli:0,rais:0,rang:0,raw:[0,2],read:[0,2],read__raw:2,read_dma_raw:2,read_raw:2,read_sequ:2,readabl:0,readacc:0,readandget:0,readinrawvalu:2,readlatest:0,readnonblock:0,readonli:0,readoutvalu:2,receiv:0,refer:0,reg_valu:0,region:[0,2],regionnam:2,regist:[0,2],registernam:2,registerpath:[0,2],registerpathnam:0,reject:0,rel:0,repres:2,represent:[0,2],representaion:2,requir:0,resp:0,respect:0,restrict:0,result:0,resultacc:0,right:0,same:[0,2],sampl:0,scalar:0,scalarregisteraccessor:0,scalarregisterobject:0,search:1,second:0,see:0,select:[0,2],send:0,sequenc:[0,2],set:[0,2],set_dmap_loc:2,setandwrit:0,setdatavalid:0,setdmapfilepath:0,shallow:0,shape:0,share:0,shared_raw_devic:0,should:[0,2],sign:0,simimlar:0,sinc:[0,2],singl:2,size:[0,2],slice:0,slicedacc:0,sourc:[0,2],specifi:[0,2],sphinx:0,start:[0,2],statement:0,statu:0,stdout:2,still:0,storag:0,str:[0,2],string:[0,2],suppli:0,support:0,sys:2,system:0,tag:0,take:[0,2],termin:0,test_area:0,test_area_push:0,textiowrapp:2,thei:0,thi:[0,2],though:0,thread:0,through:2,time:0,touch:0,transfer:0,transferel:0,transferelementid:0,transpar:0,trigger:0,two:0,twodregisteraccessor:0,type:[0,2],uint16:0,uint32:0,uint64:0,uint8:0,unbuff:0,undefin:0,understood:0,union:0,uniqu:0,unit:0,unsign:0,until:[0,2],updat:0,uppercas:0,upto:[0,2],usag:0,use:2,used:[0,2],user:[0,2],usertyp:0,uses:[0,2],using:[0,2],usual:0,utf:2,v02:2,valid:0,valu:[0,2],variabl:0,vaue:2,vector:0,veri:0,version:0,versionmnumb:0,versionnumb:0,view:2,voidregisteraccessor:0,wai:2,wait:0,wait_for_new_data:0,well:[0,2],were:0,when:[0,2],where:0,whether:0,which:[0,2],whole:2,width:[0,2],within:2,without:[0,2],word_clk_cnt:0,word_clk_cnt_1:0,word_clk_mux:[0,2],word_statu:[0,2],wordoffsetinregist:0,would:[0,2],write:[0,2],write_raw:2,writeabl:0,writeacc:0,writeaccreg:0,writedestruct:0,writeifdiffer:0,written:[0,2],you:0,zero:[0,2]},titles:["deviceaccess module","mtca4u Python Bindings Doucmentation","mtca4u module"],titleterms:{bind:1,deviceaccess:0,doucment:1,indic:1,modul:[0,2],mtca4u:[1,2],python:1,tabl:1}})
\ No newline at end of file
diff --git a/ChimeraTK-DeviceAccess-PythonBindings/tag/.git-describe b/ChimeraTK-DeviceAccess-PythonBindings/tag/.git-describe
index b9a1a86a2df..9a290b60b5a 100644
--- a/ChimeraTK-DeviceAccess-PythonBindings/tag/.git-describe
+++ b/ChimeraTK-DeviceAccess-PythonBindings/tag/.git-describe
@@ -1 +1 @@
-03.04.00-8-g6a512e2
+03.04.00-10-g56c12f0
diff --git a/ChimeraTK-DeviceAccess-PythonBindings/tag/html/.doctrees/deviceaccess.doctree b/ChimeraTK-DeviceAccess-PythonBindings/tag/html/.doctrees/deviceaccess.doctree
index 62f466c9a96..47042adb5cd 100644
Binary files a/ChimeraTK-DeviceAccess-PythonBindings/tag/html/.doctrees/deviceaccess.doctree and b/ChimeraTK-DeviceAccess-PythonBindings/tag/html/.doctrees/deviceaccess.doctree differ
diff --git a/ChimeraTK-DeviceAccess-PythonBindings/tag/html/.doctrees/environment.pickle b/ChimeraTK-DeviceAccess-PythonBindings/tag/html/.doctrees/environment.pickle
index 68363ed9ffa..613413a2be8 100644
Binary files a/ChimeraTK-DeviceAccess-PythonBindings/tag/html/.doctrees/environment.pickle and b/ChimeraTK-DeviceAccess-PythonBindings/tag/html/.doctrees/environment.pickle differ
diff --git a/ChimeraTK-DeviceAccess-PythonBindings/tag/html/_modules/deviceaccess.html b/ChimeraTK-DeviceAccess-PythonBindings/tag/html/_modules/deviceaccess.html
index a4ea24349d3..45c0bbbf0a9 100644
--- a/ChimeraTK-DeviceAccess-PythonBindings/tag/html/_modules/deviceaccess.html
+++ b/ChimeraTK-DeviceAccess-PythonBindings/tag/html/_modules/deviceaccess.html
@@ -497,7 +497,15 @@
Source code for deviceaccess
<_da_python_bindings.TransferElementID at 0x7f5298a8f400>
"""
- return self._accessor.getId()
+ return self._accessor.getId()
+
+[docs] def interrupt(self) -> None:
+ """
+ Place a thread interrupted exception on the read queue of this accessor,
+ so the thread currently waiting in a blocking read() will terminate. May
+ only be called for accessors with AccessMode.wait_for_new_data.
+ """
+ self._accessor.interrupt()
#######################################################################################################################
#######################################################################################################################
diff --git a/ChimeraTK-DeviceAccess-PythonBindings/tag/html/deviceaccess.html b/ChimeraTK-DeviceAccess-PythonBindings/tag/html/deviceaccess.html
index cc2081749a2..d20bfe232f3 100644
--- a/ChimeraTK-DeviceAccess-PythonBindings/tag/html/deviceaccess.html
+++ b/ChimeraTK-DeviceAccess-PythonBindings/tag/html/deviceaccess.html
@@ -130,7 +130,7 @@
-
-
getOneDRegisterAccessor (userType, registerPathName: str, numberOfElements: int = 0, elementsOffset: int = 0, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f248dee0d00>]] = None) → deviceaccess.OneDRegisterAccessor[source]
+getOneDRegisterAccessor (userType, registerPathName: str, numberOfElements: int = 0, elementsOffset: int = 0, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f0df499fd30>]] = None) → deviceaccess.OneDRegisterAccessor[source]
Get a OneDRegisterAccessor object for the given register.
The OneDRegisterAccessor allows to read and write registers transparently by using
the accessor object like a vector of the type UserType. If needed, the conversion
@@ -198,13 +198,13 @@
-
-
getRegisterCatalogue () → <sphinx.ext.autodoc.importer._MockObject object at 0x7f248ca39520>[source]
+getRegisterCatalogue () → <sphinx.ext.autodoc.importer._MockObject object at 0x7f0df34f85b0>[source]
Return the register catalogue with detailed information on all registers.
-
-
getScalarRegisterAccessor (userType, registerPathName: str, elementsOffset: int = 0, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f248dee0d00>]] = None) → deviceaccess.ScalarRegisterAccessor[source]
+getScalarRegisterAccessor (userType, registerPathName: str, elementsOffset: int = 0, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f0df499fd30>]] = None) → deviceaccess.ScalarRegisterAccessor[source]
Get a ScalarRegisterAccessor object for the given register.
The ScalarRegisterObject allows to read and write registers transparently by using
the accessor object like a variable of the type UserType. If needed, the conversion
@@ -252,7 +252,7 @@
-
-
getTwoDRegisterAccessor (userType, registerPathName: str, numberOfElements: int = 0, elementsOffset: int = 0, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f248dee0d00>]] = None) → deviceaccess.TwoDRegisterAccessor[source]
+getTwoDRegisterAccessor (userType, registerPathName: str, numberOfElements: int = 0, elementsOffset: int = 0, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f0df499fd30>]] = None) → deviceaccess.TwoDRegisterAccessor[source]
Get a TwoDRegisterAccessor object for the given register.
This allows to read and write transparently 2-dimensional registers.
The optional arguments allow to restrict the accessor to a region of
@@ -322,7 +322,7 @@
-
-
getVoidRegisterAccessor (registerPathName: str, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f248dee0d00>]] = None) → deviceaccess.VoidRegisterAccessor[source]
+getVoidRegisterAccessor (registerPathName: str, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f0df499fd30>]] = None) → deviceaccess.VoidRegisterAccessor[source]
Get a VoidRegisterAccessor object for the given register.
The VoidRegisterAccessor allows to read and write registers. Getting a read
accessor is only possible with the wait_for_new_data flag. This access mode
@@ -502,14 +502,14 @@
-
-
dataValidity () → <sphinx.ext.autodoc.importer._MockObject object at 0x7f248dee0730>[source]
+dataValidity () → <sphinx.ext.autodoc.importer._MockObject object at 0x7f0df499f760>[source]
Return current validity of the data.
Will always return DataValidity.ok if the backend does not support it
-
-
getAccessModeFlags () → Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f248dee0d00>][source]
+getAccessModeFlags () → Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f0df499fd30>][source]
Returns the access modes flags, that
were given at the initialization of the accessor.
Examples
@@ -551,7 +551,7 @@
-
-
getId () → <sphinx.ext.autodoc.importer._MockObject object at 0x7f248df1a5b0>[source]
+getId () → <sphinx.ext.autodoc.importer._MockObject object at 0x7f0df49d9640>[source]
Obtain unique ID for the actual implementation of this TransferElement.
This means that e.g. two instances of ScalarRegisterAccessor
created by the same call to Device.getScalarRegisterAccessor()
@@ -638,7 +638,7 @@
-
-
getVersionNumber () → <sphinx.ext.autodoc.importer._MockObject object at 0x7f248ce19fa0>[source]
+getVersionNumber () → <sphinx.ext.autodoc.importer._MockObject object at 0x7f0df38e2070>[source]
Returns the version number that is associated with the last transfer
(i.e. last read or write). See VersionNumber for details.
Examples
@@ -658,6 +658,14 @@
+
+-
+
interrupt () → None[source]
+Place a thread interrupted exception on the read queue of this accessor,
+so the thread currently waiting in a blocking read() will terminate. May
+only be called for accessors with AccessMode.wait_for_new_data.
+
+
-
isInitialised () → bool[source]
@@ -861,7 +869,7 @@
-
-class
deviceaccess. NumpyGeneralRegisterAccessor (channels, elementsPerChannel, userType, accessor, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f248dee0d00>]] = None)[source]
+class deviceaccess. NumpyGeneralRegisterAccessor (channels, elementsPerChannel, userType, accessor, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f0df499fd30>]] = None)[source]
Bases: deviceaccess.GeneralRegisterAccessor
-
@@ -1021,7 +1029,7 @@
-
-class
deviceaccess. OneDRegisterAccessor (userType, accessor, accessModeFlags: Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f248dee0d00>])[source]
+class deviceaccess. OneDRegisterAccessor (userType, accessor, accessModeFlags: Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f0df499fd30>])[source]
Bases: deviceaccess.NumpyGeneralRegisterAccessor
Accessor class to read and write registers transparently by using the accessor object
like a vector of the type UserType.
@@ -1049,7 +1057,7 @@
-
-class
deviceaccess. ScalarRegisterAccessor (userType, accessor, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f248dee0d00>]] = None)[source]
+class deviceaccess. ScalarRegisterAccessor (userType, accessor, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f0df499fd30>]] = None)[source]
Bases: deviceaccess.NumpyGeneralRegisterAccessor
Accessor class to read and write scalar registers transparently by using the accessor object
like a vector of the type UserType.
@@ -1090,7 +1098,7 @@
-
-
setAndWrite (newValue: numpy.number, versionNumber: Optional[<sphinx.ext.autodoc.importer._MockObject object at 0x7f248ce19fa0>] = None) → None[source]
+setAndWrite (newValue: numpy.number, versionNumber: Optional[<sphinx.ext.autodoc.importer._MockObject object at 0x7f0df38e2070>] = None) → None[source]
Convenience function to set and write new value.
@@ -1123,7 +1131,7 @@
-
-
writeIfDifferent (newValue: numpy.number, versionNumber: Optional[<sphinx.ext.autodoc.importer._MockObject object at 0x7f248ce19fa0>] = None, validity: <sphinx.ext.autodoc.importer._MockObject object at 0x7f248dee0730> = <sphinx.ext.autodoc.importer._MockObject object>) → None[source]
+writeIfDifferent (newValue: numpy.number, versionNumber: Optional[<sphinx.ext.autodoc.importer._MockObject object at 0x7f0df38e2070>] = None, validity: <sphinx.ext.autodoc.importer._MockObject object at 0x7f0df499f760> = <sphinx.ext.autodoc.importer._MockObject object>) → None[source]
Convenience function to set and write new value if it differes from the current value.
The given version number is only used in case the value differs.
@@ -1158,7 +1166,7 @@
-
-class
deviceaccess. TwoDRegisterAccessor (userType, accessor, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f248dee0d00>]] = None)[source]
+class deviceaccess. TwoDRegisterAccessor (userType, accessor, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f0df499fd30>]] = None)[source]
Bases: deviceaccess.NumpyGeneralRegisterAccessor
Accessor class to read and write registers transparently by using the accessor object
like a 2D array of the type UserType.
diff --git a/ChimeraTK-DeviceAccess-PythonBindings/tag/html/genindex.html b/ChimeraTK-DeviceAccess-PythonBindings/tag/html/genindex.html
index 3a7d953a811..707f7ef05c7 100644
--- a/ChimeraTK-DeviceAccess-PythonBindings/tag/html/genindex.html
+++ b/ChimeraTK-DeviceAccess-PythonBindings/tag/html/genindex.html
@@ -138,12 +138,14 @@ G
I
|
+ - isReadable() (deviceaccess.GeneralRegisterAccessor method)
+
- isReadOnly() (deviceaccess.GeneralRegisterAccessor method)
- isWriteable() (deviceaccess.GeneralRegisterAccessor method)
diff --git a/ChimeraTK-DeviceAccess-PythonBindings/tag/html/objects.inv b/ChimeraTK-DeviceAccess-PythonBindings/tag/html/objects.inv
index 186fa97af72..17fdc4eddbb 100644
Binary files a/ChimeraTK-DeviceAccess-PythonBindings/tag/html/objects.inv and b/ChimeraTK-DeviceAccess-PythonBindings/tag/html/objects.inv differ
diff --git a/ChimeraTK-DeviceAccess-PythonBindings/tag/html/searchindex.js b/ChimeraTK-DeviceAccess-PythonBindings/tag/html/searchindex.js
index 64aee309acb..0607fc11afb 100644
--- a/ChimeraTK-DeviceAccess-PythonBindings/tag/html/searchindex.js
+++ b/ChimeraTK-DeviceAccess-PythonBindings/tag/html/searchindex.js
@@ -1 +1 @@
-Search.setIndex({docnames:["deviceaccess","index","mtca4u"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,"sphinx.ext.todo":1,"sphinx.ext.viewcode":1,sphinx:55},filenames:["deviceaccess.rst","index.rst","mtca4u.rst"],objects:{"":{deviceaccess:[0,0,0,"-"],mtca4u:[2,0,0,"-"]},"deviceaccess.Device":{activateAsyncRead:[0,2,1,""],close:[0,2,1,""],getCatalogueMetadata:[0,2,1,""],getOneDRegisterAccessor:[0,2,1,""],getRegisterCatalogue:[0,2,1,""],getScalarRegisterAccessor:[0,2,1,""],getTwoDRegisterAccessor:[0,2,1,""],getVoidRegisterAccessor:[0,2,1,""],open:[0,2,1,""],read:[0,2,1,""],write:[0,2,1,""]},"deviceaccess.GeneralRegisterAccessor":{dataValidity:[0,2,1,""],getAccessModeFlags:[0,2,1,""],getDescription:[0,2,1,""],getId:[0,2,1,""],getName:[0,2,1,""],getUnit:[0,2,1,""],getValueType:[0,2,1,""],getVersionNumber:[0,2,1,""],isInitialised:[0,2,1,""],isReadOnly:[0,2,1,""],isReadable:[0,2,1,""],isWriteable:[0,2,1,""],read:[0,2,1,""],readLatest:[0,2,1,""],readNonBlocking:[0,2,1,""],setDataValidity:[0,2,1,""],write:[0,2,1,""],writeDestructively:[0,2,1,""]},"deviceaccess.NumpyGeneralRegisterAccessor":{read:[0,2,1,""],readLatest:[0,2,1,""],readNonBlocking:[0,2,1,""],set:[0,2,1,""],write:[0,2,1,""],writeDestructively:[0,2,1,""]},"deviceaccess.OneDRegisterAccessor":{getNElements:[0,2,1,""]},"deviceaccess.ScalarRegisterAccessor":{readAndGet:[0,2,1,""],setAndWrite:[0,2,1,""],writeIfDifferent:[0,2,1,""]},"deviceaccess.TwoDRegisterAccessor":{getNChannels:[0,2,1,""],getNElementsPerChannel:[0,2,1,""]},"deviceaccess.VoidRegisterAccessor":{read:[0,2,1,""],readLatest:[0,2,1,""],readNonBlocking:[0,2,1,""],write:[0,2,1,""],writeDestructively:[0,2,1,""]},"mtca4u.Device":{getCatalogueMetadata:[2,2,1,""],read:[2,2,1,""],read_dma_raw:[2,2,1,""],read_raw:[2,2,1,""],read_sequences:[2,2,1,""],write:[2,2,1,""],write_raw:[2,2,1,""]},deviceaccess:{Device:[0,1,1,""],GeneralRegisterAccessor:[0,1,1,""],NumpyGeneralRegisterAccessor:[0,1,1,""],OneDRegisterAccessor:[0,1,1,""],ScalarRegisterAccessor:[0,1,1,""],TwoDRegisterAccessor:[0,1,1,""],VoidRegisterAccessor:[0,1,1,""],getDMapFilePath:[0,3,1,""],setDMapFilePath:[0,3,1,""]},mtca4u:{Device:[2,1,1,""],get_dmap_location:[2,3,1,""],get_info:[2,3,1,""],set_dmap_location:[2,3,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:function"},terms:{"0x7f248ca39520":0,"0x7f248ce19fa0":0,"0x7f248dee0730":0,"0x7f248dee0d00":0,"0x7f248df1a5b0":0,"0x7f5298a8f400":0,"0x7f52b5f8a740":0,"2darrayofvalu":2,"abstract":0,"boolean":0,"case":0,"class":[0,2],"default":[0,2],"float":[0,2],"function":0,"import":[0,2],"int":[0,2],"long":[0,2],"new":[0,2],"return":[0,2],"short":0,"super":0,"throw":0,"true":[0,2],"try":0,"void":0,"while":0,One:0,The:[0,2],There:0,Use:2,Will:0,_da_python_bind:0,_datatowrit:2,_io:2,_mockobject:0,abc:0,about:2,abov:0,absolut:0,acc:0,access:0,accessmod:0,accessmodeflag:0,accessor:0,action:0,activ:0,activateasyncread:0,actual:0,adc0_valu:2,adc1_valu:2,adc3_valu:2,adc:0,after:0,again:2,against:2,alia:[0,2],aliasnam:0,all:[0,2],allow:0,alreadi:0,also:[0,2],alwai:0,ani:0,appli:2,applic:[0,2],arbitari:2,area:2,area_dma_via_dma:2,area_multiplexed_sequence_dma:2,arg:2,argument:0,arr1to10:0,arrai:[0,2],arrayofrawvalu:2,arriv:0,associ:0,assum:2,asynchron:0,attribut:0,autodoc:0,avail:[0,2],avoid:0,awar:2,backend:[0,2],base:[0,2],been:0,befor:0,begin:0,behaviour:0,belong:2,below:0,between:0,binari:2,bit:[0,2],block:[0,2],board:[0,2],boardwithmodul:2,bool:0,both:2,buffer:0,call:0,can:[0,2],card:2,card_with_modul:0,catalogu:[0,2],chang:0,channel:0,check:[0,2],chimeratk:[0,2],client:0,close:0,code:0,column:2,combin:0,come:2,commenc:2,common:0,compat:0,complet:0,concern:0,connect:0,construct:[0,2],constructor:[0,2],contain:[0,2],content:[0,1],contentthat:0,control:0,conveni:0,convent:0,convers:[0,2],convert:[0,2],copi:[0,2],correspond:2,coulum:2,creat:[0,2],creation:0,current:[0,2],data:[0,2],datatowrit:[0,2],datatyp:2,datavalid:0,dda:0,deactiv:0,deciv:2,defin:[0,2],demultiplex:2,depend:[0,2],deprec:2,descript:0,desir:2,destroi:0,detail:[0,2],dev:0,devic:[0,2],device_nam:2,deviceaccess:[1,2],deviceaccess_vers:2,deviceexcept:0,deviceinform:0,differ:0,dimension:[0,2],direct:2,directori:0,discard:0,dma:[0,2],dmap:[0,2],dmap_path:0,dmapfileloc:2,dmapfilepath:0,dmappath:2,dmaregisternam:2,document:0,doe:0,doubl:[0,2],dtype:[0,2],due:0,dummy_interrupt_2:0,duplic:0,dure:0,each:[0,2],effect:0,either:2,element:[0,2],elementindexinregist:[0,2],elementsoffset:0,elementsperchannel:0,elemnt:2,empti:2,enabl:0,encod:2,engin:0,equal:2,error:0,even:0,everi:[0,2],exampl:[0,2],examplecr:0,exce:[0,2],except:0,exist:0,expect:[0,2],ext:0,extract:2,fals:0,faulti:0,fetch:2,file:[0,2],first:[0,2],fit:2,fix:[0,2],flag:0,float32:[0,2],float64:[0,2],form:2,found:0,fraction:2,framework:0,free:0,from:[0,2],generalregisteraccessor:0,get:[0,2],get_dmap_loc:2,get_info:2,getaccessmodeflag:0,getcataloguemetadata:[0,2],getdescript:0,getdmapfilepath:0,getid:0,getnam:0,getnchannel:0,getnel:0,getnelementsperchannel:0,getonedregisteraccessor:0,getregistercatalogu:0,getscalarregisteraccessor:0,gettwodregisteraccessor:0,getunit:0,getvaluetyp:0,getversionnumb:0,getvoidregisteraccessor:0,github:0,give:0,given:[0,2],guarante:0,handl:0,happen:0,hardwar:[0,2],has:[0,2],have:[0,2],henc:0,hold:2,ident:0,identifi:0,ignor:[0,2],immedi:0,implement:0,includ:[0,2],index:[0,1,2],indic:0,individu:2,induvidu:2,ineffici:0,inform:[0,2],inherit:0,initi:0,input:[0,2],instanc:0,instead:2,int16:0,int32:[0,2],int64:0,int8:0,integ:0,intend:2,interest:0,interfac:0,intern:[0,2],interrupt:0,interruptacc:0,isinitialis:0,isread:0,isreadonli:0,iswrit:0,its:[0,2],just:0,kept:0,last:[0,2],latest:0,lead:0,left:0,length:2,librari:[0,2],lifetim:2,like:0,link:2,list:[0,2],locat:[0,2],lock:0,look:[0,2],lookup:[0,2],lost:0,made:2,mai:2,make:2,map:[0,2],mapfil:2,mapfile_revis:0,mapp:0,match:0,mathemat:0,matrix:2,maximm:0,mean:0,memori:2,metadata:[0,2],metadatavalu:2,metatag:0,method:[0,2],might:0,minu:0,mismatch:0,mode:[0,2],modul:1,module1:[0,2],modulenam:2,more:0,mtca4upi:2,multiplex:2,must:0,my_card:2,my_example_dmap_fil:2,name:[0,2],ndarrai:0,need:0,never:0,newvalu:0,next:0,non:0,none:[0,2],not_impl:0,now:0,number:[0,2],numberofchannel:0,numberofel:0,numberofelementstoread:2,numberofword:0,numericaddressedbackend:2,numpi:[0,2],numpygeneralregisteraccessor:0,object:[0,2],obtain:[0,2],offer:0,offset:[0,2],old:0,omit:0,ommit:2,onc:2,oneacc:0,onedregisteraccessor:0,onli:[0,2],open:[0,2],oper:0,operand:0,option:[0,2],origin:0,originacc:0,other:0,otheracc:0,otherwis:0,out:[0,2],outputstream:2,over:2,overflow:0,page:1,paramet:[0,2],parameternam:2,pars:0,part:2,pass:0,passes:2,path:[0,2],per:0,persist:0,placehold:0,pleas:0,point:[0,2],pointer:0,posit:[0,2],possibl:0,preced:2,present:0,previous:0,print:[0,2],process:0,processarrai:0,program:2,project:0,properli:0,provid:[0,2],purpos:2,push:0,put:2,python:0,queri:2,quickli:0,rais:0,rang:0,raw:[0,2],read:[0,2],read__raw:2,read_dma_raw:2,read_raw:2,read_sequ:2,readabl:0,readacc:0,readandget:0,readinrawvalu:2,readlatest:0,readnonblock:0,readonli:0,readoutvalu:2,receiv:0,refer:0,reg_valu:0,region:[0,2],regionnam:2,regist:[0,2],registernam:2,registerpath:[0,2],registerpathnam:0,reject:0,rel:0,repres:2,represent:[0,2],representaion:2,requir:0,resp:0,respect:0,restrict:0,result:0,resultacc:0,right:0,same:[0,2],sampl:0,scalar:0,scalarregisteraccessor:0,scalarregisterobject:0,search:1,second:0,see:0,select:[0,2],send:0,sequenc:[0,2],set:[0,2],set_dmap_loc:2,setandwrit:0,setdatavalid:0,setdmapfilepath:0,shallow:0,shape:0,share:0,shared_raw_devic:0,should:[0,2],sign:0,simimlar:0,sinc:[0,2],singl:2,size:[0,2],slice:0,slicedacc:0,sourc:[0,2],specifi:[0,2],sphinx:0,start:[0,2],statement:0,statu:0,stdout:2,still:0,storag:0,str:[0,2],string:[0,2],suppli:0,support:0,sys:2,system:0,tag:0,take:[0,2],test_area:0,test_area_push:0,textiowrapp:2,thei:0,thi:[0,2],though:0,through:2,time:0,touch:0,transfer:0,transferel:0,transferelementid:0,transpar:0,trigger:0,two:0,twodregisteraccessor:0,type:[0,2],uint16:0,uint32:0,uint64:0,uint8:0,unbuff:0,undefin:0,understood:0,union:0,uniqu:0,unit:0,unsign:0,until:[0,2],updat:0,uppercas:0,upto:[0,2],usag:0,use:2,used:[0,2],user:[0,2],usertyp:0,uses:[0,2],using:[0,2],usual:0,utf:2,v02:2,valid:0,valu:[0,2],variabl:0,vaue:2,vector:0,veri:0,version:0,versionmnumb:0,versionnumb:0,view:2,voidregisteraccessor:0,wai:2,wait:0,wait_for_new_data:0,well:[0,2],were:0,when:[0,2],where:0,whether:0,which:[0,2],whole:2,width:[0,2],within:2,without:[0,2],word_clk_cnt:0,word_clk_cnt_1:0,word_clk_mux:[0,2],word_statu:[0,2],wordoffsetinregist:0,would:[0,2],write:[0,2],write_raw:2,writeabl:0,writeacc:0,writeaccreg:0,writedestruct:0,writeifdiffer:0,written:[0,2],you:0,zero:[0,2]},titles:["deviceaccess module","mtca4u Python Bindings Doucmentation","mtca4u module"],titleterms:{bind:1,deviceaccess:0,doucment:1,indic:1,modul:[0,2],mtca4u:[1,2],python:1,tabl:1}})
\ No newline at end of file
+Search.setIndex({docnames:["deviceaccess","index","mtca4u"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,"sphinx.ext.todo":1,"sphinx.ext.viewcode":1,sphinx:55},filenames:["deviceaccess.rst","index.rst","mtca4u.rst"],objects:{"":{deviceaccess:[0,0,0,"-"],mtca4u:[2,0,0,"-"]},"deviceaccess.Device":{activateAsyncRead:[0,2,1,""],close:[0,2,1,""],getCatalogueMetadata:[0,2,1,""],getOneDRegisterAccessor:[0,2,1,""],getRegisterCatalogue:[0,2,1,""],getScalarRegisterAccessor:[0,2,1,""],getTwoDRegisterAccessor:[0,2,1,""],getVoidRegisterAccessor:[0,2,1,""],open:[0,2,1,""],read:[0,2,1,""],write:[0,2,1,""]},"deviceaccess.GeneralRegisterAccessor":{dataValidity:[0,2,1,""],getAccessModeFlags:[0,2,1,""],getDescription:[0,2,1,""],getId:[0,2,1,""],getName:[0,2,1,""],getUnit:[0,2,1,""],getValueType:[0,2,1,""],getVersionNumber:[0,2,1,""],interrupt:[0,2,1,""],isInitialised:[0,2,1,""],isReadOnly:[0,2,1,""],isReadable:[0,2,1,""],isWriteable:[0,2,1,""],read:[0,2,1,""],readLatest:[0,2,1,""],readNonBlocking:[0,2,1,""],setDataValidity:[0,2,1,""],write:[0,2,1,""],writeDestructively:[0,2,1,""]},"deviceaccess.NumpyGeneralRegisterAccessor":{read:[0,2,1,""],readLatest:[0,2,1,""],readNonBlocking:[0,2,1,""],set:[0,2,1,""],write:[0,2,1,""],writeDestructively:[0,2,1,""]},"deviceaccess.OneDRegisterAccessor":{getNElements:[0,2,1,""]},"deviceaccess.ScalarRegisterAccessor":{readAndGet:[0,2,1,""],setAndWrite:[0,2,1,""],writeIfDifferent:[0,2,1,""]},"deviceaccess.TwoDRegisterAccessor":{getNChannels:[0,2,1,""],getNElementsPerChannel:[0,2,1,""]},"deviceaccess.VoidRegisterAccessor":{read:[0,2,1,""],readLatest:[0,2,1,""],readNonBlocking:[0,2,1,""],write:[0,2,1,""],writeDestructively:[0,2,1,""]},"mtca4u.Device":{getCatalogueMetadata:[2,2,1,""],read:[2,2,1,""],read_dma_raw:[2,2,1,""],read_raw:[2,2,1,""],read_sequences:[2,2,1,""],write:[2,2,1,""],write_raw:[2,2,1,""]},deviceaccess:{Device:[0,1,1,""],GeneralRegisterAccessor:[0,1,1,""],NumpyGeneralRegisterAccessor:[0,1,1,""],OneDRegisterAccessor:[0,1,1,""],ScalarRegisterAccessor:[0,1,1,""],TwoDRegisterAccessor:[0,1,1,""],VoidRegisterAccessor:[0,1,1,""],getDMapFilePath:[0,3,1,""],setDMapFilePath:[0,3,1,""]},mtca4u:{Device:[2,1,1,""],get_dmap_location:[2,3,1,""],get_info:[2,3,1,""],set_dmap_location:[2,3,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:function"},terms:{"0x7f0df34f85b0":0,"0x7f0df38e2070":0,"0x7f0df499f760":0,"0x7f0df499fd30":0,"0x7f0df49d9640":0,"0x7f5298a8f400":0,"0x7f52b5f8a740":0,"2darrayofvalu":2,"abstract":0,"boolean":0,"case":0,"class":[0,2],"default":[0,2],"float":[0,2],"function":0,"import":[0,2],"int":[0,2],"long":[0,2],"new":[0,2],"return":[0,2],"short":0,"super":0,"throw":0,"true":[0,2],"try":0,"void":0,"while":0,One:0,The:[0,2],There:0,Use:2,Will:0,_da_python_bind:0,_datatowrit:2,_io:2,_mockobject:0,abc:0,about:2,abov:0,absolut:0,acc:0,access:0,accessmod:0,accessmodeflag:0,accessor:0,action:0,activ:0,activateasyncread:0,actual:0,adc0_valu:2,adc1_valu:2,adc3_valu:2,adc:0,after:0,again:2,against:2,alia:[0,2],aliasnam:0,all:[0,2],allow:0,alreadi:0,also:[0,2],alwai:0,ani:0,appli:2,applic:[0,2],arbitari:2,area:2,area_dma_via_dma:2,area_multiplexed_sequence_dma:2,arg:2,argument:0,arr1to10:0,arrai:[0,2],arrayofrawvalu:2,arriv:0,associ:0,assum:2,asynchron:0,attribut:0,autodoc:0,avail:[0,2],avoid:0,awar:2,backend:[0,2],base:[0,2],been:0,befor:0,begin:0,behaviour:0,belong:2,below:0,between:0,binari:2,bit:[0,2],block:[0,2],board:[0,2],boardwithmodul:2,bool:0,both:2,buffer:0,call:0,can:[0,2],card:2,card_with_modul:0,catalogu:[0,2],chang:0,channel:0,check:[0,2],chimeratk:[0,2],client:0,close:0,code:0,column:2,combin:0,come:2,commenc:2,common:0,compat:0,complet:0,concern:0,connect:0,construct:[0,2],constructor:[0,2],contain:[0,2],content:[0,1],contentthat:0,control:0,conveni:0,convent:0,convers:[0,2],convert:[0,2],copi:[0,2],correspond:2,coulum:2,creat:[0,2],creation:0,current:[0,2],data:[0,2],datatowrit:[0,2],datatyp:2,datavalid:0,dda:0,deactiv:0,deciv:2,defin:[0,2],demultiplex:2,depend:[0,2],deprec:2,descript:0,desir:2,destroi:0,detail:[0,2],dev:0,devic:[0,2],device_nam:2,deviceaccess:[1,2],deviceaccess_vers:2,deviceexcept:0,deviceinform:0,differ:0,dimension:[0,2],direct:2,directori:0,discard:0,dma:[0,2],dmap:[0,2],dmap_path:0,dmapfileloc:2,dmapfilepath:0,dmappath:2,dmaregisternam:2,document:0,doe:0,doubl:[0,2],dtype:[0,2],due:0,dummy_interrupt_2:0,duplic:0,dure:0,each:[0,2],effect:0,either:2,element:[0,2],elementindexinregist:[0,2],elementsoffset:0,elementsperchannel:0,elemnt:2,empti:2,enabl:0,encod:2,engin:0,equal:2,error:0,even:0,everi:[0,2],exampl:[0,2],examplecr:0,exce:[0,2],except:0,exist:0,expect:[0,2],ext:0,extract:2,fals:0,faulti:0,fetch:2,file:[0,2],first:[0,2],fit:2,fix:[0,2],flag:0,float32:[0,2],float64:[0,2],form:2,found:0,fraction:2,framework:0,free:0,from:[0,2],generalregisteraccessor:0,get:[0,2],get_dmap_loc:2,get_info:2,getaccessmodeflag:0,getcataloguemetadata:[0,2],getdescript:0,getdmapfilepath:0,getid:0,getnam:0,getnchannel:0,getnel:0,getnelementsperchannel:0,getonedregisteraccessor:0,getregistercatalogu:0,getscalarregisteraccessor:0,gettwodregisteraccessor:0,getunit:0,getvaluetyp:0,getversionnumb:0,getvoidregisteraccessor:0,github:0,give:0,given:[0,2],guarante:0,handl:0,happen:0,hardwar:[0,2],has:[0,2],have:[0,2],henc:0,hold:2,ident:0,identifi:0,ignor:[0,2],immedi:0,implement:0,includ:[0,2],index:[0,1,2],indic:0,individu:2,induvidu:2,ineffici:0,inform:[0,2],inherit:0,initi:0,input:[0,2],instanc:0,instead:2,int16:0,int32:[0,2],int64:0,int8:0,integ:0,intend:2,interest:0,interfac:0,intern:[0,2],interrupt:0,interruptacc:0,isinitialis:0,isread:0,isreadonli:0,iswrit:0,its:[0,2],just:0,kept:0,last:[0,2],latest:0,lead:0,left:0,length:2,librari:[0,2],lifetim:2,like:0,link:2,list:[0,2],locat:[0,2],lock:0,look:[0,2],lookup:[0,2],lost:0,made:2,mai:[0,2],make:2,map:[0,2],mapfil:2,mapfile_revis:0,mapp:0,match:0,mathemat:0,matrix:2,maximm:0,mean:0,memori:2,metadata:[0,2],metadatavalu:2,metatag:0,method:[0,2],might:0,minu:0,mismatch:0,mode:[0,2],modul:1,module1:[0,2],modulenam:2,more:0,mtca4upi:2,multiplex:2,must:0,my_card:2,my_example_dmap_fil:2,name:[0,2],ndarrai:0,need:0,never:0,newvalu:0,next:0,non:0,none:[0,2],not_impl:0,now:0,number:[0,2],numberofchannel:0,numberofel:0,numberofelementstoread:2,numberofword:0,numericaddressedbackend:2,numpi:[0,2],numpygeneralregisteraccessor:0,object:[0,2],obtain:[0,2],offer:0,offset:[0,2],old:0,omit:0,ommit:2,onc:2,oneacc:0,onedregisteraccessor:0,onli:[0,2],open:[0,2],oper:0,operand:0,option:[0,2],origin:0,originacc:0,other:0,otheracc:0,otherwis:0,out:[0,2],outputstream:2,over:2,overflow:0,page:1,paramet:[0,2],parameternam:2,pars:0,part:2,pass:0,passes:2,path:[0,2],per:0,persist:0,place:0,placehold:0,pleas:0,point:[0,2],pointer:0,posit:[0,2],possibl:0,preced:2,present:0,previous:0,print:[0,2],process:0,processarrai:0,program:2,project:0,properli:0,provid:[0,2],purpos:2,push:0,put:2,python:0,queri:2,queue:0,quickli:0,rais:0,rang:0,raw:[0,2],read:[0,2],read__raw:2,read_dma_raw:2,read_raw:2,read_sequ:2,readabl:0,readacc:0,readandget:0,readinrawvalu:2,readlatest:0,readnonblock:0,readonli:0,readoutvalu:2,receiv:0,refer:0,reg_valu:0,region:[0,2],regionnam:2,regist:[0,2],registernam:2,registerpath:[0,2],registerpathnam:0,reject:0,rel:0,repres:2,represent:[0,2],representaion:2,requir:0,resp:0,respect:0,restrict:0,result:0,resultacc:0,right:0,same:[0,2],sampl:0,scalar:0,scalarregisteraccessor:0,scalarregisterobject:0,search:1,second:0,see:0,select:[0,2],send:0,sequenc:[0,2],set:[0,2],set_dmap_loc:2,setandwrit:0,setdatavalid:0,setdmapfilepath:0,shallow:0,shape:0,share:0,shared_raw_devic:0,should:[0,2],sign:0,simimlar:0,sinc:[0,2],singl:2,size:[0,2],slice:0,slicedacc:0,sourc:[0,2],specifi:[0,2],sphinx:0,start:[0,2],statement:0,statu:0,stdout:2,still:0,storag:0,str:[0,2],string:[0,2],suppli:0,support:0,sys:2,system:0,tag:0,take:[0,2],termin:0,test_area:0,test_area_push:0,textiowrapp:2,thei:0,thi:[0,2],though:0,thread:0,through:2,time:0,touch:0,transfer:0,transferel:0,transferelementid:0,transpar:0,trigger:0,two:0,twodregisteraccessor:0,type:[0,2],uint16:0,uint32:0,uint64:0,uint8:0,unbuff:0,undefin:0,understood:0,union:0,uniqu:0,unit:0,unsign:0,until:[0,2],updat:0,uppercas:0,upto:[0,2],usag:0,use:2,used:[0,2],user:[0,2],usertyp:0,uses:[0,2],using:[0,2],usual:0,utf:2,v02:2,valid:0,valu:[0,2],variabl:0,vaue:2,vector:0,veri:0,version:0,versionmnumb:0,versionnumb:0,view:2,voidregisteraccessor:0,wai:2,wait:0,wait_for_new_data:0,well:[0,2],were:0,when:[0,2],where:0,whether:0,which:[0,2],whole:2,width:[0,2],within:2,without:[0,2],word_clk_cnt:0,word_clk_cnt_1:0,word_clk_mux:[0,2],word_statu:[0,2],wordoffsetinregist:0,would:[0,2],write:[0,2],write_raw:2,writeabl:0,writeacc:0,writeaccreg:0,writedestruct:0,writeifdiffer:0,written:[0,2],you:0,zero:[0,2]},titles:["deviceaccess module","mtca4u Python Bindings Doucmentation","mtca4u module"],titleterms:{bind:1,deviceaccess:0,doucment:1,indic:1,modul:[0,2],mtca4u:[1,2],python:1,tabl:1}})
\ No newline at end of file
diff --git a/ChimeraTK-DeviceAccess/head/.git-describe b/ChimeraTK-DeviceAccess/head/.git-describe
index 5ab60cdc81d..e3b1eb54a3c 100644
--- a/ChimeraTK-DeviceAccess/head/.git-describe
+++ b/ChimeraTK-DeviceAccess/head/.git-describe
@@ -1 +1 @@
-03.17.00-6-g4e6b7b4f
+03.17.00-8-ga0a85814
diff --git a/ChimeraTK-DeviceAccess/head/html/_n_d_register_accessor_abstractor_8h_source.html b/ChimeraTK-DeviceAccess/head/html/_n_d_register_accessor_abstractor_8h_source.html
index 69e0dc746cc..895092594bc 100644
--- a/ChimeraTK-DeviceAccess/head/html/_n_d_register_accessor_abstractor_8h_source.html
+++ b/ChimeraTK-DeviceAccess/head/html/_n_d_register_accessor_abstractor_8h_source.html
@@ -184,7 +184,7 @@
const NDRegisterAccessorAbstractor & operator=(const NDRegisterAccessorAbstractor &rightHandSide) const =delete Prevent copying by operator=, since it will be confusing (operator= may also be overloaded to access ...
NDRegisterAccessorAbstractor()=default Create an uninitialised abstractor - just for late initialisation.
NDRegisterAccessor< UserType > * get()
-boost::shared_ptr< TransferElement > _impl Untyped pointer to implementation.
+boost::shared_ptr< TransferElement > _impl Untyped pointer to implementation.
N-dimensional register accessor.
diff --git a/ChimeraTK-DeviceAccess/head/html/_scalar_register_accessor_8h_source.html b/ChimeraTK-DeviceAccess/head/html/_scalar_register_accessor_8h_source.html
index 07bc2c336d3..6c3ff01c6e4 100644
--- a/ChimeraTK-DeviceAccess/head/html/_scalar_register_accessor_8h_source.html
+++ b/ChimeraTK-DeviceAccess/head/html/_scalar_register_accessor_8h_source.html
@@ -390,7 +390,7 @@
NDRegisterAccessor< UserType > * get()
Class for generating and holding version numbers without exposing a numeric representation.
-boost::shared_ptr< TransferElement > _impl Untyped pointer to implementation.
+boost::shared_ptr< TransferElement > _impl Untyped pointer to implementation.
bool write(ChimeraTK::VersionNumber versionNumber={}) Write the data to device.
ChimeraTK::VersionNumber getVersionNumber() const Returns the version number that is associated with the last transfer (i.e.
diff --git a/ChimeraTK-DeviceAccess/head/html/_transfer_element_abstractor_8cc_source.html b/ChimeraTK-DeviceAccess/head/html/_transfer_element_abstractor_8cc_source.html
index 6c9b3c6044c..77d886ab2c4 100644
--- a/ChimeraTK-DeviceAccess/head/html/_transfer_element_abstractor_8cc_source.html
+++ b/ChimeraTK-DeviceAccess/head/html/_transfer_element_abstractor_8cc_source.html
@@ -138,7 +138,7 @@
void replaceTransferElement(const boost::shared_ptr< TransferElement > &newElement) Search for all underlying TransferElements which are considered identical (see mayReplaceOther()) wit...
std::list< boost::shared_ptr< TransferElement > > getInternalElements() Obtain the full list of TransferElements internally used by this TransferElement.
-boost::shared_ptr< TransferElement > _impl Untyped pointer to implementation.
+boost::shared_ptr< TransferElement > _impl Untyped pointer to implementation.
diff --git a/ChimeraTK-DeviceAccess/head/html/_transfer_element_abstractor_8h_source.html b/ChimeraTK-DeviceAccess/head/html/_transfer_element_abstractor_8h_source.html
index b81b5d6d27c..e6ece9034ed 100644
--- a/ChimeraTK-DeviceAccess/head/html/_transfer_element_abstractor_8h_source.html
+++ b/ChimeraTK-DeviceAccess/head/html/_transfer_element_abstractor_8h_source.html
@@ -169,25 +169,27 @@
-
- 206 boost::shared_ptr<TransferElement> _impl;
-
-
-
-
-
- 212 return _impl->writeDestructively(versionNumber);
-
-
-
-
-
+
+
+
+ 225 boost::shared_ptr<TransferElement> _impl;
+
+
+
+
+
+ 231 return _impl->writeDestructively(versionNumber);
+
+
+
+
+
TransferElementID getId() const Obtain unique ID for the actual implementation of this TransferElement.
AccessModeFlags getAccessModeFlags() const Return the AccessModeFlags for this TransferElement.
bool readLatest() Read the latest value, discarding any other update since the last read if present.
-bool writeDestructively(ChimeraTK::VersionNumber versionNumber={}) Just like write(), but allows the implementation to destroy the content of the user buffer in the pro...
+bool writeDestructively(ChimeraTK::VersionNumber versionNumber={}) Just like write(), but allows the implementation to destroy the content of the user buffer in the pro...
bool isReadOnly() const Check if transfer element is read only, i.e.
bool isWriteable() const Check if transfer element is writeable.
@@ -213,10 +215,11 @@
const boost::shared_ptr< TransferElement > & getHighLevelImplElement() Obtain the highest level implementation TransferElement.
void replace(boost::shared_ptr< TransferElement > newImpl) Alternative signature of relace() with the same functionality, used when a pointer to the implementat...
const std::string & getName() const Returns the name that identifies the process variable.
+void interrupt() Return from a blocking read immediately and throw boost::thread_interrupted.
Class for generating and holding version numbers without exposing a numeric representation.
const std::type_info & getValueType() const Returns the std::type_info for the value type of this transfer element.
Set of AccessMode flags with additional functionality for an easier handling.
-boost::shared_ptr< TransferElement > _impl Untyped pointer to implementation.
+boost::shared_ptr< TransferElement > _impl Untyped pointer to implementation.
bool write(ChimeraTK::VersionNumber versionNumber={}) Write the data to device.
Simple class holding a unique ID for a TransferElement.
diff --git a/ChimeraTK-DeviceAccess/head/html/_transfer_group_8cc_source.html b/ChimeraTK-DeviceAccess/head/html/_transfer_group_8cc_source.html
index 211a2c6b702..1875ce51190 100644
--- a/ChimeraTK-DeviceAccess/head/html/_transfer_group_8cc_source.html
+++ b/ChimeraTK-DeviceAccess/head/html/_transfer_group_8cc_source.html
@@ -452,7 +452,7 @@
Class for generating and holding version numbers without exposing a numeric representation.
-boost::shared_ptr< TransferElement > _impl Untyped pointer to implementation.
+boost::shared_ptr< TransferElement > _impl Untyped pointer to implementation.
bool _isWriteable Cached value whether all elements are writeable.
void dump() Print information about the accessors in this group to screen, which might help to understand which t...
diff --git a/ChimeraTK-DeviceAccess/head/html/_void_register_accessor_8cc_source.html b/ChimeraTK-DeviceAccess/head/html/_void_register_accessor_8cc_source.html
index 8e285384b2c..79f6ca45553 100644
--- a/ChimeraTK-DeviceAccess/head/html/_void_register_accessor_8cc_source.html
+++ b/ChimeraTK-DeviceAccess/head/html/_void_register_accessor_8cc_source.html
@@ -136,7 +136,7 @@
@ wait_for_new_data Make any read blocking until new data has arrived since the last read.
Base class for the register accessor abstractors (ScalarRegisterAccessor, OneDRegisterAccessor and Tw...
-boost::shared_ptr< TransferElement > _impl Untyped pointer to implementation.
+boost::shared_ptr< TransferElement > _impl Untyped pointer to implementation.
N-dimensional register accessor.
Exception thrown when a logic error has occured.
diff --git a/ChimeraTK-DeviceAccess/head/html/_void_register_accessor_8h_source.html b/ChimeraTK-DeviceAccess/head/html/_void_register_accessor_8h_source.html
index 56177c22264..140c3854fd5 100644
--- a/ChimeraTK-DeviceAccess/head/html/_void_register_accessor_8h_source.html
+++ b/ChimeraTK-DeviceAccess/head/html/_void_register_accessor_8h_source.html
@@ -157,7 +157,7 @@
Accessor class to read and write void-typed registers.
Base class for the register accessor abstractors (ScalarRegisterAccessor, OneDRegisterAccessor and Tw...
-boost::shared_ptr< TransferElement > _impl Untyped pointer to implementation.
+boost::shared_ptr< TransferElement > _impl Untyped pointer to implementation.
N-dimensional register accessor.
Exception thrown when a logic error has occured.
diff --git a/ChimeraTK-DeviceAccess/head/html/class_chimera_t_k_1_1_n_d_register_accessor_abstractor-members.html b/ChimeraTK-DeviceAccess/head/html/class_chimera_t_k_1_1_n_d_register_accessor_abstractor-members.html
index 6299313cb67..c1107c22acf 100644
--- a/ChimeraTK-DeviceAccess/head/html/class_chimera_t_k_1_1_n_d_register_accessor_abstractor-members.html
+++ b/ChimeraTK-DeviceAccess/head/html/class_chimera_t_k_1_1_n_d_register_accessor_abstractor-members.html
@@ -105,28 +105,29 @@
getUnit() const | ChimeraTK::TransferElementAbstractor | inline |
getValueType() const | ChimeraTK::TransferElementAbstractor | inline |
getVersionNumber() const | ChimeraTK::TransferElementAbstractor | inline |
- isInitialised() const | ChimeraTK::TransferElementAbstractor | inline |
- isReadable() const | ChimeraTK::TransferElementAbstractor | inline |
- isReadOnly() const | ChimeraTK::TransferElementAbstractor | inline |
- isWriteable() const | ChimeraTK::TransferElementAbstractor | inline |
- NDRegisterAccessorAbstractor()=default | ChimeraTK::NDRegisterAccessorAbstractor< UserType > | |
- NDRegisterAccessorAbstractor(const NDRegisterAccessorAbstractor &)=default | ChimeraTK::NDRegisterAccessorAbstractor< UserType > | |
- NDRegisterAccessorAbstractor(boost::shared_ptr< NDRegisterAccessor< UserType >> impl) | ChimeraTK::NDRegisterAccessorAbstractor< UserType > | explicitprotected |
- operator=(const NDRegisterAccessorAbstractor &rightHandSide) const =delete | ChimeraTK::NDRegisterAccessorAbstractor< UserType > | |
- read() | ChimeraTK::TransferElementAbstractor | inline |
- readLatest() | ChimeraTK::TransferElementAbstractor | inline |
- readNonBlocking() | ChimeraTK::TransferElementAbstractor | inline |
- replace(const NDRegisterAccessorAbstractor< UserType > &newAccessor) | ChimeraTK::NDRegisterAccessorAbstractor< UserType > | |
- replace(boost::shared_ptr< NDRegisterAccessor< UserType >> newImpl) | ChimeraTK::NDRegisterAccessorAbstractor< UserType > | |
- ChimeraTK::TransferElementAbstractor::replace(const TransferElementAbstractor &newAccessor) | ChimeraTK::TransferElementAbstractor | inline |
- ChimeraTK::TransferElementAbstractor::replace(boost::shared_ptr< TransferElement > newImpl) | ChimeraTK::TransferElementAbstractor | inline |
- replaceTransferElement(const boost::shared_ptr< TransferElement > &newElement) | ChimeraTK::TransferElementAbstractor | |
- setDataValidity(DataValidity valid=DataValidity::ok) | ChimeraTK::TransferElementAbstractor | inline |
- setPersistentDataStorage(boost::shared_ptr< ChimeraTK::PersistentDataStorage > storage) | ChimeraTK::TransferElementAbstractor | |
- TransferElementAbstractor(boost::shared_ptr< TransferElement > impl) | ChimeraTK::TransferElementAbstractor | inlineexplicit |
- TransferElementAbstractor()=default | ChimeraTK::TransferElementAbstractor | |
- write(ChimeraTK::VersionNumber versionNumber={}) | ChimeraTK::TransferElementAbstractor | inline |
- writeDestructively(ChimeraTK::VersionNumber versionNumber={}) | ChimeraTK::TransferElementAbstractor | inline |
+ interrupt() | ChimeraTK::TransferElementAbstractor | inline |
+ isInitialised() const | ChimeraTK::TransferElementAbstractor | inline |
+ isReadable() const | ChimeraTK::TransferElementAbstractor | inline |
+ isReadOnly() const | ChimeraTK::TransferElementAbstractor | inline |
+ isWriteable() const | ChimeraTK::TransferElementAbstractor | inline |
+ NDRegisterAccessorAbstractor()=default | ChimeraTK::NDRegisterAccessorAbstractor< UserType > | |
+ NDRegisterAccessorAbstractor(const NDRegisterAccessorAbstractor &)=default | ChimeraTK::NDRegisterAccessorAbstractor< UserType > | |
+ NDRegisterAccessorAbstractor(boost::shared_ptr< NDRegisterAccessor< UserType >> impl) | ChimeraTK::NDRegisterAccessorAbstractor< UserType > | explicitprotected |
+ operator=(const NDRegisterAccessorAbstractor &rightHandSide) const =delete | ChimeraTK::NDRegisterAccessorAbstractor< UserType > | |
+ read() | ChimeraTK::TransferElementAbstractor | inline |
+ readLatest() | ChimeraTK::TransferElementAbstractor | inline |
+ readNonBlocking() | ChimeraTK::TransferElementAbstractor | inline |
+ replace(const NDRegisterAccessorAbstractor< UserType > &newAccessor) | ChimeraTK::NDRegisterAccessorAbstractor< UserType > | |
+ replace(boost::shared_ptr< NDRegisterAccessor< UserType >> newImpl) | ChimeraTK::NDRegisterAccessorAbstractor< UserType > | |
+ ChimeraTK::TransferElementAbstractor::replace(const TransferElementAbstractor &newAccessor) | ChimeraTK::TransferElementAbstractor | inline |
+ ChimeraTK::TransferElementAbstractor::replace(boost::shared_ptr< TransferElement > newImpl) | ChimeraTK::TransferElementAbstractor | inline |
+ replaceTransferElement(const boost::shared_ptr< TransferElement > &newElement) | ChimeraTK::TransferElementAbstractor | |
+ setDataValidity(DataValidity valid=DataValidity::ok) | ChimeraTK::TransferElementAbstractor | inline |
+ setPersistentDataStorage(boost::shared_ptr< ChimeraTK::PersistentDataStorage > storage) | ChimeraTK::TransferElementAbstractor | |
+ TransferElementAbstractor(boost::shared_ptr< TransferElement > impl) | ChimeraTK::TransferElementAbstractor | inlineexplicit |
+ TransferElementAbstractor()=default | ChimeraTK::TransferElementAbstractor | |
+ write(ChimeraTK::VersionNumber versionNumber={}) | ChimeraTK::TransferElementAbstractor | inline |
+ writeDestructively(ChimeraTK::VersionNumber versionNumber={}) | ChimeraTK::TransferElementAbstractor | inline |
|
diff --git a/ChimeraTK-DeviceAccess/head/html/class_chimera_t_k_1_1_n_d_register_accessor_abstractor.html b/ChimeraTK-DeviceAccess/head/html/class_chimera_t_k_1_1_n_d_register_accessor_abstractor.html
index 8f28f5a66c3..9d1063ec0d7 100644
--- a/ChimeraTK-DeviceAccess/head/html/class_chimera_t_k_1_1_n_d_register_accessor_abstractor.html
+++ b/ChimeraTK-DeviceAccess/head/html/class_chimera_t_k_1_1_n_d_register_accessor_abstractor.html
@@ -214,6 +214,9 @@
DataValidity | dataValidity () const |
| Return current validity of the data. More...
|
|
+void | interrupt () |
+ | Return from a blocking read immediately and throw boost::thread_interrupted. More...
|
+ |
diff --git a/ChimeraTK-DeviceAccess/head/html/class_chimera_t_k_1_1_one_d_register_accessor.html b/ChimeraTK-DeviceAccess/head/html/class_chimera_t_k_1_1_one_d_register_accessor.html
index a392b58470b..91b3817fd2d 100644
--- a/ChimeraTK-DeviceAccess/head/html/class_chimera_t_k_1_1_one_d_register_accessor.html
+++ b/ChimeraTK-DeviceAccess/head/html/class_chimera_t_k_1_1_one_d_register_accessor.html
@@ -286,6 +286,9 @@
DataValidity | dataValidity () const |
| Return current validity of the data. More...
|
|
+void | interrupt () |
+ | Return from a blocking read immediately and throw boost::thread_interrupted. More...
|
+ |
|
diff --git a/ChimeraTK-DeviceAccess/head/html/class_chimera_t_k_1_1_scalar_register_accessor-members.html b/ChimeraTK-DeviceAccess/head/html/class_chimera_t_k_1_1_scalar_register_accessor-members.html
index 60abbc3c08d..32edf518bd6 100644
--- a/ChimeraTK-DeviceAccess/head/html/class_chimera_t_k_1_1_scalar_register_accessor-members.html
+++ b/ChimeraTK-DeviceAccess/head/html/class_chimera_t_k_1_1_scalar_register_accessor-members.html
@@ -106,44 +106,45 @@
getUnit() const | ChimeraTK::TransferElementAbstractor | inline |
getValueType() const | ChimeraTK::TransferElementAbstractor | inline |
getVersionNumber() const | ChimeraTK::TransferElementAbstractor | inline |
- isInitialised() const | ChimeraTK::TransferElementAbstractor | inline |
- isReadable() const | ChimeraTK::TransferElementAbstractor | inline |
- isReadOnly() const | ChimeraTK::TransferElementAbstractor | inline |
- isWriteable() const | ChimeraTK::TransferElementAbstractor | inline |
- NDRegisterAccessorAbstractor()=default | ChimeraTK::NDRegisterAccessorAbstractor< UserType > | |
- NDRegisterAccessorAbstractor(const NDRegisterAccessorAbstractor &)=default | ChimeraTK::NDRegisterAccessorAbstractor< UserType > | |
- NDRegisterAccessorAbstractor(boost::shared_ptr< NDRegisterAccessor< UserType >> impl) | ChimeraTK::NDRegisterAccessorAbstractor< UserType > | explicitprotected |
- operator const ScalarRegisterAccessor< UserType, OTHER_TAG > &() const | ChimeraTK::ScalarRegisterAccessor< UserType, TAG > | inline |
- operator const UserType &() const | ChimeraTK::ScalarRegisterAccessor< UserType, TAG > | inline |
- operator ScalarRegisterAccessor< UserType, OTHER_TAG > &() | ChimeraTK::ScalarRegisterAccessor< UserType, TAG > | |
- operator UserType &() | ChimeraTK::ScalarRegisterAccessor< UserType, TAG > | inline |
- operator++() | ChimeraTK::ScalarRegisterAccessor< UserType, TAG > | inline |
- operator++(int) | ChimeraTK::ScalarRegisterAccessor< UserType, TAG > | |
- operator--() | ChimeraTK::ScalarRegisterAccessor< UserType, TAG > | inline |
- operator--(int) | ChimeraTK::ScalarRegisterAccessor< UserType, TAG > | |
- operator=(UserType rightHandSide) | ChimeraTK::ScalarRegisterAccessor< UserType, TAG > | |
- ChimeraTK::NDRegisterAccessorAbstractor::operator=(const NDRegisterAccessorAbstractor &rightHandSide) const =delete | ChimeraTK::NDRegisterAccessorAbstractor< UserType > | |
- read() | ChimeraTK::TransferElementAbstractor | inline |
- readAndGet() | ChimeraTK::ScalarRegisterAccessor< UserType, TAG > | |
- readLatest() | ChimeraTK::TransferElementAbstractor | inline |
- readNonBlocking() | ChimeraTK::TransferElementAbstractor | inline |
- replace(const NDRegisterAccessorAbstractor< UserType > &newAccessor) | ChimeraTK::NDRegisterAccessorAbstractor< UserType > | |
- replace(boost::shared_ptr< NDRegisterAccessor< UserType >> newImpl) | ChimeraTK::NDRegisterAccessorAbstractor< UserType > | |
- ChimeraTK::TransferElementAbstractor::replace(const TransferElementAbstractor &newAccessor) | ChimeraTK::TransferElementAbstractor | inline |
- ChimeraTK::TransferElementAbstractor::replace(boost::shared_ptr< TransferElement > newImpl) | ChimeraTK::TransferElementAbstractor | inline |
- replaceTransferElement(const boost::shared_ptr< TransferElement > &newElement) | ChimeraTK::TransferElementAbstractor | |
- ScalarRegisterAccessor(boost::shared_ptr< NDRegisterAccessor< UserType >> impl) | ChimeraTK::ScalarRegisterAccessor< UserType, TAG > | |
- ScalarRegisterAccessor() | ChimeraTK::ScalarRegisterAccessor< UserType, TAG > | |
- setAndWrite(UserType newValue, VersionNumber versionNumber={}) | ChimeraTK::ScalarRegisterAccessor< UserType, TAG > | |
- setAsCooked(COOKED_TYPE value) | ChimeraTK::ScalarRegisterAccessor< UserType, TAG > | |
- setDataValidity(DataValidity valid=DataValidity::ok) | ChimeraTK::TransferElementAbstractor | inline |
- setPersistentDataStorage(boost::shared_ptr< ChimeraTK::PersistentDataStorage > storage) | ChimeraTK::TransferElementAbstractor | |
- TransferElementAbstractor(boost::shared_ptr< TransferElement > impl) | ChimeraTK::TransferElementAbstractor | inlineexplicit |
- TransferElementAbstractor()=default | ChimeraTK::TransferElementAbstractor | |
- TransferGroup class | ChimeraTK::ScalarRegisterAccessor< UserType, TAG > | friend |
- write(ChimeraTK::VersionNumber versionNumber={}) | ChimeraTK::TransferElementAbstractor | inline |
- writeDestructively(ChimeraTK::VersionNumber versionNumber={}) | ChimeraTK::TransferElementAbstractor | inline |
- writeIfDifferent(UserType newValue, VersionNumber versionNumber=VersionNumber{nullptr}, DataValidity validity=DataValidity::ok) | ChimeraTK::ScalarRegisterAccessor< UserType, TAG > | |
+ interrupt() | ChimeraTK::TransferElementAbstractor | inline |
+ isInitialised() const | ChimeraTK::TransferElementAbstractor | inline |
+ isReadable() const | ChimeraTK::TransferElementAbstractor | inline |
+ isReadOnly() const | ChimeraTK::TransferElementAbstractor | inline |
+ isWriteable() const | ChimeraTK::TransferElementAbstractor | inline |
+ NDRegisterAccessorAbstractor()=default | ChimeraTK::NDRegisterAccessorAbstractor< UserType > | |
+ NDRegisterAccessorAbstractor(const NDRegisterAccessorAbstractor &)=default | ChimeraTK::NDRegisterAccessorAbstractor< UserType > | |
+ NDRegisterAccessorAbstractor(boost::shared_ptr< NDRegisterAccessor< UserType >> impl) | ChimeraTK::NDRegisterAccessorAbstractor< UserType > | explicitprotected |
+ operator const ScalarRegisterAccessor< UserType, OTHER_TAG > &() const | ChimeraTK::ScalarRegisterAccessor< UserType, TAG > | inline |
+ operator const UserType &() const | ChimeraTK::ScalarRegisterAccessor< UserType, TAG > | inline |
+ operator ScalarRegisterAccessor< UserType, OTHER_TAG > &() | ChimeraTK::ScalarRegisterAccessor< UserType, TAG > | |
+ operator UserType &() | ChimeraTK::ScalarRegisterAccessor< UserType, TAG > | inline |
+ operator++() | ChimeraTK::ScalarRegisterAccessor< UserType, TAG > | inline |
+ operator++(int) | ChimeraTK::ScalarRegisterAccessor< UserType, TAG > | |
+ operator--() | ChimeraTK::ScalarRegisterAccessor< UserType, TAG > | inline |
+ operator--(int) | ChimeraTK::ScalarRegisterAccessor< UserType, TAG > | |
+ operator=(UserType rightHandSide) | ChimeraTK::ScalarRegisterAccessor< UserType, TAG > | |
+ ChimeraTK::NDRegisterAccessorAbstractor::operator=(const NDRegisterAccessorAbstractor &rightHandSide) const =delete | ChimeraTK::NDRegisterAccessorAbstractor< UserType > | |
+ read() | ChimeraTK::TransferElementAbstractor | inline |
+ readAndGet() | ChimeraTK::ScalarRegisterAccessor< UserType, TAG > | |
+ readLatest() | ChimeraTK::TransferElementAbstractor | inline |
+ readNonBlocking() | ChimeraTK::TransferElementAbstractor | inline |
+ replace(const NDRegisterAccessorAbstractor< UserType > &newAccessor) | ChimeraTK::NDRegisterAccessorAbstractor< UserType > | |
+ replace(boost::shared_ptr< NDRegisterAccessor< UserType >> newImpl) | ChimeraTK::NDRegisterAccessorAbstractor< UserType > | |
+ ChimeraTK::TransferElementAbstractor::replace(const TransferElementAbstractor &newAccessor) | ChimeraTK::TransferElementAbstractor | inline |
+ ChimeraTK::TransferElementAbstractor::replace(boost::shared_ptr< TransferElement > newImpl) | ChimeraTK::TransferElementAbstractor | inline |
+ replaceTransferElement(const boost::shared_ptr< TransferElement > &newElement) | ChimeraTK::TransferElementAbstractor | |
+ ScalarRegisterAccessor(boost::shared_ptr< NDRegisterAccessor< UserType >> impl) | ChimeraTK::ScalarRegisterAccessor< UserType, TAG > | |
+ ScalarRegisterAccessor() | ChimeraTK::ScalarRegisterAccessor< UserType, TAG > | |
+ setAndWrite(UserType newValue, VersionNumber versionNumber={}) | ChimeraTK::ScalarRegisterAccessor< UserType, TAG > | |
+ setAsCooked(COOKED_TYPE value) | ChimeraTK::ScalarRegisterAccessor< UserType, TAG > | |
+ setDataValidity(DataValidity valid=DataValidity::ok) | ChimeraTK::TransferElementAbstractor | inline |
+ setPersistentDataStorage(boost::shared_ptr< ChimeraTK::PersistentDataStorage > storage) | ChimeraTK::TransferElementAbstractor | |
+ TransferElementAbstractor(boost::shared_ptr< TransferElement > impl) | ChimeraTK::TransferElementAbstractor | inlineexplicit |
+ TransferElementAbstractor()=default | ChimeraTK::TransferElementAbstractor | |
+ TransferGroup class | ChimeraTK::ScalarRegisterAccessor< UserType, TAG > | friend |
+ write(ChimeraTK::VersionNumber versionNumber={}) | ChimeraTK::TransferElementAbstractor | inline |
+ writeDestructively(ChimeraTK::VersionNumber versionNumber={}) | ChimeraTK::TransferElementAbstractor | inline |
+ writeIfDifferent(UserType newValue, VersionNumber versionNumber=VersionNumber{nullptr}, DataValidity validity=DataValidity::ok) | ChimeraTK::ScalarRegisterAccessor< UserType, TAG > | |
diff --git a/ChimeraTK-DeviceAccess/head/html/class_chimera_t_k_1_1_scalar_register_accessor.html b/ChimeraTK-DeviceAccess/head/html/class_chimera_t_k_1_1_scalar_register_accessor.html
index 3bc32e05975..48f37454d83 100644
--- a/ChimeraTK-DeviceAccess/head/html/class_chimera_t_k_1_1_scalar_register_accessor.html
+++ b/ChimeraTK-DeviceAccess/head/html/class_chimera_t_k_1_1_scalar_register_accessor.html
@@ -267,6 +267,9 @@
DataValidity | dataValidity () const |
| Return current validity of the data. More...
|
|
+void | interrupt () |
+ | Return from a blocking read immediately and throw boost::thread_interrupted. More...
|
+ |
|