IVI™ClassDriverHelpforLabVIEW™January2007Edition,PartNumber370036E-01ThishelpfilecontainstechnicalandprogrammingsupportforthefollowingNationalInstrumentsInterchangeableVirtualInstrumentsclassdrivers:IviDCPwr,IviDmm,IviFgen,IviPwrMeter,RFSigGen,IviScope,IviSpecAn,andIviSwtch.ThishelpfilealsodescribesthefundamentalandadvancedterminologyfortheseIVIclassdrivers.ThishelpfileisintendedforusebydeveloperswithaworkingknowledgeofLabVIEW.ClickontheIVIclass-driverlibraryyouwanttoreferto:
IviDCPwrPowerSupply
IviDmmDigitalMultimeter IviFgenFunctionGenerator IviPwrMeterPowerMeter
IviRFSigGenRFSignalGenerator
IviSpecAnSpectrumAnalyzer
IviScopeOscilloscope IviSwtchSwitch
Tonavigatethishelpfile,usetheContents,Index,andSearchtabstotheleftofthiswindow.Formoreinformationaboutthishelpfile,refertothefollowingtopics:Conventions—formattingandtypographicalconventionsinthishelpfileRelatedDocumentationImportantInformationTechnicalSupportandProfessionalServicesTocommentonNationalInstrumentsdocumentation,refertotheNationalInstrumentsWebsite.©2000–2007NationalInstrumentsCorporation.Allrightsreserved.
UsingHelpConventionsNavigatingHelpSearchingHelpPrintingHelpFileTopics
ConventionsThishelpfileusesthefollowingconventions:
<> Anglebracketsthatcontainnumbersseparatedbyanellipsisrepresentarangeofvaluesassociatedwithabitorsignalname—forexample,DBIO<3..0>.
» The»symbolleadsyouthroughnestedmenuitemsanddialogboxoptionstoafinalaction.ThesequenceFile»PageSetup»OptionsdirectsyoutopulldowntheFilemenu,selectthePageSetupitem,andselectOptionsfromthelastdialogbox.Thisicondenotesanote,whichalertsyoutoimportantinformation.
bold Boldtextdenotesitemsthatyoumustselectorclickoninthesoftware,suchasmenuitemsanddialogboxoptions.Boldtextalsodenotesparameternames,emphasis,oranintroductiontoakeyconcept.
green Underlinedtextinthiscolordenotesalinktoahelptopic,helpfile,orWebaddress.
italic Italictextdenotesvariablesorcrossreferences.Thisfontalsodenotestextthatisaplaceholderforawordorvaluethatyoumustsupply.
monospace Textinthisfontdenotestextorcharactersthatyoushouldenterfromthekeyboard,sectionsofcode,programmingexamples,andsyntaxexamples.Thisfontisalsousedforthepropernamesofdiskdrives,paths,directories,programs,subprograms,subroutines,devicenames,functions,operations,variables,filenamesandextensions,andcodeexcerpts.
monospacebold
Boldtextinthisfontdenotesthemessagesandresponsesthatthecomputerautomaticallyprintstothescreen.Thisfontalsoemphasizeslinesofcodethataredifferentfromtheotherexamples.
NavigatingHelp(WindowsOnly)Tonavigatethishelpfile,usetheContents,Index,andSearchtabstotheleftofthiswindoworusethefollowingtoolbarbuttonslocatedabovethetabs:
Hide—Hidesthenavigationpanefromview.Locate—LocatesthecurrentlydisplayedtopicintheContentstab,allowingyoutoviewrelatedtopics.Back—Displaysthepreviouslyviewedtopic.Forward—DisplaysthetopicyouviewedbeforeclickingtheBackbutton.Options—Displaysalistofcommandsandviewingoptionsforthehelpfile.
PrintingHelpFileTopics(WindowsOnly)CompletethefollowingstepstoprintanentirebookfromtheContentstab:
1. Right-clickthebook.2. SelectPrintfromtheshortcutmenutodisplaythePrintTopics
dialogbox.3. SelectthePrinttheselectedheadingandallsubtopicsoption.
NoteSelectPrinttheselectedtopicifyouwanttoprintthesingletopicyouhaveselectedintheContentstab.
4. ClicktheOKbutton.
PrintingPDFDocumentsThishelpfilemaycontainlinkstoPDFdocuments.ToprintPDFdocuments,clicktheprintbuttonlocatedontheAdobeAcrobatViewertoolbar.
SearchingHelp(WindowsOnly)UsetheSearchtabtotheleftofthiswindowtolocatecontentinthishelpfile.Ifyouwanttosearchforwordsinacertainorder,suchas"relateddocumentation,"addquotationmarksaroundthesearchwordsasshownintheexample.SearchingfortermsontheSearchtaballowsyoutoquicklylocatespecificinformationandinformationintopicsthatarenotincludedontheContentstab.
WildcardsYoualsocansearchusingasterisk(*)orquestionmark(?)wildcards.Usetheasteriskwildcardtoreturntopicsthatcontainacertainstring.Forexample,asearchfor"prog*"liststopicsthatcontainthewords"program,""programmatically,""progress,"andsoon.Usethequestionmarkwildcardasasubstituteforasinglecharacterinasearchterm.Forexample,"?ext"liststopicsthatcontainthewords"next,""text,"andsoon.
NoteWildcardsearchingwillnotworkonSimplifiedChinese,TraditionalChinese,Japanese,andKoreansystems.
NestedExpressionsUsenestedexpressionstocombinesearchestofurtherrefineasearch.YoucanuseBooleanexpressionsandwildcardsinanestedexpression.Forexample,"exampleAND(programORVI)"liststopicsthatcontain"exampleprogram"or"exampleVI."Youcannotnestexpressionsmorethanfivelevels.
BooleanExpressionsClickthe buttontoaddBooleanexpressionstoasearch.ThefollowingBooleanoperatorsareavailable:
AND(default)—Returnstopicsthatcontainbothsearchterms.Youdonotneedtospecifythisoperatorunlessyouareusingnestedexpressions.OR—Returnstopicsthatcontaineitherthefirstorsecondterm.NOT—Returnstopicsthatcontainthefirsttermwithoutthesecondterm.NEAR—Returnstopicsthatcontainbothtermswithineightwordsofeachother.
SearchOptions
UsethefollowingcheckboxesontheSearchtabtocustomizeasearch:Searchpreviousresults—Narrowstheresultsfromasearchthatreturnedtoomanytopics.Youmustremovethecheckmarkfromthischeckboxtosearchalltopics.Matchsimilarwords—Broadensasearchtoreturntopicsthatcontainwordssimilartothesearchterms.Forexample,asearchfor"program"liststopicsthatincludethewords"programs,""programming,"andsoon.Searchtitlesonly—Searchesonlyinthetitlesoftopics.
IVIClassDriverHelpforLabVIEWOverviewThishelpfilecontainstechnicalandprogrammingsupportforthefollowingNationalInstrumentsInterchangeableVirtualInstrumentsclassdrivers:IviDCPwr,IviDmm,IviFgen,IviPwrMeter,RFSigGen,IviScope,IviSpecAn,andIviSwtch.ThisbookalsodescribesthefundamentalandadvancedterminologyfortheseIVIclassdrivers.ThetopicsincludedinthisbookareintendedforusebydeveloperswithaworkingknowledgeofLabVIEW.ClickontheIVIclass-driverlibraryyouwanttoreferto:
IviDCPwrPowerSupply
IviDmmDigitalMultimeter
IviFgenFunctionGenerator
IviPwrMeterPowerMeter
IviRFSigGenRFSignalGenerator
IviSpecAnSpectrumAnalyzer
IviScopeOscilloscope
IviSwtchSwitch
RelatedDocumentationThefollowingdocumentscontaininformationthatyoumightfindhelpfulasyouusethishelpfile:
ApplicationNotes—Alibrarywithmorethan100shortpapersaddressingspecifictopicssuchascreatingandcallingDLLs,developingyourowninstrumentdriversoftware,andportingapplicationsbetweenplatformsandoperatingsystems.Measurement&AutomationExplorerHelpforIVI—ThishelpfilediscusseshowtoconfigureyoursystemwithMAX.LabWindows/CVIInstrumentDriverDevelopersGuide—ThisdocumentdescribesguidelinesforwritinganIVIinstrumentdriver.Todownloadandusethisdocument,clickni.com/manuals,andsearchfortheLabWindows/CVIInstrumentDriverDevelopersGuide.IVIFoundation—ThiswebsiteprovidesinformationfromtheIVIFoundation,includingthespecificationsforeachinstrumentclass.
SampleProgramsTheIVIsampleprogramsforLabVIEWarelocatedintheLabVIEW\examples\instr\IviClass.llbdirectory.Thesampleprogramsarebasicexamplesofclassdriveroperations.Eachexampleallowsyoutointeractivelyconfigurethedevice.Someofthefrontpaneldefaultsettingsmightnotapplytoallinstruments.RefertotheVIandcontrolhelpofthespecificinstrumentdriverforadescriptionofvalidvaluesforyourinstrument.
IVIInherentCapabilitiesExpandthistopictoviewinherentVIsandProperties.
IVIInherentClassCapabilitiesOverviewThissectioncontainsinformationanddescriptionsforinherentdriverVIsthatallclassdriverssupport.ScrolldownforinformationaboutclassdriverinherentVIs.YoucancallanyoftheseinherentVIs.
IVIInherentVIsClass/PanelName VINameInitialize/CloseVIsInitialize ClassPrefixInitialize
InitializewithOptions ClassPrefixInitializeWithOptions
Close ClassPrefixClose
PropertyAccessInvalidateAllAttributes ClassPrefixInvalidateAllAttributes
ChannelAccessGetChannelName ClassPrefixGetChannelName
UtilityVIsReset ClassPrefixResetResetWithDefaults ClassPrefixResetWithDefaultsSelf-Test ClassPrefixSelf-Test
Disable ClassPrefixDisableRevisionQuery ClassPrefixRevisionQueryError-Query ClassPrefixError-QueryErrorMessage ClassPrefixErrorMessageCoercionGetNextCoercionRecord ClassPrefixGetNextCoercionRecordInterchangeabilityCheckingGetNextInterchangeWarning
ClassPrefixGetNextInterchangeWarning
ResetInterchangeCheck ClassPrefixResetInterchangeCheckClearInterchangeWarnings ClassPrefixClearInterchangeWarnings
RelatedTopicsIVIInherentPropertiesIVIStatusCodes
ClassPrefixClearInterchangeWarningsIVIInherentFunctionToformtheClassPrefixVIname,usetheprefixoftheclassdriverthatyouareworkingwith.Forexample,ifyouareworkingwiththeIviDmmclassdriver,usetheprefixIviDmmtocreatethecorrectVIname,IviDmmClearInterchangeWarnings.TheclassdriverperformsinterchangeabilitycheckingiftheClassPrefixInterchangeCheckpropertyissettoTRUE.ThisVIclearsthelistofcurrentinterchangewarnings.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheClassPrefixInitializeorClassPrefixInitializeWithOptionsVI.Thehandleidentifiesaparticularinstrumentsession.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheClassPrefixInitializeorClassPrefixInitializeWithOptionsVI.Thehandleidentifiesaparticularinstrumentsession.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
ClassPrefixCloseIVIInherentFunctionToformtheClassPrefixVIname,usetheprefixoftheclassdriverthatyouareworkingwith.Forexample,ifyouareworkingwiththeIviDmmclassdriver,usetheprefixIviDmmtocreatethecorrectVIname,IviDmmClose.
ThisVIperformsthefollowingoperations:
ClosestheinstrumentI/Osession.Destroystheinstrumentdriversessionandallofitsproperties.Deallocatesanymemoryresourcesthedriveruses.
NoteAftercallingClassPrefixClose,youcannotusetheinstrumentdriveragainuntilyoucallClassPrefixInitialize.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheClassPrefixInitializeorClassPrefixInitializeWithOptionsVI.Thehandleidentifiesaparticularinstrumentsession.errorin(noerror)UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
ClassPrefixDisableIVIInherentFunctionToformtheClassPrefixVIname,usetheprefixoftheclassdriverthatyouareworkingwith.Forexample,ifyouareworkingwiththeIviDmmclassdriver,usetheprefixIviDmmtocreatethecorrectVIname,IviDmmDisable.
ThisVIplacestheinstrumentinaquiescentstatewhereithasminimalornoimpactonthesystemtowhichitisconnected.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheClassPrefixInitializeorClassPrefixInitializeWithOptionsVI.Thehandleidentifiesaparticularinstrumentsession.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheClassPrefixInitializeorClassPrefixInitializeWithOptionsVI.Thehandleidentifiesaparticularinstrumentsession.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
ClassPrefixErrorMessageIVIInherentFunctionToformtheClassPrefixVIname,usetheprefixoftheclassdriverthatyouareworkingwith.Forexample,ifyouareworkingwiththeIviDmmclassdriver,usetheprefixIviDmmtocreatethecorrectVIname,IviDmmErrorMessage.ThisVIconvertsastatuscodereturnedbyaninstrumentdriverintoauser-readablestring.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheClassPrefixInitializeorClassPrefixInitializeWithOptionsVI.Thehandleidentifiesaparticularinstrumentsession.ErrorCodePasstheStatusparameterthatisreturnedfromanyoftheinstrumentdriverVIs.DefaultValue:0(Noerror)
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheClassPrefixInitializeorClassPrefixInitializeWithOptionsVI.Thehandleidentifiesaparticularinstrumentsession.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
ErrorMessageReturnsareadablemessagestringtoyouthat
correspondstothestatuscodeyouspecify.
ClassPrefixError-QueryIVIInherentFunctionToformtheClassPrefixVIname,usetheprefixoftheclassdriverthatyouareworkingwith.Forexample,ifyouareworkingwiththeIviDmmclassdriver,usetheprefixIviDmmtocreatethecorrectVIname,IviDmmError-Query.
ThisVIqueriestheinstrumentandreturnstheinstrumentspecificerrorinformation.Generally,youcallthisVIafteranotherVIintheinstrumentdriverreturnstheIVI_ERROR_INSTRUMENT_STATUS(0xBFFA0001)errorcode.Thedriverreturnsthiserrorcodewhentheinstrument'sstatusregisterindicatesthattheinstrument'serrorqueueisnotempty.TheClassPrefixErrorQueryVIextractsthefirsterroroutoftheinstrument'serrorqueue.Forinstrumentsthathavestatusregistersbutnoerrorqueue,thedriversimulatesanerrorqueueinsoftware.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheClassPrefixInitializeorClassPrefixInitializeWithOptionsVI.Thehandleidentifiesaparticularinstrumentsession.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheClassPrefixInitializeorClassPrefixInitializeWithOptionsVI.Thehandleidentifiesaparticularinstrumentsession.errorcodeReturnstheerrorcodereadfromtheinstrument'serrorqueue.
errormessageReturnstheerrormessagestringreadfromtheinstrument'serrormessagequeue.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
ClassPrefixGetChannelNameIVIInherentFunctionToformtheClassPrefixVIname,usetheprefixoftheclassdriverthatyouareworkingwith.Forexample,ifyouareworkingwiththeIviDmmclassdriver,usetheprefixIviDmmtocreatethecorrectVIname,IviDmmGetChannelName.
ThisVIreturnsthespecificdriverdefinedchannelnamethatcorrespondstotheone-basedindexthatyouspecify.IfthevalueyoupassfortheIndexparameterislessthanoneorgreaterthanthevalueoftheChannelCountproperty,thisVIreturnsanemptystringintheNameparameterandreturnsanerror.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheClassPrefixInitializeorClassPrefixInitializeWithOptionsVI.Thehandleidentifiesaparticularinstrumentsession.index(1)Aone-basedindexthatdefineswhichnametoreturn.TheindexmustbelessthanorequaltotheClassPrefixChannelCountproperty.instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheClassPrefixInitializeorClassPrefixInitializeWithOptionsVI.Thehandleidentifiesaparticularinstrumentsession.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
outputchannelnameReturnsthenameoftheChannelspecifiedbytheindexparameter.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.
Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
ClassPrefixGetNextCoercionRecordIVIInherentFunctionToformtheClassPrefixVIname,usetheprefixoftheclassdriverthatyouareworkingwith.Forexample,ifyouareworkingwiththeIviDmmclassdriver,usetheprefixIviDmmtocreatethecorrectVIname,IviDmmGetNextCoercionRecord.
ThisVIobtainsthecoercioninformationassociatedwiththeIVIsession.Itretrievesandclearstheoldestinstanceinwhichthespecificdrivercoercedavalueyouspecifiedtoanothervalue.IfyousettheClassPrefixRecordValueCoercionspropertytoTRUE,thespecificdriverkeepsalistofallcoercionsitmakesonViInt32orViReal64valuesyoupasstoinstrumentdriverVIs.YouusethisVItoretrieveinformationfromthatlist.TheVIreturnsanemptystringintheCoercionRecordparameterifnocoercionrecordsremainforthesession.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheClassPrefixInitializeorClassPrefixInitializeWithOptionsVI.Thehandleidentifiesaparticularinstrumentsession.
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheClassPrefixInitializeorClassPrefixInitializeWithOptionsVI.Thehandleidentifiesaparticularinstrumentsession.
coercionrecordReturnsthenextcoercionrecordfortheIVIsession.Iftherearenocoercionrecords,theVIreturnsanemptystring.
erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
ClassPrefixGetNextInterchangeWarningIVIInherentFunctionToformtheClassPrefixVIname,usetheprefixoftheclassdriverthatyouareworkingwith.Forexample,ifyouareworkingwiththeIviDmmclassdriver,usetheprefixIviDmmtocreatethecorrectVIname,IviDmmGetNextInterchangeWarning.
ThisVIreturnstheinterchangeabilitywarningsassociatedwiththeIVIsession.Itretrievesandclearstheoldestinstanceinwhichtheclassdriverrecordedaninterchangeabilitywarning.Interchangeabilitywarningsindicatethatusingyourapplicationwithadifferentinstrumentmightcausedifferentbehavior.UsethisVItoretrieveinterchangeabilitywarnings.Alternately,youmayuseNISpytoviewinterchangeabilitywarnings.Interchangeabilitycheckingexaminesthepropertiesinacapabilitygrouponlyifyouspecifyavalueforatleastonepropertywithinthatgroup.Ingeneral,theclassdrivergeneratesinterchangeabilitywarningswhenitencountersoneofthefollowingconditions:
Apropertythataffectsthebehavioroftheinstrumentisinastatethatyoudidnotspecify.Yousetaclass-definedpropertytoaninstrumentspecificvalue.Yousetthevalueofapropertythattheclassdriverdefinesasread-only.Theclassdriverencountersanerrorwhenittriestoapplyavaluetoanextensionpropertythatyourprogramneverconfigures.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheClassPrefixInitializeorClassPrefixInitializeWithOptionsVI.Thehandleidentifiesaparticularinstrumentsession.
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheClassPrefixInitializeorClassPrefixInitializeWithOptionsVI.Thehandleidentifiesaparticularinstrumentsession.interchangewarningReturnsthenextinterchangewarningfortheIVIsession.Iftherearenointerchangewarnings,thisparameterreturnsanemptystring.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
RelatedTopics
InterchangeabilityChecking
ClassPrefixInitializeIVIInherentFunctionToformtheClassPrefixVIname,usetheprefixoftheclassdriverthatyouareworkingwith.Forexample,ifyouareworkingwiththeIviDmmclassdriver,usetheprefixIviDmmtocreatethecorrectVIname,IviDmmInitializeWithOptions.
ThisVIperformsthefollowinginitializationactions:
CreatesanewIVIinstrumentdriversession.OpensasessiontothespecifieddeviceusingtheinterfaceandaddressyouspecifyfortheResourceNameparameter.IftheIDQueryparameterissettoTRUE,thisVIqueriestheinstrumentIDandchecksthatitisvalidforthisinstrumentdriver.IftheResetparameterissettoTRUE,thisVIresetstheinstrumenttoaknownstate.Sendsinitializationcommandstosettheinstrumenttothestatenecessaryfortheoperationoftheinstrumentdriver.ReturnsaninstrumenthandlethatyouusetoidentifytheinstrumentinallsubsequentinstrumentdriverVIcalls.
NoteThisVIcreatesanewsessioneachtimeyouinvokeit.AlthoughyoucanopenmorethanoneIVIsessionforthesameresource,itisbestnottodoso.Youcanusethesamesessioninmultipleprogramthreads.CautionAllIVInames,suchaslogicalnamesorvirtualnames,arecase-sensitive.Ifyouuselogicalnames,driversessionnames,orvirtualnamesinyourprogram,youmustmakesurethatthenameyouusematchesthenameintheIVIConfigurationStorefileexactly,withoutanyvariationsinthecaseofthecharactersinthename.logicalname("SampleFGen")Passesthelogicalnamethat
identifiestheparticulardriversessiontouse.Thedriversession,inturn,identifiesaspecificdriveranddeviceandspecifiestheinitialsettingsforthesession.Youconfigurethelogicalname,driversession,specificdriver,andhardwareassetwithMAX.Ifyouwanttouseyourprogramwithadifferentphysicalinstrument,youchangetheconfigurationofthelogicalnametousethedriversessionforthenewphysicalinstrument.Youcanchangetheinitialsettingsforthesessionbychangingtheconfigurationofthedriversession.DefaultValues:"SampleScope"forIviScope"SampleDmm"forIviDmm"SamplePower"forIviDCPwr"SampleSwitch"forIviSwtch"SampleFgen"forIviFgen
idquery(true)SpecifywhetheryouwanttheinstrumentdrivertoperformanIDQuery.
ValidRange:TRUE(1)PerformIDQuery(DefaultValue)FALSE(0)SkipIDQueryWhenyousetthisparametertoTRUE,thedriververifiesthattheinstrumentyouinitializeisatypethatthisdriversupports.CircumstancescanarisewhereitisundesirabletosendanIDQuerycommandstringtotheinstrument.WhenyousetthisparametertoFALSE,theVIinitializestheinstrumentwithoutperforminganIDQuery.
resetdevice(true)Specifywhetheryouwantthetoresettheinstrumentduringtheinitializationprocedure.
ValidRange:TRUE(1)ResetDevice(DefaultValue)FALSE(0)Don'tReset
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.instrumenthandleoutTheinstrumentdriverthatyouusetoidentifytheinstrumentinallsubsequentinstrumentdriverVIcalls.Note
1. TheInitializeVIcreatesanewsessioneachtimeyouinvokeit.Thisisusefulifyouhavemultiplephysicalinstancesofthesametypeofinstrument.
2. Avoidcreatingmultipleconcurrentinstrumenthandlestothesamephysicalinstrument.Althoughyoucancreatemorethanoneinstrumentdriverhandleforthesameresource,itisbestnottodoso.
erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
ClassPrefixInitializeWithOptionsIVIInherentFunctionToformtheClassPrefixVIname,usetheprefixoftheclassdriverthatyouareworkingwith.Forexample,ifyouareworkingwiththeIviDmmclassdriver,usetheprefixIviDmmtocreatethecorrectVIname,IviDmmInitializeWithOptions.Details.
logicalname("SampleScope")Passesthelogicalnamethatidentifiestheparticulardriversessiontouse.Thedriversession,inturn,identifiesaspecificdriveranddeviceandspecifiestheinitialsettingsforthesession.Youconfigurethelogicalname,driversession,specificdriver,andhardwareassetwithMAX.Ifyouwanttouseyourprogramwithadifferentphysicalinstrument,youchangetheconfigurationofthelogicalnametousethedriversessionforthenewphysicalinstrument.Youcanchangetheinitialsettingsforthesessionbychangingtheconfigurationofthedriversession.DefaultValues:"SampleScope"forIviScope"SampleDmm"forIviDmm"SamplePower"forIviDCPwr"SampleSwitch"forIviSwtch"SampleFgen"forIviFgen
idquery(True)SpecifywhetheryouwanttheinstrumentdrivertoperformanIDQuery.ValidRange:TRUE(1)—PerformIDQuery(DefaultValue)FALSE(0)—SkipIDQueryWhenyousetthisparametertoTRUE,thedriververifiesthattheinstrumentyou
initializeisatypethatthisdriversupports.CircumstancescanarisewhereitisundesirabletosendanIDQuerycommandstringtotheinstrument.WhenyousetthisparametertoFALSE,theVIinitializestheinstrumentwithoutperforminganIDQuery.
resetdevice(True)Specifywhetheryouwantthetoresettheinstrumentduringtheinitializationprocedure.ValidRange:TRUE(1)—ResetDevice(DefaultValue)FALSE(0)—DonotReset
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
optionstring("Simulate=0,RangeCheck=0,QueryInstrStatus=0,Cache=1,InterchangeCheck=0")Youcanusethisparametertosettheinitialvalueofcertainpropertiesforthesession.Thefollowingtableliststhenameandthepropertiesyouuseinthisparametertoidentifytheproperty.
Name PropertyRangeCheck CLASSPREFIX_ATTR_RANGE_CHECKQueryInstrStatus CLASSPREFIX_ATTR_QUERY_INSTRUMENT_STATUSCache CLASSPREFIX_ATTR_CACHESimulate CLASSPREFIX_ATTR_SIMULATERecordCoercions CLASSPREFIX_ATTR_RECORD_COERCIONSInterchangeCheck CLASSPREFIX_ATTR_INTERCHANGE_CHECK
Theformatofthisstringis,"PropertyName=Value"wherePropertyNameisthenameofthepropertyandValueisthevaluetowhichthepropertywillbeset.Tosetmultipleproperties,separatetheirassignmentswithacomma.IfyoupassNULLoranemptystringforthisparameter,thesessionusesthedefaultvaluesfortheproperties.Youcanoverridethedefaultvaluesbyassigningavalueexplicitlyinastringyoupassforthisparameter.You
donothavetospecifyallofthepropertiesandmayleaveanyofthemout.Ifyoudonotspecifyoneoftheproperties,itsdefaultvaluewillbeused.Thedefaultvaluesforthepropertiesareshownbelow:
Name DefaultValueRangeCheck TRUEQueryInstrStatus FALSECache TRUESimulate FALSERecordCoercions FALSEInterchangeCheck FALSEDriverSetup ""
ThefollowingarevalidvaluesforViBooleanproperties:
True: 1,TRUE,orTRUEFalse: 0,False,orFALSEDefaultValue: ""
Anexampleoptionstring:"Simulate=0,RangeCheck=1,QueryInstStatus=0,Cache=1,Spy=0,InterchangeCheck=0"
NoteSpyingonIVIAPIcallswithinNI-SpyisafeaturethatisonlyavailableifyouhaveNI-Spyinstalledonyoursystem.NI-SpyisinstalledwithseveralNIsoftwarepackages.
instrumenthandleoutTheinstrumentdriverthatyouusetoidentifytheinstrumentinallsubsequentinstrumentdriverVIcalls.
Notes
1. ThisVIcreatesanewsessioneachtimeyouinvokeit,whichisusefulifyouhavemultiplephysicalinstancesofthesametypeofinstrument.
2. Avoidcreatingmultipleconcurrentinstrumenthandlestothesamephysicalinstrument.Althoughyoucancreatemorethanoneinstrumentdriverhandleforthesameresource,itisbestnottodoso.
erroroutTheerroroutclusterpasseserrororwarninginformation
outofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
ClassPrefixInitializeWithOptionsDetailsThisVIperformsthefollowinginitializationactions:
CreatesanewIVIinstrumentdriversession.OpensasessiontothespecificdriverusingthelogicalnameoftheIVIvirtualinstrument.IftheIDQueryparameterissettoTRUE,thisVIqueriestheinstrumentIDandchecksthatitisvalidforthisinstrumentdriver.IftheResetparameterissettoTRUE,thisVIresetstheinstrumenttoaknownstate.Sendsinitializationcommandstosettheinstrumenttothestatenecessaryfortheoperationoftheinstrumentdriver.ReturnsaninstrumenthandlethatyouusetoidentifytheinstrumentinallsubsequentinstrumentdriverVIcalls.
NoteThisVIcreatesanewsessioneachtimeyouinvokeit.AlthoughyoucanopenmorethanoneIVIsessionforthesameresource,itisbestnottodoso.Youcanusethesamesessioninmultipleprogramthreads.CautionAllIVInames,suchaslogicalnamesorvirtualnames,arecase-sensitive.Ifyouuselogicalnames,driversessionnames,orvirtualnamesinyourprogram,youmustmakesurethatthenameyouusematchesthenameintheIVIConfigurationStorefileexactly,withoutanyvariationsinthecaseofthecharactersinthename.
ClassPrefixInvalidateAllAttributesIVIInherentFunctionToformtheClassPrefixVIname,usetheprefixoftheclassdriverthatyouareworkingwith.Forexample,ifyouareworkingwiththeIviDmmclassdriver,usetheprefixIviDmmtocreatethecorrectVIname,IviDmmInvalidateAllAttributes.
ThisVIinvalidatesthecachedvaluesofallpropertiesforthesession.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheClassPrefixInitializeorClassPrefixInitializeWithOptionsVI.Thehandleidentifiesaparticularinstrumentsession.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheClassPrefixInitializeorClassPrefixInitializeWithOptionsVI.Thehandleidentifiesaparticularinstrumentsession.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
ClassPrefixResetIVIInherentFunctionToformtheClassPrefixVIname,usetheprefixoftheclassdriverthatyouareworkingwith.Forexample,ifyouareworkingwiththeIviDmmclassdriver,usetheprefixIviDmmtocreatethecorrectVIname,IviDmmReset.
ThisVIresetstheinstrumenttoaknownstateandsendsinitializationcommandstotheinstrument.TheinitializationcommandssetinstrumentsettingssuchasHeadersOff,ShortCommandform,andDataTransferBinarytothestatenecessaryfortheoperationoftheinstrumentdriver.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheClassPrefixInitializeorClassPrefixInitializeWithOptionsVI.Thehandleidentifiesaparticularinstrumentsession.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheClassPrefixInitializeorClassPrefixInitializeWithOptionsVI.Thehandleidentifiesaparticularinstrumentsession.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
ClassPrefixResetInterchangeCheckIVIInherentFunctionToformtheClassPrefixVIname,usetheprefixoftheclassdriverthatyouareworkingwith.Forexample,ifyouareworkingwiththeIviDmmclassdriver,usetheprefixIviDmmtocreatethecorrectVIname,IviDmmResetInterchangeCheck.Details.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheClassPrefixInitializeorClassPrefixInitializeWithOptionsVI.Thehandleidentifiesaparticularinstrumentsession.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheClassPrefixInitializeorClassPrefixInitializeWithOptionsVI.Thehandleidentifiesaparticularinstrumentsession.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
ClassPrefixResetInterchangeCheckDetailsWhendevelopingacomplextestsystemthatconsistsofmultipletestmodules,itisgenerallyagoodideatodesignthetestmodulessothat
theycanruninanyorder.Todosorequiresensuringthateachtestmodulecompletelyconfiguresthestateofeachinstrumentituses.Ifaparticulartestmoduledoesnotcompletelyconfigurethestateofaninstrument,thestateoftheinstrumentdependsontheconfigurationfromapreviouslyexecutedtestmodule.Ifyouexecutethetestmodulesinadifferentorder,thebehavioroftheinstrumentandthereforetheentiretestmoduleislikelytochange.Thischangeinbehaviorisgenerallyinstrumentspecificdriverandrepresentsaninterchangeabilityproblem.YoucanusethisVItotestforsuchcases.AfteryoucallthisVI,theinterchangeabilitycheckingalgorithmsinthespecificdriverignoreallpreviousconfigurationoperations.BycallingthisVIatthebeginningofatestmodule,youcandeterminewhetherthetestmodulehasdependenciesontheoperationofpreviouslyexecutedtestmodules.ThisVIdoesnotcleartheinterchangeabilitywarningsfromthelistofpreviouslyrecordedinterchangeabilitywarnings.IfyouwanttoguaranteethattheClassPrefixGetNextInterchangeWarningVIonlyreturnsthoseinterchangeabilitywarningsthataregeneratedaftercallingthisVI,youmustclearthelistofinterchangeabilitywarnings.YoucancleartheinterchangeabilitywarningslistbyrepeatedlycallingtheClassPrefixGetNextInterchangeWarningVIuntilnomoreinterchangeabilitywarningsarereturned.Ifyouarenotinterestedinthecontentofthosewarnings,youcancalltheClassPrefixClearInterchangeWarningsVI.
ClassPrefixResetWithDefaultsIVIInherentFunctionToformtheClassPrefixVIname,usetheprefixoftheclassdriverthatyouareworkingwith.Forexample,ifyouareworkingwiththeIviDmmclassdriver,usetheprefixIviDmmtocreatethecorrectVIname,IviDmmResetWithDefaults.
ThisVIresetstheinstrumentandappliesinitialuser-specifiedsettingsfromtheLogicalNamewhichwasusedtoinitializethesession.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheClassPrefixInitializeorClassPrefixInitializeWithOptionsVI.Thehandleidentifiesaparticularinstrumentsession.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheClassPrefixInitializeorClassPrefixInitializeWithOptionsVI.Thehandleidentifiesaparticularinstrumentsession.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
ClassPrefixRevisionQueryIVIInherentFunctionToformtheClassPrefixVIname,usetheprefixoftheclassdriverthatyouareworkingwith.Forexample,ifyouareworkingwiththeIviDmmclassdriver,usetheprefixIviDmmtocreatethecorrectVIname,IviDmmRevisionQuery.
Obtainsthefollowinginformation:
Therevisionoftheinstrumentdriver.Thefirmwarerevisionoftheinstrumentyouarecurrentlyusing
instrumenthandleTheinstrumenthandlethatyouobtainfromtheClassPrefixInitializeorClassPrefixInitializeWithOptionsVI.Thehandleidentifiesaparticularinstrumentsession.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheClassPrefixInitializeorClassPrefixInitializeWithOptionsVI.Thehandleidentifiesaparticularinstrumentsession.instrumentdriverrevisionReturnstheinstrumentdriversoftwarerevisionnumbersintheformofastring.firmwarerevisionReturnstheinstrumentfirmwarerevisionnumbersintheformofastring.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.
Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
ClassPrefixSelf-TestIVIInherentFunctionToformtheClassPrefixVIname,usetheprefixoftheclassdriverthatyouareworkingwith.Forexample,ifyouareworkingwiththeIviDmmclassdriver,usetheprefixIviDmmtocreatethecorrectVIname,IviDmmSelf-Test.
ThisVIrunstheinstrument'sself-testroutineandreturnsthetestresult(s).
instrumenthandleTheinstrumenthandlethatyouobtainfromtheClassPrefixInitializeorClassPrefixInitializeWithOptionsVI.Thehandleidentifiesaparticularinstrumentsession.
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheClassPrefixInitializeorClassPrefixInitializeWithOptionsVI.Thehandleidentifiesaparticularinstrumentsession.selftestresultThiscontrolcontainsthevaluereturnedfromtheinstrumentselftest.Zeromeanssuccess.Foranyothercode,refertothedevice'soperatormanual.Numericresultfromself-testoperation:0=noerror(testpassed)non-zero=testfailed
self-testmessageReturnstheself-testresponsestringfromthe
instrument.Refertothedevice'sdocumentationforanexplanationofthestring'scontents.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
InherentPropertiesNoteYouaccesspropertiesthroughtheLabVIEWPropertyNode.
IVIInherentPropertiesAdvancedSessionInformationLogicalNameResourceDescriptorDriverSetup
ClassDriverIdentificationDescriptionPrefixVendorRevisionSpecificationMajorVersionSpecificationMinorVersion
InstrumentIdentificationManufacturerModelFirmwareRevision
SpecificDriverCapabilitiesSupportedInstrumentModelsGroupCapabilitiesFunctionCapabilitiesChannelCount
SpecificDriverIdentificationDescriptionLocatorPrefixRevisionMajorVersionMinorVersion
VendorUserOptionsRangeCheckQueryInstrumentStatusCacheSimulateRecordValueCoercionsInterchangeCheckSpyUseSpecificSimulation
ClassPrefixAttributeCapabilitiesInherentPropertyDataType Access Appliesto Coercion HighLevelFunctions
RO N/A None None
DescriptionThispropertyisacomma-separatedstringthatidentifiestheclasspropertiesthatthespecificinstrumentdriverimplements.PropertyNodePathClassPrefix»InherentIVISettings»SpecificDriverCapabilities»AttributeCapabilities
ClassPrefixCacheInherentPropertyDataType Access Appliesto Coercion HighLevelFunctions
R/W N/A None None
DescriptionSpecifieswhethertocachethevalueofproperties.Whencachingisenabled,thespecificdriverkeepstrackofthecurrentinstrumentsettingssothatitcanavoidsendingredundantcommandstotheinstrument.Statecachingcansignificantlyincreaseexecutionspeed.Youspecifyavalueforthispropertyfortheentireinstrumentdriver.However,thespecificdrivercanoverridethisvalueforaparticularproperty.PropertyNodePathClassPrefix»InherentIVISettings»UserOptions»ClassCache
ClassPrefixChannelCountInherentPropertyDataType Access Appliesto Coercion HighLevelFunctions
RO N/A None None
DescriptionReturnsthenumberofavailablechannels.PropertyNodePathClassPrefix»InherentIVISettings»UserOptions»ChannelCount
ClassPrefixClassDriverDescriptionInherentPropertyDataType Access Appliesto Coercion HighLevelFunctions
RO N/A None None
DescriptionReturnsabriefdescriptionoftheclassdriver.PropertyNodePathClassPrefix»InherentIVISettings»ClassDriverIdentification»Description
ClassPrefixClassDriverPrefixInherentPropertyDataType Access Appliesto Coercion HighLevelFunctions
RO N/A None None
DescriptionReturnstheprefixfortheclassinstrumentdriver.Theprefixcanbeamaximumof31characters.Thenameofeachuser-callableVIintheclassdriverbeginswiththisprefix.Forexample,ifaclassdriverhasauser-callableVInamedIviDmmInitialize,thenIviDmmistheprefixforthatdriver.PropertyNodePathClassPrefix»InherentIVISettings»ClassDriverIdentification»ClassDriverPrefix
ClassPrefixClassDriverRevisionInherentPropertyDataType Access Appliesto Coercion HighLevelFunctions
RO N/A None None
DescriptionReturnsastringthatcontainsadditionalversioninformationaboutthespecificinstrumentdriver.Thereturnedvaluecontainsdriverprefixandversion.Italsocontainsversioninformationforcompilerandcomponentsusedinthedriverbuildprocess.PropertyNodePathClassPrefix»InherentIVISettings»ClassDriverIdentification»Revision
ClassPrefixClassDriverVendorInherentPropertyDataType Access Appliesto Coercion HighLevelFunctions
RO N/A None None
DescriptionReturnsthenameofthevendorthatsuppliestheclassdriver.PropertyNodePathClassPrefix»InherentIVISettings»ClassDriverIdentification»ClassDriverVendor
ClassPrefixClassSpecificationMajorVersionInherentPropertyDataType Access Applies-to Coercion HighLevelFunctions
RO N/A None None
DescriptionSpecifiesthemajorversionnumberoftheIVIclassspecificationwithwhichtheclassdriveriscompliant.PropertyNodePathClassPrefix»InherentIVISettings»ClassDriverIdentification»ClassSpecificationMajorVersion
ClassPrefixClassSpecificationMinorVersionInherentPropertyDataType Access Appliesto Coercion HighLevelFunctions
RO N/A None None
DescriptionReturnstheminorversionnumberoftheclassinstrumentdriver.PropertyNodePathClassPrefix»InherentIVISettings»ClassDriverIdentification»MinorVersion
ClassPrefixDriverSetupInherentPropertyDataType Access Applies
to Coercion HighLevelFunctions
RO N/A None ClassPrefixInitializeWithOptions
DescriptionThispropertyreturnstheDriverSetupstringthatyouspecifiedwheninitializingthedriver.Somecasesexistwhereyoumightspecifytheinstrumentdriveroptionsatinitializationtime.Anexampleofthisisspecifyingaparticularinstrumentmodelfromamongafamilyofinstrumentsthatthedriversupports.Thisisusefulwhenusingsimulation.Youcanspecifydriver-specificoptionsthroughtheDriverSetupkeywordintheoptionStringparametertotheClassPrefixInitializeWithOptionsVIorthroughMAX.IfyoudonotspecifyaDriverSetupstring,thispropertyreturnsanemptystring.PropertyNodePathClassPrefix»InherentIVISettings»DriverSetup
ClassPrefixFirmwareRevisionInherentPropertyDataType Access Appliesto Coercion HighLevelFunctions
RO N/A None ClassPrefixRevisionQuery
DescriptionReturnsaninstrumentspecificstringthatcontainsthefirmwarerevisioninformationofthephysicalinstrument.Whensimulating,thespecificdriverreturnsthevalue.PropertyNodePathClassPrefix»InherentIVISettings»InstrumentIdentification»FirmwareRevision
ClassPrefixFunctionCapabilitiesInherentPropertyDataType Access Appliesto Coercion HighLevelFunctions
RO N/A None None
DescriptionThispropertyisacomma-separatedstringthatidentifiestheclassfunctionsthatthespecificinstrumentdriverimplements.PropertyNodePathClassPrefix»InherentIVISettings»SpecificDriverCapabilities»FunctionCapabilities
ClassPrefixGroupCapabilitiesInherentPropertyDataType Access Appliesto Coercion HighLevelFunctions
RO N/A None None
DescriptionThispropertyisacomma-separatedstringthatidentifiestheinstrumentclassandtheclass-extensiongroupsthatthespecificinstrumentdriverimplements.PropertyNodePathClassPrefix»InherentIVISettings»SpecificDriverCapabilities»GroupCapabilities
ClassPrefixInterchangeCheckInherentPropertyDataType Access Appliesto Coercion HighLevelFunctions
R/W N/A None None
DescriptionSpecifieswhetherthedriverperformsinterchangeabilitychecking.Whenthispropertyisenabled,theclassdriverkeepsalistoftheinterchangeabilitywarningsitencounters.YouviewtheinterchangeabilitywarningswithNISpy.Alternatively,youcancallClassPrefixGetNextInterchangeWarningVItoextractanddeletetheoldestrecordfromthelist.
NoteIfClassPrefixInterchangeCheckissettoTRUEandyouarenotusingNISpy,theinterchangecheckqueueisclearedbycallingClassPrefixGetNextInterchangeWarningVI.Ifyoudonotclearthequeue,theresultinglistbuild-upappearsasamemoryleak.
ThedefaultvalueisFALSE.YoucanoverridethisvaluebyspecifyingavaluewithMAX.YoucancleartheinterchangeabilitywarninglistbycallingtheClassPrefixClearInterchangeWarningsVI.PropertyNodePathClassPrefix»InherentIVISettings»UserOptions»InterchangeCheck
ClassPrefixLogicalNameInherentPropertyDataType Access Appliesto Coercion HighLevelFunctions
RO N/A None None
DescriptionYoupassalogicalnametotheclassdriverinitializationVI.MAXmustcontainanentryforthelogicalname.ThelogicalnameentryreferstoadriversessioninMAX.Thedriversessionspecifiesaphysicaldeviceandaspecificinstrumentdriver.ByassigningthenameofadifferentdriversessiontothelogicalnameinMAX,youcanexchangeoneinstrumentforanotherwithoutmodifyingorrecompilingyourLabVIEWapplication.ThispropertyindicatesthelogicalnameyouspecifiedwhenopeningthecurrentIVIsession.PropertyNodePathClassPrefix»InherentIVISettings»AdvancedSessionInformation»LogicalName
ClassPrefixManufacturerInherentPropertyDataType Access Appliesto Coercion HighLevelFunctions
RO N/A None None
DescriptionReturnsthenameofthemanufactureroftheinstrument.PropertyNodePathClassPrefix»InherentIVISettings»InstrumentIdentification»Manufacturer
ClassPrefixModelInherentPropertyDataType Access Appliesto Coercion HighLevelFunctions
RO N/A None None
DescriptionReturnsthemodelnumberornameofthephysicalinstrument.PropertyNodePathClassPrefix»InherentIVISettings»InstrumentIdentification»Model
ClassPrefixQueryInstrumentStatusInherentPropertyDataType Access Appliesto Coercion HighLevelFunctions
R/W N/A None None
DescriptionSpecifieswhetherthespecificdriverqueriestheinstrumentstatusaftereachVIcall.Queryingtheinstrumentstatusisusefulfordebugging.Aftervalidatingtheprogram,youcansetthispropertytoFALSEtodisablestatuscheckingandmaximizeperformance.Youspecifyavalueforthispropertyfortheentireinstrumentdriver.However,thedrivercanoverridethisvalueforaparticularproperty.ThedefaultvalueisFALSE.YoucanoverridethisvaluebyspecifyingavaluewithMAXorbyinitializingtheIVIsessionwiththeClassPrefixInitializeWithOptionsVI.PropertyNodePathClassPrefix»InherentIVISettings»UserOptions»QueryInstrumentStatus
ClassPrefixRangeCheckInherentPropertyDataType Access Appliesto Coercion HighLevelFunctions
R/W N/A None None
DescriptionSpecifieswhethertovalidatepropertyvaluesandVIparameters.Rangecheckingparametersisveryusefulfordebugging.Aftervalidatingtheprogram,youcansetthispropertytoFALSEtodisablerangecheckingandmaximizeperformance.ThedefaultvalueisTRUE.YoucanoverridethisvaluebyspecifyingavaluewithMAXorbyinitializingtheIVIsessionwiththeClassPrefixInitializeWithOptionsVI.PropertyNodePathClassPrefix»InherentIVISettings»UserOptions»RangeCheck
ClassPrefixRecordValueCoercionsInherentPropertyDataType Access Appliesto Coercion HighLevelFunctions
R/W N/A None None
DescriptionSpecifieswhethertheIVIEnginekeepsalistofthevaluecoercionsitmakesfor and properties.Whenthispropertyisenabled,theclassdrivermaintainsarecordofeachcoercion.YouviewthecoercionrecordswithNISpy.Alternately,youcallClassPrefix_GetNextCoercionRecordVItoextractanddeletetheoldestcoercionrecordfromthelist.ThedefaultvalueisFALSE.YoucanoverridethisvaluebyspecifyingavaluewithMAXorbyinitializingtheIVIsessionwiththeClassPrefixInitializeWithOptionsVI.
NoteIfClassPrefixRecordValueCoercionsissettoTRUEandyouarenotusingNISpy,thecoercionqueueisclearedbycallingClassPrefixGetNextCoercionInfo.Ifyoudonotclearthequeue,theresultinglistbuild-upappearsasamemoryleak.
PropertyNodePathClassPrefix»InherentIVISettings»UserOptions»RecordValueCoercions
ClassPrefixResourceDescriptorInherentPropertyDataType Access Appliesto Coercion HighLevelFunctions
RO N/A None None
DescriptionReturnstheresourcedescriptorthatthedriverusestoidentifythephysicaldevice.Ifyouinitializethedriverwithalogicalnamethatisassociatedwithadevice,thispropertycontainstheresourcedescriptorthatcorrespondstotheentryinMAX.PropertyNodePathClassPrefix»InherentIVISettings»AdvancedSessionInformation»ResourceDescriptor
ClassPrefixSimulateInherentPropertyDataType Access Appliesto Coercion HighLevelFunctions
R/W N/A None None
DescriptionSpecifieswhethertosimulateinstrumentdriverI/Ooperations.Ifsimulationisenabled,specificdriverVIsperformrangechecking,buttheydonotperforminstrumentI/O.TheclassdriverreturnssimulateddataforoutputVIparameters.ThedefaultvalueisFALSE.YoucanoverridethisvaluebyspecifyingavaluewiththeMAXorbyinitializingtheIVIsessionwiththeClassPrefixInitializeWithOptionsVI.PropertyNodePathClassPrefix»InherentIVISettings»UserOptions»Simulate
ClassPrefixSpecificDriverClassSpecificationMajorVersionInherentPropertyDataType Access Appliesto Coercion HighLevelFunctions
RO N/A None None
DescriptionReturnsthemajorversionnumberoftheIVIclassspecificationwithwhichthespecificdriveriscompliant.PropertyNodePathClassPrefix»InherentIVISettings»SpecificDriverIdentification»ClassSpecificationMajorVersion
ClassPrefixSpecificDriverClassSpecificationMinorVersionInherentPropertyDataType Access Appliesto Coercion HighLevelFunctions
RO N/A None None
DescriptionReturnstheminorversionnumberoftheIVIclassspecificationwithwhichthespecificdriveriscompliant.PropertyNodePathClassPrefix»InherentIVISettings»SpecificDriverIdentification»ClassSpecificationMinorVersion
ClassPrefixSpecificDriverDescriptionInherentPropertyDataType Access Appliesto Coercion HighLevelFunctions
RO N/A None None
DescriptionReturnsabriefdescriptionofthespecificdriver.PropertyNodePathClassPrefix»InherentIVISettings»SpecificDriverIdentification»Description
ClassPrefixSpecificDriverLocatorInherentPropertyDataType Access Appliesto Coercion HighLevelFunctions
RO N/A None None
DescriptionReturnstheinformationthattheclassdriverusestofindthespecificdrivermodule.PropertyNodePathClassPrefix»InherentIVISettings»SpecificDriverIdentification»SpecificDriverLocator
ClassPrefixSpecificDriverPrefixInherentPropertyDataType Access Appliesto Coercion HighLevelFunctions
RO N/A None None
DescriptionThenameofeachuser-callablefunctioninthespecificdriverbeginswiththisprefix.Forexample,iftheFluke45driverhasauser-callablefunctionnamed"FL45_init",then"FL45"istheprefixforthatdriver.PropertyNodePathClassPrefix»InherentIVISettings»SpecificDriverIdentification»SpecificDriverPrefix
ClassPrefixSpecificDriverRevisionInherentPropertyDataType Access Appliesto Coercion HighLevelFunctions
RO N/A None None
DescriptionReturnsastringthatcontainsadditionalversioninformationaboutthespecificinstrumentdriver.Thereturnedvaluecontainsdriverprefixandversion.Italsocontainsversioninformationforcompilerandcomponentsusedinthedriverbuildprocess.PropertyNodePathClassPrefix»InherentIVISettings»SpecificDriverIdentification»Revision
ClassPrefixSpecificDriverVendorInherentPropertyDataType Access Appliesto Coercion HighLevelFunctions
RO N/A None None
DescriptionReturnsthenameofthevendorthatsuppliesthespecificdriverPropertyNodePathClassPrefix»InherentIVISettings»SpecificDriverIdentification»SpecificDriverVendor
ClassPrefixSpyInherentPropertyDataType Access Appliesto Coercion HighLevelFunctions
R/W N/A None None
DescriptionSpecifieswhethertheclassdriverusesNISpytorecordcallstoclassdriverVIs.ThedefaultvalueisTRUE.YoucanoverridethisvaluebyinitializingtheIVIsessionwiththeClassPrefixInitializeWithOptionsVI.PropertyNodePathClassPrefix»InherentIVISettings»UserOptions»Spy
ClassPrefixSupportedInstrumentModelsInherentPropertyDataType Access Appliesto Coercion HighLevelFunctions
RO N/A None None
DescriptionReturnsacomma-separatedlistthatidentifiestheinstrumentmodelswithwhichthespecificdriveriscompatible.PropertyNodePathClassPrefix»InherentIVISettings»SpecificDriverCapabilities»SupportedInstrumentModels
ClassPrefixUseSpecificSimulationInherentPropertyDataType Access Appliesto Coercion HighLevelFunctions
R/W N/A None None
DescriptionSpecifieswhethertheclassdriverorthespecificdrivergeneratesthesimulationdataforoutputparameters.AvalueofFALSEspecifiesthattheclassdrivergeneratesthesimulationdataforoutputparameters.AvalueofTRUEspecifiesthatthespecificdrivergeneratesthesimulationdataforoutputparameters.ThedefaultvalueisFALSE.YoucanoverridethisvaluebyspecifyingavaluewithMAX.PropertyNodePathClassPrefix»InherentIVISettings»UserOptions»UseSpecificSimulation
InterchangeabilityCheckingInterchangeabilitywarningsindicatethatusingyourapplicationwithadifferentinstrumentmightcausedifferentbehavior.UsetheClassPrefixGetNextInterchangeWarningVItoretrieveinterchangeabilitywarnings.Alternately,youmayuseNISpytoviewinterchangeabilitywarnings.Interchangeabilitycheckingisperformedonacapabilitygroupbasis.Whenenabled,interchangeabilitycheckingisalwaysperformedonthebasecapabilitygroup.Interchangeabilitycheckingisperformedonextensioncapabilitygroupswhenyouhavesetavalueforanypropertyinthegroup.Ifyouneversetthevalueofanypropertyofanextensioncapabilitygroup,interchangeabilitycheckingisnotperformedonthatgroup.Ingeneral,interchangeabilitywarningsaregeneratedifthefollowingconditionsareencountered:
Apropertythataffectsthebehavioroftheinstrumentisnotinastatethatyouspecify.Thiscanhappenifyourprogramdoesnotconfigurethepropertyorifyourprogramconfiguresthepropertybutthevaluebecomesinvalidasaresultofyourprogramconfiguringadifferentproperty.Yousetorgetaninstrumentspecificproperty.YousetanpropertyforwhichtheIVIclassspecificationdefinesvaluestoaninstrumentspecificvalue.YoupassaninstrumentspecificvaluetoaVIparameterforwhichtheIVIclassspecificationdefinesvalues.Youattempttosetanpropertythattheclassdefinesasread-only.Insomecasestheclassdriversdefineread-onlypropertiesthatspecificdriversmightimplementasread/write.Theclassdriverencountersanerrorwhenittriestodisableanextensioncapabilitygroupthatyourprogramdoesnotuse.Thepurposeofdisablingunusedextensiongroupsistomakeyourprogrambehavethesameregardlessofwhethertheinstrumentsyouuseimplementtheextensioncapabilitygroup.Someinstrumentsthatimplementtheextensioncapabilitygroupmightnotsupportthevaluetowhichtheclassdriverattemptstosettheproperty.Inthiscase,theclassdriverqueuesaninterchangeabilitywarninginsteadofreturninganerrorfromtheVI.
RelatedTopicsClassPrefixClearInterchangeWarningsClassPrefixGetNextInterchangeWarningClassPrefixResetInterchangeCheckClickthefollowinglinkstolearnmoreaboutinterchangeabilitycheckingforaparticularIVIclassdriver.IviDCPwrDCPowerSupplyIviDmmDigitalMultimeterIviFgenFunctionGeneratorIviPwrMeterPowerMeterIviRFSigGenRFSignalGeneratorIviScopeOscilloscopeIviSpecAnSpectrumAnalyzerIviSwtchSwitch
IviDCPwrInterchangeabilityTheIviDCPwrclassdriverperformsinterchangeabilitycheckingwhentheIviDCPwrInterchangeCheckpropertyissettoTRUEandyoucalloneofthefollowingVIs:IviDCPwrInitiateIviDCPwrMeasure
Inadditiontothegeneralinterchangeabilitycheckingrules,theIviDCPwrclassdefinesadditionalrulesandexceptionsforeachcapabilitygroup.
IviDCPwrTrigger ThedriverneedstoperforminterchangeabilitycheckingonthisgrouponlywhentheVIperforminginterchangeabilitycheckingisIviDCPwrInitiate.
TheIviDCPwrclassdoesnotdefineadditionalinterchangeabilityrulesorexceptionsforthefollowingextensioncapabilitygroups:IviDCPwrBase,IviDCPwrSoftwareTrigger,andIviDCPwrMeasurement.
IviDmmInterchangeabilityTheIviDmmclassdriverperformsinterchangeabilitycheckingwhentheIviDmmInterchangeCheckpropertyissettoVI_TRUEandyoucalloneofthefollowingVIs:IviDmm_InitiateIviDmm_ReadIviDmm_ReadMultiPointInadditiontothegeneralinterchangeabilitycheckingrules,theIviDmmclassdefinesadditionalrulesandexceptionsforeachcapabilitygroup.
IviDmmBase IftheIviDmmFunctionpropertyissettoIVIDMM_VAL_TEMPERATURE,theIviDmmResolutionpropertyisnotrequiredtobeinauser-specifiedstate.
IviDmmACMeasurement
IftheIviDmmFunctionpropertyissettoIVIDMM_VAL_AC_VOLTS,IVIDMM_VAL_AC_CURRENT,IVIDMM_VAL_AC_PLUS_DC_VOLTS,orIVIDMM_VAL_AC_PLUS_DC_CURRENT,thenthefollowingpropertiesarerequiredtobeinauser-specifiedstate:
IviDmmACMinimumFrequencyIviDmmACMaximumFrequency
IviDmmFrequencyMeasurement
IftheIviDmmFunctionpropertyissettoIVIDMM_VAL_FREQorIVIDMM_VAL_PERIOD,thentheIviDmmFrequencyVoltageRangepropertyisrequiredtobeinauser-specifiedstate.
IviDmmTemperatureMeasurement
IftheIviDmmFunctionpropertyissettoIVIDMM_VAL_TEMPERATURE,theIviDmmTransducerTypepropertyisrequiredtobeinauser-specifiedstate.
IviDmmThermocouple
IftheIviDmmTransducerTypepropertyissettoIVIDMM_VAL_THERMOCOUPLE,thefollowingpropertiesarerequiredtobeinauser-specifiedstate:
IviDmmThermocoupleType
IviDmmReferenceJunctionTypeIviDmmFixedReferenceJunction
IviDmmResistanceTemperatureDevice
IftheIviDmmTransducerTypepropertyissettoIVIDMM_VAL_2_WIRE_RTDorIVIDMM_VAL_4_WIRE_RTD,thenthefollowingpropertiesarerequiredtobeinauser-specifiedstate:
IviDmmRTDAlphaIviDmmRTDResistance
IviDmmThermistor
IftheIviDmmTransducerTypepropertyissettoIVIDMM_VAL_THERMISTOR,theIviDmmThermistorResistancepropertyisrequiredtobeinauser-specifiedstate.
IviDmmMultiPoint
IftheIviDmmSampleCountpropertyissetto1,thenIviDMMSampleTriggerpropertyisnotrequiredtobeinauser-specifiedstate.IftheIviDmmSampleCountpropertyissetto1ortheIviDmmSampleTriggerpropertyissettoavalueotherthanIVIDMM_VAL_INTERVAL,thentheIviDmmSampleIntervalpropertyisnotrequiredtobeinauser-specifiedstate.
TheIviDmmclassdoesnotdefineadditionalinterchangeabilityrulesorexceptionsforthefollowingextensioncapabilitygroups:IviDmmSoftwareTrigger,IviDmmDeviceInfo,IviDmmAutoRangeValue,IviDmmAutoZero,andIviDmmPowerLineFrequency.
IviFgenInterchangeabilityTheIviFGenclassdriverperformsinterchangeabilitycheckingwhentheIviFgenInterchangeCheckpropertyissettoTRUEandyoucalltheIviFgenInitiateGenerationVI.Inadditiontothegeneralinterchangeabilitycheckingrules,theIviFgenclassdefinesadditionalrulesandexceptionsforeachcapabilitygroup.
IviFgenStdFunc IftheIviFgenOutputModepropertyisnotsettoIVIFGEN_VAL_OUTPUT_FUNC,nopropertiesintheIviFgenStdFuncextensiongrouparerequiredtobeinauser-specifiedstate.IftheIviFgenOutputEnabledpropertyissettoFALSEonachannel,nopropertiesintheIviFgenStdFuncextensiongrouparerequiredtobeinauser-specifiedstateonthatchannel.IftheIviFgenWaveformpropertyissettoIVIFGEN_VAL_WFM_DConachannel,thefollowingpropertiesarenotrequiredtobeinauser-specifiedstateonthatchannel:
IviFgenFuncAmplitudeIviFgenFrequencyIviFgenStartPhase
IftheIviFgenWaveformpropertyissettoIVIFGEN_VAL_WFM_SQUAREonachannel,theIviFgenDutyCycleHighpropertyisrequiredtobeinauser-specifiedstateonthatchannel.
IviFgenArbWaveform
IftheIviFgenOutputModepropertyisnotsettoIVIFGEN_VAL_OUTPUT_ARB,nopropertiesintheIviFgenArbWaveformextensiongrouparerequiredtobeinauser-specifiedstate.IftheIVIFGEN_ATTR_OUTPUT_ENABLEDpropertyissettoFALSEonachannel,nopropertiesintheIviFgenArbWaveformextensiongrouparerequiredtobeinauser-specifiedstateonthatchannel.
IviFgenArb IftheIviFgenOutputModepropertyisnotsetto
Sequence IVIFGEN_VAL_OUTPUT_SEQ,nopropertiesintheIviFgenArbSequenceextensiongrouparerequiredtobeinauser-specifiedstate.IftheIviFgenOutputEnabledpropertyissettoFALSEonachannel,nopropertiesintheIviFgenArbSequenceextensiongrouparerequiredtobeinauser-specifiedstateonthatchannel.
IviFgenTrigger IftheIviFgenOperationModepropertyisnotsettoIVIFGEN_VAL_OPERATE_BURST,nopropertiesintheIviFgenTriggerextensiongrouparerequiredtobeinauser-specifiedstate.
IviFgenInternalTrigger
IftheIviFgenTriggerSourcepropertyisnotsettoIVIFGEN_VAL_INTERNAL_TRIGGER,nopropertiesintheIviFgenInternalTriggerextensiongrouparerequiredtobeinauser-specifiedstate.
IviFgenBurst IftheIviFgenOperationModepropertyisnotsettoIVIFGEN_VAL_OPERATE_BURST,nopropertiesintheIviFgenBurstextensiongrouparerequiredtobeinauser-specifiedstate.IftheIviFgenOutputEnabledpropertyissettoFALSEonachannel,nopropertiesintheIviFgenBurstextensiongrouparerequiredtobeinauser-specifiedstateonthatchannel.
IviFgenModulateAM
IftheIviFgenOutputEnabledpropertyissettoFALSEonachannel,nopropertiesintheIviFgenModulateAMextensiongrouparerequiredtobeinauser-specifiedstateonthatchannel.IftheIviFgenAMEnabledpropertyisnotsettoTRUEonachannel,theIviFgenAMSourcepropertyisnotrequiredtobeinauser-specifiedstateonthatchannel.IftheIviFgenAMSourceisnotsettoIviFgenAMInternalonatleastonechannel,thefollowing
propertiesarenotrequiredtobeinauser-specifiedstate.
IviFgenAMInternalDepthIviFgenAMInternalWaveformIviFgenAMInternalFrequency
IviFgenModulateFM
IftheIviFgenOutputEnabledpropertyissettoFALSEonachannel,nopropertiesintheIviFgenModulateFMextensiongrouparerequiredtobeinauser-specifiedstateonthatchannel.IftheIviFgenFMEnabledpropertyisnotsettoTRUEonachannel,theIviFgenFMSourcepropertyisnotrequiredtobeinauser-specifiedstateonthatchannel.IftheIviFgenFMSourceisnotsettoIviFgenFMInternalonatleastonechannel,thefollowingpropertiesarenotrequiredtobeinauser-specifiedstate.
IviFgenFMInternalDeviationIviFgenFMInternalWaveformIviFgenFMInternalFrequency
TheIviFgenclassdoesnotdefineadditionalinterchangeabilityrulesorexceptionsforthefollowingextensioncapabilitygroups:IviFgenBase,IviFgenSoftwareTrigger.
IviPwrMeterInterchangeabilityTheIviPwrMeterclassdriverperformsinterchangeabilitycheckingwhentheIVIPWRMETER_ATTR_INTERCHANGE_CHECKpropertyissettoVI_TRUEandyoucalloneofthefollowingVIs:
IviPwrMeter_InitiateIviPwrMeter_ReadIviPwrMeter_ReadChannel
Inadditiontothegeneralinterchangeabilitycheckingrules,theIviRFSigGenclassdefinesadditionalrulesandexceptionsforthefollowingcapabilitygroups.
IviPwrMeterManualRange
Supportspowermetersthatcanmanuallyspecifytheupperandlowerlimitsofthemeasurementrange.TheIviPwrMeterManualRangeextensioncapabilityalsoincludesVIsforconfiguringthemeasurementrange.
IviPwrMeterInternalTrigger
Supportspowermetersthatcantriggerinternallyonthemeasurementsignal.Itspecifiestoconfiguretheinternaltriggereventsource,triggerlevel,andthetriggerslope.AlsoincludesVIsforconfiguringtheseproperties.
IviPwrMeterSoftwareTrigger
Supportspowermetersthatcaninitiateameasurementbasedonasoftwaretriggersignal.Youcansendasoftwaretriggertocausethepowermetertotriggerameasurement.
IviPwrMeterAveragingCount
Supportspowermetersthatcanfilterasignalbyaveragingitaspecifiednumberoftimesinmanualaveragingmode.TheIviPwrMeterAveragingCountgroupdefinesapropertyandVItospecifytheaveragingcount.
TheIviPwrMeterclassdoesnotdefineadditionalinterchangeabilityrulesorexceptionsforthefollowingextensioncapabilitygroups:IviPwrMeterChannelAcquisition IviPwrMeterTriggerSource IviPwrMeterDutyCycleCorrectionIviPwrMeterZeroCorrection IviPwrMeterCalibration IviPwrMeterReferenceOscillator
IviRFSigGenInterchangeabilityTheIviRFSigGenclassdriverperformsinterchangeabilitycheckingwhentheIVIRFSIGGEN_ATTR_INTERCHANGE_CHECKpropertyissettoVI_TRUEandyoucalloneofthefollowingVIs:IviRFSigGen_IsSettledandIviRFSigGen_WaitUntilSettled.Inadditiontothegeneralinterchangeabilitycheckingrules,theIviRFSigGenclassdefinesadditionalrulesandexceptionsforeachcapabilitygroup.
IviRFSigGenModulateAM
IftheIVIRFSIGGEN_ATTR_OUTPUT_ENABLEDpropertyissettoFalse,propertiesintheIviRFSigGenModulateAMextensiongroupneednotbeinauser-specifiedstate.IftheIVIRFSIGGEN_ATTR_AM_SOURCEpropertyisnotsettoanexternalmodulationsource,theIVIRFSIGGEN_ATTR_AM_EXTERNAL_COUPLINGpropertydoesneednotbeinauser-specifiedstate.IftheIVIRFSIGGEN_ATTR_AM_ENABLEDpropertyissettoFalse,propertiesintheIviRFSigGenModulateAMextensiongroupneednotbeinauser-specifiedstate.
IviRFSigGenModulateFM
IftheIVIRFSIGGEN_ATTR_OUTPUT_ENABLEDpropertyissettoFalse,propertiesintheIviRFSigGenModulateFMextensiongroupneednotbeinauser-specifiedstate.IftheIVIRFSIGGEN_ATTR_FM_SOURCEpropertyisnotsettoanexternalmodulationsource,thepropertiesIVIRFSIGGEN_ATTR_FM_EXTERNAL_COUPLINGdoesneednotbeinauser-specifiedstate.IftheIVIRFSIGGEN_ATTR_FM_ENABLEDpropertyissettoFalse,propertiesintheIviRFSigGenModulateFMextensiongroupneednotbeinauser-specifiedstate.
IviRFSigGenModulatePM
IftheIVIRFSIGGEN_ATTR_OUTPUT_ENABLEDpropertyissettoFalse,propertiesintheIviRFSigGenModulatePMextensiongroupneednotbeinauser-specifiedstate.IftheIVIRFSIGGEN_ATTR_FM_SOURCEpropertyisnotsettoanexternalmodulationsource,theIVIRFSIGGEN_ATTR_PM_EXTERNAL_COUPLINGpropertydoesneednotbeinauser-specifiedstate.IftheIVIRFSIGGEN_ATTR_PM_ENABLEDpropertyissettoFalse,propertiesintheIviRFSigGenModulatePMextensiongroupneednotbeinauser-specifiedstate.
IviRFSigGenModulatePulse
IftheIVIRFSIGGEN_ATTR_OUTPUT_ENABLEDpropertyissettoFalse,propertiesintheIviRFSigGenModulatePulseextensiongroupneednotbeinauser-specifiedstate.IftheIVIRFSIGGEN_ATTR_PULSE_MODULATION_SOURCEpropertyisnotsettoExternal,allotherpropertiesintheIviRFSigGenModulatePulseextensiongroupneednotbeinauser-specifiedstate.IftheIVIRFSIGGEN_ATTR_FM_ENABLEDpropertyissettoFalse,propertiesintheIviRFSigGenModulateFMextensiongroupneednotbeinauser-specifiedstate.
IviRFSigGenLFGenerator
IftheLFGeneratorOutputEnabledpropertyissettoTrueORIfLFGeneratorOutputEnabledpropertyissettoTrueANDoneofthefollowingsourcesincludesaninternalsource
AMSourceFMSourcePMSource
ANDanyofthefollowingaresettoTrueAMEnabledFMEnabledPMEnabled
thenthepropeteriesintheIviRFSigGenLFGeneratorextensiongroupshallbeinauser-specifiedstate.
IviRFSigGenLFGeneratorOutput
IftheLFGeneratorOutputEnabledpropertyissettoFalse,theLFGeneratorOutputAmplitudepropertyneednotbeinauser-specifiedstate.
IviRFSigGenPulseGenerator
IfthePulseOutputEnabledpropertyissettoTrueOutputEnabledsettoTrueANDthePulseGeneratorSourceissettoInternalANDthePulseModulationEnabledpropertyissettoTrue,thepropertiesintheIviRFSigGenPulseGeneratorextensiongroupshallbeinauser-specifiedstate.IfthePulseTriggerSourcepropertyisnotsettoInternal,thePulseInternalTriggerPeriodpropertyneednotbeinauser-specifiedstate.IfthePulseTriggerSourcepropertyisnotsettoExternal,thePulseExternalTriggerDelaypropertyandthePulseExternalTriggerSlopepropertyneednotbeinauser-specifiedstate.
IviRFSigGenPulseDoubleGenerator
IfthePulseDoubleEnabledpropertyissettoFalse,propertiesintheIviRFSigGenPulseDoubleGeneratorextensiongroupneednotbeinauser-specifiedstate.IftheIviRFSigGenPulseGeneratorextensiongroupdoesnotneedtobecheckedforinterchangeability,thenpropertiesintheIviRFSigGenPulseDoubleGenerator
extensiongroupneednotbeinauser-specifiedstate.
IviRFSigGenPulseGeneratorOutput
IfthePulseOutputEnabledpropertyissettoFalse,allotherpropertiesintheIviRFSigGenPulseGeneratorOutputextensiongroupneednotbeinauser-specifiedstate.
IviRFSigGenSweep
IftheSweepModepropertyissettoNone,allotherpropertiesintheIviRFSigGenSweepextensiongroupneednotbeinauser-specifiedstate.
IftheOutputEnabledpropertyissettoFalse,allthepropertiesintheIviRFSigGenSweepextensiongroupneednotbeinauser-specifiedstate.
IviRFSigGenFrequencySweep
IftheSweepModepropertyisnotsettoFrequencySweep,propertiesintheIviRFSigGenFrequencySweepextensiongroupneednotbeinauser-specifiedstate.IftheIviRFSigGenSweepextensiongroupdoesnotneedtobecheckedforinterchangeability,thenpropertiestheIviRFSigGenFrequencySweepextensiongroupneednotbeinauser-specifiedstate.
IviRFSigGenPowerSweep
IftheSweepModepropertyisnotsettoPowerSweep,intheIviRFSigGenPowerSweepextensiongroupneednotbeinauser-specifiedstate.IftheIviRFSigGenSweepextensiongroupdoesnotneedtobecheckedforinterchangeability,thenpropertiesintheIviRFSigGenPowerSweepextensiongroupneednotbeinauser-specifiedstate.
IviRFSigGenFrequencyStep
IftheSweepModepropertyisnotsettoFrequencyStep,propertiesintheIviRFSigGenFrequencyStepextensiongroupneednotbeinauser-specifiedstate.IftheIviRFSigGenSweepextensiongroupdoesnotneedtobecheckedforinterchangeability,thenpropertiestheIviRFSigGenFrequencyStepextensiongroupneednotbeinauser-specifiedstate.
IviRFSigGenPowerStep
IftheSweepModepropertyisnotsettoPowerStep,propertiesintheIviRFSigGenPowerStepextensiongroupneednotbeinauser-specifiedstate.IftheIviRFSigGenSweepextensiongroupdoesnotneedtobecheckedforinterchangeability,thenpropertiesintheIviRFSigGenPowerStepextensiongroupneednotbeinauser-specifiedstate.
IviRFSigGenList
IftheSweepModepropertyisnotsettoList,propertiesintheIviRFSigGenListextensiongroupneednotbeinauser-specifiedstate.IftheIviRFSigGenSweepextensiongroupdoesnotneedtobecheckedforinterchangeability,thenpropertiesintheIviRFSigGenListextensiongroupneednotbeinauser-specifiedstate.
IviRFSigGenALC
IftheALCEnabledpropertyissettoFalse,propertiestheIviRFSigGenALCextensiongroupneednotbeinauser-specifiedstate.IftheOutputEnabledpropertyissettoFalse,allthepropertiesintheIviRFSigGenALCextensiongroupneednotbeinauser-specifiedstate.
IviRFSigGenReferenceOscillator
IftheOutputEnabledpropertyissettoFalse,allthepropertiesintheIviRFSigGenReferenceOscillatorextensiongroupneednotbeinauser-specifiedstate.
IviRFSigGenSoftwareTrigger
NoadditionalinterchangeabilityrulesorexceptionsaredefinedfortheIviRFSigGenSoftwareTriggercapabilitygroup.
IviRFSigGenModulateIQ
IftheOutputEnabledpropertyissettoFalse,propertiesintheIviRFSigGenModulateIQextensiongroupneednotbeinauser-specifiedstate.IftheIQEnabledpropertyissettoFalse,propertiestheIviRFSigGenModulateIQextensiongroupneednotbeinauser-specifiedstate.
IviRFSigGenIQImpairment
IftheIQImpairmentEnabledpropertyissettoFalse,propertiesintheIviRFSigGenIQImpairmentextensiongroupneednotbeinauser-specifiedstate.IftheIviRFSigGenModulateIQextensiongroupdoesnotneedtobecheckedforinterchangeability,thenpropertiesintheIviRFSigGenIQImpairmentextensiongroupneednotbeinauser-specifiedstate.
IviRFSigGenArbGenerator
IftheIQSourcepropertyisnotsettoArbGenerator,propertiesintheIviRFSigGenArbGeneratorextensiongroupneednotbeinauser-specifiedstate.IftheArbTriggerSourcepropertyisnotsettoExternal,propertiestheArbExternalTriggerSlopepropertyneednotbeinauser-specifiedstate.IftheIviRFSigGenModulateIQextensiongroupdoesnotneedtobecheckedforinterchangeability,thenpropertiesintheIviRFSigGenArbGeneratorextension
groupneednotbeinauser-specifiedstate.
IviRFSigGenDigitalModulationBase
IftheOutputEnabledpropertyissettoFalse,propertiesintheIviRFSigGenDigitalModulationBaseextensiongroupneednotbeinauser-specifiedstate.IftheIQSourcepropertyisnotsettoDigitalModulationBase,propertiesintheIviRFSigGenDigitalModulationBaseextensiongroupneednotbeinauser-specifiedstate.IftheDigitalModulationBaseClockSourcepropertysettoExternal,theExternalClockTypepropertynotbeinauser-specifiedstate.IftheDigitalModulationBaseDataSourcepropertysettoPRBS,theDigitalModulationBasePRBSTypepropertyneednotbeinauser-specifiedstate.IftheDigitalModulationBaseDataSourcepropertyisnotsettoBitSequence,theDigitalModulationBaseSelectedBitSequencepropertyneednotbeinauser-specifiedstate.IftheIviRFSigGenModulateIQextensiongroupdoesnotneedtobecheckedforinterchangeability,thenpropertiesintheIviRFSigGenDigitalModulationBaseextensiongroupneednotbeinauser-specifiedstate
IviRFSigGenCDMABase
IftheOutputEnabledpropertyissettoFalse,propertiesintheIviRFSigGenCDMABaseextensiongroupneednotbeinauser-specifiedstate.IftheIQSourceattributeisnotsettoCDMABase,propertiesintheIviRFSigGenCDMABaseextensiongroupneednotbeinauser-specifiedstate.IftheCDMAClockSourceisnotsettoExternal,theCDMAExternalTriggerSlopepropertyneednotbeinauser-specifiedstate.
IftheIviRFSigGenModulateIQextensiongroupdoesneedtobecheckedforinterchangeability,thenpropertiesintheIviRFSigGenCDMABaseextensiongroupneednotbeinauser-specifiedstate.
IviRFSigGenTDMABase
IftheOutputEnabledpropertyissettoFalse,propertiesintheIviRFSigGenTDMABaseextensiongroupneednotbeinauser-specifiedstate.IftheIQSourcepropertyisnotsettoTDMABase,propertiesintheIviRFSigGenTDMABaseextensiongroupneednotbeinauser-specifiedstate.IftheTDMAClockSourcepropertyisnotsettoExternal,theTDMAExternalTriggerSlopepropertyneednotbeinauser-specifiedstate.IftheIviRFSigGenModulateIQextensiongroupdoesnotneedtobecheckedforinterchangeability,thenpropertiesintheIviRFSigGenTDMABaseextensiongroupneednotbeinauser-specifiedstate.
TheIviRFSigGenclassdoesnotdefineadditionalinterchangeabilityrulesorexceptionsforthefollowingextensioncapabilitygroups:IviRFSigGenAnalogModulationSourceandIviRFSigGenSoftwareTrigger.
IviScopeInterchangeabilityTheIviScopeclassdriverperformsinterchangeabilitycheckingwhentheIviScopeInterchangeCheckpropertyissettoTRUEandyoucalloneofthefollowingVIs:IviScopeInitiateAcquisitionIviScopeReadWaveformIviScopeReadMinMaxWaveformIviScopeReadWaveformMeasurementIviScopeFetchWaveformMeasurementInadditiontothegeneralinterchangeabilitycheckingrules,theIviScopeclassdefinesadditionalrulesandexceptionsforeachcapabilitygroup.
IviScopeBase TheIviScopeTriggerLevelpropertymustbeinauser-specifiedstateonlyiftheapplicationsetstheIviScopeTriggerTypepropertytoIVISCOPE_VAL_EDGE_TRIGGERorIVISCOPE_VAL_RUNT_TRIGGER.
IviScopeTVTrigger ThedriverperformsinterchangeabilitycheckingontheIviScopeTVTriggergrouponlyiftheapplicationsetstheIviScopeTriggerTypepropertytoIVISCOPE_VAL_TV_TRIGGER.TheIviScopeTVTriggerLineNumberpropertymustbeinauser-specifiedstateonlyiftheapplicationsetstheIviScopeTVTriggerEventpropertytoIVISCOPE_VAL_TV_EVENT_LINE_NUMBER.
IviScopeRuntTrigger ThedriverperformsinterchangeabilitycheckingontheIviScopeRuntTriggergrouponlyiftheapplicationsetstheIviScopeTriggerTypepropertytoIVISCOPE_VAL_RUNT_TRIGGER.
IviScopeGlitchTrigger ThedriverperformsinterchangeabilitycheckingontheIviScopeGlitchTriggergroup
onlyiftheapplicationsetstheIviScopeTriggerTypepropertytoIVISCOPE_VAL_GLITCH_TRIGGER.
IviScopeWidthTrigger ThedriverperformsinterchangeabilitycheckingontheIviScopeWidthTriggergrouponlyiftheapplicationsetstheIviScopeTriggerTypepropertytoIVISCOPE_VAL_WIDTH_TRIGGER.
IviScopeAcLineTrigger ThedriverperformsinterchangeabilitycheckingontheIviScopeAcLineTriggergrouponlyiftheapplicationsetstheIviScopeTriggerTypepropertytoIVISCOPE_VAL_AC_LINE_TRIGGER.
IviScopeWaveformMeas TheIviScopeMeasurementLowReferencepropertymustbeinastateyouspecifyisyourequestawaveformmeasurementthatrequiresthelowreferencelevel,suchasrisetime,falltime,preshootandovershoot.TheIviScopeMeasurementMidReferencepropertymustbeinauser-specifiedstateifyourequestawaveformmeasurementthatrequiresthemiddlereferencelevel,suchasfrequency,period,positiveandnegativepulsewidths,andallcycle-basedmeasurements.TheIviScopeMeasurementHighReferencepropertymustbeinauser-specifiedstateifyourequestawaveformmeasurementthatrequiresthehighreferencelevel,suchasrisetime,falltime,preshootandovershoot.
IviScopeMinMaxWaveform
ThedriverperformsinterchangeabilitycheckingontheIviScopeMinMaxWaveformgrouponlyiftheapplicationsetstheIviScopeAcquisitionTypepropertytoIVISCOPE_VAL_ENVELOPEorIVISCOPE_VAL_PEAK_DETECT.TheIviScopeNumberofEnvelopesproperty
mustbeinauser-specifiedstateonlyiftheapplicationsetstheIviScopeAcquisitionTypepropertytoIVISCOPE_VAL_ENVELOPE.
IviScopeContinuousAcquisition
Usingthisextensiongroupisinherentlynon-interchangeable.Thisspecificationdoesnotdefinethebehavioroftheinstrumentnorthedatatheinstrumentsreturnwhilecontinuouslyacquiringthedata.
IviScopeAverageAcquisition
ThedriverperformsinterchangeabilitycheckingontheIviScopeAverageAcquisitiongrouponlyiftheapplicationsetstheIviScopeAcquisitionTypepropertytoIVISCOPE_VAL_AVERAGE.
IviScopeAutoSetup Usingthisextensiongroupisinherentlynon-interchangeable.Theapplicationbehaviorthendependsontheinternalinstrument'salgorithmsforoptimalacquisitionandchannelconfiguration.
TheIviScopeclassdoesnotdefineadditionalinterchangeabilityrulesorexceptionsforthefollowingextensioncapabilitygroups:IviScopeProbeAutoSense,IviScopeSampleMode,IviScopeInterpolation,andIviScopeTriggerModifier.
IviSpecAnInterchangeabilityTheIviSpecAnclassdriverperformsinterchangeabilitycheckingwhentheIVISPECAN_ATTR_INTERCHANGE_CHECKpropertyissettoVI_TRUEandyoucalloneofthefollowingVIs:IviSpecAn_InitiateandIviSpecAn_ReadYTrace.Inadditiontothegeneralinterchangeabilitycheckingrules,theIviSpecAnclassdefinesadditionalrulesandexceptionsforthefollowingcapabilitygroups:
IviSpecAnMarker
IftheMarkerEnabledpropertyissettoFalseforaparticularmarker,thentheMarkerPosition,MarkerTrace,MarkerFrequencyCounterEnabled,MarkerFrequencyCounterResolution,andSignalTrackEnabledpropertiesneednotbeinauserspecifiedstateforthatmarker.IftheMarkerEnabledpropertyissettoFalseforallmarkers,thentheMarkerThresholdandPeakExcursionpropertiesneednotbeinauserspecifiedstate.MarkerFrequencyCounterResolutionpropertyneednotbeinauserspecifiedstateforthatmarker.
IviSpecAnExternalTrigger
ThepropertiesofthisextensiongroupmustbeinauserspecifiedstateifandonlyiftheTriggerSourcepropertyissettoExternal.
IviSpecAnVideoTrigger
ThepropertiesofthisextensiongroupmustbeinauserspecifiedstateifandonlyiftheTriggerSourcepropertyissettoVideo.
IviSpecAnExternalMixing
IftheExternalMixerEnabledpropertyissettoFalse,thenallremaininggrouppropertiesneednotbeinauserspecifiedstate.IftheExternalMixerBiasEnabledpropertyissettoFalse,thentheExternalMixerBiasandExternalMixerBiasLimitpropertiesneednotbeinauserspecifiedstate.
TheIviSpecAnclassdoesnotdefineadditionalinterchangeabilityrulesor
exceptionsforthefollowingextensioncapabilitygroups:IviSpecAnMultiTrace IviSpecAnTrigger IviSpecAnDisplayIviSpecAnMarkerType IviSpecAnDeltaMarker IviSpecAnPreselector
IviSwtchInterchangeabilityTheIviSwtchclassdriverperformsinterchangeabilitycheckingwhentheIviSwtchInterchangeCheckpropertyissettoTRUEandyoucalloneofthefollowingVIs:IviSwtchConnectChannelsIviSwtchSetPathIviSwtchInitiateScan
TheIviSwtchclassdoesnotdefineanyadditionalrulesorexceptionbeyondthethegeneralinterchangeabilitycheckingrules.
DisablingUnusedExtensions-OverviewYoumightdeveloptestprogramsthatdonotuseoneormoreoftheextensiongroupsthataclassdriverdefines.Normallyyourprogramshouldworkwithinstrumentsthatdonotimplementtheextensiongroupaswellaswiththosethatdo.However,ifyourprogramdoesnotconfigureanextensiongroupandthespecificdriverimplementsthatextensiongroup,thevaluesoftheattributesintheunusedextensiongroupareunknown.Theattributesarelikelytobesettothepower-onsettingsofthedevice.Thepower-onsettingsoftenvaryfrominstrumenttoinstrument,sowhenyourelyonaspecificdrivertoimplementanextensiongroup,youmightsacrificeinterchangeability.Toaccommodateinstrumentsthatimplementextensiongroupsthatyourprogramneverconfigures,theclassdriverdisablesunusedextensionsbysettingtheextensiongroupstoaninterchangeablestate.Thisinterchangeablestateforanextensiongroupconfigurestheextensiongrouptohavenoeffectonthebehavioroftheinstrument.Forexample,theIviDmmbasecapabilitiescontrolDMMsthatcantakeasinglemeasurement.TheIviDmmclassdefinesamultipointextensiongroupthatcontrolsDMMsthatcanacquiremultiplesamplesfrommultipletriggers.IfyoudevelopaprogramthatusesonlytheIviDmmbasecapabilitieswithaninstrumentthatimplementsthemultipointextensiongroup,theIviDmmclassdriversetsthemultipointextensiongroupattributestoaninterchangeablestatewhenyoucalltheInitiateorReadfunctionsforIviDmm.Todisablethemultipointextensiongrouptotheinterchangeablestate,theIviDmmclassdriversetsthetriggercountattributeto1andthesamplecountattributeto1.Inthisconfiguration,themultipointextensiongroupdoesnotaffecttheinstrumentsbehavior.Therefore,youcanruntheprogramwithinstrumentsthatimplementonlytheIviDmmbasecapabilitiesaswellaswithinstrumentsthatimplementthemultipointextensiongroup.Ifyourprogramhaseversetanyofthevaluesofanextensiongroup,theclassdriverdoesnotconfiguretheextensiongroup.
DisablingUnusedExtensionsIviDCPwrClassDriverTheIviDCPwrdriverdoesnotdisableunusedextensions.
DisablingUnusedExtensionsIviFgenClassDriverWhenyoucalltheIviFgen_InitiateGenerationVI,theclassdriverdisablesextensioncapabilitygroupsthattheprogramdoesnotusebysettingpropertiesoftheunusedextensiongrouptovaluesthatdisablethatextensiongroup.
IfyoudonotusetheIviFgenModulateAMextensiongroupforachannel,thisdriversetstheIVIFGEN_ATTR_AM_ENABLEDpropertytoVI_FALSEforthatchannel.IfyoudonotusetheIviFgenModulateFMextensiongroupforachannel,thisdriversetstheIVIFGEN_ATTR_FM_ENABLEDpropertytoVI_FALSEforthatchannel.
DisablingUnusedExtensionsIviDmmClassDriverWhenyoucalltheIviDmm_Initiate,theIviDmm_Read,ortheIviDmm_ReadMultiPointVIs,theclassdriverdisablesextensioncapabilitygroupsthattheprogramdoesnotusebysettingpropertiesoftheunusedextensiongrouptovaluesthatdisablethatextensiongroup.Theclassdriverdisablesextensioncapabilitygroupsasfollows:
IfyoudonotusetheIviDmmMultiPointextensiongroup,thisdriversetstheIVIDMM_ATTR_SAMPLE_COUNTandIVIDMM_ATTR_TRIGGER_COUNTpropertiesto1.IfyoudonotusetheIviDmmAutoZeroextensiongroup,thisdriversetstheIVIDMM_ATTR_AUTO_ZEROpropertytoIVIDMM_VAL_AUTO_ZERO_OFF.
DisablingUnusedExtensionsIviPwrMeterClassDriverWhenyoucalltheIviPwrMeter_init,theIviPwrMeter_InitWithOptions,ortheIviPwrMeter_ResetVI,theclassdriverdisablesextensioncapabilitygroupsthattheprogramdoesnotusebysettingoftheunusedextensiongrouptovaluesthatdisablethatextensiongroup.Theclassdriverdisablesextensioncapabilitygroupsbysettingthefollowingtothenoteddefaultvalues:
UnusedExtensionGroup PropertyIviPwrMeterChannelAcquistion IVIPWRMETER_ATTR_CHANNEL_ENABLEDIviPwrMeterTriggerSource IVIPWRMETER_ATTR_TRIGGER_SOURCEIviPwrMeterDutyCycleCorrection IVIPWRMETER_ATTR_DUTY_CYCLE_CORRECTION_ENABLEDIviPwrMeterReferenceOscillator IVIPWRMETER_ATTR_REFERENCE_OSCILLATOR_ENABLED
Note
ThefollowingextensiongroupsarenotdisabledbytheIviPwrMeterdriver:IviPwrMeterInternalTriggerIviPwrMeterSoftwareTriggerIviPwrMeterAveragingCountIviPwrMeterZeroCorrectionIviPwrMeterSoftwareTriggerIviPwrMeterManualRange
DisablingUnusedExtensionsIviRFSigGenClassDriverWhenyoucalltheIviRFSigGen_init,theIviRFSigGen_InitWithOptions,ortheIviRFSigGen_ResetVI,theclassdriverdisablesextensioncapabilitygroupsthattheprogramdoesnotusebysettingoftheunusedextensiongrouptovaluesthatdisablethatextensiongroup.Theclassdriverdisablesextensioncapabilitygroupsbysettingthefollowingtothenoteddefaultvalues:
UnusedExtensionGroup PropertyIviRFSigGenModulateAM IVIRFSIGGEN_ATTR_AM_ENABLEDIviRFSigGenModulateFM IVIRFSIGGEN_ATTR_FM_ENABLEDIviRFSigGenModulatePM IVIRFSIGGEN_ATTR_PM_ENABLEDIviRFSigGenModulatePulse IVIRFSIGGEN_ATTR_PULSE_MODULATION_ENABLEDIviRFSigGenLFGeneratorOutput IVIRFSIGGEN_ATTR_LF_GENERATOR_OUTPUT_ENABLEDIviRFSigGenPulseDoubleGenerator IVIRFSIGGEN_ATTR_PULSE_DOUBLE_ENABLEDIviRFSigGenPulseOutputEnabled IVIRFSIGGEN_ATTR_PULSE_OUTPUT_ENABLEDIviRFSigGenSweep IVIRFSIGGEN_ATTR_SWEEP_MODEIviRFSigGenFrequencySweep IVIRFSIGGEN_ATTR_SWEEP_MODEIviRFSigGenPowerSweep IVIRFSIGGEN_ATTR_SWEEP_MODEIviRFSigGenFrequencyStep IVIRFSIGGEN_ATTR_SWEEP_MODEIviRFSigGenPowerStep IVIRFSIGGEN_ATTR_SWEEP_MODEIviRFSigGenList IVIRFSIGGEN_ATTR_SWEEP_MODEIviRFSigGenACL IVIRFSIGGEN_ATTR_ALC_ENABLEDIviRFSigGenModulateIQ IVIRFSIGGEN_ATTR_IQ_ENABLEDIviRFSigGenIQImpairment IVIRFSIGGEN_ATTR_IQ_IMPAIRMENT_ENABLED
Note
ThefollowingextensiongroupsarenotdisabledbytheIviRFSigGendriver:IviRFSigGenLFGenerator
IviRFSigGenPulseGeneratorIviRFSigGenReferenceOscillatorIviRFSigGenSoftwareTriggerIviRFSigGenArbGeneratorIviRFSigGenDigitalModulationBaseIviRFSigGenCDMABaseIviRFSigGenTDMABase
DisablingUnusedExtensionsIviScopeClassDriverWhenyoucalltheIviScope_InitiateAcquisition,IviScope_ReadWaveform,IviScope_ReadMinMaxWaveform,orIviScope_ReadWaveformMeasurementVIstheclassdriverdisablesextensioncapabilitygroupsthattheprogramdoesnotusebysettingpropertiesoftheunusedextensiongrouptovaluesthatdisablethatextensiongroup.Theclassdriverdisablesextensioncapabilitiesasfollows:
IfyoudonotusetheIviScopeContinuousAcquisitionextensiongroup,thisdriversetstheIVISCOPE_ATTR_INITIATE_CONTINUOUSpropertytoVI_FALSE.IfyoudonotusetheIviScopeInterpolationextensiongroup,thisdriversetstheIVISCOPE_ATTR_INTERPOLATIONpropertytotheIVISCOPE_VAL_NO_INTERPOLATIONvalue.IfyoudonotusetheIviScopeTriggerModifierextensiongroup,thisdriversetstheIVISCOPE_ATTR_TRIGGER_MODIFIERpropertytotheIVISCOPE_VAL_NO_TRIGGER_MODvalue.
DisablingUnusedExtensionsIviSpecAnClassDriverWhenyoucalltheIviSpecAn_init,theIviSpecAn_InitWithOptions,ortheIviSpecAn_ResetVI,theclassdriverdisablesextensioncapabilitygroupsthattheprogramdoesnotusebysettingpropertiesoftheunusedextensiongrouptovaluesthatdisablethatextensiongroup.Theclassdriverdisablesextensioncapabilitygroupsbysettingthefollowingpropertiestothenoteddefaultvalues:
UnusedExtensionGroup Property
IviSpecAnMarker IVISPECAN_ATTR_MARKER_ENABLEDIviSpecAnTrigger IVISPECAN_ATTR_TRIGGER_SOURCEIviSpecAnExternalMixer IVISPECAN_ATTR_EXTERNAL_MIXER_ENABLED
Note
ThefollowingextensiongroupsarenotdisabledbytheIviRFSigGendriver:IviSpecAnMultiTraceIviSpecAnExternalTriggerIviSpecAnVideoTriggerIviSpecAnDisplayIviSpecAnMarkerTypeIviSpecAnDeltaMarkerIviSpecAnPreselector
DisablingUnusedExtensionsIviSwtchClassDriverWhenyoucalltheIviSwtch_Connect_Channels,theIviSwtch_SetPath,ortheIviSwtch_InitiateScanfunction,theclassdriverdisablesextensioncapabilitygroupsthattheprogramdoesnotusebysettingpropertiesoftheunusedextensiongrouptovaluesthatdisablethatextensiongroup.IfyoudonotusetheIviSwtchScannerextensiongroup,thedriverusesthefollowingdefaultvalues.
IVISWTCH_ATTR_SCAN_LIST ""(Emptystring)IVISWTCH_ATTR_TRIGGER_INPUT IVISWTCH_VAL_IMMEDIATEIVISWTCH_ATTR_SCAN_ADVANCED_OUTPUT IVISWTCH_VAL_NONEIVISWTCH_ATTR_SCAN_DELAY 0
IVIStatusCodesIVIclassdriverfunctionscanreturnerrorandwarningvaluesfromseveralsetsofstatuscodes.SomestatuscodesareuniquetotheIVIclassdriverfunctions.OtherstatuscodesarethesamecodesthatVISALibraryfunctionsreturn.Stillothersareerrororwarningvaluesthatfunctionsinspecificinstrumentdriversreturn.Eachsetofstatuscodeshasitsownnumericrange.Regardlessofthesourceofthestatuscode,0alwaysindicatessuccess,apositivevalueindicatesawarning,andanegativevalueindicatesanerror.
StatusCodeTables SpecificErrorandWarningCodesforClassDrivers
StatusCodeRanges IviDmmDefaultValuesofDefinedConstants
IviFgen
IVIErrorsandWarnings IviDCPwrCommonInstrumentDriverErrorsandWarnings
IviScope
Most-Often-EncounteredVISAErrorsandWarnings
IviSwtch
IviPwrMeterIviRFSigGenIviSpecAn
Thefollowingtabledefinesthedifferentrangesofstatuscodes.Thetableliststheincludefilesthatcontainthedefinedconstantsfortheparticularstatuscodes.
StatusCodeRanges
StatusCodeType NumericRange(inHex)
IncludeFile
IVIErrors BFFA0000toBFFA1FFF ivi.hIVIWarnings 3FFA0000to3FFA1FFF ivi.hClassDriverErrors BFFA2000toBFFA3FFF IviClass.hClassDriverWarnings 3FFA2000to3FFA3FFF IviClass.hSpecificDriverErrors BFFA4000toBFFA5FFF Prefix.hSpecificDriverWarnings 3FFA4000to3FFA5FFF Prefix.hCommonInstrumentDriverErrors BFFC0000toBFFCFFFF vpptype.hCommonInstrumentDriverWarnings
3FFC0000to3FFCFFFF vpptype.h
VISAErrors BFFF0000toBFFFFFFF visa.hVISAWarnings 3FFF0000to3FFFFFFF visa.h
TheCommonErrorsandWarningsarevaluesthatVXIplug&playdefinesandthatspecificinstrumentdriversreturn.Theyprovideaconsistentsetofcodesforerrorandwarningconditionsthatarecommonamongallinstrumentdrivers.EachparticularinstrumentdriverdefinesitsownsetofDriverErrorsandWarnings.Thestatuscodesvaluesforonedrivercanoverlapthestatuscodevaluesforotherdrivers.TheIVIclassdriversincludefilesdefineparticularstatuscodesastheunsignedsumofabasevalueandadecimalintegervalue.Thefollowingtableliststhebasevalues.
DefaultValuesofDefinedConstantsStatusCodeType DefinedConstantforBaseValue ValueIVIErrors IVI_ERROR_BASE BFFA0000IVIWarnings IVI_WARN_BASE 3FFA0000ClassDriverErrors IVI_CLASS_ERROR_BASE BFFA2000ClassDriverWarnings IVI_CLASS_WARN_BASE 3FFA2000SpecificDriverErrors IVI_SPECIFIC_ERROR_BASE BFFA4000SpecificDriverWarnings IVI_SPECIFIC_WARN_BASE 3FFA4000
Forexample,ifyoupassaninvalidattributeIDtoanIVIclassdriverfunction,thefunctionreturnsIVI_ERROR_INVALID_ATTRIBUTE,whichivi.hdefinesasIVI_ERROR_BASE+12,or0xBFFA000C.ThefollowingtablescontaintheIVIStatusCodes,theCommonStatusCodes,andthemostcommonlyusedVISAStatusCodes.
IVIErrorsandWarningsStatus Description0 Thecallwassuccessful.BFFA0000 Unrecoverablefailure.BFFA0001 Instrumenterrordetected.CalltheClassPrefix_error_query
functionandexaminetheerror.BFFA0002 Filecouldnotbeopened.BFFA0003 Fileisbeingread.BFFA0004 Fileisbeingmodified.BFFA0005 Drivermodulefilenotfound.BFFA0006 Cannotopendrivermodulefileforreading.BFFA0007 Drivermodulehasinvalidfileformatorcontainsinvaliddata.BFFA0008 Drivermodulecontainsundefinedreferences.BFFA0009 Cannotfindfunctionindrivermodule.BFFA000A Failureloadingdrivermodule.BFFA000B Thepathnameisinvalid.BFFA000C AttributeIDnotrecognized.BFFA000D Attributeisread-only.BFFA000E Attributeiswrite-only.BFFA000F Invalidparameter.BFFA0010 Invalidvalueforparameterorproperty.BFFA0011 Functionormethodnotsupported.BFFA0012 Attributeorpropertynotsupported.BFFA0013 Theenumerationvaluefortheparameterisnotsupported.BFFA0014 InvalidType.BFFA0015 Theattributeandfunctionparametertypesdonotmatch.BFFA0016 Thespecifiedattributealreadyhasavaluewaitingtobe
updated.BFFA0017 Thespecifieditemalreadyexists.BFFA0018 Notavalidconfiguration.
BFFA0019 Therequesteditemorvaluedoesnotexistorisnotavailable.
BFFA001A Therequestedattributevaluenotknownandcannotbedetermined.
BFFA001B Thereisnorangetableforthisattribute.BFFA001C Therangetableisinvalid.BFFA001D Aconnectiontotheinstrumenthasnotbeeninitialized.BFFA001E Theclassinstrumentdriverhasencounteredunderspecified
instrumentconfigurationsthatlimitinterchangeability.BFFA001F Nochanneltablehasbeenbuiltforthesession.The
instrumentdrivermustcallIvi_BuildChannelTableinitsIviInitfunction.
BFFA0020 Channelorrepeatedcapabilitynamespecifiedisnotvalidfortheinstrument.
BFFA0021 Unabletoallocatesystemresource.BFFA0022 Permissiontoaccessfilewasdenied.BFFA0023 Toomanyfilesopened.BFFA0024 Unabletocreatetemporaryfileintargetdirectory.BFFA0025 Alltemporaryfilenamesalreadyusedintargetdirectory.BFFA0026 Diskisfull.BFFA0027 Configurationfilewasnotfoundondisk.BFFA0028 Cannotopenconfigurationfile.BFFA0029 Errorreadingconfigurationfile.BFFA002A Invalid valueinconfigurationfile.BFFA002B Invalid valueinconfigurationfile.BFFA002C Invalid valueinconfigurationfile.BFFA002D Entrymissingfromconfigurationfile.BFFA002E InitializationfailedindriverDLL.BFFA002F Drivermodulecouldnotbeloadedbecauseofanunresolved
externalreference.BFFA0030 CannotfindCVIRun-TimeEngine.
BFFA0031 CannotopenCVIRun-TimeEngine.BFFA0032 CVIRun-TimeEnginehasinvalidformat.BFFA0033 CVIRun-TimeEngineismissingoneormorerequired
functions.BFFA0034 CVIRun-TimeEngineinitializationfailed,probablybecause
ofinsufficientmemory.BFFA0035 CVIRun-TimeEnginecouldnotbeloadedbecauseofan
unresolvedexternalreference.BFFA0036 FailureloadingCVIRun-TimeEngine.BFFA0037 CannotopenDLLtoreadexports.BFFA0038 DLLfileiscorrupt.BFFA0039 NoexporttableinDLL.BFFA003A Unknownattributenameforinitialsettinginconfigurationfile.BFFA003B Invalidattributevalueforinitialsettinginconfigurationfile.BFFA003C Memorypointerspecifiedisnotknown.BFFA003D Unabletofindanychannelorrepeatedcapabilitystrings.BFFA003E Thechannelorrepeatedcapabilitylistcontainstwo
instancesofthesamename.BFFA003F TheVirtualChannelNamesitemintheconfigurationfile
containsaduplicatevirtualchannelname.BFFA0040 TheVirtualChannelNamesitemintheconfigurationfile
containsanentrywithoutavirtualchannelname(nothingbeforethe'=').
BFFA0041 TheVirtualChannelNamesitemintheconfigurationfilecontainsaninvalidvirtualchannelname.Channelnamesmustcontainonlyalphanumerics,underscores,oranexclamationpoint.
BFFA0042 TheVirtualChannelNamesitemintheconfigurationfilecontainsavirtualchannelnamewithoutanassignedchannelstring(i.e.,nothingafter'=').
BFFA0043 TheVirtualChannelNamesitemintheconfigurationfilecontainsavirtualchannelnamethatisassignedtoanunknownorinvalidchannelstring.
BFFA0044 Channelorrepeatedcapabilitynamerequired.BFFA0045 Thechannelorrepeatedcapabilitynameisnotallowed.BFFA0046 Theattributeisnotvalidforthespecifiedchannelorrepeated
capability.BFFA0047 Thisoperationrequiresachannel–orrepeatedcapability–
basedattribute.Thespecifiedattributeisnotchannel–orrepeatedcapability–based.
BFFA0048 Thechannelhasalreadybeenexcludedforthespecifiedattributeandcannotbere-included.
BFFA0049 Theoptionstringparametercontainsanentrywithoutaname.
BFFA004A Theoptionstringparametercontainsanentrywithoutavalue.
BFFA004B Theoptionstringparametercontainsanentrywithanunknownoptionname.
BFFA004C Theoptionstringparametercontainsanentrywithanunknownoptionvalue.
BFFA004D Thisoperationisvalidonlyonasesssioncreatedbyaclassdriver.
BFFA004E Youcannotcreateaconfigurationfilenamed'ivi.ini'.Thatfilenameisreserved.
BFFA004F Therealreadyisanentryofthesamenameintherun-timeconfiguration.
BFFA0050 Theindexparameterisone-based.Youmustpassanumbergreaterthanorequalto1.
BFFA0051 Theindexexceedsthenumberofitemsavailable.BFFA0052 Youcannotsetthecacheforanattributethathasthe
IVI_VAL_NEVER_CACHEflag.BFFA0053 AninstrumentdrivercannotexportaViAddrattributetothe
end-user.UsetheIVI_VAL_HIDDENflagmacrotomakeitaprivateattribute.
BFFA0054 Channelorrepeatedcapabilitystringsmustcontainonlyalphanumerics,underscores,oranexclamationpoint.
BFFA0055 ThePrefixitemintheconfigurationfiledoesnotmatchthespecificdriver'sprefix.
BFFA0056 Thenecessarymemorycouldnotbeallocated.BFFA0057 Operationinprogress.BFFA0058 Nullpointerpassedforparameterorproperty.BFFA0059 Unexpectedresponsefromtheinstrument.BFFA005B Filenotfound.BFFA005C Thefileformatisinvalid.BFFA005D Theinstrumentstatusisnotavailable.BFFA005E InstrumentIDQueryfailed.BFFA005F Instrumentresetfailed.BFFA0060 Insufficientlocationinformationorresourcenotpresentinthe
system.BFFA0061 Thedriverisalreadyinitialized.BFFA0062 Thesimulationstatecannotbechanged.BFFA0063 Invalidnumberoflevelsinselector.BFFA0064 Invalidrangeinselector.BFFA0065 Unknownnameinselector.BFFA0066 Badly-formedselector.BFFA0067 Unknownphysicalselector.BFFA1190 Thesessionhandleisnotvalid.BFFA1198 Thesessionhandleisnotvalid.BFFA11A0 Couldnotcreatethreadlocal.BFFA1200 Thespecifiedconfigurationstorefilecouldnotbe
deserialized.BFFA1201 Adeserializewasattemptedafterapreviousdeserializehad
alreadysucceeded.BFFA1202 Thespecifiedconfigurationstorefilecouldnotbeserialized.BFFA1203 Thesessionnameorlogicalnamecouldnotberesolvedtoa
sessionordriversession.
BFFA1204 Theitemdoesnotexistintheglobalcollection.BFFA1205 Anentrywithnamealreadyexistsinthecollection.BFFA1206 Theregistryentryforthemasterconfigurationstoredoesnot
existorthefilecouldnotbefound.BFFA1207 Theitemdoesnotexistinthecollection.BFFA1208 Thedatacomponentisnotavaliddatacomponent.BFFA1209 Theelementcannotberemovedfromtheglobalcollection
whenitisreferencedinthelocalcollections.BFFA1232 Thespecifiedhandleisinvalidorofanincorrecttype.BFFA1233 ThespecifiedpropertyIDisnotvalidforthisfunction.BFFA6000 RepeatedCapabilitylistscannotbemodifiedafterattributes
havebeenaddedtothem.BFFA6001 Anattributecanonlyberestrictedtoasubsetofarepeated
capabilityonce.BFFA6002 Therepeatedcapabilitytablecannotbebuiltbecauseit
alreadyexists.BFFA6003 Therepeatedcapabilityhasnotbeendefinedyet.BFFA6004 Therepeatedcapabilitynamecannotbeanemptyornull
string.BFFA600D TheConfigServermoduleisnotpresentonthesystem.3FFA0065 Identificationquerynotsupported.3FFA0066 Resetoperationnotsupported.3FFA0067 Selftestoperationnotsupported.3FFA0068 Errorqueryoperationnotsupported.3FFA0069 Revisionquerynotsupported.
CommonInstrumentDriverErrorsandWarningsStatus Description
BFFC0001 Parameter1outofrange,orerrortryingtosetit.BFFC0002 Parameter2outofrange,orerrortryingtosetit.BFFC0003 Parameter3outofrange,orerrortryingtosetit.BFFC0004 Parameter4outofrange,orerrortryingtosetit.BFFC0005 Parameter5outofrange,orerrortryingtosetit.BFFC0006 Parameter6outofrange,orerrortryingtosetit.BFFC0007 Parameter7outofrange,orerrortryingtosetit.BFFC0008 Parameter8outofrange,orerrortryingtosetit.BFFC0011 InstrumentfailedtheIDQuery.BFFC0012 Invalidresponsefrominstrument.3FFC0101 InstrumentdoesnothaveIDQuerycapability.3FFC0102 InstrumentdoesnothaveResetcapability.3FFC0103 InstrumentdoesnothaveSelf-Testcapability.3FFC0104 InstrumentdoesnothaveErrorQuerycapability.3FFC0105 InstrumentdoesnothaveRevisionQuerycapability.
Most-Often-EncounteredVISAErrorsandWarningsStatus DescriptionBFFF0000 Miscellaneousorsystemerroroccurred.BFFF000E Invalidsessionhandle.BFFF0015 Timeoutoccurredbeforeoperationcouldcomplete.BFFF0034 Violationofrawwriteprotocoloccurred.BFFF0035 Violationofrawreadprotocoloccurred.BFFF0036 Devicereportedanoutputprotocolerror.BFFF0037 Devicereportedaninputprotocolerror.BFFF0038 Buserroroccurredduringtransfer.BFFF003A Invalidsetup(propertiesarenotconsistent).BFFF005F Nolistenersconditionwasdetected.BFFF0060 Thisinterfaceisnotthecontrollerincharge.BFFF0067 Operationisnotsupportedonthissession.3FFF0085 Thestatusvalueyoupassedisunknown.
IviDCPwrClassDriverReferenceforLabVIEWConceptsIviDCPwrTerminologyIviDCPwrClassDriverOverviewIviDCPwrExtensionCapabilityGroupsIviDCPwrBehaviorModels
IviDCPwrVIandPropertyReferenceIviDCPwrVITreeIviDCPwrPropertiesbyGroupIviDCPwrPropertyValueDefinitionsIviDCPwrErrorandCompletionCodes
OtherReferenceInterchangeabilityCheckingSimulation
IviDCPwrTerminologyThisdocumentusesthefollowingtermstodescribethepowersupply'soutput:VoltageLevel,OVPLimit,CurrentLimit,CurrentLimitBehavior,ConstantVoltageMode,ConstantCurrentMode,andUnregulatedMode.VoltageLevel—TheDCvoltagethepowersupplyattemptstogenerate.YouconfiguresthevoltagelevelwiththeIviDCPwrVoltageLevelproperty.OVP—OVPisanacronymforOvervoltageProtection.OVPLimitandOVPEnabled—IftheOVPlimitisenabled,thepowersupplydisablestheoutputwhentheoutputvoltageisgreaterthanorequaltotheOVPlimit.YouconfiguretheOVPlimitwiththeIviDCPwrOVPLimitproperty,andenableordisabletheOVPlimitwiththeIviDCPwrOVPEnabledproperty.CurrentLimitandCurrentLimitBehavior—Thecurrentlimitbehaviordeterminesthebehavioroftheinstrumentwhentheoutputcurrentisgreaterthanorequaltothecurrentlimit.Whenthecurrentlimitbehavioristrip,thepowersupplydisablestheoutputwhentheoutputcurrentisgreaterthanorequaltothecurrentlimit.Whenthecurrentlimitbehaviorisregulate,thepowersupplyrestrictstheoutputvoltagesuchthattheoutputcurrentisnotgreaterthanthecurrentlimit.YouconfigurethecurrentlimitandcurrentlimitbehaviorwiththeIviDCPwrCurrentLimitandIviDCPwrCurrentLimitBehaviorproperties.ConstantVoltageMode—Thepowersupplyissaidtobeintheconstantvoltagemodewhenthepowersupply'soutputsignalreachesthevoltagelevelbeforeitreachesthecurrentlimit.Intheconstantvoltagemode,thepowersupply'soutputvoltageremainsconstantatthevoltagelevelanditsoutputcurrentcanvary.ConstantCurrentMode—Thepowersupplyissaidtobeintheconstantcurrentmodewhenthepowersupply'soutputsignalreachesthecurrentlimitbeforeitreachesthevoltagelevel,andthecurrentlimitbehaviorissettoregulate.Intheconstantcurrentmode,thepowersupply'soutputcurrentremainsconstantatthecurrentlimitanditsoutputvoltagevaries.UnregulatedMode—Thepowersupplyissaidtobeintheunregulatedmodewhenthepowersupply'soutputsignalreachesneitherthevoltagelevelorthecurrentlimit.Intheunregulatedmode,thepowersupply's
outputcurrentandoutputvoltagevaries.
IviDCPwrClassDriverOverviewThisinstrumentdriverprovidesprogrammingsupportfortheIviDCPwrClass.TheIviDCPwrclassisdesignedtosupporttypicalDCpowersuppliesaswellascommonextendedfunctionalityfoundinmorecomplexinstruments.TheIviDCPwrclassconceptualizesaDCpowersupplyasaninstrumentcapableofgeneratingaDCpowersignal.TheIviDCPwrclassdriverdividesinstrumentcapabilitiesintoIviDCPwrBasecapabilitygroupandmultipleextensioncapabilitygroups.TheIviDCPwrBasegroupsupportsDCpowersuppliescapableofconfiguringthevoltagelevel,currentlimit,currentlimitbehavior,andovervoltageprotectionlimit,aswellasenablinganddisablingoutputchannels.Italsoallowsyoutoconfiguretheoutputrangeinwhichthepowersupplyoperates,andtoquerytheinstrumenttodetermineinwhatstateitisoperating.
ExtensionCapabilityGroupsTheIviDCPwrclassdriveridentifiesVIsandpropertiesthatbelongtoanextensiongroupwiththefollowingabbreviations.Instrumentspecificdriversarenotrequiredtoimplementanyoftheextensioncapabilitygroups.IfyouuseVIsandpropertiesthatbelongtoextensioncapabilitygroups,everyinstrumentspecificdriverthatyouusemustimplementthoseextensions.
GroupName Abbreviation DescriptionIviDCPwrTrigger [TRG] Forpowersuppliescapableof
makingchangestotheoutputsignalbasedonatriggerevent.
IviDCPwrSoftwareTrigger [SWT] Forpowersuppliescapableofmakingchangestotheoutputsignalbasedonasoftwaretriggerevent.
IviDCPwrMeasurement [MSR] Forpowersuppliescapableofreturningmeasurementcharacteristicsoftheoutputsignal.
RelatedTopicsIVIInherentClassCapabilities
IviDCPwrExtensionCapabilityGroupsTheIviDCPwrclassdriveridentifiesVIsandpropertiesthatbelongtoanextensiongroupwiththefollowingabbreviations.Instrumentspecificdriversarenotrequiredtoimplementanyoftheextensioncapabilitygroups.IfyouuseVIsandpropertiesthatbelongtoextensioncapabilitygroups,everyinstrumentspecificdriverdriverthatyouusemustimplementthoseextensions.
GroupName DescriptionIviDCPwrTrigger Forpowersuppliescapableofmaking
changestotheoutputsignalbasedonatriggerevent.
IviDCPwrSoftwareTrigger Forpowersuppliescapableofmakingchangestotheoutputsignalbasedonasoftwaretriggerevent.
IviDCPwrMeasurement Forpowersuppliescapableofreturningmeasurementcharacteristicsoftheoutputsignal.
IviDCPwrBaseCapabilityGroupTheIviDCPwrBasecapabilitygroupsupportsthemostbasicDCpowersupplycapabilities.Youcanenableordisableoutputchannels,specifytheDCvoltagetogenerate,specifyoutputlimits,andcontrolthebehaviorofthepowersupplywhentheoutputisgreaterthanorequaltooneofthelimits.Thishelpfileusesthefollowingtermstodescribethepowersupply'soutput:VoltageLevel,OVPLimit,CurrentLimit,CurrentLimitBehavior,ConstantVoltageMode,ConstantCurrentMode,andUnregulatedMode.RefertoIviDCPwrTerminologyformoreinformationontheseterms.Thesignalthatthepowersupplyproducesdependsonthevaluesofthevoltagelevel,OVPlimit,andcurrentlimitthatyousupply,andtheimpedanceoftheloadtowhichthepowersupplyisattached.Therefore,thepowersupplymightnotproducetheexactvoltageorcurrentthatyouconfigure.Thefollowingdiagramshowsthepossibleoutputscenarios.
PowerSupplyOutputDiagramAtPoint1,thepowersupply'soutputhasreachedthevoltagelevelbeforeitreachedthecurrentlimit.Thisisanexampleofthepowersupplyoperatingintheconstantvoltagemode.Notethatanypointontheverticallinedefinedbythevoltagelevelwouldalsocausethepowersupplytooperateintheconstantvoltagemode.AtPoint2,thepowersupply'soutputhasreachedthecurrentlimitbeforeitreachedthevoltagelevel.Ifthecurrentlimitbehaviorissettoregulate,thisisanexampleofthepowersupplyoperatingintheconstantcurrentmode.Ifthecurrentlimitbehaviorissettotrip,thepowersupplydisablestheoutput.Notethatanypointonthehorizontallinedefinedbythecurrentlimitwouldalsocausethepowersupplytooperateintheconstantcurrentmodewhenthecurrentlimitbehaviorissettoregulate.
Atpoint3,thepowersupply'soutputhasreachedneitherthevoltagelevelorthecurrentlimit.Thisisanexampleofthepowersupplyoperatingintheunregulatedmode.Notethatanypointwithintherectangledefinedbythevoltagelevelandcurrentlimitwouldalsocausethepowersupplytooperateintheunregulatedmode.Atpoint4,thepowersupply'soutputhasreachedtheOVPlimit.IfOVPisenabled,thepowersupplydisablestheoutput.NotethatanypointontheverticallinedefinedbytheOVPlimitwouldalsocausethepowersupplytodisabletheoutputwhenOVPisenabled.
IviDCPwrBaseVIsIviDCPwrConfigureOVPIviDCPwrConfigureCurrentLimitIviDCPwrConfigureOutputRangeIviDCPwrConfigureOutputEnabledIviDCPwrQueryOutputStateIviDCPwrResetOutputProtectionIviDCPwrQueryMaxCurrentLimitIviDCPwrQueryMaxVoltageLevelIviDCPwrVoltageLevel
IviDCPwrBasePropertiesIviDCPwrOVPEnabledIviDCPwrOVPLimitIviDCPwrCurrentLimitBehaviorIviDCPwrCurrentLimitIviDCPwrOutputEnabledRelatedTopicsIVIInherentFunctionsIVIInherentPropertiesIviDCPwrBasebehaviormodel
IviDCPwrMeasurementExtensionGroupTheIviDCPwrMeasurementextensiongroupsupportsDCpowersuppliescapableofreturningoutputsignalmeasurementssuchasvoltageandcurrent
IviDCPwrMeasurementVIIviDCPwrMeasure
IviDCPwrSoftwareTriggerExtensionGroupTheIviDCPwrSoftwareTriggerextensiongroupsupportsDCpowersuppliescapableofchangingtheoutputsignalbasedonasoftwaretriggerevent.
IviDCPwrSoftwareTriggerVIIviDCPwrSendSoftwareTrigger
IviDCPwrTriggerExtensionGroupTheIviDCPwrTriggerextensiongroupsupportsDCpowersuppliescapableofchangingtheoutputsignalbasedonatriggerevent.RefertotheIviDCPwrTriggerbehaviormodel.
IviDCPwrTriggerVIsIviDCPwrConfigureTriggerSource[TRG]IviDCPwrConfigureTriggeredVoltageLevel[TRG]IviDCPwrConfigureTriggeredCurrentLimit[TRG]IviDCPwrInitiate[TRG]IviDCPwrAbort[TRG]
IviDCPwrTriggerPropertiesIviDCPwrTriggerSourceIviDCPwrTriggeredCurrentLimitIviDCPwrTriggeredVoltageLevel
IviDCPwrBehaviorModelsIviDCPwrBaseIviDCPwrMeasurementIviDCPwrSoftwareTriggerIviDCPwrTrigger
IviDCPwrBaseBehaviorModelAfteryoucalltheIviDCPwrInitialize,IviDCPwrInitializeWithOptions,orIviDCPwrResetVIs,thepowersupplyproducesapowersignalbasedonitscurrentconfiguration.Allchangestothepowersupply'sIviDCPwrBaseVIsandpropertiestakeplaceimmediately.
IviDCPwrMeasurementBehaviorModelTheIviDCPwrMeasurementExtensionGroupfollowsthebehaviormodeloftheIviDCPwrBasecapabilitygroup.TheonlymodificationtothebehaviormodelfromtheIviDCPwrBasecapabilitygroupistheabilitytotakemeasurementontheoutputsignal.
IviDCPwrSoftwareTriggerBehaviorModelTheIviDCPwrSoftwareTriggerExtensionGroupfollowsthebehaviormodeloftheIviDCPwrTriggercapabilitygroup.TheonlymodificationtothebehaviormodelfromtheIviDCPwrTriggercapabilitygroupistheabilitytosendsoftwaretriggers.
IviDCPwrTriggerBehaviorModelThefollowingbehaviormodelshowstherelationshipbetweentheIviDCPwrTriggercapabilitygroupandpowersupplybehavior.
AfteryoucalltheIviDCPwrInitialize,IviDCPwrInitializeWithOptions,orIviDCPwrResetVIs.,thepowersupplyenterstheignoretriggerstate.Intheignoretriggerstate,thepropertiesoftheIviDCPwrBasecapabilitygroupdeterminethesignalthatthepowersupplyproduces.IviDCPwrTriggerpropertiescanbeset,butdonotaffecttheoutputsignal.CallingIviDCPwrInitiateVImovesthepowersupplytothewaitfortriggerstate.Inthewaitfortriggerstate,thepowersupplywaitsforatriggeronthetriggersourcespecifiedbytheIviDCPwrTriggerSource[TRG]property.Afterthepowersupplyreceivesatrigger,itsetsthevoltageleveltothevalueoftheIviDCPwrTriggeredVoltageLevel[TRG]property,andthecurrentlimittothevalueoftheIviDCPwrTriggeredCurrentLimit[TRG]property.Itthenreturnstotheignoretriggerstate.Afterthechangesinoutputoccur,theIviDCPwrTriggeredVoltageLevel[TRG]andIviDCPwrCurrentLimitpropertiesreflectthepowersupply'snewconfiguration.CallingIviDCPwrAbortVImovesthepowersupplyfromitscurrentstatetotheignoretriggerstate.Ifthepowersupplyhasnotyetrespondedtoatrigger,nochangeoccurstothevoltagelevelorcurrentlimit.
IviDCPwrVITreeTheVItreefortheIviDCPwrclassdriver,includingIVIandVXIplug&playrequiredVIs,isshownbelow.
NoteYouusetheLabVIEWPropertyNodetogetandsetproperties.
IviDCPwrVITreeNameorClass VIName RequiredBy
Initialize IviDCPwrInitialize IVI
InitializewithOptions IviDCPwrInitializeWithOptions
IVI
ConfigurationVIs
ConfigureVoltageLevel
IviDCPwrConfigureVoltageLevel
IviDCPwrBase
ConfigureOVP IviDCPwrConfigureOVP
IviDCPwrBase
ConfigureCurrentLimit
IviDCPwrConfigureCurrentLimit
IviDCPwrBase
ConfigureOutputRange
IviDCPwrConfigureOutputRange
IviDCPwrBase
ConfigureOutputEnabled
IviDCPwrConfigureOutputEnabled
IviDCPwrBase
Triggering
ConfigureTriggerSource[TRG]
IviDCPwrConfigureTriggerSource
IviDCPwrTrigger
ConfigureTriggeredVoltageLevel[TRG]
IviDCPwrConfigureTriggeredVoltageLevel
IviDCPwrTrigger
ConfigureTriggeredCurrentLimit[TRG]
IviDCPwrConfigureTriggeredCurrentLimit
IviDCPwrTrigger
Action
Initiate[TRG] IviDCPwrInitiate IviDCPwrTrigger
Abort[TRG] IviDCPwrAbort IviDCPwrTrigger
SendSoftwareTrigger
IviDCPwrSendSoftwareTrigger
IviDCPwrSoftwareTrigger
QueryMaxCurrentLimit
IviDCPwrQueryMaxCurrentLimit
IviDCPwrBase
QueryMaxVoltageLevel
IviDCPwrQueryMaxVoltageLevel
IviDCPwrBase
QueryOutputState IviDCPwrQueryOutputState
IviDCPwrBase
ResetOutputProtection
IviDCPwrResetOutputProtection
IviDCPwrBase
Measure IviDCPwrMeasure IviDCPwrMeasurement
Utility
Reset IviDCPwrReset IVI
ResetWithDefaults IviDCPwrResetWithDefaults
VPP
Self-Test IviDCPwrSelf-Test IVI
Disable IviDCPwrDisable VPP
InvalidateAllAttributes
IviDCPwrInvalidateAllAttributes
VPP
RevisionQuery IviDCPwrRevisionQuery
IVI
Error-Query IviDCPwrError-Query
IVI
ErrorMessage IviDCPwrErrorMessage
IVI
GetChannelName IviDCPwrGetChannelName
VPP
InterchangeabilityInfo
GetNextInterchangeWarning
IviDCPwrGetNextInterchangeWarning
IVI
ResetInterchangeCheck
IviDCPwrResetInterchangeCheck
IVI
ClearInterchangeWarnings
IviDCPwrClearInterchangeWarnings
IVI
CoercionInfo
GetNextCoercionRecord
IviDCPwrGetNextCoercionRecord
IVI
Close IviDCPwrClose IVI
RelatedTopicsIviDCPwrPropertiesIVIInherentVIs
IviDCPwrPropertiesNoteYouusetheLabVIEWPropertyNodetogetandsetproperties.
BasePropertiesIviDCPwrVoltageLevelIviDCPwrOVPEnabledIviDCPwrOVPLimitIviDCPwrCurrentLimitBehaviorIviDCPwrCurrentLimitIviDCPwrOutputEnabled
IviDCPwrTriggerPropertiesIviDCPwrTriggerSourceIviDCPwrTriggeredCurrentLimitIviDCPwrTriggeredVoltageLevel
IviDCPwrPropertyValueDefinitionsThefollowingtabledefinesvaluesforallIviDCPwrclasspropertyconstants.
NoteInthefollowingtable,theliteralstringIVIDCPWR_ATTR_precedesthepropertynameandtheliteralstringIVIDCPWR_VALprecedesthevalueextensionname.
IviDCPwrPropertyDefinedValues
Property DefinedValue
DefinedValue DefinedValue
CURRENTLIMITBEHAVIOR
Regulate 0 ThepowersupplyregulatestheoutputcurrentatthevalueoftheIviDCPwrCurrentLimitpropertywhentheoutputreachesorexceedsthatvalue.
Trip 1 ThepowersupplydisablestheoutputwhentheoutputcurrentreachesorexceedsthevalueoftheIviDCPwrCurrentLimitproperty.
TRIGGERSOURCE
Immediate 0 Thepowersupplydoesnotwaitforatriggerbeforechangingtheoutputsignal.
External 1 Thepowersupplywaitsforanexternaltriggerbeforechangingtheoutputsignal.
Software 2 ThepowersupplywaitsfortheIviDCPwrSendSoftwareTriggerVItoexecutebeforechangingtheoutputsignal.
TTL0 3 ThepowersupplywaitsforatriggerontheTTL0linebeforechangingtheoutputsignal.
TTL1 4 ThepowersupplywaitsforatriggerontheTTL1linebeforechangingtheoutputsignal.
TTL2 5 ThepowersupplywaitsforatriggerontheTTL2linebeforechangingtheoutputsignal.
TTL3 6 ThepowersupplywaitsforatriggerontheTTL3linebeforechangingtheoutputsignal.
TTL4 7 ThepowersupplywaitsforatriggerontheTTL4linebeforechangingthe
outputsignal.TTL5 8 Thepowersupplywaitsforatriggeron
theTTL5linebeforechangingtheoutputsignal.
TTL6 9 ThepowersupplywaitsforatriggerontheTTL6linebeforechangingtheoutputsignal.
TTL7 10 ThepowersupplywaitsforatriggerontheTTL7linebeforechangingtheoutputsignal.
ECLO 11 ThepowersupplywaitsforatriggerontheECL0linebeforechangingtheoutputsignal.
ECL1 12 ThepowersupplywaitsforatriggerontheECL1linebeforechangingtheoutputsignal.
PXIStar 13 ThepowersupplywaitsforatriggeronthePXISTARlinebeforechangingtheoutputsignal.
RTSI0 14 ThepowersupplywaitsforatriggerontheRTSI0linebeforechangingtheoutputsignal.
RTSI1 15 ThepowersupplywaitsforatriggerontheRTSI1linebeforechangingtheoutputsignal.
RTSI2 16 ThepowersupplywaitsforatriggerontheRTSI2linebeforechangingtheoutputsignal.
RTSI3 17 ThepowersupplywaitsforatriggerontheRTSI3linebeforechangingtheoutputsignal.
RTSI4 18 ThepowersupplywaitsforatriggerontheRTSI4linebeforechangingtheoutputsignal.
RTSI5 19 Thepowersupplywaitsforatriggeron
theRTSI5linebeforechangingtheoutputsignal.
RTSI6 20 ThepowersupplywaitsforatriggerontheRTSI6linebeforechangingtheoutputsignal.
RelatedTopicsIviDCPwrVITreeIviDCPwrProperties
IviDCPwrErrorandWarningCodesStatusCodeRangesStatusCodeType NumericRange(inHex)IviDCPwrErrors 0xBFFA2001to0xBFFA3FFFIviDCPwrWarnings 0x3FFA2001to0x3FFA3FFFIVISpecificDriverErrors 0xBFFA4000to0xBFFA5FFFIVISpecificDriverWarnings 0x3FFA4000to0x3FFA5FFFIVIErrors 0xBFFA0000to0xBFFA1FFFIVIWarnings 0x3FFA0000to0x3FFA1FFFCommonInstrumentDriverErrors 0xBFFC0000to0xBFFCFFFFCommonInstrumentDriverWarnings 0x3FFC0000to0x3FFCFFFFVISAErrors 0xBFFF0000to0xBFFFFFFFVISAWarnings 0x3FFF0000to0xFFFFFFF
IviDCPwrErrorCodeError Value MessageIVIDCPWR_ERROR_NOT_TRIGGER_SOFTWARE
0xBFFA1001 Thetriggersourceisnotsoftwaretrigger.
RelatedTopicIVIStatusCodes
IviDCPwrFunctionsExpandthisbooktoviewanalphabetizedlistofIviDCPwrfunctions.
IviDCPwrAbortIviDCPwrTriggerCapabilityGroup[TRG]ThisVIabortsallpendingoutputchanges.
NoteIfyoucallthisVIaftercallingtheIviDCPwrInitiate[TRG]VI,thepowersupplyignoresanytriggeranddoesnotchangetheoutput.instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviDCPwrInitializeorIviDCPwrInitializeWithOptionsVI.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviDCPwrInitializeorIviDCPwrInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviDCPwrConfigureCurrentLimitIviDCPwrBaseCapabilityGroupThisVIconfiguresthecurrentlimit.Youspecifytheoutputcurrentlimitvalueandthebehaviorofthepowersupplywhentheoutputcurrentisgreaterthanorequaltothatvalue.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviDCPwrInitializeorIviDCPwrInitializeWithOptionsVI.channelname("CHANNEL1")PassthevirtualchannelnamethatyouassigntotheinstrumentinMAX.Virtualchannelnamesarealiasesforinstrumentspecificchannelstrings.Theinstrumentspecificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.YouassignavirtualchannelnametoaninstrumentspecificchannelthroughMAX.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrumentspecificchannelnames.DefaultValue:CHANNEL1
behavior(regulate)Passthebehavioryouwantthepowersupplytoexhibitwhentheoutputcurrentisgreaterthanorequaltothevalueofthelimitparameter.ThedriverusesthisvaluetosettheIviDCPwrCurrentLimitBehaviorproperty.DefinedValues:IVIDCPWR_VAL_CURRENT_REGULATE—RegulatorylimitIVIDCPWR_VAL_CURRENT_TRIP—TriplimitDefaultValue:IVIDCPWR_VAL_CURRENT_REGULATE
limit(0.0amps)Passthecurrentlimityouwanttouse.ThedriverusesthisvaluetosettheIviDCPwrCurrentLimitproperty.Units:ampsDefaultValue:0.0
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviDCPwrInitializeorIviDCPwrInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviDCPwrConfigureOutputEnabledIviDCPwrBaseCapabilityGroupConfigureswhetherthesignalthatthepowersupplyproducesonachannelappearsattheoutputconnector.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviDCPwrInitializeorIviDCPwrInitializeWithOptionsVI.channelname("CHANNEL1")PassthevirtualchannelnamethatyouassigntotheinstrumentinMAX.Virtualchannelnamesarealiasesforinstrumentspecificchannelstrings.Theinstrumentspecificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.YouassignavirtualchannelnametoaninstrumentspecificchannelthroughMAX.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrumentspecificchannelnames.DefaultValue:CHANNEL1
enabled(true)Passwhetheryouwantthesignalthepowersupplyproducesonachanneltoappearattheoutputconnector.ThedriverusesthisvaluetosettheIviDCPwrOutputEnabledproperty.ValidValues:TRUE-EnabletheoutputFALSE-DisabletheoutputDefaultValue:TRUE
errorin(noerror)Theerrorinclustercanaccepterrorinformation
wiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviDCPwrInitializeorIviDCPwrInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviDCPwrConfigureOutputRangeIviDCPwrBaseCapabilityGroupConfiguresthepowersupply'soutputrangeonachannel.Youspecifywhetheryouwanttoconfigurethevoltageorcurrentrange,andthevaluetowhichtosettherange.
Notes
1. Settingavoltagerangecaninvalidateapreviouslyconfiguredcurrentrange.
2. Settingacurrentrangecaninvalidateapreviouslyconfiguredvoltagerange.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviDCPwrInitializeorIviDCPwrInitializeWithOptionsVI.channelname("CHANNEL1")PassthevirtualchannelnamethatyouassigntotheinstrumentinMAX.Virtualchannelnamesarealiasesforinstrumentspecificchannelstrings.Theinstrumentspecificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.YouassignavirtualchannelnametoaninstrumentspecificchannelthroughMAX.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrumentspecificchannelnames.DefaultValue:CHANNEL1
rangetype(Voltage)Passthetypeofrangeyouwanttoconfigure.DefinedValues:IVIDCPWR_VAL_RANGE_VOLTAGE—VoltageRangeIVIDCPWR_VAL_RANGE_CURRENT—CurrentRangeDefaultValue:IVIDCPWR_VAL_RANGE_VOLTAGE
Notes
1. Settingavoltagerangecaninvalidateapreviouslyconfiguredcurrentrange.
2. Settingacurrentrangecaninvalidateapreviouslyconfiguredvoltagerange.
range(0.0)Passtherangeinwhichyouwantthepowersupplytooperate.IfyoupassavalueofIVIDCPWR_VAL_RANGE_CURRENTfortheRangeTypeparameter,specifythisparameterinamps.IfyoupassavalueofIVIDCPWR_VAL_RANGE_VOLTAGEfortheRangeTypeparameter,specifythisparameterinvolts.Units: volts(forvoltagerange)
amps(forcurrentrange)DefaultValue: 0.0errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviDCPwrInitializeorIviDCPwrInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviDCPwrConfigureOVPIviDCPwrBaseCapabilityGroupThisVIconfiguresthepowersupply'sovervoltageprotection.Youspecifytheovervoltagelimitandthebehaviorofthepowersupplywhentheoutputvoltageisgreaterthanorequaltothatvalue.WhentheenabledparameterisFALSE,thelimitparameterdoesnotaffecttheinstrument'sbehavior,andthedriverignoresthelimitparameter.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviDCPwrInitializeorIviDCPwrInitializeWithOptionsVI.channelname("CHANNEL1")PassthevirtualchannelnamethatyouassigntotheinstrumentinMAX.Virtualchannelnamesarealiasesforinstrumentspecificchannelstrings.Theinstrumentspecificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.YouassignavirtualchannelnametoaninstrumentspecificchannelthroughMAX.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrumentspecificchannelnames.DefaultValue:CHANNEL1
enabled(true)PasswhetheryouwanttoenableordisabletheOVPlimit.ThedriverusesthisvaluetosettheIviDCPwrOVPEnabledproperty.DefinedValues:TRUE—EnableOVPlimit
FALSE—DisableOVPlimitDefaultValue:TRUE
limit(0.0V)Passtheovervoltageprotectionlimityouwanttouse.ThedriverusesthisvaluetosettheIviDCPwrOVPLimitproperty.Units:volts(V)DefaultValue:0.0V
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviDCPwrInitializeorIviDCPwrInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviDCPwrConfigureTriggerSourceIviDCPwrTriggerCapabilityGroup[TRG]ThisVIconfiguresthetriggersourcetowhichthepowersupplyrespondsafteryoucallIviDCPwrInitiate[TRG].Whenthepowersupplyreceivesatriggersignalonthesourceyouspecify,itchangesitscurrentandvoltageoutputs.YouconfigurethetriggeredcurrentandvoltageoutputswiththeIviDCPwrConfigureTriggeredCurrentLimit[TRG]andIviDCPwrConfigureTriggeredVoltageLevel[TRG]VIs.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviDCPwrInitializeorIviDCPwrInitializeWithOptionsVI.channelname("CHANNEL1")PassthevirtualchannelnamethatyouassigntotheinstrumentinMAX.Virtualchannelnamesarealiasesforinstrumentspecificchannelstrings.Theinstrumentspecificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.YouassignavirtualchannelnametoaninstrumentspecificchannelthroughMAX.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrumentspecificchannelnames.DefaultValue:CHANNEL1
source(Immediate)Passthetriggersourcetowhichyouwantthepowersupplytorespond.ThedriversetstheIviDCPwrTriggerSource[TRG]propertytothisvalue.DefinedValues:
IVIDCPWR_VAL_TRIG_IMMEDIATE—Thepowersupplydoesnotwaitforatriggerofanykind.IVIDCPWR_VAL_TRIG_EXTERNAL—Thepowersupplywaitsforatriggerontheexternaltriggerpoint.IVIDCPWR_VAL_SOFTWARE_TRIG—ThepowersupplywaitsuntilyoucalltheIviDCPwrSendSoftwareTrigger[SWT]VI.IVIDCPWR_VAL_TRIG_TTL0—ThepowersupplywaitsuntilitreceivesatriggeronthePXITRIG0line(forPXIinstruments)ortheVXITTL0line(forVXIinstruments).IVIDCPWR_VAL_TRIG_TTL1—ThepowersupplywaitsuntilitreceivesatriggeronthePXITRIG1line(forPXIinstruments)ortheVXITTL1line(forVXIinstruments).IVIDCPWR_VAL_TRIG_TTL2—ThepowersupplywaitsuntilitreceivesatriggeronthePXITRIG2line(forPXIinstruments)ortheVXITTL2line(forVXIinstruments).IVIDCPWR_VAL_TRIG_TTL3—ThepowersupplywaitsuntilitreceivesatriggeronthePXITRIG3line(forPXIinstruments)ortheVXITTL3line(forVXIinstruments).IVIDCPWR_VAL_TRIG_TTL4—ThepowersupplywaitsuntilitreceivesatriggeronthePXITRIG4line(forPXIinstruments)ortheVXITTL4line(forVXIinstruments).IVIDCPWR_VAL_TRIG_TTL5—ThepowersupplywaitsuntilitreceivesatriggeronthePXITRIG5line(forPXIinstruments)ortheVXITTL5line(forVXIinstruments).IVIDCPWR_VAL_TRIG_TTL6—ThepowersupplywaitsuntilitreceivesatriggeronthePXITRIG6line(forPXIinstruments)ortheVXITTL6line(forVXIinstruments).IVIDCPWR_VAL_TRIG_TTL7—ThepowersupplywaitsuntilitreceivesatriggeronthePXITRIG7line(forPXIinstruments)ortheVXITTL7line(forVXIinstruments).IVIDCPWR_VAL_TRIG_ECL0—ThepowersupplywaitsuntilitreceivesatriggerontheVXIECL0line.IVIDCPWR_VAL_TRIG_ECL1—ThepowersupplywaitsuntilitreceivesatriggerontheVXIECL1line.
IVIDCPWR_VAL_TRIG_PXI_STAR—ThepowersupplywaitsuntilitreceivesatriggeronthePXISTARtriggerbus.IVIDCPWR_VAL_TRIG_RTSI_0—ThepowersupplywaitsuntilitreceivesatriggeronRTSIline0.IVIDCPWR_VAL_TRIG_RTSI_1—ThepowersupplywaitsuntilitreceivesatriggeronRTSIline1.IVIDCPWR_VAL_TRIG_RTSI_2—ThepowersupplywaitsuntilitreceivesatriggeronRTSIline2.IVIDCPWR_VAL_TRIG_RTSI_3—ThepowersupplywaitsuntilitreceivesatriggeronRTSIline3.IVIDCPWR_VAL_TRIG_RTSI_4—ThepowersupplywaitsuntilitreceivesatriggeronRTSIline4.IVIDCPWR_VAL_TRIG_RTSI_5—ThepowersupplywaitsuntilitreceivesatriggeronRTSIline5.IVIDCPWR_VAL_TRIG_RTSI_6—ThepowersupplywaitsuntilitreceivesatriggeronRTSIline6.DefaultValue:IVIDCPWR_VAL_TRIG_IMMEDIATE
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviDCPwrInitializeorIviDCPwrInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviDCPwrConfigureTriggeredCurrentLimitIviDCPwrTriggerCapabilityGroup[TRG]ThisVIconfiguresthecurrentlimitthepowersupplyusesafteritreceivesatrigger.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviDCPwrInitializeorIviDCPwrInitializeWithOptionsVI.channelname("CHANNEL1")PassthevirtualchannelnamethatyouassigntotheinstrumentinMAX.Virtualchannelnamesarealiasesforinstrumentspecificchannelstrings.Theinstrumentspecificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.YouassignavirtualchannelnametoaninstrumentspecificchannelthroughMAX.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrumentspecificchannelnames.DefaultValue:CHANNEL1
triggeredlimit(0.0amps)Passthecurrentlimityouwantthepowersupplytouseafteritreceivesatrigger.ThedriversetstheIviDCPwrTriggeredCurrentLimit[TRG]propertytothisvalue.Units:ampsDefaultValue:0.0amps
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.Usethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfrom
otherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviDCPwrInitializeorIviDCPwrInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviDCPwrConfigureTriggeredVoltageLevelIviDCPwrTriggerCapabilityGroup[TRG]ThisVIconfigurestheDCvoltagelevelthepowersupplyattemptstogenerateafteritreceivesatrigger.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviDCPwrInitializeorIviDCPwrInitializeWithOptionsVI.channelname("CHANNEL1")PassthevirtualchannelnamethatyouassigntotheinstrumentinPassthevirtualchannelnamethatyouassigntotheinstrumentinMAX.Virtualchannelnamesarealiasesforinstrumentspecificchannelstrings.Theinstrumentspecificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.YouassignavirtualchannelnametoaninstrumentspecificchannelthroughMAX.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrumentspecificchannelnames.DefaultValue:CHANNEL1
triggeredlevel(0.0V)PasstheDCvoltagelevelyouwantthepowersupplytoattempttogenerateafteritreceivesatrigger.ThedriversetstheIviDCPwrTriggeredVoltageLevel[TRG]propertytothisvalue.Units:volts(V)DefaultValue:0.0V
errorin(noerror)Theerrorinclustercanaccepterrorinformation
wiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviDCPwrInitializeorIviDCPwrInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviDCPwrConfigureVoltageLevelIviDCPwrBaseCapabilityGroupThisVIconfigurestheDCvoltagelevelthatthepowersupplyattemptstogenerate.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviDCPwrInitializeorIviDCPwrInitializeWithOptionsVI.channelname("CHANNEL1")PassthevirtualchannelnamethatyouassigntotheinstrumentinMAX.Virtualchannelnamesarealiasesforinstrumentspecificchannelstrings.Theinstrumentspecificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.YouassignavirtualchannelnametoaninstrumentspecificchannelthroughMAX.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrumentspecificchannelnames.DefaultValue:CHANNEL1
level(0.0V)PasstheDCvoltageyouwantthepowersupplytoattempttogenerate.ThedriversetstheIviDCPwrVoltageLevelpropertytothisvalue.Units:volts(V)DefaultValue:0.0V
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmore
informationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviDCPwrInitializeorIviDCPwrInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviDCPwrGetChannelNameIviDCPwrBaseCapabilityGroupThisVIreturnsthespecificdriverdefinedchannelnamethatcorrespondstotheone-basedindexthatyouspecify.IfthevalueyoupassfortheIndexparameterislessthanoneorgreaterthanthevalueoftheChannelCountproperty,thefunctionreturnsanemptystringintheNameparameterandreturnsanerror.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviDCPwrInitializeorIviDCPwrInitializeWithOptionsVI.Thehandleidentifiesaparticularinstrumentsession.
index(1)Aone-basedindexthatdefineswhichnametoreturn.TheindexmustbelessthanorequaltotheClassPrefixChannelCountproperty.instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviDCPwrInitializeorIviDCPwrInitializeWithOptionsVI.Thehandleidentifiesaparticularinstrumentsession.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
outputchannelnameReturnsthenameoftheChannelspecifiedbytheindexparameter.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviDCPwrInitiateIviDCPwrTriggerCapabilityGroup[TRG]ThisVIinitiatesoutputchangesthatyoupreviouslyspecified.AfteryoucallthisVI,thepowersupplywaitsforthetriggeryouspecifywiththeIviDCPwrConfigureTriggerSource[TRG]VI.Afterthepowersupplydetectsthetrigger,itupdatesitsvoltagelevelandcurrentlimittothevaluesyouspecifywiththeIviDCPwrConfigureTriggeredVoltageLevel[TRG]andIviDCPwrConfigureTriggeredCurrentLimit[TRG]VIs.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviDCPwrInitializeorIviDCPwrInitializeWithOptionsVI.
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviDCPwrInitializeorIviDCPwrInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviDCPwrMeasureIviDCPwrMeasurement[MSR]ThisVItakesasinglemeasurementonthechannelyouspecify.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviDCPwrInitializeorIviDCPwrInitializeWithOptionsVI.channelname("CHANNEL1")PassthevirtualchannelnamethatyouassigntotheinstrumentinMAX.Virtualchannelnamesarealiasesforinstrumentspecificchannelstrings.Theinstrumentspecificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.YouassignavirtualchannelnametoaninstrumentspecificchannelthroughMAX.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrumentspecificchannelnames.DefaultValue:CHANNEL1
measurementtype(voltage)Passthemeasurementyouwantthepowersupplytotake.DefinedValues:IVIDCPWR_VAL_MEASURE_VOLTAGE—DCvoltageIVIDCPWR_VAL_MEASURE_CURRENT—DCcurrentDefaultValue:IVIDCPWR_VAL_MEASURE_VOLTAGE
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.
Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviDCPwrInitializeorIviDCPwrInitializeWithOptionsVI.measurementReturnsthemeasuredvalue.IfyoupassavalueofIVIDCPWR_VAL_MEASURE_CURRENTforthemeasurementTypeparameter,thisparameterreturnsavalueinamps.IfyoupassavalueofIVIDCPWR_VAL_MEASURE_VOLTAGEforthemeasurementTypeparameter,thisparameterreturnsavalueinvolts.
Units: volts(forvoltagemeasurement)amps(forcurrentmeasurement)
erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviDCPwrQueryMaxCurrentLimitIviDCPwrBaseCapabilityGroupThisVIreturnsthemaximumprogrammablecurrentlimitthatthepowersupplyacceptsforaparticularvoltagelevelonachannelfortheoutputrangetowhichthepowersupplyiscurrentlyconfigured.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviDCPwrInitializeorIviDCPwrInitializeWithOptionsVI.channelname("CHANNEL1")PassthevirtualchannelnamethatyouassigntotheinstrumentinMAX.Virtualchannelnamesarealiasesforinstrumentspecificchannelstrings.Theinstrumentspecificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.YouassignavirtualchannelnametoaninstrumentspecificchannelthroughMAX.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrumentspecificchannelnames.DefaultValue:CHANNEL1
voltagelevel(0.0V)Passthevoltagelevelforwhichtodeterminethemaximumprogrammablecurrentlimit.Units:volts(V)DefaultValue:0.0
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.Usethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfrom
otherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviDCPwrInitializeorIviDCPwrInitializeWithOptionsVI.maxcurrentlimitThisparameterreturnsthemaximumprogrammablecurrentlimitforthevoltagelevelyouspecify.Units:amps(A)
erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviDCPwrQueryMaxVoltageLevelIviDCPwrBaseCapabilityGroupThisVIreturnsthemaximumprogrammablevoltagelevelthatthepowersupplyacceptsforaparticularcurrentlimitonachannelfortheoutputrangetowhichthepowersupplyiscurrentlyconfigured.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviDCPwrInitializeorIviDCPwrInitializeWithOptionsVI.channelname("CHANNEL1")PassthevirtualchannelnamethatyouassigntotheinstrumentinMAX.Virtualchannelnamesarealiasesforinstrumentspecificchannelstrings.Theinstrumentspecificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.YouassignavirtualchannelnametoaninstrumentspecificchannelthroughMAX.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrumentspecificchannelnames.DefaultValue:CHANNEL1
currentlimit(0.0amps)Passthecurrentlimitforwhichtodeterminethemaximumprogrammablevoltagelevel.Units:amps(A).DefaultValue:0.0
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.Usethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfrom
otherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviDCPwrInitializeorIviDCPwrInitializeWithOptionsVI.maxvoltagelevelThisparameterreturnsthemaximumprogrammablevoltagelevelforthecurrentlimityouspecify.Units:volts(V)
erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviDCPwrQueryOutputStateIviDCPwrBaseCapabilityGroupThisVIreturnswhetherthepowersupplyisinaparticularoutputstate.Details
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviDCPwrInitializeorIviDCPwrInitializeWithOptionsVI.channelname("CHANNEL1")PassthevirtualchannelnamethatyouassigntotheinstrumentinMAX.Virtualchannelnamesarealiasesforinstrumentspecificchannelstrings.Theinstrumentspecificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.YouassignavirtualchannelnametoaninstrumentspecificchannelthroughMAX.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrumentspecificchannelnames.DefaultValue:CHANNEL1
outputstate(ConstantVoltage)Passtheoutputstateforwhichyouwanttoquery.DefinedValues:IVIDCPWR_VAL_OUTPUT_CONSTANT_VOLTAGE—ConstantVoltageStateIVIDCPWR_VAL_OUTPUT_CONSTANT_CURRENT—ConstantCurrentStateIVIDCPWR_VAL_OUTPUT_UNREGULATED—UnregulatedStateIVIDCPWR_VAL_OUTPUT_OVER_VOLTAGE—OvervoltageState
IVIDCPWR_VAL_OUTPUT_OVER_CURRENT—OvercurrentStateDefaultValue:IVIDCPWR_VAL_OUTPUT_CONSTANT_VOLTAGE
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviDCPwrInitializeorIviDCPwrInitializeWithOptionsVI.instateThisparameterreturnsTRUEifthepowersupplyiscurrentlyinthestateyouspecifywiththeOutputStateparameter,andFALSEifitisnot.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviDCPwrQueryOutputStateDetailsAconstantvoltageconditionoccurswhentheoutputvoltageisequaltothevalueoftheIviDCPwrVoltageLevelpropertyandthecurrentislessthanorequaltothevalueoftheIviDCPwrCurrentLimitproperty.AconstantcurrentconditionoccurswhentheoutputcurrentisequaltothevalueoftheIviDCPwrCurrentLimitpropertyandtheIviDCPwrCurrentLimitBehaviorpropertyissettoIVIDCPWR_VAL_CURRENT_REGULATE.AnunregulatedconditionoccurswhentheoutputvoltageislessthanthevalueoftheIviDCPwrVoltageLevelpropertyandthecurrentislessthanthevalueoftheIviDCPwrCurrentLimitproperty.AnovervoltageconditionoccurswhentheoutputvoltageisequaltoorgreaterthanthevalueoftheIviDCPwrOVPLimitpropertyandtheIviDCPwrOVPEnabledpropertyissettoTRUE.Anover-currentconditionoccurswhentheoutputcurrentisequaltoor
greaterthanthevalueoftheIviDCPwrCurrentLimitpropertyandtheIviDCPwrCurrentLimitBehaviorpropertyissettoIVIDCPWR_VAL_CURRENT_TRIP.Wheneitheranovervoltageconditionoranover-currentconditionoccurs,thepowersupply'soutputprotectiondisablestheoutput.Ifthepowersupplyisinanovervoltageorover-currentstate,itdoesnotproducepoweruntiltheoutputprotectionisreset.TheIviDCPwrResetOutputProtectionVIresetstheoutputprotection.Oncetheoutputprotectionisreset,thepowersupplyresumesgeneratingapowersignal.
IviDCPwrResetOutputProtectionIviDCPwrBaseCapabilityGroupThisVIclearsalloutput-protectionconditionsonthepowersupply.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviDCPwrInitializeorIviDCPwrInitializeWithOptionsVI.
channelname("CHANNEL1")PassthevirtualchannelnamethatyouassigntotheinstrumentinMAX.Virtualchannelnamesarealiasesforinstrumentspecificchannelstrings.Theinstrumentspecificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.YouassignavirtualchannelnametoaninstrumentspecificchannelthroughMAX.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrumentspecificchannelnames.DefaultValue:CHANNEL1
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviDCPwrInitializeorIviDCPwrInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmore
informationabouttheerrordisplayed.
IviDCPwrSendSoftwareTriggerIviDCPwrSoftwareTrigger[SWT]ThisVIsendsacommandtotriggerthepowersupply.CallthisVIifyouconfigurethepowersupplytorespondtosoftwaretriggers.Ifthepowersupplyisnotconfiguredtorespondtosoftwaretriggers,thisVIreturnstheerrorIVIDCPWR_ERROR_TRIGGER_NOT_SOFTWARE(0xBFFA1001).
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviDCPwrInitializeorIviDCPwrInitializeWithOptionsVI.
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviDCPwrInitializeorIviDCPwrInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviDCPwrPropertiesExpandthisbooktoviewanalphabetizedlistofIviDCPwrproperties.
ActiveChannelActiveChannelPropertyDataType Access Appliesto Coercion HighLevelVIs
WO n/a none none
DescriptionSpecifiesthechannelnameusedtoaccessallsubsequentchannel-basedpropertiesinthispropertynode.Setthechannelbeforesettingchannel-basedproperties.Passanamethattheinstrumentdriverdefinesoravirtualchannelnametheend-userdefinesintheIVIconfigurationfileinMAX.PropertyNodePath<classdriver>»ActiveChannel
IviDCPwrChannelCountIviDCPwrBasePropertyDataType Access Appliesto Coercion HighLevelVIs
RO N/A None None
DescriptionReturnsthenumberofchannelsavailableontheinstrument.PropertyNodePathIviDCPwr»InherentIVISettings»SpecificDriverCapabilities»ChannelCount
IviDCPwrCurrentLimitIviDCPwrBasePropertyDataType Access Applies
to Coercion HighLevelVIs
R/W Channel N/A IviDCPwrConfigureCurrentLimit
DescriptionThischannel-basedpropertyspecifiestheoutputcurrentlimit.TheunitsareAmperes.ThevalueoftheIviDCPwrCurrentLimitBehaviorpropertydeterminesthebehaviorofthepowersupplywhentheoutputcurrentisequaltoorgreaterthanthevalueofthisproperty.PropertyNodePathIviDCPwr»BasicOperation»CurrentLimit
IviDCPwrCurrentLimitBehaviorIviDCPwrBasePropertyDataType Access Applies
to Coercion HighLevelVIs
R/W Channel N/A IviDCPwrConfigureCurrentLimit
DescriptionThischannel-basedpropertyspecifiesthebehaviorofthepowersupplywhentheoutputcurrentisequaltoorgreaterthanthevalueoftheIviDCPwrCurrentLimitproperty.PropertyNodePathIviDCPwr»BasicOperation»CurrentLimitBehaviorDefinedValuesIVIDCPWR_VAL_CURRENT_REGULATEIVIDCPWR_VAL_CURRENT_TRIP
IviDCPwrOutputEnabledIviDCPwrBasePropertyDataType Access Applies
to Coercion HighLevelVIs
R/W Channel N/A IviDCPwrConfigureOutputEnabled
DescriptionThischannel-basedpropertyspecifieswhetherthesignalthepowersupplyproducesappearsattheoutputconnector.PropertyNodePathIviDCPwr»BasicOperation»OutputEnabled
IviDCPwrOVPEnabledIviDCPwrBasePropertyDataType Access Appliesto Coercion HighLevelVIs
R/W Channel N/A IviDCPwrConfigureOVP
DescriptionThischannel-basedpropertyspecifieswhetherthepowersupplyprovidesovervoltageprotection.IfthispropertyissettoTRUE,thepowersupplydisablestheoutputwhentheoutputvoltageisgreaterthanorequaltothevalueoftheIviDCPwrOVPLimitproperty.PropertyNodePathIviDCPwr»BasicOperation»OVPEnabled
IviDCPwrOVPLimitIviDCPwrBasePropertyDataType Access Appliesto Coercion HighLevelVIs
R/W Channel N/A IviDCPwrConfigureOVP
DescriptionThischannel-basedpropertyspecifiesthevoltagethepowersupplyallows.Theunitsarevolts.IftheIviDCPwrOVPEnabledpropertyissettoTRUE,thepowersupplydisablestheoutputwhentheoutputvoltageisgreaterthanorequaltothevalueofthisproperty.IftheIviDCPwrOVPEnabledpropertyissettoFALSE,thispropertydoesnotaffectthebehavioroftheinstrument.PropertyNodePathIviDCPwr»BasicOperation»OVPLimit
IviDCPwrTriggerSource[TRG]IviDCPwrTriggerProperty[TRG]DataType Access Applies
to Coercion HighLevelVIs
R/W Channel N/A IviDCPwrConfigureTriggerSource[TRG]
DescriptionThischannel-basedpropertyspecifiesthetriggersource.AfteryoucallIviDCPwrInitiate[TRG],thepowersupplywaitsforatriggereventfromthesourceyouspecifywiththisproperty.Afteratriggereventoccurs,thepowersupplychangesthevoltageleveltothevalueoftheIviDCPwrTriggeredVoltageLevel[TRG],andthecurrentlimittothevalueoftheIviDCPwrTriggeredCurrentLimit[TRG],properties.PropertyNodePathIviDCPwr»Trigger»TriggerSource[TRG]DefinedValuesIVIDCPWR_VAL_TRIG_IMMEDIATEIVIDCPWR_VAL_TRIG_EXTERNALIVIDCPWR_VAL_SOFTWARE_TRIGIVIDCPWR_VAL_TRIG_TTL0IVIDCPWR_VAL_TRIG_TTL1IVIDCPWR_VAL_TRIG_TTL2IVIDCPWR_VAL_TRIG_TTL3IVIDCPWR_VAL_TRIG_TTL4IVIDCPWR_VAL_TRIG_TTL5IVIDCPWR_VAL_TRIG_TTL6IVIDCPWR_VAL_TRIG_TTL7IVIDCPWR_VAL_TRIG_ECL0IVIDCPWR_VAL_TRIG_ECL1IVIDCPWR_VAL_TRIG_PXI_STAR
IVIDCPWR_VAL_TRIG_RTSI_0IVIDCPWR_VAL_TRIG_RTSI_1IVIDCPWR_VAL_TRIG_RTSI_2IVIDCPWR_VAL_TRIG_RTSI_3IVIDCPWR_VAL_TRIG_RTSI_4IVIDCPWR_VAL_TRIG_RTSI_5IVIDCPWR_VAL_TRIG_RTSI_6
IviDCPwrTriggeredCurrentLimit[TRG]IviDCPwrTriggerProperty[TRG]DataType Access Applies
to Coercion HighLevelVIs
R/W Channel N/A IviDCPwrConfigureTriggeredCurrentLimit[TRG]
DescriptionThischannel-basedpropertyspecifiesthevaluetowhichthepowersupplysetsthecurrentlimitafteratriggereventoccurs.Theunitsareamps.AfteryoucallIviDCPwrInitiate[TRG],thepowersupplywaitsforatriggereventfromthesourceyouspecifywiththeIviDCPwrTriggerSource[TRG],property.Afteratriggereventoccurs,thepowersupplysetsthecurrentlimittothevalueofthisproperty.Afteratriggeroccurs,thevalueoftheIviDCPwrCurrentLimit[TRG]propertyreflectsthenewvaluetowhichthecurrentlimithasbeenset.PropertyNodePathIviDCPwr»Trigger»TriggeredCurrent[TRG]
IviDCPwrTriggeredVoltageLevel[TRG]IviDCPwrTriggerPropertyDataType Access Applies
to Coercion HighLevelVIs
R/W Channel N/A IviDCPwrConfigureTriggeredVoltageLevel[TRG]
DescriptionThischannel-basedpropertyspecifiesthevaluetowhichthepowersupplysetsthevoltagelevelafteratriggereventoccurs.Theunitsarevolts.AfteryoucallIviDCPwrInitiate[TRG],thepowersupplywaitsforatriggereventfromthesourceyouspecifywiththeIviDCPwrTriggerSource[TRG],property.Afteratriggereventoccurs,thepowersupplysetsthevoltageleveltothevalueofthisproperty.Afteratriggeroccurs,thevalueoftheIviDCPwrVoltageLevel[TRG]propertyreflectsthenewvaluetowhichthevoltagelevelhasbeenset.PropertyNodePathIviDCPwr»Trigger»TriggeredVoltageLevel[TRG]
IviDCPwrVoltageLevelIviDCPwrBasePropertyDataType Access Applies
to Coercion HighLevelVIs
R/W Channel N/A IviDCPwrConfigureVoltageLevel
DescriptionThischannel-basedpropertyspecifiesthevoltageleveltheDCpowersupplyattemptstogenerate.Theunitsarevolts.PropertyNodePathIviDCPwr»BasicOperation»VoltageLevel
IviDCPwrDefinedValuesExpandthisbooktoviewanalphabetizedlistofIviDCPwrdefinedvalues.
IVIDCPWR_VAL_CURRENT_REGULATEThepowersupplyregulatestheoutputcurrentatthevalueoftheIviDCPwrCurrentLimitpropertywhentheoutputreachesorexceedsthatvalue.DefinedValue:0
IVIDCPWR_VAL_CURRENT_TRIPThepowersupplydisablestheoutputwhentheoutputcurrentreachesorexceedsthevalueoftheIviDCPwrCurrentLimitproperty.DefinedValue:1
IVIDCPWR_VAL_SOFTWARE_TRIGThepowersupplywaitsfortheIviDCPwrSendSoftwareTriggerVItoexecutebeforechangingtheoutputsignal.DefinedValue:2
IVIDCPWR_VAL_TRIG_ECL0ThepowersupplywaitsforatriggerontheECL0linebeforechangingtheoutputsignal.DefinedValue:11
IVIDCPWR_VAL_TRIG_ECL1ThepowersupplywaitsforatriggerontheECL1linebeforechangingtheoutputsignal.DefinedValue:12
IVIDCPWR_VAL_TRIG_EXTERNALThepowersupplywaitsforanexternaltriggerbeforechangingtheoutputsignal.DefinedValue:1
IVIDCPWR_VAL_TRIG_IMMEDIATEThepowersupplydoesnotwaitforatriggerbeforechangingtheoutputsignal.DefinedValue:0
IVIDCPWR_VAL_TRIG_IMMEDIATEThepowersupplydoesnotwaitforatriggerbeforechangingtheoutputsignal.DefinedValue:0
IVIDCPWR_VAL_TRIG_PXI_STARThepowersupplywaitsforatriggeronthePXISTARlinebeforechangingtheoutputsignal.DefinedValue:13
IVIDCPWR_VAL_TRIG_RTSI_0ThepowersupplywaitsforatriggerontheRTSI0linebeforechangingtheoutputsignal.DefinedValue:14
IVIDCPWR_VAL_TRIG_RTSI_1ThepowersupplywaitsforatriggerontheRTSI1linebeforechangingtheoutputsignal.DefinedValue:15
IVIDCPWR_VAL_TRIG_RTSI_2ThepowersupplywaitsforatriggerontheRTSI2linebeforechangingtheoutputsignal.DefinedValue:16
IVIDCPWR_VAL_TRIG_RTSI_3ThepowersupplywaitsforatriggerontheRTSI3linebeforechangingtheoutputsignal.DefinedValue:17
IVIDCPWR_VAL_TRIG_RTSI_4ThepowersupplywaitsforatriggerontheRTSI4linebeforechangingtheoutputsignal.DefinedValue:18
IVIDCPWR_VAL_TRIG_RTSI_5ThepowersupplywaitsforatriggerontheRTSI5linebeforechangingtheoutputsignal.DefinedValue:19
IVIDCPWR_VAL_TRIG_RTSI_6ThepowersupplywaitsforatriggerontheRTSI6linebeforechangingtheoutputsignal.DefinedValue:20
IVIDCPWR_VAL_TRIG_TTL0ThepowersupplywaitsforatriggerontheTTL0linebeforechangingtheoutputsignal.DefinedValue:3
IVIDCPWR_VAL_TRIG_TTL1ThepowersupplywaitsforatriggerontheTTL1linebeforechangingtheoutputsignal.DefinedValue:4
IVIDCPWR_VAL_TRIG_TTL2ThepowersupplywaitsforatriggerontheTTL2linebeforechangingtheoutputsignal.DefinedValue:5
IVIDCPWR_VAL_TRIG_TTL3ThepowersupplywaitsforatriggerontheTTL3linebeforechangingtheoutputsignal.DefinedValue:6
IVIDCPWR_VAL_TRIG_TTL4ThepowersupplywaitsforatriggerontheTTL4linebeforechangingtheoutputsignal.DefinedValue:7
IVIDCPWR_VAL_TRIG_TTL5ThepowersupplywaitsforatriggerontheTTL5linebeforechangingtheoutputsignal.DefinedValue:8
IVIDCPWR_VAL_TRIG_TTL6ThepowersupplywaitsforatriggerontheTTL6linebeforechangingtheoutputsignal.DefinedValue:9
IVIDCPWR_VAL_TRIG_TTL7ThepowersupplywaitsforatriggerontheTTL7linebeforechangingtheoutputsignal.DefinedValue:10
PropertiesforControllingIviDCPwrSimulationNoteYoucansetSimulationAttributesinMAXontheInitialSettingstabofIVIDrivers»Advanced»SimulationDriverSessions»nisIviClassorinthesimulationinteractivepanels.RefertoNationalInstrumentsIVIDriverHelp»ConfiguringYourSystemformoreinformation.
TwosetsofpropertiesexistforusewiththeIviDCPwrSimulationDriver.Thefollowingtabledescribespropertiesthatcontrolbehaviorofthedriver.AnothertablelistspropertiesthatsimulatethestatusofspecificdriverVIs.AnIviDCPwrSimulatorSetupDialogBoxexiststohelpyouconfigurethemeasurementsimulationfortheIviDCPwrSimulatordriver.
IviDCPwrPropertiesforControllingSimulationName Data
TypeAccess Applies
toDescription
INTERACTIVE_SIMULATION Boolean W No Specifieswhethertosetthedrivertointeractivemode.Ininteractivemode,thesimulationdriverusespop-upuserinterfacepanelsforgettinginformationfromyou.Non-interactivemodeisusefulwhenyoudonotwanttheinteractivepanelstointerruptyourtestprogram.
SELF_TEST_CODE Integer W No Specifiestheself-testcode.WhentheIviDCPwrSelf-TestVIiscalled,theself-testresultparameterreturnsthis
value.SELF_TEST_MSG String W No Specifiesthe
self-testmessage.WhentheIviDCPwrSelf-TestVIiscalled,theself-testmessageparameterreturnsthisstring.
ERROR_QUERY_CODE Integer W No Specifiestheerror-querycode.WhentheIviDCPwrError-QueryVIiscalled,theerrorcodeparameterreturnsthisvalue.
ERROR_QUERY_MSG String W No Specifiestheerror-querymessage.WhentheIviDCPwrError-QueryVIiscalled,theerrormessageparameterreturnsthisstring.
DRIVER_REV_QUERY String W No Specifiestheinstrument
driverrevisionmessage.WhentheIviDCPwrRevisionQueryVIiscalled,theinstrumentdriverrevisionparameterreturnsthisstring.
INSTR_REV_QUERY String W No Specifiesthefirmwarerevisionmessage.WhentheIviDCPwrRevisionQueryVIiscalled,thefirmwarerevisionparameterreturnsthisstring.
SIMULATE_STATUS_CODE Boolean W No SpecifieswhethertosimulatereturncodesfromtheIviDCPwrdriverVIs.RefertothePropertiesforIviDCPwrSimulation
tableformore
RelatedTopicsSettingUpSimulatedErrorsSettingUpSimulationforVXIplug&playVIs
IviDCPwrSimulatorSetupDialogBoxTwosetsofpropertiesexistforusewiththeIviDCPwrSimulationDriver.YouusethedialogboxshownbelowtoconfigurethemeasurementsimulationfortheIviDCPwrSimulatordriver.Scrolldowntoseeadescriptionofeachcontrol.
SimulatorSetupDialogBoxAlwayspromptforoutputdatasimulationLeavingthiscontrolselectedcausesthepaneltoappearateverymeasurementacquisitioneventinyourprogram.Allsimulatedacquisitionsintheprogramusethesamemeasurementconfigurationinformation.Unselectingthiscontrolcausesthemeasurementsimulationpaneltoneverappearagainduringthecourseofyourprogram.ChannelThiscontrolspecifiesthechannelforwhichyouwanttoconfigureasimulationmeasurement.MeasurementEnterthemeasurementbasetouseforallcomputergeneratedmeasurements.AllcomputergeneratedmeasurementvaluesfallwithintherangeofthisvalueplusorminusthevalueoftheNoisecontrol.ValidRange:anyvalueNoiseEnterthereadingnoisetouseforallcomputergeneratedmeasurements.AllcomputergeneratedmeasurementvaluesfallwithintherangeofthevalueoftheMeasurementcontrolplusorminusthisvalue.ValidRange:anypositivevalue
PropertiesforStatusSimulationinIviDCPwrWhenanIviDCPwrdriverfunctioniscalled,thedriverquerieswhetherNISDCPWR_ATTR_SIMULATE_STATUS_CODEisenabled.Ifenabled,thedrivergetstheappropriatefunction'ssimulationstatuscode.Ifthevalueofthesimulationstatuscoderepresentsawarning(hasapositivevalue),thenitisreturnedasthefunction'sreturnstatusonlyifnoothererrororwarningoccurredbeforethefunctionends.Ifthevalueofthesimulationstatuscoderepresentsanerror(hasanegativevalue),thenitisreturnedasthefunction'sreturnstatusonlyifnoothererroroccurredbeforethefunctionends.ThefollowingIviDCPwrVIsdonotsupportstatuscodesimulation:
IviDCPwrGetErrorIviDCPwrClearErrorIviDCPwrGetNextInterchangeWarningIviDCPwrResetNextInterchangeWarningIviDCPwrClearNextInterchangeWarningIviDCPwrGetNextCoercionRecord
EachVIsupportedbytheIviDCPwrclassdriverhasacorrespondingpropertythatdeterminesthestatuscodetoreturnwhenstatuscodesimulationisenabled.ThefollowingtableliststhestatuscodepropertiesandtheVIforwhichtheyreturnavalue.ThesepropertiesarealloftypeViInt32,non-readable,andnon-channelbased.
NoteInthefollowingtable,theliteralstringNISDCPWRprecedesallpropertynames.
IviDCPwrPropertiesforStatusSimulationProperty VIINIT_STATUS IviDCPwr
Initialize,IviDCPwrInitializeWithOptions
CLOSE_STATUS IviDCPwrCloseRESET_STATUS IviDCPwrResetSELF_TEST_STATUS IviDCPwrSelf-Test
ERROR_QUERY_STATUS IviDCPwrError-Query
ERROR_MESSAGE_STATUS IviDCPwrErrorMessage
REVISION_QUERY_STATUS IviDCPwrRevisionQuery
RESET_DEFAULT_STATUS IviDCPwrResetWithDefaults
DISABLE_STATUS IviDCPwrDisableINVALIDATE_STATUS IviDCPwr
InvalidateAllAttributes
GET_CH_NAME_STATUS IviDCPwrGetChannelName
CONFIGURE_OUTPUT_ENABLED_STATUS IviDCPwrConfigureOutputEnabled
CONFIGURE_OUTPUT_RANGE_STATUS IviDCPwrConfigureOutputRange
CONFIGURE_CURRENT_LIMIT_STATUS IviDCPwrConfigureCurrentLimit
CONFIGURE_OVP_STATUS IviDCPwr
ConfigureOVPCONFIGURE_VOLTAGE_LEVEL_STATUS IviDCPwr
ConfigureVoltageLevel
QUERY_OUTPUT_STATE_STATUS IviDCPwrQueryOutputState
QUERY_MAX_CURRENT_LIMIT_STATUS IviDCPwrQueryMaxCurrentLimit
QUERY_MAX_VOLTAGE_LEVEL_STATUS IviDCPwrQueryMaxVoltageLevel
RESET_OUTPUT_PROTECTION_STATUS IviDCPwrResetOutputProtection
CONFIGURE_TRIGGER_SOURCE_STATUS IviDCPwrConfigureTriggerSource
CONFIGURE_TRIGGERED_VOLTAGE_LEVEL_STATUS IviDCPwrConfigureTriggeredVoltageLevel
CONFIGURE_TRIGGERED_CURRENT_LIMIT_STATUS IviDCPwrConfigureTriggeredCurrentLimit
ABORT_STATUS IviDCPwrAbortINITIATE_STATUS IviDCPwrInitiateSEND_SOFTWARE_TRIGGER_STATUS IviDCPwrSend
SoftwareTriggerMEASURE_STATUS IviDCPwrMeasure
IviDmmClassDriverReferenceforLabVIEWConceptsIviDmmClassDriverOverviewIviDmmExtensionCapabilityGroupsIviDmmBehaviorModels
IviDmmVIandPropertyReferenceIviDmmVITreeIviDmmPropertiesbyGroupIviDmmPropertyValueDefinitionsIviDmmErrorandCompletionCodesOtherReferenceInterchangeabilityCheckingSimulation
IviDmmClassDriverOverviewThisinstrumentdriverprovidesprogrammingsupportfortheIviDmmClass.TheIviDmmclassisdesignedtosupportthetypicalDMMaswellascommonextendedfunctionalityfoundinmorecomplexinstruments.TheIviDmmclassdriverconceptualizesaDMMasaninstrumentthatcanmeasurescalarquantitiesofaninputsignalandcanbeappliedtoawidevarietyofinstruments.Typicallythemeasuredquantityisavoltage(ACandDC),current,orresistance.However,theIviDmmclassdrivercansupportinstrumentsthatmeasureotherquantitiessuchastemperatureandfrequency.ThedrivercontainsalltheVIsthattheIVIFoundationrequiresfortheIviDmmspecification.ThisdriverrequiresNI-VISAandtheIVICompliancePackagetobeinstalled.TheIviDmmclassisdividedintoaIviDmmBasecapabilitygroupandseveralextensiongroups.ThebasecapabilitygroupisusedtoconfigureaDMMforatypicalmeasurement(whichincludessettingthemeasurementVI,desiredrange,desiredresolution,andtriggersource),initiatingthatmeasurement,andreturningameasuredvalue.ManyDMMssupportmeasurementtypesthatrequireadditionalparameterstobeconfigured,suchastheminimumandmaximumfrequencyoftheinputsignalforACmeasurements.TheIviDmmclassdefinesextensiongroupsforeachmeasurementtypethatrequirestheseadditionalparameters.TheIviDmmclassalsodefinesanextensiongroupcalledIviDmmMultiPoint.TheIviDmmMultiPointextensiongroupisusedtoconfigureDMMsthatcanacquiremultiplemeasurementsbasedonmultipletriggersandtakemultiplemeasurementspertrigger.ThistypeofinstrumentusedinconjunctionwithascanneristypicallyusedtoimplementascanningDMM.Inaddition,theIviDmmclassdefinesextensiongroupsthatconfigureadvancedsettingssuchasauto-zeroandpowerlinefrequency,orreturnadditionalinformationaboutthecurrentstateoftheinstrumentsuchasaperturetime.UsethisdrivertodevelopprogramsthatareindependentofaparticularDMM.YoucanusethisclassdriverwithanyDMMthathasanIVIinstrumentspecificdriverthatiscompliantwiththeIviDmmclass.TheIviDmmclassdriveraccessesthespecificdriverforyourinstrumentusing
theconfigurationinformationyousupplywithMAX.
ExtensionCapabilityGroupsTheIviDmmclassdriveridentifiesVIsandpropertiesthatbelongtoanextensiongroupwiththefollowingabbreviations.Instrumentspecificdriversarenotrequiredtoimplementanyoftheextensioncapabilitygroups.IfyouuseVIsandpropertiesthatbelongtoextensioncapabilitygroups,everyinstrumentspecificdriverthatyouusemustimplementthoseextensions.
GroupName Abbreviation DescriptionIviDmmACMeasurement [AC] Definespropertiesthat
configureadditionalsettingsforACmeasurements.Thesepropertiesaretheminimumandmaximumfrequencycomponentsoftheinputsignal.ThisextensiongroupalsodefinesVIsthatconfiguretheseproperties.
IviDmmAutoRangeValue [ARV] SupportsDMMswiththecapabilitytoreturntheactualrangevaluewhenautoranging.
IviDmmAutoZero [AZ] SupportsDMMswiththecapabilitytotakeanautozeroreading.Ingeneral,theauto-zerocapabilityofaDMMnormalizesallmeasurementsbasedonaZeroReading.
IviDmmDeviceInfo [DI] DefinesaVIandasetofpropertiesthatyoucanquerytogain
additionalinformationabouttheinstrument'sconfiguration
IviDmmFrequencyMeasurement [FREQ] SupportsDMMsthattakefrequencymeasurements.Itdefinespropertiesthatarerequiredtoconfigureadditionalparametersneededforfrequencymeasurements.
IviDmmMultiPoint [MP] Supportsinstrumentscapableofacquiringmeasurementsbasedonmultipletriggers,andacquiringmultiplemeasurementsforeachtrigger
IviDmmPowerLineFrequency [PLF] SupportsDMMswiththecapabilitytospecifythepowerlinefrequency.
IviDmmResistanceTemperatureDevice
[RTD] SupportsDMMsthattaketemperaturemeasurementsusingaresistancetemperaturedevice(RTD)transducertype.
IviDmmSoftwareTrigger [SWT] SupportsDMMsthatcaninitiateameasurementbasedonasoftwaretriggersignal.YoucansendasoftwaretriggertocausetheDMMto
initiateameasurement.
IviDmmTemperatureMeasurement [TMP] SupportsDMMsthattaketemperaturemeasurementswithathermocouple,anRTD,orathermistortransducertype.Thisextensiongroupselectsthetransducertype.Othercapabilitygroupsfurtherconfiguretemperaturesettingsbasedonthetransducertype.
IviDmmThermistor [THM] SupportsDMMsthattaketemperaturemeasurementsusingathermistortransducertype.
IviDmmThermocouple [TC] SupportsDMMsthattaketemperaturemeasurementsusingathermocoupletransducertype.
IviDmmTriggerSlope [TS] SupportsDMMsthatcanspecifythepolarityoftheexternaltriggersignal.ItdefinesanpropertyandaVItoconfigurethispolarity.
RelatedTopicsIVIInherentClassCapabilities
IviDmmExtensionCapabilityGroupsTheIviDmmclassdriveridentifiesVIsandpropertiesthatbelongtoanextensiongroupwiththefollowingabbreviations.Instrumentspecificdriversarenotrequiredtoimplementanyoftheextensioncapabilitygroups.IfyouuseVIsandpropertiesthatbelongtoextensioncapabilitygroups,everyinstrumentspecificdriverthatyouusemustimplementthoseextensions.
GroupName DescriptionIviDmmACMeasurement Definespropertiesthatconfigure
additionalsettingsforACmeasurements.Thesepropertiesaretheminimumandmaximumfrequencycomponentsoftheinputsignal.ThisextensiongroupalsodefinesVIsthatconfiguretheseproperties.
IviDmmAutoRangeValue SupportsDMMswiththecapabilitytoreturntheactualrangevaluewhenautoranging.
IviDmmAutoZero SupportsDMMswiththecapabilitytotakeanautozeroreading.Ingeneral,theauto-zerocapabilityofaDMMnormalizesallmeasurementsbasedonaZeroReading.
IviDmmDeviceInfo DefinesaVIandasetofpropertiesthatyoucanquerytogainadditionalinformationabouttheinstrument'sconfiguration
IviDmmFrequencyMeasurement SupportsDMMsthattakefrequencymeasurements.Itdefinespropertiesthatarerequiredtoconfigureadditionalparametersneededforfrequencymeasurements.
IviDmmMultiPoint Supportsinstrumentscapableofacquiringmeasurementsbasedon
multipletriggers,andacquiringmultiplemeasurementsforeachtrigger
IviDmmPowerLineFrequency SupportsDMMswiththecapabilitytospecifythepowerlinefrequency.
IviDmmResistanceTemperatureDevice
SupportsDMMsthattaketemperaturemeasurementsusingaresistancetemperaturedevice(RTD)transducertype.
IviDmmSoftwareTrigger SupportsDMMsthatcaninitiateameasurementbasedonasoftwaretriggersignal.YoucansendasoftwaretriggertocausetheDMMtoinitiateameasurement.
IviDmmTemperatureMeasurement SupportsDMMsthattaketemperaturemeasurementswithathermocouple,anRTD,orathermistortransducertype.Thisextensiongroupselectsthetransducertype.Othercapabilitygroupsfurtherconfiguretemperaturesettingsbasedonthetransducertype.
IviDmmThermistor SupportsDMMsthattaketemperaturemeasurementsusingathermistortransducertype.
IviDmmThermocouple SupportsDMMsthattaketemperaturemeasurementsusingathermocoupletransducertype.
IviDmmTriggerSlope SupportsDMMsthatcanspecifythepolarityoftheexternaltriggersignal.ItdefinesanpropertyandaVItoconfigurethispolarity.
IviDmmACMeasurementExtensionGroupTheIviDmmACMeasurementextensiongroupsupportsDMMsthattakeACvoltageorACcurrentmeasurements.ItdefinespropertiesthatconfigureadditionalsettingsforACmeasurements.Thesepropertiesaretheminimumandmaximumfrequencycomponentsoftheinputsignal.ThisextensiongroupalsodefinesVIsthatconfiguretheseproperties.
ACMeasurementExtensionVIIviDmmConfigureACBandwidth
ACMeasurementExtensionPropertiesIviDmmACMinimumFrequencyIviDmmACMaximumFrequencyRelatedTopicsIviDmmBehaviorModelIviDmmVITreeIviDmmProperties
IviDmmAutoRangeValueExtensionGroupTheIviDmmAutoRangeValueextensionsupportsDMMswiththecapabilitytoreturntheactualrangevaluewhenautoranging.
AutoRangeValueExtensionVIIviDmmGetAutoRangeValue
AutoRangeValueExtensionPropertyIviDmmAutoRangeValueRelatedTopicsIviDmmbehaviormodel
IviDmmAutoZeroExtensionGroupTheIviDmmAutoZeroextensiongroupsupportsDMMsthathavethecapabilitytotakeanauto-zeroreading.Ingeneral,theauto-zerocapabilityofaDMMnormalizesallmeasurementsbasedonaZeroReading.
AutoZeroExtensionVIIviDmmConfigureAutoZeroMode
AutoZeroExtensionPropertyIviDmmAutoZeroRelatedTopicsIviDmmbehaviormodel
IviDmmBaseCapabilityGroupTheIviDmmbasecapabilitygroupsupportsDMMsthattakeonemeasurementatatime.TheIviDmmbasecapabilitygroupdefinespropertiesandtheirvaluestoconfigurethetypeofmeasurementandhowthemeasurementisperformed.Thesepropertiesincludethemeasurementfunction,range,resolution,triggersource,andtriggerdelay.TheIviDmmbasecapabilitygroupincludesVIsforconfiguringtheDMMaswellasinitiatingandretrievingmeasurements.
IviDmmBaseVIsIviDmmConfigureMeasurementIviDmmConfigureTriggerIviDmmReadIviDmmAbortIviDmmInitiateIviDmmFetchIviDmmSendSoftwareTriggerIviDmmIsOver-Range
IviDmmBasePropertiesIviDmmFunctionIviDmmRangeIviDmmResolutionIviDmmTriggerSourceIviDmmTriggerDelayRelatedTopicsIVIInherentVIsIVIInherentPropertiesIviDmmBehaviorModelFormoreVIandpropertyinformation:IviDmmVITreeIviDmmProperties
IviDmmDeviceInfoExtensionGroupTheIviDmmDeviceInfocapabilitygroupdefinesasetofread-onlypropertiesthatcanbequeriedtogainadditionalinformationconcerninghowtheDMMispresentlyconfigured.
IviDmmDeviceInfoVIIviDmmGetApertureTimeInfo
IviDmmDeviceInfoPropertiesIviDmmApertureTime[DI]IviDmmApertureTimeUnits[DI]
BehaviorModelIviDmmbehaviormodel
IviDmmFrequencyMeasurementExtensionGroupTheIviDmmFrequencyMeasurementextensiongroupsupportsDMMsthattakefrequencymeasurements.Thisgroupdefinespropertiesthatarerequiredtoconfigureadditionalparametersneededforfrequencymeasurements.
FrequencyMeasurementExtensionVIIviDmmConfigureFrequencyVoltageRange[FRQ]
FrequencyMeasurementExtensionPropertyIviDmmFrequencyVoltageRangeRelatedTopicsIviDmmbehaviormodel
IviDmmMultiPointExtensionGroupTheIviDmmMultiPointextensiongroupdefinesextensionsforDMMscapableofacquiringmeasurementsbasedonmultipletriggers,andacquiringmultiplemeasurementsforeachtrigger.TheIviDmmMultiPointextensiongroupdefinesadditionalpropertiessuchsamplecount,sampletrigger,triggercount,andsampleintervaltocontrolmultipointDMMs.TheIviDmmMultiPointextensiongroupalsoaddsVIsforconfiguringtheDMMaswellasstartingacquisitionsandretrievingmultiplemeasuredvalues.
MultipointExtensionVIsIviDmmConfigureMeasCompleteDestIviDmmConfigureMultipointIviDmmReadMultipointIviDmmFetchMultiplePoint
MultipointExtensionPropertiesIviDmmMeasCompleteDestination[MP]IviDmmSampleCount[MP]IviDmmSampleInterval[MP]IviDmmSampleTrigger[MP]IviDmmTriggerCount[MP]RelatedTopicsIviDmmPropertiesIviDmmVIsIviDmmbehaviormodel
IviDmmPowerLineFrequencyExtensionGroupTheIviDmmPowerLineFrequencyextensiongroupsupportsDMMswiththecapabilitytospecifythepowerlinefrequency.
PowerLineFrequencyExtensionVIIviDmmConfigurePowerLineFrequency[PLF]
PowerLineFrequencyExtensionPropertyIviDmmPowerlineFrequencyRelatedTopicsIviDmmbehaviormodel
IviDmmResistanceTemperatureDeviceExtensionGroupTheIviDmmResistanceTemperatureDeviceextensiongroupsupportsDMMsthattaketemperaturemeasurementsusingaresistancetemperaturedevice(RTD)transducertype.TheIviDmmclassassumesthatyouareusingaPlatinumResistanceTemperatureDevice.
ResistanceTemperatureDeviceExtensionVIIviDmmConfigureRTD
ResistanceTemperatureDeviceExtensionPropertiesIviDmmRTDAlphaIviDmmRTDResistanceRelatedTopicsIviDmmbehaviormodel
IviDmmSoftwareTriggerExtensionGroupTheIviDmmSoftwareTriggerextensiongroupsupportsDMMsthatcaninitiateameasurementbasedonasoftwaretriggersignal.YoucansendasoftwaretriggertocausetheDMMtoinitiateameasurement.
SoftwareTriggerExtensionVIIviDmmSendSoftwareTriggerRelatedTopicsIviDmmbehaviormodel
IviDmmTemperatureMeasurementExtensionGroupTheIviDmmTemperatureMeasurementextensiongroupsupportsDMMsthattaketemperaturemeasurementswithathermocouple,anRTD,orathermistortransducertype.Thisextensiongroupselectsthetransducertype.Othercapabilitygroupsfurtherconfiguretemperaturesettingsbasedonthetransducertype.
TemperatureMeasurementExtensionVIIviDmmConfigureTransducerType
TemperatureMeasurementExtensionPropertyIviDmmTransducerType[TMP]RelatedTopicsIviDmmbehaviormodel
IviDmmThermistorExtensionGroupTheIviDmmThermistorextensiongroupsupportsDMMsthattaketemperaturemeasurementsusingathermistortransducertype.TheIviDmmclassassumesthatyouareusinganinterchangeablethermistor.Interchangeablethermistorsarethermistorsthatexhibitsimilarbehaviorforagivenresistancevalue.
ThermistorExtensionVIIviDmmConfigureThermistor[THM]
ThermistorExtensionPropertyIviDmmThermistorResistanceRelatedTopicsIviDmmbehaviormodel
IviDmmThermocoupleExtensionGroupTheIviDmmThermocoupleextensiongroupsupportsDMMsthattaketemperaturemeasurementsusingathermocoupletransducertype.
ThermocoupleExtensionVIsIviDmmConfigureThermocoupleIviDmmConfigureFixedRefJunction
ThermocoupleExtensionPropertiesIviDmmFixedReferenceJunctionIviDmmReferenceJunctionTypeIviDmmThermocoupleTypeRelatedTopicsIviDmmbehaviormodel
IviDmmTriggerSlopeExtensionGroupTheIviDmmTriggerSlopeextensiongroupsupportsDMMsthatcanspecifythepolarityoftheexternaltriggersignal.ItdefinesanpropertyandaVItoconfigurethispolarity.
TriggerSlopeExtensionVIIviDmmConfigureTriggerSlope
TriggerSlopeExtensionPropertyIviDmmTriggerSlopeRelatedTopicsIviDmmbehaviormodel
IviDmmBehaviorModelsIviDmmIviDmmMultiPointIviDmmSoftwareTrigger
IviDmmBehaviorModelThefollowingstatediagramshowsrelationshipsbetweentheIviDmmbasecapabilitygroupandDMMbehavior.
IviDmmBehaviorModelThemainstateintheIviDmmClassistheIdlestate.TheDMMenterstheIdlestatewhenitispowered-on,whenitsuccessfullycompletesameasurement,orwhenyoucallIviDmmAbortfromapreviousmeasurement.Typically,youconfiguretheDMMwhileitisintheIdlestate.IviDmmpropertiescanbeconfiguredindividuallywiththepropertynodeorwiththehigh-levelIviDmmConfigureMeasurementVI.TheIviDmmReadandIviDmmInitiateVIscausetheDMMtoleavetheIdlestateandtransitiontotheWait-For-Triggerstate.TheIviDmmReadVIdoesnotreturnuntilthemeasurementprocessiscompleteandtheDMMhasreturnedtotheIdlestate.TheIviDmmInitiateVIreturnsassoonastheDMMleavestheIdlestate.TheDMMleavestheWait-For-Triggerstatewhenitreceivesatriggerevent.ThetypeoftriggereventisspecifiedbythepropertyIviDmmTriggerSource.Afterthespecifiedtriggereventoccurs,theDMMwaitstheamountoftimespecifiedbythepropertyIviDmmTriggerDelayandthentakesameasurement.ThetypeofmeasurementisspecifiedbytheIviDmm
Function,IviDmmRange,andIviDmmResolutionproperties.IfyousettheIviDmmFunctionpropertytoavaluethatrequiresanextensioncapabilitygroup,thepropertiesofthatcapabilitygroupfurtherconfigurethemeasurement.Afterthemeasurementistaken,theDMM(ifitiscapableofdoingso)generatestheMeasurementCompletesignalandreturnstotheIdlestate.TheIviDmmbasecapabilitygroupdoesnotrequirethataDMMbeabletogenerateaMeasurementCompletesignal.TheMeasurementCompletesignalispresentedintheBaseCapabilitiesStateDiagramtodefinewhenthesignalisgeneratedasmostDMMsgeneratethissignalbutmaynotbeabletoconfigureit.TheIviDmmFetchVIisusedtoretrievemeasurementsthatwereinitiatedbytheIviDmmInitiateVI.ThemeasurementdatareturnedfromtheIviDmmReadandIviDmmFetchVIsisacquiredaftertheDMMhaslefttheWait-For-Triggerstate.
IviDmmMultiPointBehaviorModelThefollowingstatediagramshowsrelationshipsbetweenIviDmmMultiPointextensiongroupandDMMbehavior.OnlytheelementsaddedbytheIviDmmMultiPointcapabilitygrouparerepresentedinthisstatediagram.
IviDmmMultiPointBehaviorModelTheIviDmmMultiPointbehaviormodelbuildsuponthefundamentalIviDmmbehaviormodelandonlydocumentsadditionalitemsintroducedbytheIviDmmMultiPointextensiongroup.ThemainstateistheIdlestate.Typically,youconfiguretheIviDmmMultiPointpropertieswhileDMMisintheIdlestate.IviDmmMultiPointpropertiescanbeconfiguredindividuallywiththehigh-levelIviDmmConfigureMultiPointVI.TheIviDmmInitiateandIviDmmReadMultiPointVIscausetheDMMtoleavetheIdlestateandtransitiontotheWait-For-Triggerstate.TheIviDmmReadMultiPointVIdoesnotreturnuntilthemeasurementprocessiscompleteandtheDMMreturnstotheIdlestate.TheIviDmmInitiateVIreturnsassoonastheDMMleavestheIdlestate.TheIviDmmMultiPointextensiongroupdoesnotaddadditionalcapabilitiestotheWait-For-Triggerstate.AftertheDMMleavestheWait-For-Triggerstate,itthenexecutesadelay.ThelengthofthedelayisspecifiedbytheIviDmmTriggerDelayproperty.Afterthemeasurementistaken,theDMMthen,ifitiscapableofdoingso,generatestheMeasurementCompletesignal.TheDMMthencomparesthesamplecountwiththenumberofmeasurementstakensincethelasttriggerevent.ThesamplecountisspecifiedbytheIviDmmSampleCount[MP]property.IfthenumbermeasurementsisnotequaltothesamplecounttheDMMmovestotheWait-For-Sample-Triggerstate.TheDMMremainsintheWait-For-Sample-TriggerstateuntiltheeventspecifiedbythepropertyIviDmmSampleTrigger[MP]occurs.Thenittakesanothermeasurement.Oncethenumberofmeasurementstakenisequaltothesamplecount,theDMMthencomparesthenumbertriggercountwiththenumberoftriggereventsthathaveoccurredsinceeithertheIviDmmInitiateorIviDmmReadMultiPointVIwascalled.Thetriggercountisspecifiedby
thepropertyIviDmmTriggerCount[MP].Ifthenumberoftriggereventsisnotequaltothetriggercount,theDMMreturnstotheWait-For-Triggerstate.Oncethenumberoftriggereventsisequaltothetriggercount,theDMMreturnstotheIdlestate.TheIviDmmFetchMultiPointVIisusedtoretrievemeasureddatafrommeasurementsinitiatedbytheIviDmmInitiateVI.ThemeasurementdatareturnedfromtheIviDmmReadMultiPointandIviDmmFetchMultiPointVIsisacquiredaftertheDMMhaslefttheWait-For-Triggerstate.
IviDmmSoftwareTriggerBehaviorModelThebehaviormodeloftheIviDmmSoftwareTriggerfollowsthebehaviormodeloftheIviDmmBasecapabilitygroupandtheIviDmmMultiPointextensiongroup.Itdefinesanadditionaltriggereventforthetriggersource.TheDMMleavestheWait-For-TriggerstatewhenitreceivesatriggereventspecifiedbytheIviDmmTriggerSourceproperty.TheDMMleavestheWait-For-Sample-TriggerstatewhenitreceivesatriggereventspecifiedbytheIviDmmSampleTrigger[MP]property.WhenthetriggersourceorsampletriggerissettoIVIDMM_VAL_SOFTWARE_TRIG,theIviDmmSendSoftwareTriggerVIisusedtogeneratethetriggerevent.CallingthisVIcausestheDMMtotakeameasurement.
IviDmmVITreeTheVItreefortheIviDmmclassdriver,includingIVIandVXIplug&playrequiredVIs,isshowninthefollowingtable.
NoteYouusetheLabVIEWPropertyNodetogetandsetproperties.
IviDmmVITreeNameorClass VIName RequiredBy
Initialize IviDmmInitialize
VPP
InitializeWithOptions
IviDmmInitializeWithOptions
IVI
Configuration
ConfigureMeasurement
IviDmmConfigureMeasurement
IviDmmConfigureMeasurement
SpecificMeasurements
ConfigureACBandwidth[AC]
IviDmmConfigureACBandwidth
IviDmmACMeasurement
ConfigureFrequencyVoltageRange[FRQ]
IviDmmConfigureFrequencyVoltageRange
IviDmmFrequencyMeasurement
Temperature
ConfigureTransducerType[TMP]
IviDmmConfigureTransducerType
IviDmmTemperatureMeasurement
ConfigureThermocouple[TC]
IviDmmConfigureThermocouple
IviDmmThermocouple
ConfigureFixedRefJunction[TC]
IviDmmConfigureFixedRefJunction
IviDmmThermocouple
IviDmm IviDmmResistanceTemperatureDevice
ConfidentRTD[RTD]
ConfigureRTD
ConfigureThermistor[THM]
IviDmmConfigureThermistor
IviDmmThermistor
Trigger
ConfigureTrigger
IviDmmConfigureTrigger
IviDmm
ConfigureTriggerSlope
IviDmmConfigureTriggerSlope
IviDmmTriggerSlope
Multipoint
ConfigureMultipoint[MP]
IviDmmConfigureMultipoint
IviDmmMultiPoint
ConfigureMeasCompleteDest[MP]
IviDmmConfigureMeasCompleteDest
IviDmmMultiPoint
MeasurementOperationOptions
ConfigureAutoZeroMode[AZ]
IviDmmConfigureAutoZeroMode
IviDmmAutoZero
ConfigurePowerLineFrequency[PLF]
IviDmmConfigurePowerLineFrequency
IviDmmPowerLineFrequency
ConfigurationInformation
GetAutoRangeValue[ARV]
IviDmmGetAutoRangeValue
IviDmmAutoRangeValue
GetApertureTimeInfo[DI]
IviDmmGetApertureTimeInfo
IviDmmDeviceInfo
Measurement
Read IviDmmRead IviDmm
ReadMultipoint[MP]
IviDmmReadMultipoint
IviDmmMultiPoint
Low-LevelMeasurement
Initiate IviDmmInitiate IviDmm
SendSoftwareTrigger
IviDmmSendSoftwareTrigger
IviDmmSoftwareTrigger
Fetch IviDmmFetch IviDmm
FetchMultipoint[MP]
IviDmmFetchMultiplePoint
IviDmmMultiPoint
Abort IviDmmAbort IviDmm
IsOverrange IviDmmIsOver-Range
IviDmm
Utility
Reset IviDmmReset VPP
ResetWithDefaults
ResetWithDefaults
VPP
Self-Test IviDmmSelf-Test
VPP
Disable Disable VPP
InvalidateAll InvalidateAllAttributes
VPP
Attributes
RevisionQuery
IviDmmRevisionQuery
VPP
Error-Query IviDmmError-Query
VPP
ErrorMessage IviDmmErrorMessage
VPP
InterchangeabilityInfo
GetNextInterchangeWarning
IviDmmGetNextInterchangeWarning
IVI
ResetInterchangeCheck
IviDmmResetInterchangeCheck
IVI
ClearInterchangeWarnings
IviDmmClearInterchangeWarnings
IVI
CoercionInfo
GetNextCoercionRecord
IviDmmGetNextCoercionRecord
IVI
Close IviDmmClose VPP
RelatedTopicsIviDmmPropertiesIVIInherentVIs
IviDmmPropertiesNoteYouusetheLabVIEWPropertyNodetogetandsetproperties.
IviDmmBasePropertiesIviDmmFunctionIviDmmRangeIviDmmResolutionIviDmmTriggerSourceIviDmmTriggerDelay
ACMeasurementPropertiesIviDmmACMinimumFrequencyIviDmmACMaximumFrequency
AutoRangeValuePropertiesIviDmmAutoRangeValue
AutoZeroPropertiesIviDmmAutoZero
DeviceInfoPropertiesIviDmmApertureTime[DI]IviDmmApertureTimeUnits[DI]
FrequencyMeasurementPropertiesIviDmmFrequencyVoltageRange
MultipointPropertiesIviDmmMeasCompleteDestination[MP]IviDmmSampleCount[MP]IviDmmSampleInterval[MP]IviDmmSampleTrigger[MP]IviDmmTriggerCount[MP]
PowerLineFrequencyPropertyIviDmmPowerlineFrequency
ResistanceTemperatureDevicePropertiesIviDmmRTDAlphaIviDmmRTDResistance
TemperatureMeasurementPropertiesIviDmmTransducerType
ThermistorPropertiesIviDmmThermistorResistance
ThermocouplePropertiesIviDmmThermocoupleTypeIviDmmReferenceJunctionTypeIviDmmFixedReferenceJunction
TriggerSlopePropertiesIviDmmTriggerSlope
IviDmmPropertyValueDefinitionsThefollowingtabledefinesvaluesforeachpropertyconstantintheIviDmmclass.
NoteInthefollowingtable,theliteralstringIVIDMMprecedesthepropertyname,andtheliteralstringIVIDMMprecedesthevalueextensionname.
IviDmmPropertyDefinedValues
Property ValueName DefinedValue Definitions
APERTURETIMEUNITS
Seconds 0 ReportsthattheunitsforthevaluereturnedbyIviDmmApertureTimeseconds
PowerLineCycles
1 ReportsthattheunitsforthevaluereturnedbyIviDmmApertureTimePowerlineCycles.
AUTOZER0 Off 0 Disablesauto-ranging.TheDMMsetstherangetothevalueitmostrecentlycalculated.Furtherqueriesofthispropertyreturntheactualrange.
On 1 ConfigurestheDMMtotakeaZeroReadingforeachmeasurement.TheDMMsubtractstheZeroReadingfromthevalueitmeasures.
Once 2 ConfigurestheDMMtocalculatetherangebeforethenextmeasurement.TheDMMusesthisrangevalueforallsubsequentmeasurements.Furtherqueriesofthispropertyshouldreturntheactualrange.
FUNCTION DCVolts 1 SetstheDMMtomeasureDCvoltage.ACVolts 2 SetstheDMMtomeasureACvoltage.DCCurrent 3 SetstheDMMtomeasureDCcurrent.ACCurrent 4 SetstheDMMtomeasureACcurrent.2WireResistance
5 SetstheDMMtomeasure2-wireresistance.
4WireResistance
101 SetstheDMMtomeasure4-wireresistance.
Frequency 104 SetstheDMMtomeasurefrequency.Period 105 SetstheDMMtomeasureperiod.
AC+DCVolts
106 SetstheDMMtomeasureACplusDCvoltage.
AC+DCCurrent
107 SetstheDMMtomeasureACplusDCcurrent.
Temperature 108 SetstheDMMtomeasuretemperatureinCelsius.
MEASCOMPLETEDEST
None -1 Themeasurementcompletesignalisnotrouted.
External 2 Routesthemeasurement-completesignaltotheexternalconnector.
PXITRIG0orVXITTL0
111 TheDMMexitstheWait-For-TriggerortheWait-For-Sample-TriggerstatewhenitreceivesatriggeronTTL0.
PXITRIG1orVXITTL1
112 TheDMMexitstheWait-For-TriggerortheWait-For-Sample-TriggerstatewhenitreceivesatriggeronTTL1.
PXITRIG2orVXITTL2
113 TheDMMexitstheWait-For-TriggerortheWait-For-Sample-TriggerstatewhenitreceivesatriggeronTTL2.
PXITRIG3orVXITTL3
114 TheDMMexitstheWait-For-TriggerortheWait-For-Sample-TriggerstatewhenitreceivesatriggeronTTL3.
PXITRIG4orVXITTL4
115 TheDMMexitstheWait-For-TriggerortheWait-For-Sample-TriggerstatewhenitreceivesatriggeronTTL4.
PXITRIG5orVXITTL5
116 TheDMMexitstheWait-For-TriggerortheWait-For-Sample-TriggerstatewhenitreceivesatriggeronTTL5.
PXITRIG6orVXITTL6
117 TheDMMexitstheWait-For-TriggerortheWait-For-Sample-TriggerstatewhenitreceivesatriggeronTTL6.
PXITRIG7orVXITTL7
118 TheDMMexitstheWait-For-TriggerortheWait-For-Sample-TriggerstatewhenitreceivesatriggeronTTL7.
ECLO 119 TheDMMexitstheWait-For-TriggerortheWait-For-Sample-TriggerstatewhenitreceivesatriggeronECL0.
ECL1 120 TheDMMexitstheWait-For-TriggerortheWait-For-Sample-TriggerstatewhenitreceivesatriggeronECL1.
PXIStar 131 TheDMMexitstheWait-For-TriggerortheWait-For-Sample-TriggerstatewhenitreceivesatriggeronthePXIStartriggerbus.
RTSI0 140RTSI1 141RTSI2 142RTSI3 143RTSI4 144RTSI5 145RTSI6 146
RANGE On -1.0 ConfigurestheDMMtocalculatetherangebeforeeachmeasurementautomatically.WhenthispropertyissettoIVIDMM_VAL_AUTO_RANGE_ONyoucanobtaintheactualrangetheDMMiscurrentlyusingbygettingthevalueoftheIviDmmAutoRangeValueproperty.
Off -2.0 Disablesauto-ranging.TheDMMsetstherangetothevalueitmostrecentlycalculated.Furtherqueriesofthispropertyreturntheactualrange.
Once -3.0 ConfigurestheDMMtocalculatetherangebeforethenextmeasurement.TheDMMusesthisrangevalueforallsubsequentmeasurements.Furtherqueriesofthispropertyshouldreturntheactualrange.
SAMPLETRIGGER
Immediate 1 1
External 2 2SoftwareTriggerFunction
3 TheDMMexitstheWait-For-TriggerstateortheWait-For-Sample-TriggerstatewhentheIviDmmSendSoftwareTriggerVIexecutes.
Interval 10 TheDMMexitstheWait-For-Sample-TriggerstatewhenthelengthoftimespecifiedbytheIviDmmSampleIntervalpropertyelapses.
PXITRIG0orVXITTL0
111 111
PXITRIG1orVXITTL1
112 112
PXITRIG2orVXITTL2
113 113
PXITRIG3orVXITTL3
114 114
PXITRIG4orVXITTL4
115 115
PXITRIG5orVXITTL5
116 116
PXITRIG6orVXITTL6
117 117
PXITRIG7orVXITTL7
118 118
ECLO 119 TheDMMexitstheWait-For-TriggerortheWait-For-Sample-TriggerstatewhenitreceivesatriggeronECL0.
ECL1 120 120PXIStar 131 TheDMMexitstheWait-For-Triggeror
theWait-For-Sample-TriggerstatewhenitreceivesatriggeronthePXIStar
triggerbus.RTSI0 140RTSI1 141RTSI2 142RTSI3 143RTSI4 144RTSI5 145RTSI6 146
TEMPTCREFJUNCTYPE
Internal 1 SetstheDMMtouseafixedvalueforthethermocouplejunctioncompensation.
Fixed 2 SetstheDMMtouseafixedvalueforthethermocouplejunctioncompensation.
TEMPTCTYPE
B 1 SetstheDMMtomeasuretemperaturefromaB-typethermocouple.
C 2 SetstheDMMtomeasuretemperaturefromaC-typethermocouple.
D 3 SetstheDMMtomeasuretemperaturefromaD-typethermocouple.
E 4 SetstheDMMtomeasuretemperaturefromaE-typethermocouple.
G 5 SetstheDMMtomeasuretemperaturefromaG-typethermocouple.
J 6 SetstheDMMtomeasuretemperaturefromaJ-typethermocouple.
K 7 SetstheDMMtomeasuretemperaturefromaK-typethermocouple.
N 8 SetstheDMMtomeasuretemperaturefromaN-typethermocouple.
R 9 SetstheDMMtomeasuretemperaturefromaR-typethermocouple.
S 10 SetstheDMMtomeasuretemperature
fromaS-typethermocouple.T 11 SetstheDMMtomeasuretemperature
fromaT-typethermocouple.U 12 SetstheDMMtomeasuretemperature
fromaU-typethermocouple.V 13 SetstheDMMtomeasuretemperature
fromaV-typethermocouple.TEMPTRANSDUCERTYPE
Thermocouple 1 SetstheDMMtomeasuretemperatureusingathermocouple.UsetheIviDmmThermocoupleextensiongrouptoconfigureadditionalsettingsforthistransducertype.
Thermistor 2 SetstheDMMtomeasuretemperatureusingathermistor.UsetheIviDmmThermistorextensiongroupconfigureadditionalsettingsforthistransducertype.
2-WireRTD 3 SetstheDMMtomeasuretemperatureusinga2-wiretemperatureresistancedevice.UsetheIviDmmResistanceTemperatureDeviceExtensionGrouptoconfigureadditionalsettingsforthistransducertype.
4-WireRTD 4 SetstheDMMtomeasuretemperatureusinga4-wiretemperatureresistancedevice.UsetheIviDmmResistanceTemperatureDeviceExtensionGrouptoconfigureadditionalsettingsforthistransducertype.
TRIGGERDELAY
On -1.0 ConfigurestheDMMtocalculatethetriggerdelaybeforeeachmeasurement.
Off -2.0 StopstheDMMfromcalculatingthetriggerdelay.SetsthetriggerdelaytothelasttriggerdelaytheDMMcalculated.
NoteAfteryousetthispropertyto
IVIDMM_VAL_AUTO_DELAY_OFFfurtherqueriesofthispropertyshouldreturntheactualdelay.
TRIGGERSLOPE
Positive 0 Setsthetriggereventtooccurontherisingedgeofthetriggerpulse.
Negative 1 Setsthetriggereventtooccuronthefallingedgeofthetriggerpulse.
TRIGGERSOURCE
Immediate 1 TheDMMexitstheWait-For-TriggerstateortheWait-For-Sample-Triggerstateimmediatelyafterentering.Itdoesnotwaitforatriggerofanykind.
External 2 TheDMMexitstheWait-For-Triggerstatewhenatriggeroccursontheexternaltriggerinput.
SoftwareTriggerFunction
3 TheDMMexitstheWait-For-TriggerstateortheWait-For-Sample-TriggerstatewhentheIviDmmSendSoftwareTriggerVIexecutes.
PXITRIG0orVXITTL0
111 TheDMMexitstheWait-For-TriggerortheWait-For-Sample-TriggerstatewhenitreceivesatriggeronTTL0.
PXITRIG1orVXITTL1
112 TheDMMexitstheWait-For-TriggerortheWait-For-Sample-TriggerstatewhenitreceivesatriggeronTTL1.
PXITRIG2orVXITTL2
113 TheDMMexitstheWait-For-TriggerortheWait-For-Sample-TriggerstatewhenitreceivesatriggeronTTL2.
PXITRIG3orVXITTL3
114 TheDMMexitstheWait-For-TriggerortheWait-For-Sample-TriggerstatewhenitreceivesatriggeronTTL3.
PXITRIG4orVXITTL4
115 TheDMMexitstheWait-For-TriggerortheWait-For-Sample-TriggerstatewhenitreceivesatriggeronTTL4.
PXITRIG5orVXITTL5
116 TheDMMexitstheWait-For-TriggerortheWait-For-Sample-Triggerstatewhen
itreceivesatriggeronTTL5.PXITRIG6orVXITTL6
117 TheDMMexitstheWait-For-TriggerortheWait-For-Sample-TriggerstatewhenitreceivesatriggeronTTL6.
PXITRIG7orVXITTL7
118 TheDMMexitstheWait-For-TriggerortheWait-For-Sample-TriggerstatewhenitreceivesatriggeronTTL7.
ECLO 119 TheDMMexitstheWait-For-TriggerortheWait-For-Sample-TriggerstatewhenitreceivesatriggeronECL0.
ECL1 120 TheDMMexitstheWait-For-TriggerortheWait-For-Sample-TriggerstatewhenitreceivesatriggeronECL1.
PXIStar 131 TheDMMexitstheWait-For-TriggerortheWait-For-Sample-TriggerstatewhenitreceivesatriggeronthePXIStartriggerbus.
RTSI0 140RTSI1 141RTSI2 142RTSI3 143RTSI4 144RTSI5 145RTSI6 146
RelatedTopicsIviDmmVITreeIviDmmProperties
IviDmmErrorandWarningCodesStatusCodeRangesStatusCodeType NumericRange(inHex)IviDmmErrors 0xBFFA2001to0xBFFA3FFFIviDmmWarnings 0x3FFA2001to0x3FFA3FFFIVISpecificDriverErrors 0xBFFA4000to0xBFFA5FFFIVISpecificDriverWarnings 0x3FFA4000to0x3FFA5FFFIVIErrors 0xBFFA0000to0xBFFA1FFFIVIWarnings 0x3FFA0000to0x3FFA1FFFCommonInstrumentDriverErrors 0xBFFC0000to0xBFFCFFFFCommonInstrumentDriverWarnings 0x3FFC0000to0x3FFCFFFFVISAErrors 0xBFFF0000to0xBFFFFFFFVISAWarnings 0x3FFF0000to0xFFFFFFF
TheIviDmmclassdriverdefinestheerrorcodesshowninthefollowingtableinadditiontotheIVIdefinederrorcodes.
IviDmmErrorCodesError Value MessageIVIDMM_ERROR_MAX_TIME_EXCEEDED 0xBFFA2001 Maximum
timeexceededbeforetheoperationcompleted.
IVIDMM_ERROR_TRIGGER_NOT_SOFTWARE 0xBFFA1001 Thetriggersourceisnotsoftwaretrigger.
IviDmmWarningCodeWarning Value MessageIVIDMM_WARN_OVER_RANGE 0x3FFA2001 OverRangewarning
RelatedTopicIVIStatusCodes
IviDmmVIsExpandthisbooktoviewanalphabetizedlistofIviDmmVIs.
IviDmmAbortIviDmmBaseCapabilityGroupThisVIabortsapreviouslyinitiatedmeasurementandreturnstheDMMtotheIdlestate.
NoteThisVIdoesnotchecktheinstrumentstatus.Typically,youcallthisVIonlyinasequenceofcallstootherlow-leveldriverVIs.Thesequenceperformsoneoperation.Youusethelow-levelVIstooptimizeoneormoreaspectsofinteractionwiththeinstrument.Ifyouwanttochecktheinstrumentstatus,calltheIviDmmError-QueryVIattheconclusionofthesequence.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviDmmInitializeorIviDmmInitializeWithOptionsVI.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviDmmInitializeorIviDmmInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviDmmConfigureACBandwidthIviDmmACMeasurementCapabilityGroup[AC]ThisVIconfigurestheACminimumandmaximumfrequencyforDMMsthattakeACvoltageorACcurrentmeasurements.ThisVIaffectsthebehavioroftheinstrumentonlyiftheIviDmmFunctionpropertyissettoanACvoltageorACcurrentmeasurement.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviDmmInitializeorIviDmmInitializeWithOptionsVI.acminfrequency(20.0Hz)PasstheminimumexpectedfrequencycomponentoftheinputsignalinHertz.ThedriversetstheIviDmmACMinimumFrequency[AC]propertytothisvalue.DefaultValue:20.0
acmaxfrequency(300.0E+3Hz)PassthemaximumexpectedfrequencycomponentoftheinputsignalinHertz.ThedriversetstheIviDmmACMaximumFrequency[AC]propertytothisvalue.DefaultValue:300000.0
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviDmmInitializeorIviDmmInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.
Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviDmmConfigureAutoZeroModeIviDmmAutoZeroCapabilityGroup[AZ]ThisVIconfigurestheauto-zeromodeoftheDMM.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviDmmInitializeorIviDmmInitializeWithOptionsVI.autozeromode(Off)Specifytheauto-zeromode.ThedriversetstheIviDmmAutoZero[AZ]propertytothisvalue.Whentheauto-zeromodeisenabled,theDMMinternallydisconnectstheinputsignalandtakesaZeroReading.TheDMMthensubtractstheZeroReadingfromthemeasurement.Thispreventsoffsetvoltagespresentintheinstrument'sinputcircuitryfromaffectingmeasurementaccuracy.DefinedValues:IVIDMM_VAL_AUTO_ZERO_ON—ConfigurestheDMMtotakeaZeroReadingforeachmeasurement.TheDMMsubtractstheZeroReadingfromthevalueitmeasures.IVIDMM_VAL_AUTO_ZERO_OFF—Disablestheauto-zerofeature.IVIDMM_VAL_AUTO_ZERO_ONCE—ConfigurestheDMMtotakeaZeroReadingimmediately.TheDMMthensubtractsthisZeroReadingfromallsubsequentvaluesitmeasures.DefaultValue:IVIDMM_VAL_AUTO_ZERO_OFF
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.
Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviDmmInitializeorIviDmmInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviDmmConfigureFixedRefJunctionIviDmmThermocoupleCapabilityGroup[TC]ThisVIconfiguresthefixedreferencejunctionforathermocouplewithafixedreferencejunctiontype.ThisVIaffectsthebehavioroftheinstrumentonlywhentheIviDmmReferenceJunctionType[TC]propertyissettoIVIDMM_VAL_TEMP_REF_JUNC_FIXED.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviDmmInitializeorIviDmmInitializeWithOptionsVI.fixedrefjunc(0.0ºCelsius)Passthereferencejunctiontemperaturewhenafixedreferencejunctiontypethermocoupleisusedtotakethetemperaturemeasurement.TheunitsaredegreesCelsius.ThedriversetstheIviDmmFixedReferenceJunction[TC]propertytothisvalue.DefaultValue:0.0ºC
NoteThispropertymayalsobeusedtospecifythethermocouplejunctiontemperatureofaninstrumentthatdoesnothaveaninternaltemperaturesensor.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviDmmInitializeorIviDmmInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformation
outofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviDmmConfigureFrequencyVoltageRangeIviDmmFrequencyMeasurementCapabilityGroup[FRQ]ThisVIconfiguresthefrequencyvoltagerangeoftheDMMforfrequencyandperiodmeasurements.ThisVIaffectsthebehavioroftheinstrumentonlyiftheIviDmmFunctionpropertyissettoIVIDMM_VAL_FREQorIVIDMM_VAL_PERIOD.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviDmmInitializeorIviDmmInitializeWithOptionsVI.freqvoltrange(10.0VRMS)PasstheexpectedmaximumvalueoftheinputsignalforfrequencyandperiodmeasurementsinvoltsRMS.ThedriversetstheIviDmmFrequencyVoltageRange[FRQ]propertytothisvalue.Thedriverreservesspecialnegativevaluesfortheauto-rangemode.DefinedValues:IVIDMM_VAL_AUTO_RANGE_ON(-1.0)—Auto-rangeOnIVIDMM_VAL_AUTO_RANGE_OFF(-2.0)—Auto-rangeOffDefaultValue:10.0VRMS
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviDmmInitializeorIviDmmInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviDmmConfigureMeasCompleteDestIviDmmMultiPointCapabilityGroup[MP]ThisVIconfiguresthedestinationofthemeasurement-completesignal.ThissignaliscommonlyreferredtoasVoltmeterComplete.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviDmmInitializeorIviDmmInitializeWithOptionsVI.meascompletedest(None)Specifythedestinationofthemeasurement-completesignal.ThedriversetstheIviDmmMeasCompleteDestination[MP]propertytothisvalue.DefinedValues:IVIDMM_VAL_NONE—NoneIVIDMM_VAL_EXTERNAL—ExternalIVIDMM_VAL_TTL0—PXITRIG0orVXITTL0IVIDMM_VAL_TTL1—PXITRIG1orVXITTL1IVIDMM_VAL_TTL2—PXITRIG2orVXITTL2IVIDMM_VAL_TTL3—PXITRIG3orVXITTL3IVIDMM_VAL_TTL4—PXITRIG4orVXITTL4IVIDMM_VAL_TTL5—PXITRIG5orVXITTL5IVIDMM_VAL_TTL6—PXITRIG6orVXITTL6IVIDMM_VAL_TTL7—PXITRIG7orVXITTL7IVIDMM_VAL_ECL0—VXIECL0IVIDMM_VAL_ECL1—VXIECL1IVIDMM_VAL_PXI_STAR—PXIStarIVIDMM_VAL_RTSI_0—RTSIline0
IVIDMM_VAL_RTSI_1—RTSIline1IVIDMM_VAL_RTSI_2—RTSIline2IVIDMM_VAL_RTSI_3—RTSIline3IVIDMM_VAL_RTSI_4—RTSIline4IVIDMM_VAL_RTSI_5—RTSIline5IVIDMM_VAL_RTSI_6—RTSIline6DefaultValue:IVIDMM_VAL_NONE
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviDmmInitializeorIviDmmInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviDmmConfigureMeasurementIviDmmBaseCapabilityGroupThisVIconfiguresthecommonpropertiesoftheDMM.Thesepropertiesincludethemeasurementfunction,maximumrange,andresolution.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviDmmInitializeorIviDmmInitializeWithOptionsVI.measurementfunction(DCVolts)PassthemeasurementVIyouwanttheDMMtoperform.ThedriversetstheIviDmmFunctionpropertytothisvalue.ValidValues:IVIDMM_VAL_DC_VOLTS—DCVoltsIVIDMM_VAL_AC_VOLTS—ACVoltsIVIDMM_VAL_DC_CURRENT—DCCurrentIVIDMM_VAL_AC_CURRENT—ACCurrentIVIDMM_VAL_2_WIRE_RES—2-WireResistanceIVIDMM_VAL_4_WIRE_RES—4-WireResistanceIVIDMM_VAL_AC_PLUS_DC_VOLTS—ACplusDCVoltsIVIDMM_VAL_AC_PLUS_DC_CURRENT—ACplusDCCurrentIVIDMM_VAL_FREQ—FrequencyIVIDMM_VAL_PERIOD—PeriodIVIDMM_VAL_TEMPERATURE—Temperature(C)DefaultValue:IVIDMM_VAL_DC_VOLTS
range(-1.0:Auto)Passthemeasurementrangeyouwanttouse.ThedriversetstheIviDmmRangepropertytothisvalue.
Usepositivevaluestorepresenttheabsolutevalueofthemaximumexpectedmeasurement.ThevaluemustbeinunitsappropriatefortheMeasurementFunction.Forexample,whenyousettheMeasurementFunctiontoIVIDMM_VAL_DC_VOLTS,youmustspecifytheRangeinvolts.Settingthisparameterto10.0configurestheDMMtomeasureDCvoltagesfrom–10.0to+10.0volts.ThedriverreservesspecialnegativevaluesforcontrollingtheDMM'sauto-rangingcapability.DefinedValues:IVIDMM_VAL_AUTO_RANGE_ON(-1.0)—Auto-rangeOnIVIDMM_VAL_AUTO_RANGE_OFF(-2.0)—Auto-rangeOffIVIDMM_VAL_AUTO_RANGE_ONCE(-3.0)—Auto-rangeOnceDefaultValue:IVIDMM_VAL_AUTO_RANGE_ON(-1.0)
Notes
1. SettingthisparametertoIVIDMM_VAL_AUTO_RANGE_ONCEconfigurestheDMMtoauto-rangeonce,turnauto-rangeoff,andthenremainatthecurrentmaximumrange.
2. SettingthistoparameterIVIDMM_VAL_AUTO_RANGE_OFFconfigurestheDMMtostopauto-rangingandkeeptherangefixedatthecurrentmaximumrange.
absoluteresolution(0.001)Passyourdesiredmeasurementresolutioninabsoluteunits.ThedriversetstheIviDmmResolutionpropertytothisvalue.ThevaluemustbeinunitsappropriatefortheMeasurementfunction.Settingthisparametertolowervaluesincreasesthemeasurementaccuracy.Settingthisparametertohighervaluesincreasesthemeasurementspeed.DefaultValue:0.001
NoteThisparameterisignorediftheRangeparameterissettoIVIDMM_VAL_AUTO_RANGE_ON.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviDmmInitializeorIviDmmInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviDmmConfigureMultiPointIviDmmMultiPointCapabilityGroup[MP]ThisVIconfiguresthepropertiesthataffectmultipointmeasurements.Thesepropertiesarethetriggercount,samplecount,sampletriggerandsampleinterval.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviDmmInitializeorIviDmmInitializeWithOptionsVI.triggercount(1)PassthenumberoftriggersyouwanttheDMMtoreceivebeforereturningtotheIdlestate.ThedriversetstheIviDmmTriggerCount[MP]propertytothisvalue.DefaultValue:1
samplecount(1)PassthenumberofmeasurementsyouwanttheDMMtotakeeachtimeitreceivesatrigger.ThedriversetstheIviDmmSampleCount[MP]propertytothisvalue.DefaultValue:1
sampletrigger(Immediate)Passthetypeofsampletriggeryouwanttouse.ThedriversetstheIviDmmSampleTrigger[MP]propertytothisvalue.WhentheDMMtakesameasurementandtheSampleCountparameterisgreaterthan1,theDMMdoesnottakethenextmeasurementuntiltheeventyouspecifyintheSampleTriggerparameteroccurs.ValidValues:IVIDMM_VAL_IMMEDIATE—ImmediateIVIDMM_VAL_EXTERNAL—ExternalIVIDMM_VAL_SOFTWARE_TRIG—SoftwareTriggerFunction
IVIDMM_VAL_INTERVAL—IntervalIVIDMM_VAL_TTL0—PXITRIG0orVXITTL0IVIDMM_VAL_TTL1—PXITRIG1orVXITTL1IVIDMM_VAL_TTL2—PXITRIG2orVXITTL2IVIDMM_VAL_TTL3—PXITRIG3orVXITTL3IVIDMM_VAL_TTL4—PXITRIG4orVXITTL4IVIDMM_VAL_TTL5—PXITRIG5orVXITTL5IVIDMM_VAL_TTL6—PXITRIG6orVXITTL6IVIDMM_VAL_TTL7—PXITRIG7orVXITTL7IVIDMM_VAL_ECL0—VXIECL0IVIDMM_VAL_ECL1—VXIECL1IVIDMM_VAL_PXI_STAR—PXIStarIVIDMM_VAL_RTSI_0—RTSIline0IVIDMM_VAL_RTSI_1—RTSIline1IVIDMM_VAL_RTSI_2—RTSIline2IVIDMM_VAL_RTSI_3—RTSIline3IVIDMM_VAL_RTSI_4—RTSIline4IVIDMM_VAL_RTSI_5—RTSIline5IVIDMM_VAL_RTSI_6—RTSIline6DefaultValue:IVIDMM_VAL_IMMEDIATE
Notes
1. IVIDMM_VAL_IMMEDIATE—TheDMMtakesthenextmeasurementimmediately.TheDMMdoesnotwaitforatriggerofanykind.
2. IVIDMM_VAL_EXTERNAL—TheDMMtakesthenextmeasurementwhenatriggeroccursontheexternaltriggerinput.
3. IVIDMM_VAL_SOFTWARE_TRIG—TheDMMtakesthenextmeasurementwhenyoucalltheSendSoftwareTrigger[SWT]VI.
4. IVIDMM_VAL_INTERVAL—TheDMMtakesthenext
measurementafterwaitingthelengthoftimeyouspecifyintheSampleIntervalparameter.
ThisparameterisignoredifthevalueoftheSampleCountparameteris1.
sampleinterval(0.0s)PassthelengthoftimeyouwanttheDMMtowaitbetweensamples.Expressthisvalueinseconds.ThedriversetstheIviDmmSampleInterval[MP]propertytothisvalue.IftheSampleCountparameterisgreaterthan1andtheSampleTriggerparameterissettoIVIDMM_VAL_INTERVAL,theDMMwaitsbetweenmeasurementsforthelengthoftimeyouspecifywiththisparameter.Otherwise,thispropertydoesnotaffectthebehavioroftheinstrument.DefaultValue:0.0seconds
Notes
1. ThisparameterisignoredifthevalueoftheSampleCountparameteris1.
2. ThisparameterisignoredifthevalueoftheSampleTriggerparameterisnotIVIDMM_VAL_INTERVAL.
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviDmmInitializeorIviDmmInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviDmmConfigurePowerLineFrequencyIviDmmPowerLineFrequencyCapabilityGroup[PLF]ThisVIconfiguresthepowerlinefrequencyoftheDMM.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviDmmInitializeorIviDmmInitializeWithOptionsVI.powerlinefrequency(60.0Hz)SpecifythepowerlinefrequencyinHertz.ThedriversetstheIviDmmPowerlineFrequency[PLF]propertytothisvalue.DefaultValue:60.0Hz
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviDmmInitializeorIviDmmInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviDmmConfigureRTDIviDmmResistanceTemperatureDeviceCapabilityGroup[RTD]ThisVIconfiguresthealphaandresistanceparametersforaresistancetemperaturedevice.ThisVIaffectsthebehavioroftheinstrumentonlywhentheIviDmmTransducerType[TMP]propertyissettoIVIDMM_VAL_2_WIRE_RTDorIVIDMM_VAL_4_WIRE_RTD.
NoteThedriverassumesthatyouareusingaPlatinumResistanceTemperatureDevice.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviDmmInitializeorIviDmmInitializeWithOptionsVI.alpha(0.0)Passthealphaparameterforaresistancetemperaturedevice.ThedriversetstheIviDmmRTDAlpha[RTD]propertytothisvalue.DefaultValue:0.0
resistance(0.0ohms)SpecifiestheR0parameter(resistance)foraresistancetemperaturedevice.TheRTDresistanceisalsoknownastheRTDreferencevalue.ThedriversetstheIviDmmRTDResistance[RTD]propertytothisvalue.DefaultValue:0.0ohms
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmore
informationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviDmmInitializeorIviDmmInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviDmmConfigureThermistorIviDmmThermistorCapabilityGroup[THM]ThisVIconfigurestheresistanceforathermistortemperaturemeasurementdevice.ThisVIaffectsthebehavioroftheinstrumentonlywhentheIviDmmTransducerTypepropertyissettoIVIDMM_VAL_THERMISTOR.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviDmmInitializeorIviDmmInitializeWithOptionsVI.resistance(0.0ohms)PasstheresistanceofthethermistorinOhms.ThedriversetstheIviDmmThermistorResistance[THM]propertytothisvalue.DefaultValue:0.0ohms
NoteThedriverassumesthatyouareusinganinterchangeablethermistor.Interchangeablethermistorsarethermistorsthatexhibitsimilarbehaviorforagivenresistancevalue.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviDmmInitializeorIviDmmInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviDmmConfigureThermocoupleIviDmmThermocoupleCapabilityGroup[TC]ThisVIconfiguresthethermocoupletypeandthereferencejunctiontypeofthethermocoupleforDMMsthattaketemperaturemeasurementsusingathermocoupletransducertype.ThisVIaffectsthebehavioroftheinstrumentonlyiftheIviDmmTransducerType[TMP]propertyissettoIVIDMM_VAL_THERMOCOUPLE.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviDmmInitializeorIviDmmInitializeWithOptionsVI.thermocoupletype(B)Passthetypeofthermocoupleusedtomeasurethetemperature.ThedriverusesthisvaluetosettheIviDmmThermocoupleType[TC]property.DefinedValues:IVIDMM_VAL_TEMP_TC_BIVIDMM_VAL_TEMP_TC_CIVIDMM_VAL_TEMP_TC_DIVIDMM_VAL_TEMP_TC_EIVIDMM_VAL_TEMP_TC_JIVIDMM_VAL_TEMP_TC_KIVIDMM_VAL_TEMP_TC_NIVIDMM_VAL_TEMP_TC_RIVIDMM_VAL_TEMP_TC_SIVIDMM_VAL_TEMP_TC_TIVIDMM_VAL_TEMP_TC_UIVIDMM_VAL_TEMP_TC_V
DefaultValue:IVIDMM_VAL_TEMP_TC_B
refjunctype(Internal)Passthetypeofreferencejunctiontobeusedinthereferencejunctioncompensationofathermocouplemeasurement.ThedriverusesthisvaluetosettheIviDmmReferenceJunctionType[TC]property.DefinedValues:IVIDMM_VAL_TEMP_REF_JUNC_INTERNAL—TheDMMusesaninternalreferencejunctiontype.IVIDMM_VAL_TEMP_REF_JUNC_FIXED—TheDMMusesafixedvalueforthereferencejunction.UsetheIviDmmConfigureFixedRefJunction[TC]VItospecifythefixedreferencejunctionvalue.DefaultValue:IVIDMM_VAL_TEMP_REF_JUNC_INTERNAL
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviDmmInitializeorIviDmmInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviDmmConfigureTransducerTypeIviDmmTemperatureMeasurementCapabilityGroup[TMP]ThisVIconfigurestheDMMtotaketemperaturemeasurementsfromaspecifiedtransducertype.ThisVIaffectsthebehavioroftheinstrumentonlywhentheIviDmmFunctionpropertyissetto.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviDmmInitializeorIviDmmInitializeWithOptionsVI.transducertype(Thermocouple)Passthetypeofdeviceusedtomeasurethetemperature.ThedriverusesthisvaluetosettheIviDmmTransducerType[TMP]property.DefinedValues:IVIDMM_VAL_THERMOCOUPLE—ThermocoupleIVIDMM_VAL_THERMISTOR—ThermistorIVIDMM_VAL_2_WIRE_RTD—2WireResistanceTemperatureDeviceIVIDMM_VAL_4_WIRE_RTD—4WireResistanceTemperatureDeviceDefaultValue:
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmore
informationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviDmmInitializeorIviDmmInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviDmmConfigureTriggerIviDmmBaseCapabilityGroupThisVIconfiguresthecommonDMMtriggerproperties.Thesepropertiesarethetriggersourceandtriggerdelay.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviDmmInitializeorIviDmmInitializeWithOptionsVI.triggersource(Immediate)Specifythetriggersourceyouwanttouse.ThedriversetstheIviDmmTriggerSourcepropertytothisvalue.AfteryoucalltheReadorInitiateVI,theDMMwaitsforthetriggeryouspecifyinthisparameter.Afteritreceivesthetrigger,theDMMwaitsthelengthoftimeyouspecifyintheTriggerDelayparameter.TheDMMthentakesameasurement.ValidValues:IVIDMM_VAL_IMMEDIATE—ImmediateIVIDMM_VAL_EXTERNAL—ExternalIVIDMM_VAL_SOFTWARE_TRIG—SoftwareTriggerFunctionIVIDMM_VAL_TTL0—PXITRIG0orVXITTL0IVIDMM_VAL_TTL1—PXITRIG1orVXITTL1IVIDMM_VAL_TTL2—PXITRIG2orVXITTL2IVIDMM_VAL_TTL3—PXITRIG3orVXITTL3IVIDMM_VAL_TTL4—PXITRIG4orVXITTL4IVIDMM_VAL_TTL5—PXITRIG5orVXITTL5IVIDMM_VAL_TTL6—PXITRIG6orVXITTL6IVIDMM_VAL_TTL7—PXITRIG7orVXITTL7IVIDMM_VAL_ECL0—VXIECL0
IVIDMM_VAL_ECL—VXIECL1IVIDMM_VAL_PXI_STAR—PXIStarIVIDMM_VAL_RTSI_0—RTSIline0IVIDMM_VAL_RTSI_1—RTSIline1IVIDMM_VAL_RTSI_2—RTSIline2IVIDMM_VAL_RTSI_3—RTSIline3IVIDMM_VAL_RTSI_4—RTSIline4IVIDMM_VAL_RTSI_5—RTSIline5IVIDMM_VAL_RTSI_6—RTSIline6DefaultValue:IVIDMM_VAL_IMMEDIATE
Notes
1. IVIDMM_VAL_IMMEDIATE—TheDMMdoesnotwaitforatriggerofanykind.
2. IVIDMM_VAL_EXTERNAL—TheDMMwaitsforatriggerontheexternaltriggerinput.
3. IVIDMM_VAL_SOFTWARE_TRIG—TheDMMwaitsuntilyoucalltheSendSoftwareTrigger[SWT]VI.
triggerdelay(0.0s)Passthevalueyouwanttouseforthetriggerdelay.Expressthisvalueinseconds.ThedriversetstheIviDmmTriggerDelaypropertytothisvalue.ThetriggerdelayspecifiesthelengthoftimetheDMMwaitsafteritreceivesthetriggerandbeforeittakesameasurement.Usepositivevaluestosetthetriggerdelayinseconds.ThedriverreservesnegativevaluesforconfiguringtheDMMtocalculatethetriggerdelayautomatically.DefaultValue:0.0seconds
Notes
1. SettingthisparametertoIVIDMM_VAL_AUTO_DELAY_ON(-1.0)configurestheDMMtocalculatethetriggerdelaybeforeeachmeasurement.
2. SettingthisparametertoIVIDMM_VAL_AUTO_DELAY_OFF
(-2.0)stopstheDMMfromcalculatingthetriggerdelayandsetsthetriggerdelaytothelastautomaticallycalculatedvalue.
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviDmmInitializeorIviDmmInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviDmmConfigureTriggerSlopeIviDmmTriggerSourceCapabilityGroup[TS]ThisVIconfiguresthepolarityoftheexternaltriggersourceoftheDMM.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviDmmInitializeorIviDmmInitializeWithOptionsVI.triggerslope(0:Positive)Passthepolarityoftheexternaltriggerslope.ThedriversetstheIviDmmTriggerSlope[TS]propertytothisvalue.TheDMMtriggersoneithertherisingorthefallingedgeoftheexternaltriggersourcedependingonthevalueofthisproperty.DefinedValues:IVIDMM_VAL_POSITIVE-Thedrivertriggersontherisingedgeoftheexternaltrigger.IVIDMM_VAL_NEGATIVE-Thedrivertriggersonthefallingedgeoftheexternaltrigger.Default:IVIDMM_VAL_POSITIVE
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviDmmInitializeorIviDmmInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviDmmFetchIviDmmBaseCapabilityGroupThisVIreturnsthevaluefromapreviouslyinitiatedmeasurement.YoumustfirstcalltheIviDmmInitiateVItoinitiateameasurementbeforecallingthisVI.
Notes
1. AfterthisVIexecutes,theReadingparametercontainsanactualreadingoravalueindicatingthatanoverrangeconditionoccurred.
2. Ifanoverrangeconditionoccurs,theReadingparametercontainsanIEEE-definedNaN(NotaNumber)valueandtheVIreturnstheIVIDMM_WARN_OVER_RANGE(0x3FFA2001)warningcode.
3. YoucantestthemeasurementvalueforanoverrangeconditionbycallingtheIviDmmIsOver-RangeVI.
4. TheclassdriverreturnsasimulatedmeasurementwhenthisVIiscalledandtheIviDmmSimulatepropertyissettoTRUEandtheIviDmmUseSpecificSimulationpropertyissettoFALSE.Forinformationonhowtoconfigureasimulatedmeasurement,refertoNationalInstrumentsIVIDriverHelp»IVIClassDriverSimulationOverview.
5. ThisVIdoesnotchecktheinstrumentstatus.Typically,youcallthisVIonlyinasequenceofcallstootherlow-leveldriverVIs.Thesequenceperformsoneoperation.Youusethelow-levelVIstooptimizeoneormoreaspectsofinteractionwiththeinstrument.Ifyouwanttochecktheinstrumentstatus,calltheIviDmmError-QueryVIattheconclusionofthesequence.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviDmmInitializeorIviDmmInitializeWithOptionsVI.
maximumtime(5000ms)Passthemaximumlengthoftimeinwhichtoallowthefetchoperationtocomplete.Expressthisvalueinmilliseconds.Iftheoperationdoesnotcompletewithinthistimeinterval,theVIreturnstheIVIDMM_ERROR_MAX_TIME_EXCEEDED(0xBFFA2003)errorcode.Whenthisoccurs,youcancallIviDmmAborttocancelthefetchoperationandreturntheinstrumenttotheIdlestate.DefinedValues:IVIDMM_VAL_MAX_TIME_INFINITE(-1)—Waitindefinitelyforatimeout.IVIDMM_VAL_MAX_TIME_IMMEDIATE(0)—Donotwaitforatimeout.DefaultValue:5000(ms)
NoteTheMaximumTimeparameteraffectsonlythisVI.Ithasnoeffectonothertimeoutparametersorproperties.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviDmmInitializeorIviDmmInitializeWithOptionsVI.readingReturnsthemeasuredvalue.ThevalueyouspecifyfortheMeasurementFunctionparameteroftheIviDmmConfigureMeasurementVIdeterminestheunitsofthisparameterasshowninthefollowingtable.DCVolts voltsACVolts voltsDCCurrent amperesACCurrent amperes2-WireResistance ohms4-WireResistance ohms
ACplusDCVolts volts
ACplusDCCurrent amperesTemperature CelsiusFrequency hertzPeriod secondsNotes
1. Ifanoverrangeconditionoccurs,theReadingparametercontainsanIEEE-definedNaN(NotaNumber)valueandtheVIreturnstheIVIDMM_WARN_OVER_RANGE(0x3FFA2001)warningcode.
2. YoucantestthemeasurementvalueforanoverrangeconditionbycallingtheIviDmmIsOver-RangeVI.
erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviDmmFetchMultiPointIviDmmMultiPointCapabilityGroup[MP]ThisVIreturnsanarrayofvaluesfromapreviouslyinitiatedmultipointmeasurement.ThenumberofmeasurementstheDMMtakesisdeterminedbythevaluesyouspecifyfortheTriggerCountandSampleCountparametersoftheIviDmmConfigureMulti-Point[MP]VI.CalltheIviDmmInitiateVItoinitiateameasurementbeforecallingthisVI.
Notes
1. AfterthisVIexecutes,eachelementintheReadingArrayparameterisanactualreadingoravalueindicatingthatanoverrangeconditionoccurred.
2. Ifanoverrangeconditionoccurs,thecorrespondingReadingArrayelementcontainsanIEEE-definedNaN(NotaNumber)valueandtheVIreturnsIVIDMM_WARN_OVER_RANGE(0x3FFA2001).
3. YoucantesteachelementintheReadingArrayparameterforoverrangewiththeIviDmmIsOver-RangeVI.
4. TheclassdriverreturnsasimulatedmeasurementwhenthisVIiscalledandtheIviDmmSimulatepropertyissettoTRUEandtheIviDmmUseSpecificSimulationpropertyissettoFALSE.Forinformationonhowtoconfigureasimulatedmeasurement,refertoNationalInstrumentsIVIDriverHelp»IVIClassDriverSimulationOverview.
5. ThisVIdoesnotchecktheinstrumentstatus.Typically,youcallthisVIonlyinasequenceofcallstootherlow-leveldriverVIs.Thesequenceperformsoneoperation.Youusethelow-levelVIstooptimizeoneormoreaspectsofinteractionwiththeinstrument.Ifyouwanttochecktheinstrumentstatus,calltheIviDmmError-QueryVIattheconclusionofthesequence.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviDmmInitializeorIviDmmInitializeWithOptionsVI.maximumtime(5000ms)Passthemaximumlengthoftimeinwhichtoallowthemultipointfetchoperationtocompleteexpressedinmilliseconds.Iftheoperationdoesnotcompletewithinthistimeinterval,theVIreturnstheIVIDMM_ERROR_MAX_TIME_EXCEEDED(0xBFFA2003)errorcode.Whenthisoccurs,youcancallIviDmmAborttocancelthemultipointfetchoperationandreturntheinstrumenttotheIdlestate.DefinedValues:IVIDMM_VAL_MAX_TIME_INFINITE(1)—Waitindefinitelyforatimeout.IVIDMM_VAL_MAX_TIME_IMMEDIATE(0)—Donotwaitforatimeout.DefaultValue:5000ms
NoteTheMaximumTimeparameteraffectsonlythisVI.Ithasnoeffectonothertimeoutparametersorproperties.arraysize(1)PassthenumberofelementsintheReadingArrayparameter.DefaultValue:1
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviDmmInitializeorIviDmmInitializeWithOptionsVI.readingarrayReturnsanarrayofthemostrecentmeasurementvalues.ThevalueyouspecifyfortheMeasurementFunctionparameteroftheIviDmmConfigureMeasurementVIdeterminestheunitsofthisparameter,asshowninthefollowingtable.
DCVolts voltsACVolts voltsDCCurrent amperesACCurrent amperes2-WireResistance ohms4-WireResistance ohmsACplusDCVolts voltsACplusDCCurrent amperesTemperature CelsiusFrequency hertzPeriod secondsNotes
1. Ifanoverrangeconditionoccurs,thecorrespondingReadingArrayelementcontainsanIEEE-definedNaN(NotaNumber)valueandtheVIreturnstheIVIDMM_WARN_OVER_RANGE(0x3FFA2001)warningcode.
2. YoucantesteachelementintheReadingArrayparameterforanoverrangeconditionbycallingtheIviDmmIsOver-RangeVI.
actualnumberofpointsIndicatesthenumberofmeasuredvaluestheVIplacesintheReadingArrayparameter.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviDmmGetApertureTimeInfoIviDmmDeviceInfoCapabilityGroup[DI]ThisVIreturnsadditionalinformationaboutthestateoftheinstrument.Specifically,itreturnstheaperturetimeandtheaperturetimeunits.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviDmmInitializeorIviDmmInitializeWithOptionsVI.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviDmmInitializeorIviDmmInitializeWithOptionsVI.aperturetime(sec)ReturnsthevalueoftheIviDmmApertureTime[DI]property.TheunitsofthispropertydependonthevalueoftheIviDmmApertureTimeUnits[DI]property.
aperturetimeunitsReturnsthevalueoftheIviDmmApertureTimeUnits[DI]property.DefinedReturnValues:IVIDMM_VAL_SECONDS(0)—SecondsIVIDMM_VAL_POWER_LINE_CYCLES(1)—Powerlinecycles
erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviDmmGetAutoRangeValueIviDmmAutoRangeValueCapabilityGroup[ARV]ThisVIreturnstheactualrangetheDMMiscurrentlyusing,evenwhileitisauto-ranging.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviDmmInitializeorIviDmmInitializeWithOptionsVI.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviDmmInitializeorIviDmmInitializeWithOptionsVI.actualrangeReturnsthevalueoftheIviDmmAutoRangeValueproperty.TheunitsofthereturnedvaluedependonthevalueoftheIviDmmFunctionproperty.
erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviDmmInitiateIviDmmBaseCapabilityGroupThisVIinitiatesameasurement.AfteryoucallthisVI,theDMMleavestheIdlestateandwaitsforatrigger.Details.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviDmmInitializeorIviDmmInitializeWithOptionsVI.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviDmmInitializeorIviDmmInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviDmmInitiateDetailsThisVIappliesdefaultvaluestopropertiesthathavenotbeensetbyyouunderthefollowingconditions:
1. IfyouhavenotsetthevalueofanypropertyintheIviDmmMultiPointextensiongroup,theVIsetstheIviDmmSampleCount[MP]andIviDmmTriggerCount[MP]propertiesto1.
2. IfyouhavenotsetthevalueoftheIviDmmAutoZero[AZ]property,theVIsetsthevalueofthispropertyto
IVIDMM_VAL_AUTO_ZERO_OFF(0).
Notes
1. ThisVIdoesnotchecktheinstrumentstatus.Typically,youcallthisVIonlyinasequenceofcallstootherlow-leveldriverVIs.Thesequenceperformsoneoperation.Youusethelow-levelVIstooptimizeoneormoreaspectsofinteractionwiththeinstrument.Ifyouwanttochecktheinstrumentstatus,calltheIviDmmError-QueryVIattheconclusionofthesequence.
2. ThisVIperformsinterchangeabilitycheckingwhentheIviDmmInterchangeCheckpropertyissettoTRUE.UseNISpytoviewinterchangeabilitywarnings.Alternately,youmayusetheIviDmmGetNextInterchangeWarningVItoretrieveinterchangeabilitywarnings.Formoreinformationaboutinterchangeabilitychecking,refertotheIviDmmInterchangeCheckproperty.
3. TheclassdriverinitiatesasimulatedmeasurementwhenthisVIiscalledandtheIviDmmSimulatepropertyissettoTRUEandtheIviDmmUseSpecificSimulationpropertyissettoFALSE.Forinformationonhowtoconfigureasimulatedmeasurement,refertoNationalInstrumentsIVIDriverHelp»IVIClassDriverSimulationOverview.
IviDmmIsOver-RangeIviDmmBaseCapabilityGroupThisVItakesameasurementvaluethatyouobtainfromeithertheReadorFetchVIsanddeterminesifthevalueisavalidmeasurementvalueoravalueindicatingthatanoverrangeconditionoccurred.
NoteThisVIdoesnotchecktheinstrumentstatus.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviDmmInitializeorIviDmmInitializeWithOptionsVI.measurementvaluePassthemeasurementvaluethatyouobtainfromeithertheReadorFetchVI.Thedriverteststhisvaluetodetermineifthevalueisavalidmeasurementvalueoravalueindicatingthatanoverrangeconditionoccurred.DefaultValue:0.0
NoteIfanoverrangeconditionoccurs,themeasurementvaluecontainsanIEEE-definedNaN(NotaNumber)valueindicatingthatanoverrangeoccurred.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviDmmInitializeorIviDmmInitializeWithOptionsVI.isoverrangeReturnswhetherthemeasuredvalueisavalidmeasurementoravalueindicatingthatanoverrangeconditionoccurred.
ReturnValues:True—Thevalueindicatesanoverrangeconditionoccurred.False—Thevalueisavalidmeasurement.
NoteIfanoverrangeconditionoccurs,themeasurementvaluecontainsanIEEE-definedNaN(NotaNumber)valueindicatingthatanoverrangeoccurred.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviDmmReadIviDmmBaseCapabilityGroupThisVIinitiatesameasurement,waitsuntiltheDMMhasreturnedtotheIdlestate,andreturnsthemeasuredvalue.ThisVIappliesdefaultvaluestopropertiesthathavenotbeensetbyyouunderthefollowingconditions:
1. IfyouhavenotsetthevalueofanypropertyintheIviDmmMultiPointextensiongroup,theVIsetstheIviDmmSampleCount[MP]andIviDmmTriggerCount[MP]propertiesto1.
2. IfyouhavenotsetthevalueoftheIviDmmAutoZero[AZ]property,theVIsetsthevalueofthispropertytoIVIDMM_VAL_AUTO_ZERO_OFF(0).
Notes
1. AfterthisVIexecutes,theReadingparametercontainsanactualreadingoravalueindicatingthatanoverrangeconditionoccurred.
2. Ifanoverrangeconditionoccurs,theReadingparametercontainsanIEEE-definedNaN(NotaNumber)valueandtheVIreturnstheIVIDMM_WARN_OVER_RANGE(0x3ffA2001)warningcode.
3. YoucantestthemeasurementvalueforanoverrangeconditionbycallingtheIviDmmIsOver-RangeVI.
4. ThisVIperformsinterchangeabilitycheckingwhentheIviDmmInterchangeCheckpropertyissettoTRUE.UseNISpytoviewinterchangeabilitywarnings.Alternately,youmayusetheIviDmmGetNextInterchangeWarningVItoretrieveinterchangeabilitywarnings.Formoreinformationaboutinterchangeabilitychecking,refertotheIviDmmInterchange
Checkproperty.5. Theclassdriverreturnsasimulatedmeasurementwhenthis
VIiscalledandtheIviDmmSimulatepropertyissettoTRUEandtheIviDmmUseSpecificSimulationpropertyissettoFALSE.Forinformationonhowtoconfigureasimulatedmeasurement,refertoNationalInstrumentsIVIDriverHelp»IVIClassDriverSimulationOverview.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviDmmInitializeorIviDmmInitializeWithOptionsVI.maximumtime(5000ms)Passthemaximumlengthoftimeinwhichtoallowthereadoperationtocomplete.Expressthisvalueinmilliseconds.Iftheoperationdoesnotcompletewithinthistimeinterval,theVIreturnstheIVIDMM_ERROR_MAX_TIME_EXCEEDED(0xBFFA2003)errorcode.Whenthisoccurs,youcancallIviDmmAborttocancelthereadoperationandreturntheinstrumenttotheIdlestate.DefinedValues:IVIDMM_VAL_MAX_TIME_INFINITE(-1)—Waitindefinitelyforatimeout.IVIDMM_VAL_MAX_TIME_IMMEDIATE(0)—Donotwaitforatimeout.DefaultValue:5000(ms)
NoteTheMaximumTimeparameteraffectsonlythisVI.Ithasnoeffectonothertimeoutparametersorproperties.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviDmmInitializeorIviDmmInitializeWithOptionsVI.readingReturnsthemeasuredvalue.Thevalueyouspecifyforthe
MeasurementFunctionparameteroftheIviDmmConfigureMeasurementVIdeterminestheunitsofthisparameterasshowninthefollowingtable.DCVolts voltsACVolts voltsDCCurrent amperesACCurrent amperes2-WireResistance ohms4-WireResistance ohmsACplusDCVolts voltsACplusDCCurrent amperesTemperature CelsiusFrequency hertzPeriod secondsNotes
1. Ifanoverrangeconditionoccurs,theReadingparametercontainsanIEEE-definedNaN(NotaNumber)valueandtheVIreturnstheIVIDMM_WARN_OVER_RANGE(0x3FFA2001)warningcode.
2. YoucantestthemeasurementvalueforanoverrangeconditionbycallingtheIviDmmIsOver-RangeVI.
erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviDmmReadMultiPointIviDmmMultiPointCapabilityGroup[MP]ThisVIinitiatesthemeasurement,waitsfortheDMMtoreturntotheIdlestate,andreturnsanarrayofmeasuredvalues.ThenumberofmeasurementstheDMMtakesisdeterminedbythevaluesyouspecifyfortheTriggerCountandSampleCountparametersoftheIviDmmConfigureMultiPoint[MP]VI.ThisVIappliesdefaultvaluestopropertiesthatyouhavenotsetunderthefollowingconditions:
1. IfyouhavenotsetthevalueofanypropertyintheIviDmmMultiPointextensiongroup,theVIsetstheIviDmmSampleCount[MP]andIviDmmTriggerCount[MP]propertiesto1.
2. IfyouhavenotsetthevalueoftheIviDmmAutoZero[AZ]property,theVIsetsthevalueofthispropertytoIVIDMM_VAL_AUTO_ZERO_OFF(0).
Notes
1. AfterthisVIexecutes,eachelementintheReadingArrayparameterisanactualreadingoravalueindicatingthatanoverrangeconditionoccurred.
2. Ifanoverrangeconditionoccurs,thecorrespondingReadingArrayelementcontainsanIEEE-definedNaN(NotaNumber)valueandtheVIreturnstheIVIDMM_WARN_OVER_RANGE(0x3FFA2001)warningcode.
3. YoucantesteachelementintheReadingArrayparameterforanoverrangeconditionbycallingtheIviDmmIsOver-RangeVI.
4. ThisVIperformsinterchangeabilitycheckingwhentheIviDmm
InterchangeCheckpropertyissettoTRUE.UseNISpytoviewinterchangeabilitywarnings.Alternately,youmayusetheIviDmmGetNextInterchangeWarningVItoretrieveinterchangeabilitywarnings.Formoreinformationaboutinterchangeabilitychecking,refertotheIviDmmInterchangeCheckproperty.
5. TheclassdriverinitiatesanarrayofsimulatedmeasurementswhenthisVIiscalledandtheIviDmmSimulatepropertyissettoTRUEandtheIviDmmUseSpecificSimulationpropertyissettoFALSE.Forinformationonhowtoconfigureasimulatedmeasurement,refertoNationalInstrumentsIVIDriverHelp»IVIClassDriverSimulationOverview.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviDmmInitializeorIviDmmInitializeWithOptionsVI.maximumtime(5000ms)Passthemaximumlengthoftimeinwhichtoallowthemultipointreadoperationtocomplete.Expressthisvalueinmilliseconds.Iftheoperationdoesnotcompletewithinthistimeinterval,theVIreturnstheIVIDMM_ERROR_MAX_TIME_EXCEEDED(0xBFFA2003)errorcode.Whenthisoccurs,youcancalltheIviDmmAbortVItocancelthemultipointreadoperationandreturntheinstrumenttotheIdlestate.DefinedValues:IVIDMM_VAL_MAX_TIME_INFINITE(-1)—Waitindefinitelyforatimeout.IVIDMM_VAL_MAX_TIME_IMMEDIATE(0)—Donotwaitforatimeout.DefaultValue:5000ms
NoteTheMaximumTimeparameteraffectsonlythisVI.Ithasnoeffectonothertimeoutparametersorproperties.arraysizePassthenumberofelementsintheReadingArrayparameter.DefaultValue:None
errorin(noerror)Theerrorinclustercanaccepterrorinformation
wiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviDmmInitializeorIviDmmInitializeWithOptionsVI.readingarrayReturnsanarrayofthemostrecentmeasurementvalues.ThevalueyouspecifyfortheMeasurementFunctionparameteroftheIviDmmConfigureMeasurementVIdeterminestheunitsofthisparameterasshowninthefollowingtable:DCVolts voltsACVolts voltsDCCurrent amperesACCurrent amperes2-WireResistance ohms4-WireResistance ohmsACplusDCVolts voltsACplusDCCurrent amperesTemperature CelsiusFrequency hertzPeriod secondsNotes
1. Ifanoverrangeconditionoccurs,thecorrespondingReadingArrayelementcontainsanIEEE-definedNaN(NotaNumber)valueandtheVIreturnstheIVIDMM_WARN_OVER_RANGE(0x3FFA2001)warningcode.
2. YoucantesteachelementintheReadingArrayparameterforanoverrangeconditionbycallingtheIviDmmIsOver-RangeVI.
actualnumberofpointsIndicatesthenumberofmeasuredvaluestheVIplacesintheReadingArrayparameter.erroroutTheerroroutclusterpasseserrororwarninginformation
outofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviDmmSendSoftwareTriggerIviDmmSoftwareTriggerCapabilityGroupThisVIsendsacommandtotriggertheinstrument.YoumustsatisfycertainconditionsbeforeyoucansuccessfullycallthisVI,TheIviDmmTriggerSourceortheIviDmmSampleTriggerpropertyissettoIVIDMM_VAL_SOFTWARE_TRIG.Ifthisconditionisnottrue,thisVIdoesnotsendthesoftwaretriggerandreturnstheerrorIVIDMM_ERROR_TRIGGER_NOT_SOFTWARE.ThisVIdoesnotchecktheinstrumentstatus.Typically,theend-usercallsthisVIonlyinasequenceofcallstootherlow-leveldriverVIs.Thesequenceperformsoneoperation.Theend-userusesthelow-levelVIstooptimizeoneormoreaspectsofinteractionwiththeinstrument.Tochecktheinstrumentstatus,calltheIviDmmError-QueryVIattheconclusionofthesequence.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviDmmInitializeorIviDmmInitializeWithOptionsVI.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviDmmInitializeorIviDmmInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviDmmPropertiesExpandthisbooktoviewanalphabetizedlistofIviDmmproperties.
IviDmmACMaximumFrequency[AC]IviDmmACMeasurementPropertyDataType Access Applies
to Coercion HighLevelVIs
R/W N/A Up IviDmmConfigureACBandwidth
DescriptionSpecifiesthemaximumfrequencycomponentoftheinputsignalforACmeasurements.ThevalueofthispropertyaffectsinstrumentbehavioronlywhenyousettheIviDmmFunctionpropertytoanACmeasurement.PropertyNodePathIviDmm»ACMeasurements»ACMaximum[AC]
IviDmmACMinimumFrequency[AC]IviDmmACMeasurementPropertyDataType Access Applies
to Coercion HighLevelVIs
R/W N/A Down IviDmmConfigureACBandwidth
DescriptionSpecifiestheminimumfrequencycomponentoftheinputsignalforACmeasurements.ThevalueofthispropertyaffectsinstrumentbehavioronlywhenyousettheIviDmmFunctionpropertytoanACmeasurement.PropertyNodePathIviDmm»ACMeasurements»ACMinimumFrequency[AC]
IviDmmApertureTime[DI]IviDmmDeviceInfoProperty[DI]DataType Access Applies
to Coercion HighLevelVIs
RO N/A None IviDmmGetApertureTimeInfo
DescriptionReturnsthemeasurementaperturetimeforthecurrentconfiguration.Theunitsforthispropertyareeithersecondsorpowerlinecycles(PLCs)andaredeterminedbythevalueoftheIviDmmApertureTimeUnits[DI]property.PropertyNodePathIviDmm»ConfigurationInformation»ApertureTime[DI]
IviDmmApertureTimeUnits[DI]IviDmmDeviceInfoProperty[DI]DataType Access Applies
to Coercion HighLevelVIs
RO N/A None IviDmmGetApertureTimeInfo
DescriptionReturnstheunitsforthepropertyIviDmmApertureTime[DI].PropertyNodePathIviDmm»ConfigurationInformation»ApertureTimeUnits[DI]DefinedValuesIVIDMM_VAL_SECONDSIVIDMM_VAL_POWER_LINE_CYCLES
IviDmmAutoRangeValueAutoRangeValuePropertyDataType Access Applies
to Coercion HighLevelVIs
RO N/A None IviDmmGetAutoRangeValue
DescriptionAlwaysreturnstheactualrangetheDMMiscurrentlyusing,evenwhentheDMMisauto-ranging.BecausethevalueofthispropertycanchangeastheDMMauto-ranges,youshouldnevercachethisproperty.PropertyNodePathIviDmm»ConfigurationInformation»AutoRangeValue
IviDmmAutoZero[AZ]AutoZeroPropertyDataType Access Applies
to Coercion HighLevelVIs
R/W N/A None IviDmmConfigureAutoZeroMode
DescriptionSpecifiestheauto-zeromode.Ingeneral,theauto-zerocapabilityofaDMMnormalizesallmeasurementsbasedonaZeroReading.Whenautozeroingisenabled,theDMMinternallydisconnectstheinputsignalandtakesaZeroReading.TheDMMthensubtractstheZeroReadingfromthemeasurement,whichpreventsoffsetvoltagespresentintheDMM'sinputcircuitryfromaffectingmeasurementaccuracy.PropertyNodePathIviDmm»MeasurementOperationOptions»AutoZero[AZ]DefinedValuesIVIDMM_VAL_AUTO_ZERO_OFFIVIDMM_VAL_AUTO_ZERO_ONIVIDMM_VAL_AUTO_ZERO_ONCE
IviDmmFixedReferenceJunction[TC]ThermocoupleProperty[TC]DataType Access Applies
to Coercion HighLevelVIs
R/W N/A None IviDmmConfigureFixedRefJunction
DescriptionSpecifiestheexternalreferencejunctiontemperaturewhenafixedreferencejunctiontypethermocoupleisusedtotakethetemperaturemeasurement.ThetemperatureisspecifiedindegreesCelsius.ThevalueofthispropertyaffectsinstrumentbehavioronlywhentheIviDmmReferenceJunctionType[TC]propertyissettoIVIDMM_VAL_TEMP_REF_JUNC_FIXED.PropertyNodePathIviDmm»TemperatureMeasurements»Thermocouple»FixedReferenceJunction[TC]
IviDmmFrequencyVoltageRange[FRQ]FrequencyMeasurementProperty[FRQ]DataType Access Applies
to Coercion HighLevelVIs
R/W N/A Up IviDmmConfigureFrequencyVoltageRange
DescriptionSpecifiestheexpectedmaximumvalueoftheinputsignalforfrequencyandperiodmeasurements.ThevalueofthispropertyaffectsinstrumentbehavioronlywhentheIviDmmFunctionpropertyissettoIVIDMM_VAL_FREQorIVIDMM_VAL_PERIOD.PropertyNodePathIviDmm»FrequencyMeasurements»FrequencyVoltageRange[FRQ]
IviDmmFunctionIviDmmBasePropertyDataType Access Applies
to Coercion HighLevelVIs
R/W N/A None IviDmmConfigureMeasurement
DescriptionSpecifiesthemeasurementfunction.PropertyNodePathIviDmm»BasicOperation»FunctionDefinedValuesIVIDMM_VAL_DC_VOLTSIVIDMM_VAL_AC_VOLTSIVIDMM_VAL_DC_CURRENTIVIDMM_VAL_AC_CURRENTIVIDMM_VAL_2_WIRE_RESIVIDMM_VAL_FREQIVIDMM_VAL_PERIODIVIDMM_VAL_4_WIRE_RESIVIDMM_VAL_AC_PLUS_DC_VOLTSIVIDMM_VAL_AC_PLUS_DC_CURRENTIVIDMM_VAL_TEMPERATURE
IviDmmMeasCompleteDestination[MP]MultipointPropertyDataType Access Applies
to Coercion HighLevelVIs
R/W N/A None IviDmmConfigureMeasurementCompleteDestination
DescriptionAftereachmeasurement,theDMMgeneratesameasurement-completesignal.Thispropertyspecifiesthedestinationofthemeasurement-completesignal.ThissignaliscommonlyreferredtoasVoltmeterComplete.PropertyNodePathIviDmm»MultipointAcquisition»MeasCompleteDestination[MP]DefinedValuesIVIDMM_VAL_NONEIVIDMM_VAL_EXTERNALIVIDMM_VAL_TTL0IVIDMM_VAL_TTL1IVIDMM_VAL_TTL2IVIDMM_VAL_TTL3IVIDMM_VAL_TTL4IVIDMM_VAL_TTL5IVIDMM_VAL_TTL6IVIDMM_VAL_TTL7IVIDMM_VAL_ECL0IVIDMM_VAL_ECL1IVIDMM_VAL_PXI_STARIVIDMM_VAL_RTSI_0IVIDMM_VAL_RTSI_1IVIDMM_VAL_RTSI_3
IVIDMM_VAL_RTSI_4IVIDMM_VAL_RTSI_5IVIDMM_VAL_RTSI_6
IviDmmPowerlineFrequency[PLF]PowerLineFrequencyProperty[PLF]DataType Access Applies
to Coercion HighLevelVIs
R/W N/A None IviDmmConfigurePowerLineFrequency
DescriptionSpecifiesthepowerlinefrequencyinhertz.PropertyNodePathIviDmm»MeasurementOperationOptions»PowerlineFrequency[PLF]
IviDmmRangeIviDmmBasePropertyDataType Access Applies
to Coercion HighLevelVIs
R/W N/A IviDmmConfigureMeasurement
DescriptionSpecifiesthemeasurementrange.Usepositivevaluestorepresenttheabsolutevalueofthemaximumexpectedmeasurement.ThevalueisinunitsappropriateforthecurrentvalueoftheIviDmmFunctionproperty.Forexample,whenyousettheIviDmmFunctionpropertytoIVIDMM_VAL_DC_VOLTS,theunitsarevolts.Settingthispropertyto10.0configurestheDMMtomeasureDCvoltagesfrom–10.0to+10.0volts.
NoteNegativevaluesarereservedforcontrollingtheDMM'sauto-rangingcapability.
AfteryousetthispropertytoIVIDMM_VAL_AUTO_RANGE_OFForIVIDMM_VAL_AUTO_RANGE_ONCE,furtherqueriesofthispropertyreturntheactualrange.WhenyousetthispropertytoIVIDMM_VAL_AUTO_RANGE_ON,youcanobtaintheactualrangetheDMMiscurrentlyusingbygettingthevalueoftheIviDmmAutoRangeValue[ARV]property.PropertyNodePathIviDmm»BasicOperation»RangeDefinedValuesIVIDMM_VAL_AUTO_RANGE_ONIVIDMM_VAL_AUTO_RANGE_OFFIVIDMM_VAL_AUTO_RANGE_ONCE
IviDmmReferenceJunctionType[TC]ThermocoupleProperty[TC]DataType Access Applies
to Coercion HighLevelVIs
R/W N/A None IviDmmConfigureThermocouple
DescriptionSpecifiesthetypeofreferencejunctiontobeusedinthereferencejunctioncompensationofathermocouplemeasurement.ThevalueofthispropertyaffectsinstrumentbehavioronlywhentheIVIDMM_VAL_TEMP_TRANSDUCER_TYPEpropertyissettoIVIDMM_VAL_THERMOCOUPLE.PropertyNodePathIviDmm»TemperatureMeasurements»Thermocouple»ReferenceJunctionType[TC]DefinedValuesIVIDMM_VAL_TEMP_REF_JUNC_INTERNALIVIDMM_VAL_TEMP_REF_JUNC_FIXED
IviDmmResolutionIviScopeBasePropertyDataType Access Applies
to Coercion HighLevelVIs
R/W N/A Down IviDmmConfigureMeasurement
DescriptionSpecifiesthemeasurementresolutionoftheDMMinabsoluteunits.Settingthispropertytolowervaluesincreasesthemeasurementaccuracy.Settingthispropertytohighervaluesincreasesthemeasurementspeed.PropertyNodePathIviDmm»BasicOperation»Resolution
IviDmmRTDAlpha[RTD]ResistanceTemperatureDeviceProperty[RTD]DataType Access Appliesto Coercion HighLevelVIs
R/W N/A None IviDmmConfigureRTD
DescriptionSpecifiesthealphaparameterforaresistancetemperaturedevice.ThevalueofthispropertyaffectsinstrumentbehavioronlywhentheIVIDMM_VAL_TEMP_TRANSDUCER_TYPEpropertyissettoIVIDMM_VAL_2_WIRE_RTDorIVIDMM_VAL_4_WIRE_RTD.PropertyNodePathIviDmm»TemperatureMeasurements»ResistanceTemperatureDevice»RTDAlpha[RTD]
IviDmmRTDResistance[RTD]ResistanceTemperatureDeviceProperty[RTD]DataType Access Appliesto Coercion HighLevelVIs
R/W N/A None IviDmmConfigureRTD
DescriptionSpecifiestheR0parameter(resistance)foraresistancetemperaturedevice(RTD).TheRTDresistanceisalsoknownastheRTDreferencevalue.ThevalueofthispropertyaffectsinstrumentbehavioronlywhentheIVIDMM_VAL_TEMP_TRANSDUCER_TYPEpropertyissettoIVIDMM_VAL_2_WIRE_RTDorIVIDMM_VAL_4_WIRE_RTD.PropertyNodePathIviDmm»TemperatureMeasurements»ResistanceTemperatureDevice»RTDResistance[RTD]
IviDmmSampleCount[MP]MultipointProperty[MP]DataType Access Appliesto Coercion HighLevelVIs
R/W N/A None IviDmmConfigureMultipoint
DescriptionSpecifiesthenumberofmeasurementstheDMMtakeseachtimeitreceivesatrigger.PropertyNodePathIviDmm»MultipointAcquisition»SampleCount[MP]
IviDmmSampleInterval[MP]MultipointPropertyDataType Access Appliesto Coercion HighLevelVIs
R/W N/A Up IviDmmConfigureMultipoint
DescriptionSpecifiestheintervalbetweensamplesinseconds.ThispropertyaffectsinstrumentoperationonlywhentheIviDmmSampleCount[MP]propertyisgreaterthan1andtheIviDmmSampleTrigger[MP]propertyissettoIVIDMM_VAL_INTERVAL.Inthiscase,theDMMwaitsbetweenmeasurementsforthelengththetimeyouspecifywiththisproperty.PropertyNodePathIviDmm»MultipointAcquisition»SampleInterval[MP]
IviDmmSampleTrigger[MP]MultipointPropertyDataType Access Appliesto Coercion HighLevelVIs
R/W N/A None IviDmmConfigureMultipoint
DescriptionSpecifiesthesampletriggersource.ThispropertyaffectsinstrumentoperationonlywhentheIviDmmSampleCount[MP]propertyisgreaterthan1.WhentheDMMtakesameasurementandtheIviDmmSampleCount[MP]propertyisgreaterthan1,theDMMdoesnottakethenextmeasurementuntiltheeventyouspecifywiththispropertyoccurs.WhenyousetthispropertytoIVIDMM_VAL_IMMEDIATE,theDMMdoesnotwaitforatriggerofanykindbetweenmeasurements.WhenyousetthispropertytoIVIDMM_VAL_EXTERNAL,theDMMwaitsforatriggerontheexternaltriggerinputbeforeittakesthenextmeasurement.WhenyousetthispropertytoIVIDMM_VAL_SOFTWARE_TRIG,theDMMwaitsuntilyoucalltheIviDmmSendSoftwareTrigger[SWT]VIbeforeittakesthenextmeasurement.WhenyousetthispropertytoIVIDMM_VAL_INTERVAL,theDMMwaitsthelengthoftimeyouspecifywiththeIviDmmSampleInterval[MP]propertybeforeittakesthenextmeasurement.PropertyNodePathIviDmm»MultipointAcquisition»SampleTrigger[MP]DefinedValuesIVIDMM_VAL_IMMEDIATEIVIDMM_VAL_EXTERNALIVIDMM_VAL_SOFTWARE_TRIGIVIDMM_VAL_INTERVALIVIFGEN_VAL_TTL0IVIFGEN_VAL_TTL1IVIFGEN_VAL_TTL2IVIFGEN_VAL_TTL3
IVIFGEN_VAL_TTL4IVIFGEN_VAL_TTL5IVIFGEN_VAL_TTL6IVIFGEN_VAL_TTL7IVIFGEN_VAL_ECL0IVIFGEN_VAL_ECL1IVIFGEN_VAL_PXI_STARIVIFGEN_VAL_RTSI_0IVIFGEN_VAL_RTSI_1IVIFGEN_VAL_RTSI_2IVIFGEN_VAL_RTSI_3IVIFGEN_VAL_RTSI_4IVIFGEN_VAL_RTSI_5IVIFGEN_VAL_RTSI_6
IviDmmThermistorResistance[THM]ThermistorProperty[THM]DataType Access Appliesto Coercion HighLevelVIs
R/W N/A None IviDmmConfigureThermistor
DescriptionSpecifiestheresistanceofthethermistorinOhms.ThevalueofthispropertyaffectsinstrumentbehavioronlywhentheIviDmmTransducerType[TMP]propertyissettoIVIDMM_VAL_THERMISTOR.PropertyNodePathIviDmm»TemperatureMeasurements»Thermistor»ThermistorResistance[THM]
IviDmmThermocoupleType[TC]ThermocoupleProperty[TC]DataType Access Applies
to Coercion HighLevelVIs
R/W N/A None IviDmmConfigureThermocouple
DescriptionSpecifiesthetypeofthermocoupleusedtomeasurethetemperature.ThevalueofthispropertyaffectsinstrumentbehavioronlywhentheIVIDMM_VAL_TEMP_TRANSDUCER_TYPEissettoIVIDMM_VAL_THERMOCOUPLE.PropertyNodePathIviDmm»TemperatureMeasurements»Thermocouple»ThermocoupleType[TC]DefinedValuesIVIDMM_VAL_TEMP_TC_BIVIDMM_VAL_TEMP_TC_CIVIDMM_VAL_TEMP_TC_DIVIDMM_VAL_TEMP_TC_EIVIDMM_VAL_TEMP_TC_GIVIDMM_VAL_TEMP_TC_JIVIDMM_VAL_TEMP_TC_KIVIDMM_VAL_TEMP_TC_NIVIDMM_VAL_TEMP_TC_RIVIDMM_VAL_TEMP_TC_SIVIDMM_VAL_TEMP_TC_TIVIDMM_VAL_TEMP_TC_UIVIDMM_VAL_TEMP_TC_V
IviDmmTransducerType[TMP]TemperatureMeasurementProperty[TMP]DataType Access Applies
to Coercion HighLevelVIs
R/W N/A None IviDmmConfigureTransducerType
DescriptionSpecifiesthedeviceusedtomeasurethetemperature.ThevalueofthispropertyaffectsinstrumentbehavioronlywhentheIviDmmFunctionpropertyissettoIVIDMM_VAL_TEMPERATURE.PropertyNodePathIviDmm»TemperatureMeasurements»TransducerType[TMP]DefinedValuesIVIDMM_VAL_THERMOCOUPLEIVIDMM_VAL_THERMISTORIVIDMM_VAL_2_WIRE_RTDIVIDMM_VAL_4_WIRE_RTD
IviDmmTriggerCount[MP]MultipointProperty[MP]DataType Access Appliesto Coercion HighLevelVIs
R/W N/A None IviDmmConfigureMultipoint
DescriptionSpecifiesthenumberoftriggerstheDMMacceptsbeforeitreturnstotheIdlestate.PropertyNodePathIviDmm»MultipointAcquisition»TriggerCount[MP]
IviDmmTriggerDelayIviScopeBasePropertyDataType Access Applies
to Coercion HighLevelVIs
R/W N/A Seenotebelow.
IviDmmConfigureTrigger
DescriptionSpecifiesthelengthoftimetheDMMwaitsafteritreceivesthetriggerandbeforeittakesameasurement.Usepositivevaluestosetthetriggerdelayinseconds.
NoteNegativevaluesarereservedforconfiguringtheDMMtocalculatethetriggerdelayautomatically.
SettingthispropertytoIVIDMM_VAL_AUTO_DELAY_ONconfigurestheDMMtocalculatethetriggerdelaybeforeeachmeasurement.SettingthispropertytoIVIDMM_VAL_AUTO_DELAY_OFFstopstheDMMfromcalculatingthetriggerdelayandsetsthetriggerdelaytothelastautomaticallycalculatedvalue.PropertyNodePathIviDmm»BasicOperation»TriggerDelayDefinedValuesIVIDMM_VAL_AUTO_DELAY_ONIVIDMM_VAL_AUTO_DELAY_OFF
IviDmmTriggerSlope[TS]TriggerSlopeProperty[TS]DataType Access Applies
to Coercion HighLevelVIs
R/W N/A None IviDmmConfigureTriggerSlope
DescriptionSpecifieswhetherthetriggeroccursontherisingedge(IVIDMM_VAL_POSITIVE)oronthefallingedge(IVIDMM_VAL_NEGATIVE)oftheexternaltriggersource.PropertyNodePathIviDmm»Trigger»TriggerSlope[TS]DefinedValuesIVIDMM_VAL_POSITIVEIVIDMM_VAL_NEGATIVE
IviDmmTriggerSourceIviScopeBasePropertyDataType Access Appliesto Coercion HighLevelVIs
R/W N/A None IviDmmConfigureTrigger
DescriptionSpecifiesthetriggersource.AfteryoucalleithertheReadorInitiateVI,theDMMwaitsforthetriggeryouspecifywiththisproperty.Afteritreceivesthetrigger,theDMMwaitsthelengthoftimeyouspecifywiththeIviDmmTriggerDelayproperty.TheDMMthentakesameasurement.PropertyNodePathIviDmm»Trigger»TriggerSourceDefinedValuesIVIDMM_VAL_IMMEDIATEIVIDMM_VAL_EXTERNALIVIDMM_VAL_SOFTWARE_TRIGIVIDMM_VAL_TTL0IVIDMM_VAL_TTL1IVIDMM_VAL_TTL2IVIDMM_VAL_TTL3IVIDMM_VAL_TTL4IVIDMM_VAL_TTL5IVIDMM_VAL_TTL6IVIDMM_VAL_TTL7IVIDMM_VAL_ECL0IVIDMM_VAL_ECL1IVIDMM_VAL_PXI_STARIVIDMM_VAL_RTSI_0IVIDMM_VAL_RTSI_1IVIDMM_VAL_RTSI_3
IVIDMM_VAL_RTSI_4IVIDMM_VAL_RTSI_5IVIDMM_VAL_RTSI_6
IviDmmDefinedValuesExpandthisbooktoviewanalphabetizedlistofIviDmmdefinedvalues.
IVIDMM_VAL_2_WIRE_RESSetstheDMMtomeasure2-wireresistance.Definedvalue:5
IVIDMM_VAL_2_WIRE_RTDSetstheDMMtomeasuretemperatureusinga2-wiretemperatureresistancedevice.UsetheIviDmmResistanceTemperatureDeviceextensiongrouptoconfigureadditionalsettingsforthistransducertype.DefinedValue:3
IVIDMM_VAL_4_WIRE_RESSetstheDMMtomeasure4-wireresistance.DefinedValue:101
IVIDMM_VAL_4_WIRE_RTDSetstheDMMtomeasuretemperatureusinga4-wiretemperatureresistancedevice.UsetheIviDmmResistanceTemperatureDeviceextensiongrouptoconfigureadditionalsettingsforthistransducertype.DefinedValue:4
IVIDMM_VAL_AC_CURRENTSetstheDMMtomeasureACcurrent.Definedvalue:4
IVIDMM_VAL_AC_PLUS_DC_CURRENTSetstheDMMtomeasureACplusDCcurrent.DefinedValue:107
IVIDMM_VAL_AC_PLUS_DC_VOLTSSetstheDMMtomeasureACplusDCvoltage.DefinedValue:106
IVIDMM_VAL_AC_VOLTSSetstheDMMtomeasureACvoltage.DefinedValue:2
IVIDMM_VAL_AUTO_DELAY_OFFStopstheDMMfromcalculatingthetriggerdelay.SetsthetriggerdelaytothelasttriggerdelaytheDMMcalculated.DefinedValue:-2.0
IVIDMM_VAL_AUTO_DELAY_ONConfigurestheDMMtocalculatethetriggerdelaybeforeeachmeasurement.DefinedValue:-1.0
IVIDMM_VAL_AUTO_RANGE_OFFDisablesauto-ranging.TheDMMsetstherangetothevalueitmostrecentlycalculated.Definedvalue:-2.0
IVIDMM_VAL_AUTO_RANGE_ONConfigurestheDMMtocalculatetherangebeforeeachmeasurementautomatically.Definedvalue:-1.0
IVIDMM_VAL_AUTO_RANGE_ONCEConfigurestheDMMtocalculatetherangebeforethenextmeasurement.TheDMMusesthisrangevalueforallsubsequentmeasurements.Definedvalue:-3.0
IVIDMM_VAL_AUTO_ZERO_OFFDisablestheauto-zerofeature.DefinedValue:0
IVIDMM_VAL_AUTO_ZERO_ONConfigurestheDMMtotakeaZeroReadingforeachmeasurement.TheDMMsubtractstheZeroReadingfromthevalueitmeasures.DefinedValue:1
IVIDMM_VAL_AUTO_ZERO_ONCEConfigurestheDMMtotakeaZeroReadingimmediately.TheDMMthensubtractsthisZeroReadingfromallsubsequentvaluesitmeasures.DefinedValue:2
IVIDMM_VAL_DC_CURRENTSetstheDMMtomeasureDCcurrent.Definedvalue:3
IVIDMM_VAL_DC_VOLTSSetstheDMMtomeasureDCvoltage.Definedvalue:1
IVIDMM_VAL_ECL0TheDMMexitstheWait-For-TriggerortheWait-For-Sample-TriggerstatewhenitreceivesatriggeronECL0.DefinedValue:119
IVIDMM_VAL_ECL1TheDMMexitstheWait-For-TriggerortheWait-For-Sample-TriggerstatewhenitreceivesatriggeronECL1.DefinedValue:120
IVIDMM_VAL_EXTERNALRoutesthemeasurementcompletesignaltotheexternalconnector.DefinedValue:2
IVIDMM_VAL_EXTERNAL(forMEAS_COMPLETE_DEST)Routesthemeasurement-completesignaltotheexternalconnector.DefinedValue:2
IVIDMM_VAL_EXTERNAL(forSAMPLE_TRIGGER)TheDMMexitstheWait-For-Sample-Triggerstatewhenatriggeroccursontheexternaltriggerinput.DefinedValue:2
IVIDMM_VAL_EXTERNAL(forTRIGGER_SOURCE)TheDMMexitstheWait-For-Triggerstatewhenatriggeroccursontheexternaltriggerinput.DefinedValue:2
IVIDMM_VAL_EXTERNALforIviDmmMeasCompleteDestinationRoutesthemeasurement-completesignaltotheexternalconnector.DefinedValue:2
IVIDMM_VAL_EXTERNALforIviDmmTriggerSourceTheDMMexitstheWait-For-Triggerstatewhenatriggeroccursontheexternaltriggerinput.DefinedValue:2
IVIDMM_VAL_FREQSetstheDMMtomeasurefrequency.DefinedValue:104
IVIDMM_VAL_IMMEDIATETheDMMexitstheWait-For-TriggerstateortheWait-For-Sample-Triggerstateimmediatelyafterentering.Itdoesnotwaitforatriggerofanykind.DefinedValue:1
IVIDMM_VAL_INTERVALTheDMMexitstheWait-For-Sample-TriggerstatewhenthelengthoftimespecifiedbytheIVIDMM_ATTR_SAMPLE_INTERVALpropertyelapses.DefinedValue:10
IVIDMM_VAL_NEGATIVESetsthetriggereventtooccuronthefallingedgeofthetriggerpulse.DefinedValue:1
IVIDMM_VAL_NONEThemeasurementcompletesignalisnotrouted.DefinedValue:-1
IVIDMM_VAL_PERIODSetstheDMMtomeasureperiod.DefinedValue:105
IVIDMM_VAL_POSITIVESetsthetriggereventtooccurontherisingedgeofthetriggerpulse.DefinedValue:0
IVIDMM_VAL_POWER_LINE_CYCLESReportsthattheunitsforthevaluereturnedbyIVIDMM_ATTR_APERTURE_TIMEarePowerLineCycles.DefinedValue:1
IVIDMM_VAL_PXI_STARTheDMMexitstheWait-For-TriggerortheWait-For-Sample-TriggerstatewhenitreceivesatriggeronthePXIStartriggerbus.DefinedValue:131
IVIDMM_VAL_RTSI_0RoutesthemeasurementcompletesignaltoRTSI0.DefinedValue:140
IVIDMM_VAL_RTSI_1RoutesthemeasurementcompletesignaltoRTSI1.DefinedValue:141
IVIDMM_VAL_RTSI_2RoutesthemeasurementcompletesignaltoRTSI2.DefinedValue:142
IVIDMM_VAL_RTSI_3RoutesthemeasurementcompletesignaltoRTSI3.DefinedValue:143
IVIDMM_VAL_RTSI_4RoutesthemeasurementcompletesignaltoRTSI4.DefinedValue:144
IVIDMM_VAL_RTSI_5RoutesthemeasurementcompletesignaltoRTSI5.DefinedValue:145
IVIDMM_VAL_RTSI_6RoutesthemeasurementcompletesignaltoRTSI6.DefinedValue:146
IVIDMM_VAL_SECONDSReportsthattheunitsforthevaluereturnedbyIVIDMM_ATTR_APERTURE_TIMEareseconds.DefinedValue:0
IVIDMM_VAL_SOFTWARE_TRIGTheDMMexitstheWait-For-TriggerstateortheWait-For-Sample-TriggerstatewhentheIviDmm_SendSoftwareTriggerfunctionexecutes.IfyousettheIVIDMM_ATTR_TRIGGER_SOURCEpropertytothisvalue,theinstrumentcanonlybetriggeredbycallingtheIviDmm_SendSoftwareTriggerfunction.IfyousettheIVIDMM_ATTR_SAMPLE_TRIGGERpropertytothisvalue,theinstrumentcanonlybetriggeredoneachsamplebycallingtheIviDmm_SendSoftwareTriggerfunction.DefinedValue:3
IVIDMM_VAL_TEMPERATURESetstheDMMtomeasuretemperatureinCelsius.DefinedValue:108
IVIDMM_VAL_TEMP_FSetstheDMMtomeasuretemperatureinFahrenheit.DefinedValue:109
IVIDMM_VAL_TEMP_REF_JUNC_FIXEDSetstheDMMtouseafixedvalueforthethermocouplejunctioncompensation.UsetheIVIDMM_ATTR_TEMP_TC_FIXED_REF_JUNCpropertytosetthefixedreferencejunctionvalue.DefinedValue:2
IVIDMM_VAL_TEMP_REF_JUNC_INTERNALSetstheDMMtouseaninternalsensoratthethermocouplejunctionforthejunctioncompensation.DefinedValue:1
IVIDMM_VAL_TEMP_TC_BSetstheDMMtomeasuretemperaturefromaB-typethermocouple.DefinedValue:1
IVIDMM_VAL_TEMP_TC_CSetstheDM7MtomeasuretemperaturefromaC-typethermocouple.DefinedValue:2
IVIDMM_VAL_TEMP_TC_DSetstheDMMtomeasuretemperaturefromaD-typethermocouple.DefinedValue:3
IVIDMM_VAL_TEMP_TC_ESetstheDMMtomeasuretemperaturefromanE-typethermocouple.DefinedValue:4
IVIDMM_VAL_TEMP_TC_GSetstheDMMtomeasuretemperaturefromaG-typethermocouple.DefinedValue:5
IVIDMM_VAL_TEMP_TC_JSetstheDMMtomeasuretemperaturefromaJ-typethermocouple.DefinedValue:6
IVIDMM_VAL_TEMP_TC_KSetstheDMMtomeasuretemperaturefromaK-typethermocouple.DefinedValue:7
IVIDMM_VAL_TEMP_TC_NSetstheDMMtomeasuretemperaturefromanN-typethermocouple.DefinedValue:8
IVIDMM_VAL_TEMP_TC_RSetstheDMMtomeasuretemperaturefromanR-typethermocouple.DefinedValue:9
IVIDMM_VAL_TEMP_TC_SSetstheDMMtomeasuretemperaturefromanS-typethermocouple.DefinedValue:10
IVIDMM_VAL_TEMP_TC_TSetstheDMMtomeasuretemperaturefromaT-typethermocouple.DefinedValue:11
IVIDMM_VAL_TEMP_TC_USetstheDMMtomeasuretemperaturefromaU-typethermocouple.DefinedValue:12
IVIDMM_VAL_TEMP_TC_VSetstheDMMtomeasuretemperaturefromaV-typethermocouple.DefinedValue:13
IVIDMM_VAL_THERMISTORSetstheDMMtomeasuretemperatureusingathermistor.UsetheIviDmmThermistorextensiongrouptoconfigureadditionalsettingsforthistransducertype.DefinedValue:2
IVIDMM_VAL_THERMOCOUPLESetstheDMMtomeasuretemperatureusingathermocouple.UsetheIviDmmThermocoupleextensiongrouptoconfigureadditionalsettingsforthistransducertype.DefinedValue:1
IVIDMM_VAL_TTL0TheDMMexitstheWait-For-TriggerortheWait-For-Sample-TriggerstatewhenitreceivesatriggeronTTL0.DefinedValue:112
IVIDMM_VAL_TTL1TheDMMexitstheWait-For-TriggerortheWait-For-Sample-TriggerstatewhenitreceivesatriggeronTTL1.DefinedValue:111
IVIDMM_VAL_TTL2TheDMMexitstheWait-For-TriggerortheWait-For-Sample-TriggerstatewhenitreceivesatriggeronTTL2.DefinedValue:113
IVIDMM_VAL_TTL3TheDMMexitstheWait-For-TriggerortheWait-For-Sample-TriggerstatewhenitreceivesatriggeronTTL3.DefinedValue:114
IVIDMM_VAL_TTL4TheDMMexitstheWait-For-TriggerortheWait-For-Sample-TriggerstatewhenitreceivesatriggeronTTL4.DefinedValue:115
IVIDMM_VAL_TTL5TheDMMexitstheWait-For-TriggerortheWait-For-Sample-TriggerstatewhenitreceivesatriggeronTTL5.DefinedValue:116
IVIDMM_VAL_TTL6TheDMMexitstheWait-For-TriggerortheWait-For-Sample-TriggerstatewhenitreceivesatriggeronTTL6.DefinedValue:117
IVIDMM_VAL_TTL7TheDMMexitstheWait-For-TriggerortheWait-For-Sample-TriggerstatewhenitreceivesatriggeronTTL7.DefinedValue:118
PropertiesforControllingIviDmmSimulationNoteYoucansetSimulationAttributesinMAXontheInitialSettingstabofIVIDrivers»Advanced»SimulationDriverSessions»nisIviClassorinthesimulationinteractivepanels.RefertoNationalInstrumentsIVIDriverHelp»ConfiguringYourSystemformoreinformation.
TwosetsofpropertiesexistforusewiththeIviDmmSimulationdriver.Thefollowingtabledescribespropertiesthatcontrolbehaviorofthedriver.AnothertablelistspropertiesthatsimulatethestatusofspecificdriverVIs.AnIviDmmSimulatorSetupDialogBoxexiststohelpyouconfigurethemeasurementsimulationfortheIviDmmSimulatordriver.
PropertiesforControllingIviDmmSimulationName Data
TypeAccess Applies
toDescription
INTERACTIVE_SIMULATION Boolean W No Specifieswhethertosetthedrivertointeractivemode.Ininteractivemode,thesimulationdriverusespop-upuserinterfacepanelsforgettinginformationfromyou.Non-interactivemodeisusefulwhenyoudonotwanttheinteractivepanelstointerruptyourtestprogram.
SELF_TEST_CODE Integer W No Specifiestheself-testcode.WhentheIviDmmSelf-Testresultparameterreturnsthisvalue.
SELF_TEST_MSG String W No Specifiestheself-testmessage.WhentheIviDmmSelf-TestVIiscalled,themessageparameterreturnsthisstring.
ERROR_QUERY_CODE Integer W No Specifiestheerror-querycode.WhentheIviDmmError-Querycodeparameterreturnsthisvalue.
ERROR_QUERY_MSG String W No Specifiestheerror-querymessage.WhentheIviDmmError-QueryVIiscalled,theerrormessagestring.
DRIVER_REV_QUERY String W No Specifiestheinstrumentdriverrevisionmessage.WhentheVIiscalled,theparameterreturnsthisstring.
INSTR_REV_QUERY String W No Specifiesthefirmwarerevisionmessage.WhentheIviDmmRevisionQueryVIiscalled,thefirmwarerevisionreturnsthisstring.
READING_BASE Double W No Specifiesthebasevalueofallcomputergeneratedmeasurements.Simulatedmeasurementsfallbetweentherangeofthisvalueplusthevalueofthe
NISDMM_ATTR_READING_NOISEandthisvalueminusthevalueoftheNISDMM_ATTR_READING_NOISE
NoteThispropertyisignorediftheNISDMM_ATTR_FORCE_OVERRANGEpropertyissettoTRUE.
READING_NOISE Double W No Specifiesthereadingnoiseofallcomputergeneratedmeasurements.SimulatedmeasurementsfallbetweentherangeofthevalueoftheNISDMM_ATTR_READING_BASEplusthisvalueandthevalueoftheNISDMM_ATTR_READING_BASEminusthethisvalue.
NoteThispropertyisignorediftheNISDMM_ATTR_FORCE_OVERRANGEpropertyissettoTRUE.
FORCE_OVERRANGE Boolean W No Specifieswhethertoreturnandoverrangevalueforallcomputergeneratedmeasurements.Whenenabled,allmeasurementVIssimulateameasurementover-loadconditionbyreturningavalueofIVI_VAL_NANasthemeasurementandanoverrangewarningasthestatuscode.
SIMULATE_STATUS_CODE Boolean W No SpecifieswhethertosimulatereturncodesfromtheIviDmmdriverVIs.RefertotheIviDmmPropertiesforStatusSimulationtable.
RelatedTopicsSettingUpSimulatedErrorsSettingUpSimulationforVXIplug&playVIs
IviDmmSimulatorSetupDialogBoxTwosetsofpropertiesexistforusewiththeIviDmmSimulationDriver.YouusethedialogboxshownbelowtoconfigurethemeasurementsimulationfortheIviDmmSimulatordriver.Scrolldowntoseeadescriptionofeachcontrol.
AlwayspromptforoutputdatasimulationLeavingthiscontrolselectedcausesthepaneltoappearateverymeasurementacquisitioneventinyourprogram.Allsimulatedacquisitionsintheprogramusethesamemeasurementconfigurationinformation.Unselectingthiscontrolcausesthemeasurementsimulationpaneltoneverappearagainduringthecourseofyourprogram.ForceOver-RangeSelectthiscontrolifyouwanttoforceanoverrangeconditiontooccurduringmeasurementevents.Whenenabled,allmeasurementssimulateameasurementover-loadconditionbyreturningNotaNumber(Nan)valueasthemeasurementandanoverrangewarningasthereturnstatus.MeasurementBaseEnterthemeasurementbasetouseforallcomputergeneratedmeasurements.AllcomputergeneratedmeasurementvaluesfallwithintherangeofthisvalueplusorminusthevalueoftheMeasurementNoisecontrol.ValidRange:anyvalueMeasurementNoiseEnterthereadingnoisetouseforallcomputergeneratedmeasurements.AllcomputergeneratedmeasurementvaluesfallwithintherangeofthevalueoftheMeasurementBasecontrolplusorminusthisvalue.ValidRange:anypositivevalue
PropertiesforStatusSimulationinIviDmmWhenanIviDmmdriverVIiscalled,thedriverquerieswhetherNISDMM_ATTR_SIMULATE_STATUS_CODEisenabled.Ifenabled,thedrivergetstheappropriateVI'ssimulationstatuscode.Ifthevalueofthesimulationstatuscoderepresentsawarning(hasapositivevalue),thenitisreturnedastheVI'sreturnstatusonlyifnoothererrororwarningoccurredbeforetheVIends.Ifthevalueofthesimulationstatuscoderepresentsanerror(hasanegativevalue),thenitisreturnedastheVI'sreturnstatusonlyifnoothererroroccurredbeforetheVIends.ThefollowingIviDmmVIsdonotsupportstatuscodesimulation:
IviDmmGetErrorIviDmmClearErrorIviDmmGetNextInterchangeWarningIviDmmResetNextInterchangeWarningIviDmmClearNextInterchangeWarningIviDmmGetNextCoercionRecord
EachVIsupportedbytheIviDmmclassdriverhasacorrespondingpropertythatdeterminesthestatuscodetoreturnwhenstatuscodesimulationisenabled.ThefollowingtableliststhestatuscodepropertiesandtheVIforwhichtheyreturnavalue.ThesepropertiesarealloftypeViInt32,non-readable,andnon-channelbased.
NoteInthefollowingtable,theliteralstringNISDMM_ATTR_precedesallpropertynames.
IviDmmPropertiesforStatusSimulationProperty VIINIT_STATUS IviDmm
Initialize,IviDmmInitializeWithOptions
CLOSE_STATUS IviDmmCloseRESET_STATUS IviDmmResetSELF_TEST_STATUS IviDmmSelf-TestERROR_QUERY_STATUS IviDmmError-
QueryERROR_MESSAGE_STATUS IviDmmError
MessageREVISION_QUERY_STATUS IviDmmRevision
QueryRESET_DEFAULT_STATUS IviDmmReset
WithDefaultsDISABLE_STATUS IviDmmDisableINVALIDATE_STATUS IviDmm
InvalidateAllAttributes
CONFIGURE_MEASUREMENT_STATUS IviDmmConfigureMeasurement
CONFIGURE_TRIGGER_STATUS IviDmmConfigureTrigger
READ_STATUS IviDmmReadFETCH_STATUS IviDmmFetchABORT_STATUS IviDmmAbortINITIATE_STATUS IviDmmInitiateIS_OVER_RANGE_STATUS IviDmmIsOver-
RangeCONFIGURE_AC_BANDWIDTH_STATUS IviDmm
ConfigureACBandwidth
CONFIGURE_FREQUENCY_VOLTAGE_RANGE_STATUS IviDmmConfigureFrequencyVoltageRange
CONFIGURE_TRANSDUCER_TYPE_STATUS IviDmmConfigureTransducerType
CONFIGURE_FIXED_REF_JUNCTION_STATUS IviDmm
ConfigureFixedRefJunction
CONFIGURE_THERMOCOUPLE_STATUS IviDmmConfigureThermocouple
CONFIGURE_RTD_STATUS IviDmmConfigureRTD
CONFIGURE_THERMISTOR_STATUS IviDmmConfigureThermistor
CONFIGURE_MEAS_COMPLETE_DEST_STATUS IviDmmConfigureMeasCompleteDest
CONFIGURE_MULTI_POINT_STATUS IviDmmConfigureMultiPoint
READ_MULTI_POINT_STATUS IviDmmReadMultiPoint
FETCH_MULTI_POINT_STATUS IviDmmFetchMultiPoint
CONFIGURE_TRIGGER_SLOPE_STATUS IviDmmConfigureTriggerSlope
SEND_SOFTWARE_TRIGGER_STATUS IviDmmSendSoftwareTrigger
GET_APERTURE_TIME_INFO_STATUS IviDmmGetApertureTimeInfo
GET_AUTO_RANGE_VALUE_STATUS IviDmmGetAutoRangeValue
CONFIGURE_AUTO_ZERO_MODE_STATUS IviDmmConfigureAutoZeroMode
CONFIGURE_POWER_LINE_FREQUENCY_STATUS IviDmm
ConfigurePowerLineFrequency
IviFgenClassDriverReferenceforLabVIEWConceptsIviFgenClassDriverOverviewIviFgenExtensionCapabilityGroupsIviFgenBehaviorModels
IviFgenVIandPropertyReferenceIviFgenVITreeIviFgenPropertiesbyGroupIviFgenPropertyValueDefinitionsIviFgenErrorandCompletionCodesOtherReferenceInterchangeabilityCheckingSimulation
IviFgenClassDriverOverviewThisinstrumentdriverprovidesprogrammingsupportfortheIviFgenClass.TheIviFgenclassdriverconceptualizesafunctiongeneratorasaninstrumentcapableofgeneratingananalogvoltagewaveform,andcanbeappliedtoawiderangeofinstruments.Theoutputsignalistypicallyfunctionalinnature(forexamplesinusoidalorsquare).Someinstrumentssupportthegenerationofarbitrarywaveforms,whichconsistofuser-specifieddata.Ifthefunctiongeneratoralsosupportsthegenerationofarbitrarywaveformsequences,theoutputsignalcanconsistofasequenceofrepeatedarbitrarywaveforms.TheIviFgenclassdriverisdividedintobasecapabilitiesandextensions.Thebasecapabilitiesconfigureafunctiongeneratorforbasicsignaloutput.Withtheextensions,youcanconfigureafunctiongeneratortogenerateaspecifictypeofwaveform.AninstrumentdrivermustsupporteithertheIviFgenStdFuncorIviFgenArbWfmextension.ThedrivercontainsalltheVIsthattheIVIFoundationrequiresfortheIviFgenspecification.ThisdriverrequiresNI-VISAandtheIVICompliancePackagetobeinstalled.Usethisdrivertodevelopprogramsthatareindependentofaparticularfunctiongenerator.YoucanusethisclassdriverwithanyfunctiongeneratorthathasanIVIinstrumentspecificdriverthatiscompliantwiththeIviFgenclass.TheIviFgenclassdriveraccessesthespecificdriverforyourinstrumentusingtheconfigurationinformationyousupplywithMAX.TheIviFgenclassdriverdividesinstrumentcapabilitiesintoaIviFgenBasecapabilitygroupandmultipleextensioncapabilitygroups.TheIviFgenBasegroupsupportsfunctiongeneratorscapableofconfiguringoutputimpedancesandthereferenceclocksource,andenablinganddisablingthefunctiongenerator'soutputs.Thebasecapabilitiesalonedonotsupportgeneratinganoutputsignal.Instead,afunctiongeneratormustsupportatleastoneofthesignaloutputextensions:IviFgenStdFunc,IviFgenArbWfm,orIviFgenArbSeq.ThebasegroupconsistsofthefollowingVIsandproperties.TheseVIsandpropertiesareimplementedbyallfunctiongeneratorinstrumentdriversthatarecompliantwiththeIviFgenclass.
IviFgenExtensionCapabilityGroupsTheIviFgenclassdriveridentifiesVIsandpropertiesthatbelongtoanextensiongroupwiththefollowingabbreviations.Instrumentspecificdriversarenotrequiredtoimplementanyoftheextensioncapabilitygroups.IfyouuseVIsandpropertiesthatbelongtoextensioncapabilitygroups,everyinstrumentspecificdriverthatyouusemustimplementthoseextensions.
GroupName Abbreviation DescriptionIviFgenStdFunc [STD] Forinstrumentscapableof
generatingstandardperiodicwaveforms.
IviFgenArbWfm [ARB] Forinstrumentscapableofgeneratinguser-definedarbitrarywaveforms.
IviFgenArbFrequency [AF] Forinstrumentscapableofspecifyingtherateatwhichthefunctiongeneratorproducesanentirecycleofanarbitrarywaveform.
IviFgenArbSeq [SEQ] Forinstrumentscapableofgeneratingauser-definedsequenceofarbitrarywaveforms.
IviFgenTrigger [TRG] Forinstrumentscapableofproducingasignaluponreceiptofatrigger.
IviFgenInternalTrigger [IT] Forinstrumentscapableofproducingasignaluponreceiptofatriggerfromaninternaltriggersource.
IviFgenSoftwareTrigger [SWT] Forinstrumentscapableofproducingasignaluponreceiptofasoftwaretrigger.
IviFgenBurst [BST] Forinstrumentscapableofgeneratingafixednumberofwaveformcyclessignalupon
receiptofatrigger.IviFgenModulateAM [AM] Forinstrumentscapableof
applyingamplitudemodulationtoanoutputsignal.
IviFgenModulateFM [FM] Forinstrumentscapableofapplyingfrequencymodulationtoanoutputsignal.
RelatedTopicsIVIInherentClassCapabilitiesStandardFunctionWaveformDescriptionOverviewArbitraryWaveformOverviewArbitrarySequenceOverviewAmplitudeModulationOverviewFrequencyModulationOverviewOutputStageOverview
StandardFunctionWaveformDescriptionOverviewInstrumentvendorstypicallyhavedifferentdefinitionsforwaveformproperties.Inordertoachieveaconsistentwaveformdescriptionbetweendifferentinstrumentvendors,thisclassdriverprovideswaveformpropertydefinitionsthatmustbefollowedwhendevelopinginstrumentdrivers.Thedefinitionsforthesewaveformpropertiesareasfollows:WaveformType—Theoverall"shape"ofoneperiodofthestandardwaveform.Thisspecificationdefinessixwaveformtypes:Sine,Square,Triangle,RampUp,RampDown,andDC.Amplitude—Thedifferencebetweenthemaximumandminimumwaveformvalues,orthepeak-to-peakvoltagevalue.DCOffset—Thedifferencebetweentheaverageofthemaximumandminimumwaveformvaluesandthex-axis(0volts).ApositiveDCoffsetplacesthemiddleofthewaveformabovethex-axis,whileanegativeDCoffsetplacesthemiddleofthewaveformbelowthex-axis.Frequency—Thenumberofwaveformcyclesgeneratedinonesecond.StartPhase—Specifiesthewaveform'shorizontaloffset.Theunitsaredegreesofonewaveformcycle.Forexample,a180degreephaseoffsetmeansoutputgenerationbeginshalfwaythroughthewaveform.Astartphaseof360degreesoffsetstheoutputbyanentirewaveformcycle.Itisthereforeidenticaltoastartphaseof0degrees.Thefollowingillustrationdiagramstheseproperties.
IllustrationofBasicWaveformPropertiesDutyCycle—Asquarewaveformrequiresanadditionalparametertoconfigurethedutycycleofthewaveform.Dutycycleisdefinedasthepercentageoftimeduringonecycleforwhichthesquarewaveisatitshighvalue.
SquareWaveformwith75percentDutyCycle
ArbitraryWaveformOverviewTheIviFgenArbWfmExtensionGroupsupportsfunctiongeneratorscapableofproducinguser-definedarbitrarywaveforms.Youcanmodifyparametersofthearbitrarywaveformsuchassamplerate,waveformgain,andwaveformoffset.TheIviFgenArbWfmextensiongroupincludesVIsforcreating,configuring,andgeneratingarbitrarywaveforms,andforreturninginformationaboutarbitrarywaveformcreation.ThisextensionaffectsinstrumentbehaviorwhentheIviFgenOutputModepropertyissettoIVIFGEN_VAL_OUTPUT_ARBorIVIFGEN_VAL_OUTPUT_SEQ.Beforeafunctiongeneratorcanproduceanarbitrarywaveform,youmustconfiguresomesignalgenerationproperties.Thisspecificationprovidesdefinitionsforarbitrarywaveformpropertiesthatmustbefollowedwhendevelopinginstrumentdrivers.Thedefinitionofanarbitrarywaveformanditspropertiesaregiveninthefollowinglist:
ArbitraryWaveform—Auser-definedseriesofsequentialdatapoints,between-1.0and1.0inclusive,thatdescribeanoutputwaveform.Gain—Thefactorbywhichthefunctiongeneratorscalesthearbitrarywaveformdata.Forexample,againvalueof2.0causesthewaveformdatatorangefrom-2.0Vto+2.0V.Offset—Thevaluethefunctiongeneratoraddstothescaledarbitrarywaveformdata.Forexample,scaledarbitrarywaveformdatathatrangesfrom-1.0Vto+1.0Visgeneratedfrom0.0Vto2.0Vwhentheenduserspecifiesawaveformoffsetof1.0V.NoteTheoffsetisaddedtoanyinherentoffsetinthearbitrarywaveformdata.
Thefollowingfiguresillustratethedefinitionsforarbitrarywaveformproperties.
ExamplesofNormalized,Scaled,andOffsetData
Size,SampleRate,andTimeElementsofaWaveformThesamplerateisthereciprocaloftheamountoftimeforwhichpointsin
thearbitrarywaveformisgenerated.Thefrequencyatwhichthefunctiongeneratorproducesonecycleofanarbitrarywaveformcanbeexpressedbytheequation:
ArbitrarySequenceOverviewInadditiontoallowingyoutospecifyanarbitrarywaveform,somefunctiongeneratorsallowyoutospecifyasequenceofarbitrarywaveformsforthefunctiongeneratortoproduce.Thisclassdriverdefinesanarbitrarysequenceasalistofarbitrarywaveformstoproduce.Eachwaveforminthesequenceisrepeatedadiscretenumberoftimesbeforeproducingthenextwaveform.Whengeneratinganarbitrarysequence,thewaveformpropertiesofGain,Offset,andSampleRate,definedintheArbitraryWaveformOverviewapplytoallwaveformsinthesequence.Thefollowingfigureillustratesthedefinitionofanarbitrarysequence.
WaveformSequencing
AmplitudeModulationOverviewAmplitudemodulationisaccomplishedbyvaryingtheamplitudeofacarrierwaveformaccordingtotheamplitudeofamodulatingwaveform.Thegeneralequationforapplyingamplitudemodulationtoawaveformis:AM(t)=[M(t)+1]×C(t),whereC(t)isthecarrierwaveform,M(t)isthemodulatingwaveform,andAM(t)isthemodulatedsignal.Thisclassdriverprovidesmodulatingwaveformpropertydefinitionsthatmustbefollowedwhendevelopingspecificinstrumentdrivers.Thecarrierwaveformisdefinedasthewaveformthatthefunctiongeneratorproduceswithoutanymodulation.Themodulatingwaveformisdefinedbythefollowingproperties:WaveformType—Theoverall"shape"ofoneperiodofthemodulatingwaveform.Thisclassdriverdefinesfivemodulatingwaveformtypes:Sine,Square,Triangle,RampUp,andRampDown.Frequency—Thenumberofmodulatingwaveformcyclesgeneratedinonesecond.ModulationDepth—Theextenttowhichthemodulatingwaveformaffectstheamplitudeofthecarrierwaveform.Thisvalueisexpressedasapercentageoftotalmodulation.Atthemaximumpeakofthemodulatingwaveform,theamplitudeoftheoutputsignalisequalto(100.0+ModulationDepth)percentofthecarriersignalamplitude.Attheminimumpeakofthemodulatingwaveform,theamplitudeoftheoutputsignalisequalto(100.0–ModulationDepth)percentofthecarriersignalamplitude.Atamodulationdepthof0percent,themodulatingwaveformhasnoeffectonthecarrierwaveform.Atamodulationdepthof100percent,theamplitudeoftheoutputsignalvariesbetween0.0Vandtwicetheamplitudeofthecarriersignal.Thefollowingdiagramillustratestheeffectofamplitudemodulationonacarriersignal,andtheeffectontheoutputsignalofvaryingthemodulationdepth.
OnekHzCarrierSineWaveanda100percentAmplitudeModulated
Wave
FrequencyModulationOverviewFrequencymodulationisaccomplishedbyvaryingthefrequencyofacarrierwaveformaccordingtotheamplitudeofamodulatingwaveform.Thegeneralequationforafrequencymodulatedwaveformis:FM(t)=C[t+(M(t))],whereC(t)isthecarrierwaveform,M(t)isthemodulatingwaveform,andFM(t)isthefrequencymodulatedsignal.Thisclassdriverprovidesmodulatingwaveformpropertydefinitionsthatmustbefollowedwhendevelopingspecificinstrumentdrivers.Thecarrierwaveformisdefinedasthewaveformthefunctiongeneratorproduceswithoutanymodulation.Themodulatingwaveformisdefinedbythefollowingproperties:
WaveformType—Theoverall"shape"ofoneperiodofthemodulatingwaveform.Thisclassdriverdefinesfivemodulationwaveformtypes:Sine,Square,Triangle,RampUp,andRampDown.
Frequency—Thenumberofmodulatingwaveformcyclesgeneratedinonesecond.
PeakFrequencyDeviation—Thevariationoffrequencythemodulatingwaveformappliestothecarrierwaveform.Thisvalueisexpressedinhertz.At0hertzdeviation,themodulatingwaveformhasnoeffectonthecarrierwaveform.Asfrequencydeviationincreases,thefrequencyvariationinthemodulatedwaveformincreases.Atthemaximumpeakofthemodulatingsignal,thefrequencyoftheoutputsignalisequaltothefrequencyofthecarriersignalplusthefrequencyofthemodulatingsignal.Attheminimumpeakofthemodulatingsignal,thefrequencyoftheoutputsignalisequaltothefrequencyofthecarriersignalminusthefrequencyofthemodulatingsignal.Thefollowingdiagramillustratestheeffectoffrequencymodulationonacarriersignal,andtheeffectontheoutputsignalofvaryingthepeakfrequencydeviation.
OnekHzCarrierSineWaveandaFrequencyModulatedWaveat20HzPeakDeviation
OutputStageOverviewThisclassdrivermodelstheoutputstageofthefunctiongeneratorwiththefollowingproperties:OutputVoltage,OutputImpedance,andSystemImpedance.Thedefinitionsofthesepropertiesareasfollows:
OutputVoltage—Thevoltageofthewaveformattheoutputterminalwhenconnectedtoamatchedtermination.OutputImpedance—Theimpedanceofthefunctiongeneratorattheoutputterminal.SystemImpedance—Theimpedanceofthesystemattachedtotheoutputterminal.
Thesepropertiesareshowninthefollowingillustration.
IllustrationofOutputPathPropertiesThecombinationoftheoutputimpedanceofthefunctiongeneratorandtheimpedanceofthesystemattachedtotheoutputterminalofthefunctiongeneratorformavoltagedividernetwork.Theactualvoltageacrossthesystemimpedancedependsonthisvoltagedividernetwork.Theamplitudeofthesignalthefunctiongeneratorproducesisbasedontheassumptionthatthesystemimpedancematchesthefunctiongenerator'soutputimpedance.Ifthesystemimpedancediffersfromtheoutputimpedance,youmustconsiderthisfactortoachievethedesiredoutputvoltage.Theactualoutputvoltagecanbefoundbyusingthefollowingequations:
Whentheoutputloadmatchesthesystemload(inotherwords, ,
),theinstrumentdrivercalculatesthecorrectvaluefor toresultin beingsettotherequesteduservalue.Ifyouhavenotmatchedthesystemimpedancetotheoutputimpedance,youmustcalculatetheoutputvoltageonyourown.Forexample,considerthecasewhere ismuchlargerthan ,aswhenaveryhighsystemimpedanceisattached
totheoutputterminal.Inthiscase, .However,becausethe
instrumentdriverhasassumedamatchedload(inotherwords, )theoutputvoltageistwicetherequestedvalue.Inthiscase,youshouldrequestanoutputvoltagethatishalfofthedesiredoutputvaluetoachievetheintendedoutput.
IviFgenExtensionCapabilityGroupsTheIviFgenclassdriveridentifiesVIsandpropertiesthatbelongtoanextensiongroupwiththefollowinggroupnames.Instrumentspecificdriversarenotrequiredtoimplementanyoftheextensioncapabilitygroups.IfyouuseVIsandpropertiesthatbelongtoextensioncapabilitygroups,everyinstrumentspecificdriverthatyouusemustimplementthoseextensions.
GroupName Abbreviation DescriptionIviFgenStdFunc [STD] Forinstrumentscapableof
generatingstandardperiodicwaveforms.
IviFgenArbWfm [ARB] Forinstrumentscapableofgeneratinguser-definedarbitrarywaveforms.
IviFgenArbFrequency [AF] Forinstrumentscapableofspecifyingtherateatwhichthefunctiongeneratorproducesanentirecycleofanarbitrarywaveform.
IviFgenArbSeq [SEQ] Forinstrumentscapableofgeneratingauser-definedsequenceofarbitrarywaveforms.
IviFgenTrigger [TRG] Forinstrumentscapableofproducingasignaluponreceiptofatrigger.
IviFgenInternalTrigger [IT] Forinstrumentscapableofproducingasignaluponreceiptofatriggerfromaninternaltriggersource.
IviFgenSoftwareTrigger [SWT] Forinstrumentscapableofproducingasignaluponreceiptofasoftwaretrigger.
IviFgenBurst [BST] Forinstrumentscapableofgeneratingafixednumberofwaveformcyclessignalupon
receiptofatrigger.IviFgenModulateAM [AM] Forinstrumentscapableof
applyingamplitudemodulationtoanoutputsignal.
IviFgenModulateFM [FM] Forinstrumentscapableofapplyingfrequencymodulationtoanoutputsignal.
IviFgenArbFrequencyExtensionGroupTheIviFgenArbFrequencyextensiongroupsupportsfunctiongeneratorscapableofproducingarbitrarywaveformsthatallowyoutosettherateatwhichanentirearbitrarywaveformisgenerated.Inordertosupportthisextension,adrivermustfirstsupporttheIviFgenArbWfmextensiongroup.ThisextensionusestheIviFgenArbWfmextensiongroup'spropertiesofwaveformhandle,gain,andoffsettoconfigureanarbitrarywaveform.
IviFgenArbFrequencyVIIviFgenConfigureArbFrequency
IviFgenArbFrequencyPropertyIviFgenArbFrequency[AF]RelatedTopicsIviFgenVITreeIviFgenProperties
IviFgenArbSeqExtensionGroupTheIviFgenArbSeqextensiongroupsupportsfunctiongeneratorscapableofproducingsequencesofarbitrarywaveforms.Inordertosupportthisextension,adrivermustfirstsupporttheIviFgenArbWfmextensiongroup.ThisextensionsusestheIviFgenArbWfmextensiongroup'spropertiesofsamplerate,gain,andoffsettoconfigureasequence.TheIviFgenArbSeqextensiongroupincludesVIsforcreating,configuring,andgeneratingsequences,andforreturninginformationaboutarbitrarysequencecreation.
IviFgenArbSeqVIsIviFgenQueryArbSequenceCapabilitiesIviFgenCreateArbitrarySequence[SEQ]IviFgenConfigureArbitrarySequenceIviFgenClearArbitrarySequenceIviFgenClearArbitraryMemory
IviFgenArbSeqPropertiesIviFgenArbitrarySequenceHandleIviFgenMaxNumberofSequencesIviFgenMaxLoopCountIviFgenMaxSequenceLengthIviFgenMinSequenceLengthRelatedTopicsIviFgenVITreeIviFgenProperties
IviFgenArbWfmExtensionGroupTheIviFgenArbWfmextensiongroupsupportsfunctiongeneratorscapableofproducinguser-definedarbitrarywaveforms.Youcanmodifyparametersofthearbitrarywaveformsuchassamplerate,waveformgain,andwaveformoffset.TheIviFgenArbWfmextensiongroupincludesVIsforcreating,configuring,andgeneratingarbitrarywaveforms,andforreturninginformationaboutarbitrarywaveformcreation.
IviFgenArbWfmVIsIviFgenConfigureSampleRateIviFgenQueryArbWaveformCapabilitiesIviFgenCreateArbitraryWfmIviFgenConfigureArbitraryWfmIviFgenClearArbitraryWfm
IviFgenArbWfmPropertiesIviFgenArbitraryWaveformGainIviFgenArbitraryWaveformOffsetIviFgenArbSampleRateIviFgenArbitraryWaveformHandleIviFgenMaxNumberofWaveformsIviFgenMaxWaveformSizeIviFgenMinWaveformSizeIviFgenWaveformQuantumRelatedTopicsIviFgenVITreeIviFgenProperties
IviFgenBaseCapabilityGroupTheIviFgenBasecapabilitiessupportthemostbasicfunctiongeneratorcapabilities.Youcanconfiguretheoutputimpedanceandreferenceclocksource,andenableordisablethefunctiongenerator'soutputconnectors.Thebasecapabilitiesdonotsupportthegenerationofaspecifickindofoutputsignal.Instead,afunctiongeneratormustsupporteithertheIviFgenStdFuncorIviFgenArbWfmextensions.Thisorganizationisrequiredbecausemanyfunctiongeneratorssupportonlyoneoftheseextensiongroups.Ifafunctiongeneratorsupportsmorethanoneoftheseextensions,theoutputmodecanbeconfiguredtospecifywhichextensionthefunctiongeneratorusestoproduceasignal.
IviFgenBaseVIsIviFgenConfigureOutputModeIviFgenConfigureRefClockSourceIviFgenConfigureOperationModeIviFgenConfigureOutputImpedanceIviFgenConfigureOutputEnabled.IviFgenInitiateGenerationIviFgenAbortGeneration
IviFgenBasePropertiesIviFgenOperationModeIviFgenOutputEnabledIviFgenOutputImpedanceIviFgenOutputModeIviFgenReferenceClockSourceFormoreVIandpropertyinformation:IviFgenVITreeIviFgenPropertiesRelatedTopics
IVIInherentVIsIVIInherentPropertiesIviFgenBaseBehaviorModel
IviFgenBurstExtensionGroupTheIviFgenBurstExtensionGroupsupportsfunctiongeneratorscapableofproducingadiscretenumberofwaveformcyclesuponreceiptofatrigger.YouspecifythetriggersourcewiththeIviFgenTriggerExtensionGroup.Forstandardandarbitrarywaveforms,acycleisoneperiodofthewaveform.Forarbitrarysequences,acycleisonecompleteprogressionthroughthegenerationofalliterationsofallwaveformsinthesequence.
IviFgenBurstVIIviFgenConfigureBurstCount
IviFgenBurstPropertyIviFgenBurstCountRelatedTopicsIviFgenVITreeIviFgenPropertiesIviFgenBurstbehaviormodel
IviFgenInternalTriggerExtensionGroupTheIviFgenInternalTriggerExtensionGroupsupportsfunctiongeneratorscapableofgeneratingoutputbasedonaninternallygeneratedtriggersignal.Youcanconfiguretherateatwhichinternaltriggersaregenerated.
IviFgenInternalTriggerVIIviFgenConfigureInternalTriggerRate
IviFgenInternalTriggerPropertyIviFgenInternalTriggerRateRelatedTopicsIviFgenVITreeIviFgenPropertiesIviFgenInternalTriggerbehaviormodel
IviFgenModulateAMExtensionGroupTheIviFgenModulateAMExtensionGroupsupportsfunctiongeneratorsthatcanapplyamplitudemodulationtoanoutputsignal.Youcanenableordisableamplitudemodulation,andspecifythesourceofthemodulatingsignal.Ifthefunctiongeneratorsupportsaninternalmodulationsource,youcanspecifythewaveformtype,frequency,andmodulationdepth.
IviFgenModulateAMVIsIviFgenConfigureAMEnabledIviFgenConfigureAMSourceIviFgenConfigureAMInternal
IviFgenModulateAMPropertiesIviFgenAMEnabledIviFgenAMSourceIviFgenAMInternalDepthIviFgenAMInternalFrequencyIviFgenAMInternalWaveformRelatedTopicsIviFgenVITreeIviFgenProperties
IviFgenModulateFMExtensionGroupTheIviFgenModulateFMExtensionGroupsupportsfunctiongeneratorsthatcanapplyfrequencymodulationtoanoutputsignal.Youcanenableordisablefrequencymodulation,andspecifythesourceofthemodulatingsignal.Ifthefunctiongeneratorsupportsaninternalmodulationsource,youcanspecifythewaveformtype,frequency,andpeakfrequencydeviation.
IviFgenModulateFMVIsIviFgenConfigureFMEnabledIviFgenConfigureFMSourceIviFgenConfigureFMInternal
IviFgenModulateFMPropertiesIviFgenFMEnabledIviFgenFMSourceIviFgenFMInternalDeviationIviFgenFMInternalFrequencyIviFgenFMInternalWaveformRelatedTopicsIviFgenVITreeIviFgenProperties
IviFgenSoftwareTriggerExtensionGroupTheIviFgenSoftwareTriggerExtensionGroupsupportsfunctiongeneratorsthatcangenerateoutputbasedonasoftwaretriggersignal.Youcansendasoftwaretriggertocausesignaloutputtooccur.
IviFgenSoftwareTriggerVIIviFgenSendSoftwareTriggerRelatedTopicsIviFgenVITree
IviFgenStdFuncExtensionGroupTheIviFgenStdFuncextensiongroupsupportsfunctiongeneratorsthatcanproducemanufacturer-suppliedperiodicwaveforms.Youcanmodifyparametersofthewaveformsuchasfrequency,amplitude,DCoffset,andphaseoffset.
IviFgenStdFuncVIIviFgenConfigureStandardWaveform
IviFgenStdFuncPropertiesIviFgenFuncAmplitudeIviFgenDCOffsetIviFgenDutyCycleHighIviFgenFrequencyIviFgenStartPhaseIviFgenWaveformRelatedTopicsIviFgenVITreeIviFgenProperties
IviFgenTriggerExtensionGroupTheIviFgenTriggerExtensionGroupsupportsfunctiongeneratorscapableofrespondingtoatriggersignal.ThevalueoftheIviFgenOperationModepropertydetermineshowthefunctiongeneratorrespondstothetriggersource.
IviFgenTriggerVIIviFgenConfigureTriggerSource
IviFgenTriggerProperty
IviFgenTriggerSource[TRG]RelatedTopicsIviFgenVITreeIviFgenProperties
IviFgenBehaviorModelsIviFgenArbSeqIviFgenArbWfmIviFgenBaseIviFgenBurstIviFgenArbFrequencyIviFgenInternalTriggerIviFgenModulateAMIviFgenModulateFMIviFgenStdFuncIviFgenTriggerIviFgenSoftwareTrigger
IviFgenArbFrequencyBehaviorModelTheIviFgenArbFrequencyExtensionGroupfollowsthebehaviormodeloftheIviFgenBasecapabilitygroup.TheonlymodificationtothebehaviormodelfromtheIviFgenBasecapabilitygroupistheabilitytoconfigureIviFgenArbFrequencysettings.
IviFgenArbSeqBehaviorModelTheIviFgenArbSeqExtensionGroupfollowsthebehaviormodeloftheIviFgenArbWfmcapabilitygroup.TheonlymodificationtothebehaviormodelfromthefundamentalcapabilitygroupistheabilitytoconfigureIviFgenArbSeqsettings.
IviFgenArbWfmBehaviorModelTheIviFgenArbWfmExtensionGroupfollowsthebehaviormodeloftheIviFgenBasecapabilitygroup.TheonlymodificationtothebehaviormodelfromtheIviFgenBasecapabilitygroupistheabilitytoconfigureIviFgenArbWfmsettings.
IviFgenBaseBehaviorModelThefollowingbehaviormodelshowstherelationshipbetweentheIviFgenbasecapabilitygroupandfunctiongeneratorbehavior.
IviFgenBehaviorModelAfteryoucalltheClassPrefixInitialize,ClassPrefixInitializeWithOptions,orClassPrefixResetVIs,thefunctiongeneratorenterstheoutputgenerationstate.CallingIviFgenAbortGenerationmovesthefunctiongeneratortotheconfigurationstate.Dependingonthespecificfunctiongenerator,thismightcausesignalgenerationtocease.AnychangesmadetotheinstrumentwhileintheconfigurationstatetakeplacenolaterthanwhenyoucallIviFgenInitiateGeneration,butcanoccurbeforethen.CallingIviFgenInitiateGenerationmovesthefunctiongeneratorbacktotheoutputgenerationstate.Theoutputsignalthenreflectsallconfigurationchangesmadetothefunctiongeneratorwhileintheconfigurationstate.Anychangesmadetotheinstrumentwhileintheoutputgenerationstatetakeplaceimmediately.Whenthefunctiongeneratorisintheoutputgenerationstate,itgeneratesoutputbasedonthecurrentvalueoftheIviFgenOperationModeproperty.IftheIviFgenOperationModepropertyissettoIVIFGEN_VAL_OPERATE_CONTINUOUS,thefunctiongeneratorproducesthewaveformcontinuously.IftheIviFgenOperationModepropertyissettoavalueotherthanIVIFGEN_VAL_OPERATE_CONTINUOUS,thepropertiesandVIsofacorrespondingextensiongroupcontroltheoperationofthefunctiongenerator.Refertothebehaviormodelforthecorrespondingextensiongroupfordetailsregardinginstrumentbehavior.ThisspecificationdoesnotdefinewhenthefunctiongeneratorchangestoanewoperationmodeifthevalueoftheIviFgenOperationModepropertychangeswhilethefunctiongeneratorisintheoutputgenerationstate.
IviFgenBurstBehaviorModelThebehaviormodelfortheIviFgenBurstextensioncapabilitygroupleveragesthebehaviormodelfortheIviFgenBaseextensiongroup.Theonlydifferenceiswhathappenswhilethefunctiongeneratorisintheoutputgenerationstate.ThefollowingdiagramshowstheoutputgenerationstatefortheIviFgenBurstextensiongroup.
IviFgenBurstBehaviorModelWhenthefunctiongeneratorenterstheoutputgenerationstateandtheIviFgenOperationModepropertyissettoIVIFGEN_VAL_OPERATE_BURST,thefunctiongeneratorentersthewait-for-triggerstate.Thefunctiongeneratorexitsthewait-for-triggerstatewhenitreceivesatriggerfromthesourcethattheIviFgenTriggerSource[TRG]propertyspecifies.Afterthefunctiongeneratorexitsthewait-for-triggerstateitgeneratesonecompletecycleofthecurrentlyconfiguredwaveform.TheIviFgenOutputModepropertydeterminesthetypeofwaveformthatthefunctiongeneratorproduces.ThewaveformcouldbeastandardVI,anarbitrarywaveform,oranarbitrarysequence.Afterthefunctiongeneratorproduceseachwaveformcycle,thefunctiongeneratorcomparesthetotalnumberofwaveformcyclesthathavebeengeneratedsincethefunctiongeneratorexitedthewait-for-triggerstatewiththevalueoftheIviFgenBurstCountproperty.IfthetotalnumberofwaveformsgeneratedislessthanthevalueoftheIviFgenBurstCountproperty,thefunctiongeneratorproducesanotherwaveformcycle.IfthetotalnumberofwaveformsgeneratedisequaltothevalueoftheIviFgenBurstCountproperty,thefunctiongeneratorreturnstothewait-for-triggerstate.Afterthefunctiongeneratorbeginstogeneratewaveformcycles,itignoresalltriggersignalsuntilthenumberofwaveformcyclesspecifiedbytheIviFgenBurstCountpropertyhavebeengenerated.
IviFgenInternalTriggerBehaviorModelTheIviFgenInternalTriggerExtensionGroupfollowsthebehaviormodeloftheIviFgenBasecapabilitygroup.TheonlymodificationtothebehaviormodelfromtheIviFgenBasecapabilitygroupistheabilitytoconfigureIviFgenInternalTriggersettings.
IviFgenModulateAMBehaviorModelTheIviFgenModulateAMExtensionGroupfollowsthebehaviormodeloftheIviFgenBasecapabilitygroup.TheonlymodificationtothebehaviormodelfromtheIviFgenBasecapabilitygroupistheabilitytoconfigureIviFgenModulateAMsettings.
IviFgenModulateFMBehaviorModelTheIviFgenModulateFMExtensionGroupfollowsthebehaviormodeloftheIviFgenBasecapabilitygroup.TheonlymodificationtothebehaviormodelfromtheIviFgenBasecapabilitygroupistheabilitytoconfigureIviFgenModulateFMsettings.
IviFgenSoftwareTriggerBehaviorModelTheIviFgenSoftwareTriggerExtensionGroupfollowsthebehaviormodeloftheIviFgenBasecapabilitygroup.TheonlymodificationtothebehaviormodelfromtheIviFgenBasecapabilitygroupistheabilitytoconfigureIviFgenSoftwareTriggersettings.
IviFgenStdFuncBehaviorModelTheIviFgenStdFuncExtensionGroupfollowsthebehaviormodeloftheIviFgenBasecapabilitygroup.TheonlymodificationtothebehaviormodelfromtheIviFgenBasecapabilitygroupistheabilitytoconfigureIviFgenStdFuncsettings.
IviFgenTriggerBehaviorModelTheIviFgenTriggerExtensionGroupfollowsthebehaviormodeloftheIviFgenBasecapabilitygroup.TheonlymodificationtothebehaviormodelfromtheIviFgenBasecapabilitygroupistheabilitytoconfigureIviFgenTriggersettings.
IviFgenVITreeTheVItreefortheIviFgenclassdriver,includingIVIandVXIplug&playrequiredVIs,isshowninthefollowingtable.
NoteYouusetheLabVIEWPropertyNodetogetandsetproperties.
IviFgenVITreeNameorClass VIName RequiredByInitialize IviFgenInitialize VPPInitializeWithOptions IviFgenInitializeWith
OptionsIVI
Configuration
ConfigureOutputMode
IviFgenConfigureOutputMode
IviFgen
ConfigureOperationMode
IviFgenConfigureOperationMode
IviFgen
ConfigureRefClockSource
IviFgenConfigureRefClockSource
IviFgen
ConfigureOutputImpedance
IviFgenConfigureOutputImpedance
IviFgen
ConfigureOutputEnabled
IviFgenConfigureOutputEnabled.
IviFgen
StandardWaveform
ConfigureStandardWaveform[STD]
IviFgenConfigureStandardWaveform
IviFgenStdFunc
ArbitraryWaveform
QueryArbWaveformCapabilities[ARB]
IviFgenQueryArbWaveformCapabilities
IviFgenArbWfm
CreateArbitraryWaveform[ARB]
IviFgenCreateArbitraryWfm
IviFgenArbWfm
ConfigureSampleRate[ARB]
IviFgenConfigureSampleRate
IviFgenArbWfm
ConfigureArbitrary IviFgenConfigure IviFgenArbWfm
Waveform[ARB] ArbitraryWfm
ClearArbitraryWaveform[ARB]
IviFgenClearArbitraryWfm
IviFgenArbWfm
ArbitraryWaveformFrequency
ConfigureArbFrequency[ARBF]
IviFgenConfigureArbFrequency
IviFgenArbFrequency
ArbitrarySequence
QueryArbitrarySequenceCapabilities[SEQ]
IviFgenQueryArbSequenceCapabilities
IviFgenArbSeq
CreateArbitrarySequence[SEQ]
IviFgenCreateArbitrarySequence[SEQ]
IviFgenArbSeq
ConfigureArbitrarySequence[SEQ]
IviFgenConfigureArbitrarySequence
IviFgenArbSeq
ClearArbitrarySequence[SEQ]
IviFgenClearArbitrarySequence
IviFgenArbSeq
ClearArbitraryMemory[SEQ]
IviFgenClearArbitraryMemory
IviFgenArbSeq
Trigger
ConfigureTriggerSource[TRG]
IviFgenConfigureTriggerSource
IviFgenTrigger
InternalTrigger
ConfigureInternalTriggerRate[ITRG]
IviFgenConfigureInternalTriggerRate
IviFgenInternalTrigger
Burst
ConfigureBurstCount[BST]
IviFgenConfigureBurstCount
IviFgenBurst
AmplitudeModulation
ConfigureAMEnabled[AM]
IviFgenConfigureAMEnabled
IviFgenModulateAM
ConfigureAMSource[AM]
IviFgenConfigureAMSource
IviFgenModulateAM
ConfigureAMInternal IviFgenConfigureAMInternal
IviFgenModulateAM
FrequencyModulation
ConfigureFMEnabled[FM]
IviFgenConfigureFMEnabled
IviFgenModulateFM
ConfigureFMSource[FM]
IviFgenConfigureFMSource
IviFgenModulateFM
ConfigureFMInternal[FM]
IviFgenConfigureFMInternal
IviFgenModulateFM
ActionVIs
InitiateGeneration IviFgenInitiateGeneration
IviFgen
AbortGeneration IviFgenAbortGeneration
IviFgen
SendSoftwareTrigger[SWT]
IviFgenSendSoftwareTrigger
IviFgenSoftwareTrigger
UtilityVIs
Reset IviFgenReset VPP
ResetWithDefaults ResetWithDefaults VPP
Self-Test IviFgenSelf-Test VPP
Disable Disable VPP
InvalidateAllAttributes InvalidateAllAttributes
VPP
RevisionQuery IviFgenRevisionQuery
VPP
Error-Query IviFgenError-Query VPP
ErrorMessage IviFgenErrorMessage
VPP
GetChannelName IviFgenGetChannelName
VPP
InterchangeabilityInfo
GetNextInterchangeWarning
IviFgenGetNextInterchangeWarning
IVI
ResetInterchangeCheck
IviFgenResetInterchangeCheck
IVI
ClearInterchangeWarnings
IviFgenClearInterchangeWarnings
IVI
CoercionInfo
GetNextCoercionRecord
IviFgenGetNextCoercionRecord
IVI
Close IviFgenClose VPP
RelatedTopicsIviFgenPropertiesIVIInherentVIs
IviFgenPropertiesNoteYouusetheLabVIEWPropertyNodetogetandsetproperties.
IviFgenBasePropertiesIviFgenOperationModeIviFgenOutputEnabledIviFgenOutputImpedanceIviFgenOutputModeIviFgenReferenceClockSource
IviFgenStdFuncPropertiesIviFgenFuncAmplitudeIviFgenDCOffsetIviFgenDutyCycleHighIviFgenFrequencyIviFgenStartPhaseIviFgenWaveform
IviFgenArbWfmPropertiesIviFgenArbitraryWaveformGainIviFgenArbitraryWaveformOffsetIviFgenArbSampleRateIviFgenArbitraryWaveformHandleIviFgenMaxNumberofWaveformsIviFgenMaxWaveformSizeIviFgenMinWaveformSizeIviFgenWaveformQuantum
IviFgenArbFrequencyPropertiesIviFgenArbFrequency
IviFgenArbSeqPropertiesIviFgenArbitrarySequenceHandleIviFgenMaxNumberofSequencesIviFgenMaxLoopCountIviFgenMaxSequenceLengthIviFgenMinSequenceLength
IviFgenTriggerPropertiesIviFgenTriggerSource
IviFgenInternalTriggerPropertiesIviFgenInternalTriggerRate
IviFgenBurstPropertiesIviFgenBurstCount
IviFgenModulateAMPropertiesIviFgenAMEnabledIviFgenAMSourceIviFgenAMInternalDepthIviFgenAMInternalFrequency
IviFgenModulateFMPropertiesIviFgenFMEnabledIviFgenFMSourceIviFgenFMInternalDeviationIviFgenFMInternalFrequency
IviFgenPropertyValueDefinitionsThefollowingtabledefinestheIDvalueforallIviFgenclassproperties.
NoteInthefollowingtabletheliteralstringIVIFGENprecedesallpropertynames,andtheliteralstringIVIFGEN_VAL_precedesalldefinedvaluenames.
IviFgenPropertyDefinedValues
Property ValueName
DefinedValue Description
OPERATIONMODE
Continuous 0 Configuresthefunctiongeneratortogenerateoutputcontinuously.
OPERATE_BURST Burst 1 Configuresthefunctiongeneratortogenerateaburstofwaveformcycles.
OUTPUTMODE StandardFunction
0 ThedriverusesthepropertiesandfunctionsoftheIviFgenStdFuncextensiongrouptoconfigurethefunctiongenerator'soutputsignal.
ArbitraryWaveform
1 ThedriverusesthepropertiesandfunctionsoftheIviFgenArbWfmExtensionGrouptoconfigurethefunctiongenerator'soutputsignal.
ArbitrarySequence
2 ThedriverusesthepropertiesandfunctionsoftheIviFgenArbWfmandIviFgenArbSeqExtensionGroupstogethertoconfigurethefunctiongenerator'soutputsignal.
REFERENCECLOCKSOURCE
Internal 0 Thefunctiongeneratorproducesthereferenceclocksignalinternally.
External 1 Thefunctiongeneratorreceivesthereferenceclocksignalfromanexternalsource.
Sine 1 Configuresthefunctiongeneratortoproduceasinusoidwaveform.
Square 2 Configuresthefunctiongeneratortoproduceasquarewaveform.
Triangle 3 Configuresthefunctiongeneratortoproduceatriangularwaveform.
RampUp 4 Configuresthefunctiongeneratortoproduceapositiverampwaveform.
Ramp 5 Configuresthefunctiongeneratorto
Down produceanegativerampwaveform.DC 6 Configuresthefunctiongeneratorto
produceaconstantvoltage.TRIGGERSOURCE
External 1 Thefunctiongeneratordoesnotproduceanoutputsignaluntilitreceivesatriggeronitsexternaltriggerinputterminal.
SoftwareTriggerFunction
2 ThefunctiongeneratordoesnotproduceanoutputsignaluntiltheIviFgen_SendSoftwareTriggerfunctioniscalled.IfyousettheIVIFGEN_ATTR_TRIGGER_SOURCEpropertytothisvalue,theinstrumentcanonlybetriggeredbycallingtheIviFgen_SendSoftwareTriggerfunction.
Internal 3 Thefunctiongeneratorwaitsuntilitreceivesatriggerfromitsinternaltriggersource.
VXITTL0 111 ThefunctiongeneratorwaitsuntilitreceivesatriggerontheTLL0line.
VXITTL1 112 ThefunctiongeneratorwaitsuntilitreceivesatriggerontheTLL1line.
VXITTL2 113 ThefunctiongeneratorwaitsuntilitreceivesatriggerontheTLL2line.
VXITTL3 114 ThefunctiongeneratorwaitsuntilitreceivesatriggerontheTLL3line.
VXITTL4 115 ThefunctiongeneratorwaitsuntilitreceivesatriggerontheTLL4line.
VXITTL5 116 ThefunctiongeneratorwaitsuntilitreceivesatriggerontheTLL5line.
VXITTL6 117 ThefunctiongeneratorwaitsuntilitreceivesatriggerontheTLL6line.
VXITTL7 118 ThefunctiongeneratorwaitsuntilitreceivesatriggerontheTLL7line.
ECLO 119 ThefunctiongeneratorwaitsuntilitreceivesatriggerontheECL0line.
ECL1 120 ThefunctiongeneratorwaitsuntilitreceivesatriggerontheECL1line.
PXIStar 131 ThefunctiongeneratorwaitsuntilitreceivesatriggeronthePXIStarbus.
RTSI0 141 ThefunctiongeneratorwaitsuntilitreceivesatriggerontheRTSI0line.
RTSI1 142 ThefunctiongeneratorwaitsuntilitreceivesatriggerontheRTSI1line.
RTSI2 143 ThefunctiongeneratorwaitsuntilitreceivesatriggerontheRTSI2line.
RTSI3 144 ThefunctiongeneratorwaitsuntilitreceivesatriggerontheRTSI3line.
RTSI4 145 ThefunctiongeneratorwaitsuntilitreceivesatriggerontheRTSI4line.
RTSI5 146 ThefunctiongeneratorwaitsuntilitreceivesatriggerontheRTSI5line.
RTSI6 147 ThefunctiongeneratorwaitsuntilitreceivesatriggerontheRTSI6line.
AMSOURCE Internal 0 Thefunctiongeneratorusesaninternallygeneratedwaveformtomodulatetheoutputsignal.
External 1 Thefunctiongeneratorusesawaveformfromanexternalsourcetomodulatetheoutputsignal.
FMSOURCE Internal 0 Thefunctiongeneratorusesaninternallygeneratedwaveformtofrequencymodulatetheoutputsignal.
External 1 Thefunctiongeneratorusesawaveformfromanexternalsourcetomodulatetheoutputsignal.
FormoreVIandpropertyinformation:IviFgenVITree
IviFgenProperties
IviFgenErrorandWarningCodesStatusCodeRangesStatusCodeType NumericRange(inHex)IviFgenErrors 0xBFFA2001to0xBFFA3FFFIviFgenWarnings 0x3FFA2001to0x3FFA3FFFIVISpecificDriverErrors 0xBFFA4000to0xBFFA5FFFIVISpecificDriverWarnings 0x3FFA4000to0x3FFA5FFFIVIErrors 0xBFFA0000to0xBFFA1FFFIVIWarnings 0x3FFA0000to0x3FFA1FFFCommonInstrumentDriverErrors 0xBFFC0000to0xBFFCFFFFCommonInstrumentDriverWarnings 0x3FFC0000to0x3FFCFFFFVISAErrors 0xBFFF0000to0xBFFFFFFFVISAWarnings 0x3FFF0000to0x3FFFFFFF
TheIviFgenclassdriverdefinesthefollowingerrorcodesinadditiontotheIVI-definederrorcodes.
IviFgenErrorCodesError Value MessageIVIFGEN_ERROR_NO_WFMS_AVAILABLE 0xBFFA2004 The
functiongenerator'swaveformmemoryisfull.
IVIFGEN_ERROR_WFM_IN_USE 0xBFFA2008 Thewaveformiscurrentlyinuse.
IVIFGEN_ERROR_NO_SEQS_AVAILABLE 0xBFFA2009 Thefunctiongenerator'ssequencememoryisfull.
IVIFGEN_ERROR_SEQ_IN_USE 0xBFFA200D Thesequenceiscurrentlyinuse.
IVIFGEN_ERROR_TRIGGER_NOT_SOFTWARE 0xBFFA1001 Thetriggersourceisnotasoftwaretrigger.
RelatedTopicIVIStatusCodes
IviFgenVIsExpandthisbooktoviewanalphabetizedlistofIviFgenVIs.
IviFgenAbortGenerationIviFgenBaseCapabilityGroupThisVIabortsapreviouslyinitiatedsignalgeneration.IfthefunctiongeneratorisintheOutputGenerationState,thisVImovesthefunctiongeneratortotheConfigurationState.IfthefunctiongeneratorisalreadyintheConfigurationState,theVIdoesnothing.
YoucanconfiguretheoutputofthefunctiongeneratorregardlessofwhetherthefunctiongeneratorisintheConfigurationStateortheGenerationState.ThismeansthatyouarenotrequiredtocalltheIviFgenAbortGenerationVIpriortoconfiguringtheoutputofthefunctiongenerator.Manyfunctiongeneratorsconstantlygenerateanoutputsignal,anddonotrequireyoutoabortsignalgenerationpriortoconfiguringtheinstrument.Ifafunctiongenerator'soutputcannotbeaborted(thatis,thefunctiongeneratorcannotstopgeneratingasignal)thisVIdoesnothing.YouarenotrequiredtocalltheIviFgenInitiateGenerationandIviFgenAbortGenerationVIs.WhetheryouchoosetocalltheseVIsinanapplicationprogramhasnoimpactoninterchangeability.YoucanchoosetousetheseVIsifyouwanttooptimizeyourapplicationforinstrumentsthatexhibitincreasedperformancewhenoutputconfigurationisperformedwhiletheinstrumentisnotgeneratingasignal.
NoteThisVIdoesnotnormallychecktheinstrumentstatus.Typically,youcallthisVIonlyinasequenceofcallstootherlow-leveldriverVIs.Thesequenceperformsoneoperation.Youusethelow-levelVIstooptimizeoneormoreaspectsofinteractionwiththeinstrument.Ifyouwanttochecktheinstrumentstatus,calltheIviFgenError-QueryVIattheconclusionofthesequence.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.errorin(noerror)Theerrorinclustercanaccepterrorinformation
wiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviFgenClearArbitraryMemoryIviFgenArbSeqCapabilityGroup[SEQ]ThisVIremovesallpreviouslycreatedarbitrarywaveformsandsequencesfromthefunctiongenerator'smemory.ThisVIalsoinvalidatesallwaveformandsequencehandles.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviFgenClearArbitrarySequenceIviFgenArbSeqCapabilityGroup[SEQ]ThisVIremovesapreviouslycreatedarbitrarysequencefromthefunctiongenerator'smemoryandinvalidatesthesequence'shandle.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.sequencehandle(0)Passthehandleofthearbitrarysequenceyouwantthefunctiongeneratortoremove.YoucreatemultiplearbitrarysequencesusingtheIviFgenCreateArbitrarySequence[SEQ]VI.TheIviFgenCreateArbitrarySequence[SEQ]VIreturnsahandlethatyouusetoidentifyeachsequence.DefinedValues:IVIFGEN_VAL_ALL_SEQUENCES(-1)Removeallsequencesfromthefunctiongenerator.DefaultValue:None
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviFgenClearArbitraryWaveformIviFgenArbWfmCapabilityGroup[ARB]ThisVIremovesapreviouslycreatedarbitrarywaveformfromthefunctiongenerator'smemoryandinvalidatesthewaveform'shandle.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.waveformhandle(0)Passthehandleofthearbitrarywaveformyouwantthefunctiongeneratortoremove.YoucreatemultiplearbitrarywaveformsusingtheIviFgenCreateArbitraryWaveform[ARB]VI.TheIviFgenCreateArbitraryWaveformVIreturnsahandlethatyouusetoidentifyeachwaveform.DefinedValues:IVIFGEN_VAL_ALL_WAVEFORMS(-1)—Removeallwaveformsfromthefunctiongenerator.DefaultValue:0
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviFgenConfigureAMEnabled[AM]IviFgenModulateAMCapabilityGroupThisVIconfigureswhetherthefunctiongeneratorappliesamplitudemodulationtothechannel.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.channelname("CHANNEL1")PassthevirtualchannelnamethatyouassigntotheinstrumentinMAX.Virtualchannelnamesarealiasesforinstrumentspecificchannelstrings.Theinstrumentspecificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.YouassignavirtualchannelnametoaninstrumentspecificchannelthroughMAX.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrumentspecificchannelnames.DefaultValue:"CHANNEL1"
AMenabled(TRUE)Specifywhetheryouwantthefunctiongeneratortoapplyamplitudemodulationtothechannel.ThedriversetstheIviFgenAMEnabled[AM]propertytothisvalue.DefaultValue:TRUE
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.
Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviFgenConfigureAMInternalIviFgenModulateAMCapabilityGroup[AM]ThisVIconfiguresthepropertiesthatcontrolthefunctiongenerator'sinternalamplitudemodulationsource.Thesepropertiesarethemodulationdepth,waveform,andfrequency.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.modulationdepth(0.00%)Passthepercentageoffullmodulationyouwanttoapplytothecarriersignal.ThedriversetstheIviFgenAMInternalDepth[AM]propertytothisvalue.At0%depth,theoutputamplitudeequalsthecarriersignal'samplitude.At100%depth,theoutputamplitudeequalstwicethecarriersignal'samplitude.Units:Percentage(%)DefaultValue:0.0%
modulationfrequency(1000Hz)Passthefrequencyatwhichyouwanttheinstrumenttogeneratethemodulatingwaveform.ThedriversetstheIviFgenAMInternalFrequency[AM]propertytothisvalue.Units:hertz(Hz)DefaultValue:1000Hz
modulationwaveform(Sine)Passthewaveformyouwanttousetomodulatetheoutputsignal.ThedriversetstheIviFgenAMInternalWaveform[AM]propertytothisvalue.DefinedValues:IVIFGEN_VAL_AM_INTERNAL_SINE—SinusoidwaveformIVIFGEN_VAL_AM_INTERNAL_SQUARE—Squarewaveform
IVIFGEN_VAL_AM_INTERNAL_TRIANGLE—TrianglewaveformIVIFGEN_VAL_AM_INTERNAL_RAMP_UP—PositiverampwaveformIVIFGEN_VAL_AM_INTERNAL_RAMP_DOWN—NegativerampwaveformIVIFGEN_VAL_AM_INTERNAL_DC—DCwaveformDefaultValue:IVIFGEN_VAL_AM_INTERNAL_SINE—Sinusoidwaveform
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviFgenConfigureAMSourceIviFgenModulateAMCapabilityGroup[xxx]ThisVIconfiguresthesourceoftheamplitudemodulatingsignalthefunctiongeneratorusesforthechannel.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.channelname("CHANNEL1")PassthevirtualchannelnamethatyouassigntotheinstrumentinMAX.Virtualchannelnamesarealiasesforinstrumentspecificchannelstrings.Theinstrumentspecificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.YouassignavirtualchannelnametoaninstrumentspecificchannelthroughMAX.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrumentspecificchannelnames.DefaultValue:"CHANNEL1"
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
source(Internal)Passthesourceofthemodulatingsignalyouwanttouse.ThedriversetstheIviFgenAMSource[AM]propertytothisvalue.ValidValues:
IVIFGEN_VAL_AM_INTERNALinternalmodulationsourceIVIFGEN_VAL_AM_EXTERNALexternalmodulationsourceDefaultValue:IVIFGEN_VAL_AM_INTERNALinternalmodulationsource
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviFgenConfigureArbFrequencyIviFgenArbFrequencyCapabilityGroupThisVIconfigurestherateatwhichthefunctiongeneratorproducesanentirecycleofanarbitrarywaveformonachannel.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.channelname("CHANNEL1")PassthevirtualchannelnamethatyouassigntotheinstrumentinMAX.Virtualchannelnamesarealiasesforinstrumentspecificchannelstrings.Theinstrumentspecificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.YouassignavirtualchannelnametoaninstrumentspecificchannelthroughMAX.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrumentspecificchannelnames.DefaultValue:"CHANNEL1"
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
frequency(0.0Hz)Passthefrequencyatwhichyouwantthefunctiongeneratortoproduceonecycleofanarbitrarywaveform.ThedriversetstheIviFgenArbFrequency[AF]propertytothisvalue.
Units:hertz(Hz)DefaultValue:0.00
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviFgenConfigureArbitrarySequenceIviFgenArbSeqCapabilityGroup[SEQ]ThisVIconfiguresthepropertiesofthefunctiongeneratorthataffectarbitrarysequencegeneration.Thesepropertiesarethearbitrarysequencehandle,gain,andoffset.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.channelname("CHANNEL1")PassthevirtualchannelnamethatyouassigntotheinstrumentinMAX.Virtualchannelnamesarealiasesforinstrumentspecificchannelstrings.Theinstrumentspecificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.YouassignavirtualchannelnametoaninstrumentspecificchannelthroughMAX.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrumentspecificchannelnames.DefaultValue:"CHANNEL1"
sequencehandle(0)Passthehandleofthearbitrarysequenceyouwantthefunctiongeneratortoproduce.ThedriversetstheIviFgenArbitrarySequenceHandle[SEQ]propertytothisvalue.YoucreateanarbitrarysequenceusingtheIviFgenCreateArbitrarySequence[SEQ]VI.TheIviFgenCreateArbitrarySequenceVIreturnsahandlethatyouusetoidentifythesequence.
DefaultValue:None
gain(1.00)Specifiesthefactorbywhichthefunctiongeneratorscalesthearbitrarywaveformsinthesequence.Whenyoucreatearbitrarywaveforms,youmustfirstnormalizethedatapointstoarangeof–1.00to+1.00.Youusethispropertytoscalethewaveformsinthesequencetootherranges.ThedriversetstheIviFgenArbitraryWaveformGain[ARB]propertytothisvalue.Forexample,toconfiguretheoutputsignaltorangefrom–2.00Vto+2.00V,setthegainto2.00.Units:NoneDefaultValue:1.00
offset(0.00V)Specifiesthevaluethefunctiongeneratoraddstothearbitrarywaveformsinthesequence.Whenyoucreatearbitrarywaveforms,youmustfirstnormalizethedatapointstoarangeof–1.00to+1.00.Youusethisparametertoshifttherangesofthearbitrarywaveformsinthesequence.ThedriversetstheIviFgenArbitraryWaveformOffset[ARB]propertytothisvalue.Forexample,toconfiguretheoutputsignaltorangefrom0.00Vto2.00Vinsteadof–1.00Vto1.00V,settheOffsetto1.00.Units:Volts(V)DefaultValue:0
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviFgenConfigureArbitraryWaveformIviFgenArbWfmCapabilityGroup[ARB]ThisVIconfiguresthepropertiesofthefunctiongeneratorthataffectarbitrarywaveformgeneration.Thesepropertiesarethearbitrarywaveformhandle,gain,andoffset.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.channelname("CHANNEL1")PassthevirtualchannelnamethatyouassigntotheinstrumentinMAX.Virtualchannelnamesarealiasesforinstrumentspecificchannelstrings.Theinstrumentspecificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.YouassignavirtualchannelnametoaninstrumentspecificchannelinMAX.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrumentspecificchannelnames.DefaultValue:"CHANNEL1"
waveformhandle(0)Passthehandleofthearbitrarywaveformyouwantthefunctiongeneratortoproduce.ThedriversetstheIviFgenArbitraryWaveformHandle[ARB]propertytothisvalue.YoucreateanarbitrarywaveformusingtheIviFgenCreateArbitraryWaveform[ARB]VI.TheIviFgenCreateArbitraryWaveform[ARB]VIreturnsahandlethatyouusetoidentifythewaveform.DefaultValue:None
gain(1.00)Specifiesthefactorbywhichthefunctiongeneratorscalesthearbitrarywaveformdata.Whenyoucreatearbitrarywaveforms,youmustfirstnormalizethedatapointstoarangeof–1.00to+1.00.Youusethispropertytoscalethearbitrarywaveformtootherranges.ThedriversetstheIviFgenArbitraryWaveformGain[ARB]propertytothisvalue.Forexample,toconfiguretheoutputsignaltorangefrom–2.00Vto+2.00V,setthegainto2.00.Units:NoneDefaultValue:1.00
offset(0.00V)Specifiesthevaluethefunctiongeneratoraddstothearbitrarywaveformdata.Whenyoucreatearbitrarywaveforms,youmustfirstnormalizethedatapointstoarangeof–1.00to+1.00.Youusethisparametertoshiftthearbitrarywaveform'srange.ThedriversetstheIviFgenArbitraryWaveformOffset[ARB]propertytothisvalue.Forexample,toconfiguretheoutputsignaltorangefrom0.00Vto2.00Vinsteadof–1.00Vto1.00V,settheOffsetto1.00.Units:Volts(V)DefaultValue:0.0V
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviFgenConfigureBurstCountIviFgenBurstCapabilityGroupThisVIconfigurestheburstcount.WhenthefunctiongeneratorreceivesatriggerwhileintheBurstoperationmode,itgeneratesthenumberofwaveformcyclesyouspecifyintheBurstCountcontrol.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.channelname("CHANNEL1")PassthevirtualchannelnamethatyouassigntotheinstrumentinMAX.Virtualchannelnamesarealiasesforinstrumentspecificchannelstrings.Theinstrumentspecificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.YouassignavirtualchannelnametoaninstrumentspecificchannelthroughMAX.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrumentspecificchannelnames.DefaultValue:"CHANNEL1"
burstcount(1)Passthenumberofwaveformcyclesyouwantthefunctiongeneratortoproduceafteritreceivesatrigger.ThedriversetstheIviFgenBurstCountpropertytothisvalue.Forstandardandarbitrarywaveforms,acycleisoneperiodofthewaveform.Anarbitrarysequenceconsistsofmultiplearbitrarywaveformsinasequence.Eachwaveformcanberepeatedadiscretenumberoftimesbeforethenextwaveformisproduced.Forarbitrarysequences,acycleisonecompleteprogressionthroughthegenerationofalliterationsofallwaveformsinthesequence.
DefaultValue:1
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviFgenConfigureFMEnabledIviFgenModulateFMCapabilityGroup[FM]ThisVIconfigureswhetherthefunctiongeneratorappliesfrequencymodulationtothechannel.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.channelname("CHANNEL1")PassthevirtualchannelnamethatyouassigntotheinstrumentinMAX.Virtualchannelnamesarealiasesforinstrumentspecificchannelstrings.Theinstrumentspecificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.YouassignavirtualchannelnametoaninstrumentspecificchannelthroughMAX.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrumentspecificchannelnames.DefaultValue:"CHANNEL1"
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
FMenabled(TRUE)Specifywhetheryouwantthefunctiongeneratortoapplyfrequencymodulationtothechannel.ThedriversetstheIviFgenFMEnabled[FM]propertytothisvalue.DefaultValue:TRUE
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviFgenConfigureFMInternalIviFgenModulateFMCapabilityGroup[FM]ThisVIconfiguresthepropertiesthatcontrolthefunctiongenerator'sinternalfrequencymodulationsource.Thesepropertiesarethepeakdeviation,waveform,andfrequency.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.peakdeviation(100Hz)Passthemaximumfrequencydeviationyouwantthefunctiongeneratortoapplytothecarrierwaveform.Thisdeviationcorrespondstothemaximumamplitudelevelofthemodulatingsignal.ThedriversetstheIviFgenFMInternalDeviation[FM]propertytothisvalue.Units:hertz(Hz)DefaultValue:100.0
modulationfrequency(1000Hz)Specifiesthefrequencyoftheinternalmodulatingsignal.ThedriversetstheIviFgenFMInternalFrequency[FM]propertytothisvalue.Units:hertz(Hz)DefaultValue:1000Hz
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
modulationwaveform(Sine)Passthewaveformyouwanttousetomodulatetheoutputsignal.ThedriversetstheIviFgenFM
InternalWaveform[FM]propertytothisvalue.DefinedValues:IVIFGEN_VAL_FM_INTERNAL_SINESinusoidwaveformIVIFGEN_VAL_FM_INTERNAL_SQUARESquarewaveformIVIFGEN_VAL_FM_INTERNAL_TRIANGLETrianglewaveformIVIFGEN_VAL_FM_INTERNAL_RAMP_UPPositiverampwaveformIVIFGEN_VAL_FM_INTERNAL_RAMP_DOWNNegativerampwaveformDefaultValue:IVIFGEN_VAL_FM_INTERNAL_SINESinusoidwaveform
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviFgenConfigureFMSourceIviFgenModulateFMCapabilityGroupThisVIconfiguresthesourceofthefrequencymodulatingsignalthefunctiongeneratorusesforthechannel.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.channelname("CHANNEL1")PassthevirtualchannelnamethatyouassigntotheinstrumentinMAX.Virtualchannelnamesarealiasesforinstrumentspecificchannelstrings.Theinstrumentspecificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.YouassignavirtualchannelnametoaninstrumentspecificchannelthroughMAX.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrumentspecificchannelnames.DefaultValue:"CHANNEL1"
source(Internal)Passthesourceofthemodulatingsignalyouwanttouse.ThedriversetstheIviFgenFMSource[FM]propertytothisvalue.ValidValues:IVIFGEN_VAL_FM_INTERNALinternalmodulationsourceIVIFGEN_VAL_FM_EXTERNALexternalmodulationsourceDefault:IVIFGEN_VAL_FM_INTERNALinternalmodulationsource
errorin(noerror)Theerrorinclustercanaccepterrorinformation
wiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviFgenConfigureInternalTriggerRateIviFgenInternalTriggerCapabilityGroupThisVIconfigurestherateatwhichthefunctiongenerator'sinternaltriggersourcegeneratestriggersignals.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
triggerrateSpecifytherateatwhichyouwantthefunctiongenerator'sinternaltriggerratetogeneratetriggersignals.ThedriversetstheIviFgenInternalTriggerRate[IT]tothisvalue.instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviFgenConfigureOperationModeIviFgenBaseCapabilityGroupThisVIconfigurestheoperationmodeofthefunctiongenerator.Theoperationmodedetermineshowthefunctiongeneratorproducesoutputonachannel.Forexample,youcanselecttogenerateoutputcontinuouslyortogenerateadiscretenumberofwaveformcyclesbasedonatriggerevent.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.channelname("CHANNEL1")PassthevirtualchannelnamethatyouassigntotheinstrumentinMAX.Virtualchannelnamesarealiasesforinstrumentspecificchannelstrings.Theinstrumentspecificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.YouassignavirtualchannelnametoaninstrumentspecificchannelthroughMAX.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrumentspecificchannelnames.DefaultValue:"CHANNEL1"
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
operationmode(Continuous)Passtheoperationmodeyouwantthefunctiongeneratortouse.ThedriversetstheIviFgenOperationModepropertytothisvalue.DefinedValues:IVIFGEN_VAL_OPERATE_CONTINUOUS—continuousgenerationIVIFGEN_VAL_OPERATE_BURST—burstgenerationDefaultValue:IVIFGEN_VAL_OPERATE_CONTINUOUS—continuousgeneration
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviFgenConfigureOutputEnabledIviFgenBaseCapabilityGroupThisVIconfigureswhetherthesignalthefunctiongeneratorproducesappearsatthechannel'soutputconnector.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.channelname("CHANNEL1")Ifthepropertyischannel-based,thisparameterspecifiesthenameofthechannelonwhichtosetthevalueoftheproperty.Ifthepropertyisnotchannel-based,thenpassVI_NULLoranemptystring.PassthevirtualchannelnamethatyouassigntotheinstrumentinMAX.Virtualchannelnamesarealiasesforinstrumentspecificchannelstrings.Theinstrumentspecificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.YouassignavirtualchannelnametoaninstrumentspecificchannelthroughMAX.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrumentspecificchannelnames.DefaultValue:"CHANNEL1"
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
channelenabled(True)Specifywhetheryouwantthesignalthefunctiongeneratorproducestoappearattheoutputterminal.ThedriversetstheIviFgenOutputEnabledpropertytothisvalue.DefaultValue:TRUE
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviFgenConfigureOutputImpedanceIviFgenBaseCapabilityGroupThisVIconfigurestheoutputimpedanceforthechannelyouspecify.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.channelname("CHANNEL1")PassthevirtualchannelnamethatyouassigntotheinstrumentinMAX.Virtualchannelnamesarealiasesforinstrumentspecificchannelstrings.Theinstrumentspecificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.YouassignavirtualchannelnametoaninstrumentspecificchannelthroughMAX.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrumentspecificchannelnames.DefaultValue:"CHANNEL1"
impedance(50ohms)Passtheimpedancevalueyouwantthefunctiongeneratortouse.ThedriversetstheIviFgenOutputImpedancepropertytothisvalue.Avalueof0.0indicatesthatthefunctiongeneratorisconnectedtoahigh-impedanceload.
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.
Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviFgenConfigureOutputModeIviFgenBaseCapabilityGroupThisVIconfigurestheoutputmodeofthefunctiongenerator.Theoutputmodedeterminesthekindofwaveformthefunctiongeneratorproduces.Forexample,youcanselecttooutputastandardwaveform,anarbitrarywaveform,orasequenceofarbitrarywaveforms.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.outputmode(StandardFunction)Passtheoutputmodeyouwantthefunctiongeneratortouse.ThedriversetstheIviFgenOutputModepropertytothisvalue.ThevalueyouspecifydetermineswhichVIsandpropertiesyouusetoconfigurethewaveformthefunctiongeneratorproduces.WhenyousetthisparametertoIVIFGEN_VAL_OUTPUT_FUNC,usethefollowingVItoconfigurethewaveform:IviFgenConfigureStandardWaveform[STD]InplaceofusingthisVI,youcansetthefollowingproperties:IviFgenWaveform[STD]IviFgenFuncAmplitude[STD]IviFgenDCOffset[STD]IviFgenFrequency[STD]IviFgenStartPhase[STD]IviFgenDutyCycleHigh[STD]WhenyousetthisparametertoIVIFGEN_VAL_OUTPUT_ARB,usethefollowingVIstoconfigurethewaveform:IviFgenQueryArbWaveformCapabilities[ARB]IviFgenCreateArbitraryWaveform[ARB]
IviFgenClearArbitraryWaveform[ARB]IviFgenConfigureSampleRate[ARB]IviFgenConfigureArbitraryWaveform[ARB]IviFgenConfigureArbFrequency[AF]InsteadofusingtheIviFgenConfigureSampleRate[ARB]andIviFgenConfigureArbitraryWaveform[ARB]VIs,youcansetthefollowingproperties:IviFgenArbitraryWaveformHandle[ARB]IviFgenArbitraryWaveformGain[ARB]IviFgenArbitraryWaveformOffset[ARB]IviFgenArbSampleRate[ARB]IviFgenArbFrequency[AF]WhenyousetthisparametertoIVIFGEN_VAL_OUTPUT_SEQ,usethefollowingVIstoconfigurethesequence:IviFgenQueryArbWaveformCapabilities[ARB]IviFgenCreateArbitraryWaveform[ARB]IviFgenClearArbitraryWaveform[ARB]IviFgenQueryArbSequenceCapabilities[SEQ]IviFgenClearArbitrarySequence[SEQ]IviFgenClearArbitraryMemory[SEQ]IviFgenConfigureSampleRate[ARB]IviFgenConfigureArbitrarySequence[SEQ]InsteadofusingtheIviFgenConfigureSampleRate[ARB]andIviFgenConfigureArbitrarySequence[SEQ]VIs,youcansetthefollowingproperties:IviFgenArbitrarySequenceHandle[SEQ]IviFgenArbitraryWaveformGain[ARB]IviFgenArbitraryWaveformOffset[ARB]IviFgenArbSampleRate[ARB]DefinedValues:
IVIFGEN_VAL_OUTPUT_FUNCStandardFunctionOutputIVIFGEN_VAL_OUTPUT_ARBArbitraryWaveformOutputIVIFGEN_VAL_OUTPUT_SEQArbitrarySequenceoutputDefaultValue:IVIFGEN_VAL_OUTPUT_FUNCStandardFunctionOutput
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviFgenConfigureRefClockSourceIviFgenBaseCapabilityGroupThisVIconfiguresthefunctiongenerator'sreferenceclocksource.Thefunctiongeneratorusesthereferenceclocktoderivefrequenciesandsamplerateswhengeneratingoutput.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
referenceclocksource(Internal)Passthereferenceclocksourceyouwantthefunctiongeneratortouse.ThedriversetstheIviFgenReferenceClockSourcepropertytothisvalue.Thefunctiongeneratorderivesthefrequenciesandsampleratesthatitusestogeneratewaveformsfromthesourceyouspecify.Forexample,whenyousetthisparametertoIVIFGEN_VAL_REF_CLOCK_EXTERNAL,thefunctiongeneratorusesthesignalitreceivesatitsexternalclockterminalasitsreferenceclock.DefinedValues:IVIFGEN_VAL_REF_CLOCK_INTERNAL—InternalclocksourceIVIFGEN_VAL_REF_CLOCK_EXTERNAL—ExternalclocksourceIVIFGEN_VAL_REF_CLOCK_RTSI_CLOCK—RTSIclocksource
Default:IVIFGEN_VAL_REF_CLOCK_INTERNAL—Internalclocksource
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviFgenConfigureSampleRateIviFgenArbWfmCapabilityGroup[ARB]ThisVIconfigurestherateatwhichthefunctiongeneratorproducesthepointsthatmakeuparbitrarywaveforms.Whenyouconfigurethefunctiongeneratortoproduceanarbitrarysequence,thisisthesamplerateforallarbitrarywaveformsinthesequence.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.samplerate(1000Samp/s)Passthesamplerateatwhichyouwantthefunctiongeneratortooutputarbitrarywaveforms.ThedriversetstheIviFgenArbSampleRate[ARB]propertytothisvalue.Units:Samples-per-Second(Samp/s)DefaultValue:1000
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviFgenConfigureStandardWaveformIviFgenStdFuncCapabilityGroup[STD]ThisVIconfiguresthepropertiesofthefunctiongeneratorthataffectstandardwaveformgeneration.Thesepropertiesarethewaveform,amplitude,DCoffset,frequency,andstartphase.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.channelname("CHANNEL1")PassthevirtualchannelnamethatyouassigntotheinstrumentinMAX.Virtualchannelnamesarealiasesforinstrumentspecificchannelstrings.Theinstrumentspecificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.YouassignavirtualchannelnametoaninstrumentspecificchannelthroughMAX.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrumentspecificchannelnames.DefaultValue:"CHANNEL1"
waveform(Sine)Passthestandardwaveformthatyouwantthefunctiongeneratortoproduce.ThedriversetstheIviFgenWaveform[STD]propertytothisvalue.ValidValues:IVIFGEN_VAL_WFM_SINE—Sinusoidwaveform
IVIFGEN_VAL_WFM_SQUARE—SquarewaveformIVIFGEN_VAL_WFM_TRIANGLE—TrianglewaveformIVIFGEN_VAL_WFM_RAMP_UP—PositiverampwaveformIVIFGEN_VAL_WFM_RAMP_DOWN—NegativerampwaveformIVIFGEN_VAL_WFM_DC—ConstantvoltageDefaultValue:IVIFGEN_VAL_WFM_SINE—Sinusoidwaveform
amplitude(1.0V)Passtheamplitudeofthestandardwaveformthatyouwantthefunctiongeneratortoproduce.Thisvalueistheamplitudeattheoutputterminal.ThedriversetstheIviFgenFuncAmplitude[STD]propertytothisvalue.Forexample,toproduceawaveformrangingfrom–5.00Vto+5.00V,settheamplitudeto10.00V.Units:Voltspeak-to-peak(Vpp)DefaultValue:1.0V
NoteThisparameterdoesnotaffectfunctiongeneratorbehaviorwhenyousettheWaveformparametertoIVIFGEN_VAL_WFM_DC.dcoffset(0.00V)PasstheDCoffsetofthestandardwaveformthatyouwantthefunctiongeneratortoproduce.Thisvalueistheoffsetattheoutputterminal.ThevalueistheoffsetfromgroundtothecenterofthewaveformyouspecifywiththeWaveformparameter.ThedriversetstheIviFgenDCOffset[STD]propertytothisvalue.Forexample,toconfigureawaveformwithanamplitudeof10.00voltstorangefrom0.00Vto+10.00V,settheDCOffsetto5.00V.Units:volts(V)DefaultValue:0.0
frequency(0.0Hz)Passthefrequencyofthestandardwaveformthatyouwantthefunctiongeneratortoproduce.ThedriversetstheIviFgenFrequency[STD]propertytothisvalue.Units:hertz(Hz)DefaultValue:1000.0Hz
NoteThisparameterdoesnotaffectfunctiongeneratorbehaviorwhenyousettheWaveformparametertoIVIFGEN_VAL_WFM_DC.
startphase(0.00Degrees)Passthehorizontaloffsetofthestandardwaveformyouwantthefunctiongeneratortoproduce.Youspecifythispropertyindegreesofonewaveformcycle.ThedriversetstheIviFgenStartPhase[STD]propertytothisvalue.Astartphaseof180degreesmeansoutputgenerationbeginshalfwaythroughthewaveform.Astartphaseof360degreesoffsetstheoutputbyanentirewaveformcycle,whichisidenticaltoastartphaseof0degrees.Units:DegreesofonecycleDefaultValue:0.0
NoteThisparameterdoesnotaffectfunctiongeneratorbehaviorwhenyousettheWaveformparametertoIVIFGEN_VAL_WFM_DC.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviFgenConfigureTriggerSourceIviFgenTriggerCapabilityGroup[TRG]ThisVIconfiguresthetriggersourceforachannel.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.channelname("CHANNEL1")PassthevirtualchannelnamethatyouassigntotheinstrumentinMAX.Virtualchannelnamesarealiasesforinstrumentspecificchannelstrings.Theinstrumentspecificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.YouassignavirtualchannelnametoaninstrumentspecificchannelthroughMAX.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrumentspecificchannelnames.DefaultValue:"CHANNEL1"
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
triggersource(External)Specifythetriggersourceyouwanttouse.ThedriversetstheIviFgenTriggerSource[TRG]propertytothisvalue.AfteryoucalltheIviFgenInitiateGenerationVI,thefunctiongeneratorwaitsforthetriggeryouspecifyinthisparameter.Afterit
receivesatrigger,thefunctiongeneratorproducesoutputbasedonthevalueoftheIviFgenOperationModeproperty.DefinedValues:IVIFGEN_VAL_INTERNAL_TRIGGER—InternalIVIFGEN_VAL_EXTERNAL—ExternalIVIFGEN_VAL_SOFTWARE_TRIG—SoftwareTriggerFunctionIVIFGEN_VAL_TTL0—PXITRIG0orVXITTL0IVIFGEN_VAL_TTL1—PXITRIG1orVXITTL1IVIFGEN_VAL_TTL2—PXITRIG2orVXITTL2IVIFGEN_VAL_TTL3—PXITRIG3orVXITTL3IVIFGEN_VAL_TTL4—PXITRIG4orVXITTL4IVIFGEN_VAL_TTL5—PXITRIG5orVXITTL5IVIFGEN_VAL_TTL6—PXITRIG6orVXITTL6IVIFGEN_VAL_TTL7—PXITRIG7orVXITTL7IVIFGEN_VAL_ECL0—VXIECL0IVIFGEN_VAL_ECL1—VXIECL1IVIFGEN_VAL_PXI_STAR—PXIStarIVIFGEN_VAL_RTSI_0—RTSIline0IVIFGEN_VAL_RTSI_1—RTSIline1IVIFGEN_VAL_RTSI_2—RTSIline2IVIFGEN_VAL_RTSI_3—RTSIline3IVIFGEN_VAL_RTSI_4—RTSIline4IVIFGEN_VAL_RTSI_5—RTSIline5IVIFGEN_VAL_RTSI_6—RTSIline6DefaultValue:IVIFGEN_VAL_EXTERNAL—External
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.
Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviFgenCreateArbitrarySequenceIviFgenArbSeqCapabilityGroup[SEQ]Anarbitrarysequenceconsistsofmultiplewaveforms.Foreachwaveform,youspecifythenumberoftimesthefunctiongeneratorproducesthewaveformbeforeproceedingtothenextwaveform.Thenumberoftimestorepeataspecificwaveformiscalledtheloopcount.ThisVIcreatesanarbitrarysequencefromanarrayofwaveformhandlesandanarrayofcorrespondingloopcounts.TheVIreturnsahandlethatidentifiesthesequence.YoupassthishandletotheIviFgenConfigureArbitrarySequence[SEQ]VItospecifywhatarbitrarysequenceyouwantthefunctiongeneratortoproduce.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.sequencelength(1)Passthenumberofwaveformsinthenewarbitrarysequenceyouwanttocreate.Thevalueyoupassmustbebetweentheminimumandmaximumsequencelengthsthefunctiongeneratorallows.YoucanobtaintheminimumandmaximumsequencelengthsfromtheMinimumSequenceLengthandMaximumSequenceLengthparametersoftheIviFgenQueryArbSequenceCapabilities[SEQ]VI.DefaultValue:1
waveformhandlesarray(empty)Passthearrayofwaveformhandlesfromwhichyouwanttocreateanewarbitrarysequence.ThearraymusthaveatleastasmanyelementsasthevalueyouspecifyintheSequenceLengthparameter.EachWaveformHandlesarrayelementhasacorrespondingLoopCountsarrayelementthatindicateshowmanytimesthatwaveformisrepeated.
YouobtainwaveformhandleswhenyoucreatearbitrarywaveformswiththeIviFgenCreateArbitraryWaveform[ARB]VI.DefaultValue:None
loopcountsarray(empty)Passthearrayofloopcountsyouwanttousetocreateanewarbitrarysequence.ThearraymusthaveatleastasmanyelementsasthevalueyouspecifyintheSequenceLengthparameter.EachLoopCountsarrayelementcorrespondstoaWaveformHandlesarrayelementandindicateshowmanytimestorepeatthatwaveform.EachelementoftheLoopCountarraymustbelessthanorequaltothemaximumnumberofloopcountsthefunctiongeneratorallows.YoucanobtainthemaximumloopcountfromtheMaximumLoopCountparameteroftheIviFgenQueryArbSequenceCapabilities[SEQ]VI.DefaultValue:None
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.sequencehandleReturnsthehandlethatidentifiesthenewarbitrarysequence.YoupassthishandletotheIviFgenConfigureArbitrarySequence[SEQ]VItogeneratethearbitrarysequence.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviFgenCreateArbitraryWaveformIviFgenArbWfmCapabilityGroup[ARB]ThisVIcreatesanarbitrarywaveformandreturnsahandlethatidentifiesthatwaveform.YoupassthishandletotheIviFgenConfigureArbitraryWaveform[ARB]VItoproducethatwaveform.YoualsousethehandlesthisVIreturnstospecifyasequenceofarbitrarywaveformswiththeIviFgenCreateArbitrarySequence[SEQ]VI.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.waveformsize(0)Passthesizeofthearbitrarywaveformyouwantcreate.Thesizemustmeetthefollowingrestrictions:
Thesizeislessthanorequaltothemaximumwaveformsizetheinstrumentallows.Thesizeisgreaterthanorequaltotheminimumwaveformsizetheinstrumentallows.Thesizeisanintegermultipleoftheinstrument'swaveformquantum.
YoucanobtainthesevaluesfromtheMaximumWaveformSize,MinimumWaveformSize,andWaveformQuantumparametersoftheIviFgenQueryArbWaveformCapabilities[ARB]VI.DefaultValue:None
waveformdataarray(empty)Specifythearrayofdatayouwanttouseforthenewarbitrarywaveform.ThearraymusthaveatleastasmanyelementsasthevalueyouspecifyintheWaveformSizeparameter.
Youmustnormalizethedatapointsinthearraytobebetween–1.00and+1.00.DefaultValue:None
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.waveformhandleReturnsthehandlethatidentifiesthenewarbitrarywaveform.YoupassthishandletotheIviFgenConfigureArbitraryWaveform[ARB]VItogeneratethearbitrarywaveform.YoupassanarrayofthesehandlestotheIviFgenCreateArbitrarySequence[SEQ]VItocreateanarbitrarysequence.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviFgenGetChannelNameIviFgenBaseCapabilityGroupThisVIreturnsthespecificdriverdefinedchannelnamethatcorrespondstotheone-basedindexthatyouspecify.IfthevalueyoupassfortheIndexparameterislessthanoneorgreaterthanthevalueoftheChannelCountproperty,theVIreturnsanemptystringintheNameparameterandreturnsanerror.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.Thehandleidentifiesaparticularinstrumentsession.
index(1)Aone-basedindexthatdefineswhichnametoreturn.TheindexmustbelessthanorequaltotheClassPrefixChannelCountproperty.instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.Thehandleidentifiesaparticularinstrumentsession.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
outputchannelnameReturnsthenameoftheChannelspecifiedbytheindexparameter.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviFgenInitiateGenerationIviFgenBaseCapabilityGroupThisVIinitiatessignalgeneration.IfthefunctiongeneratorisintheConfigurationstate,thisVImovesthefunctiongeneratortotheOutputGenerationstate.IfthefunctiongeneratorisalreadyintheOutputGenerationstate,thisVIdoesnothing.Details.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviFgenInitiateGenerationDetailsTheinstrumentisintheGenerationstateafteryoucalltheIviFgenInitialize,IviFgenInitializeWithOptions,orIviFgenResetVIs.YoucanconfiguretheoutputofthefunctiongeneratorregardlessofwhetherfunctiongeneratorisintheConfigurationStateortheGenerationState.ThismeansthatyouarerequiredtocalltheIviFgenInitiateGenerationVIonlyifyouabortsignalgenerationbycallingtheIviFgenAbortGeneration
VI.Manyfunctiongeneratorsconstantlygenerateanoutputsignal,anddonotrequireyoutoinitiatesignalgeneration.Ifafunctiongeneratorisalwaysoutputtingthecurrentlyconfiguredsignal,thisVIdoesnothing.YouarenotrequiredtocalltheIviFgenInitiateGenerationandIviFgenAbortGenerationVIs.WhetheryouchoosetocalltheseVIsinanapplicationprogramhasnoimpactoninterchangeability.YoucanchoosetousetheseVIsifyouwanttooptimizeyourapplicationforinstrumentsthatexhibitincreasedperformancewhenoutputconfigurationisperformedwhiletheinstrumentisnotgeneratingasignal.ThisVIdisablesextensionsthatyouhavenotsetunderthefollowingconditions:
1. IfyouhavenotsetthevalueofanypropertyintheIviFgenModulateAMextensiononachannel,thisVIsetstheIviFgen»AmplitudeModulation»AMEnabled[AM]propertytoFALSEforthatchannel.
2. IfyouhavenotsetthevalueofanypropertyintheIviFgenModulateFMextensiononachannel,thisVIsetstheIviFgen»FrequencyModulation»FMEnabled[FM]propertytoFALSEforthatchannel.
Notes
1. ThisVIdoesnotnormallychecktheinstrumentstatus.Typically,youcallthisVIonlyinasequenceofcallstootherlow-leveldriverfunctions.Thesequenceperformsoneoperation.Youusethelow-levelVIstooptimizeoneormoreaspectsofinteractionwiththeinstrument.Ifyouwanttochecktheinstrumentstatus,calltheIviFgenError-QueryVIattheconclusionofthesequence.
2. ThisVIperformsinterchangeabilitycheckingwhentheIviFgenInterchangeCheckpropertyissettoTRUE.UseNISpytoviewinterchangeabilitywarnings.Alternatively,youmayusetheIviFgenGetNextInterchangeWarningVItoretrieveinterchangeabilitywarnings.Formoreinformationaboutinterchangeabilitychecking,refertotheIviFgenInterchangeCheckproperty.
IviFgenQueryArbSequenceCapabilitiesIviFgenArbSeqCapabilityGroupThisVIreturnsthepropertiesofthefunctiongeneratorthatarerelatedtocreatingarbitrarysequences.Thesepropertiesarethemaximumnumberofsequences,minimumsequencelength,maximumsequencelength,andmaximumloopcount.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.maxnumberofsequencesReturnsthemaximumnumberofarbitrarywaveformsequencesthatthefunctiongeneratorallows.ThedriverobtainsthisvaluefromtheIviFgenMaxNumberofSequencesproperty.minsequencelengthReturnstheminimumnumberofarbitrarywaveformsthefunctiongeneratorallowsinasequence.ThedriverobtainsthisvaluefromtheIviFgenMinSequenceLengthproperty.maxsequencelengthReturnsthemaximumnumberofarbitrarywaveformsthefunctiongeneratorallowsinasequence.ThedriverobtainsthisvaluefromtheIviFgenMaxSequenceLengthproperty.
maxloopcountReturnsthemaximumnumberoftimesthefunctiongeneratorcanrepeatanarbitrarywaveforminasequence.ThedriverobtainsthisvaluefromtheIviFgenMaxLoopCountproperty.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviFgenQueryArbWaveformCapabilitiesIviFgenArbWfmCapabilityGroup[SEQ]ThisVIreturnsthepropertiesofthefunctiongeneratorthatarerelatedtocreatingarbitrarywaveforms.Thesepropertiesarethemaximumnumberofwaveforms,waveformquantum,minimumwaveformsize,andmaximumwaveformsize.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.maxnumberofwaveformsReturnsthemaximumnumberofarbitrarywaveformsthatthefunctiongeneratorallows.ThedriverobtainsthisvaluefromtheIviFgenMaxNumberofWaveforms[ARB]property.waveformquantumThesize(suchas,numberofpoints)ofeachwaveformmustbeamultipleofaconstantquantumvalue.Thisparameterobtainsthequantumvaluethefunctiongeneratoruses.ThedriverreturnsthisvaluefromtheIviFgenWaveformQuantum[ARB]property.Forexample,whenthispropertyreturnsavalueof8,allwaveformsizesmustbeamultipleof8.
minwaveformsizeReturnstheminimumnumberofpointsthefunctiongeneratorallowsinawaveform.ThedriverobtainsthisvaluefromtheIviFgenMinWaveformSize[ARB]property.maxwaveformsizeReturnsthemaximumnumberofpointsthefunctiongeneratorallowsinawaveform.ThedriverobtainsthisvaluefromtheIviFgenMaxWaveformSize[ARB]property.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviFgenSendSoftwareTriggerIviFgenSoftwareTriggerCapabilityGroup[SWT]ThisVIsendsacommandtotriggertheinstrument.YoumustsatisfycertainconditionsbeforeyoucansuccessfullycallthisVI,TheIviFgenTriggerSourceissettoIVIDMM_VAL_SOFTWARE_TRIG.Ifthisconditionisnottrue,thisVIdoesnotsendthesoftwaretriggerandreturnstheerrorIVIFGEN_ERROR_TRIGGER_NOT_SOFTWARE.ThisVIdoesnotchecktheinstrumentstatus.Typically,theend-usercallsthisVIonlyinasequenceofcallstootherlow-leveldriverVIs.Thesequenceperformsoneoperation.Theend-userusesthelow-levelVIstooptimizeoneormoreaspectsofinteractionwiththeinstrument.Tochecktheinstrumentstatus,calltheIviFgenError-QueryVIattheconclusionofthesequence.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviFgenInitializeorIviFgenInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviFgenPropertiesExpandthisbooktoviewanalphabetizedlistofIviFgenproperties.
IviFgenAMEnabled[AM]IviFgenModulateAMProperty[AM]DataType Access Applies
to Coercion HighLevelVIs
R/W Channel N/A IviFgenConfigureAMEnabled
DescriptionThischannel-basedpropertyspecifieswhetherthefunctiongeneratorappliesamplitudemodulationtotheoutputsignal.PropertyNodePathIviFgen»AmplitudeModulation»AMEnabled[AM]
IviFgenAMInternalDepth[AM]IviFgenModulateAMProperty[AM]DataType Access Appliesto Coercion HighLevelVIs
R/W N/A N/A IviFgenConfigureAMInternal
DescriptionSpecifiestheextentofmodulationthefunctiongeneratorappliestothecarriersignal.Theunitsareapercentageoffullmodulation.At0%depth,theoutputamplitudeequalsthecarriersignal'samplitude.At100%depth,theoutputamplitudeequalstwicethecarriersignal'samplitude.ThispropertyaffectsfunctiongeneratorbehavioronlywhentheIviFgenAMSource[AM]propertyissettoIVIFGEN_VAL_AM_INTERNAL.PropertyNodePathIviFgen»AmplitudeModulation»AMInternalDepth[AM]
IviFgenAMInternalFrequencyIviFgenModulateAMProperty[AM]DataType Access Appliesto Coercion HighLevelVIs
R/W N/A N/A IviFgenConfigureAMInternal
DescriptionSpecifiesthefrequencyofthestandardwaveformthatthefunctiongeneratorusestomodulatetheoutputsignal.Theunitsarehertz(Hz).ThispropertyaffectsfunctiongeneratorbehavioronlywhentheIviFgenAMSource[AM]propertyissettoIVIFGEN_VAL_AM_INTERNAL.PropertyNodePathIviFgen»AmplitudeModulation»AMInternalFrequency
IviFgenAMInternalWaveform[AM]IviFgenModulateAMProperty[AM]DataType Access Appliesto Coercion HighLevelVIs
R/W N/A N/A IviFgenConfigureAMInternal
DescriptionSpecifiesthestandardwaveformtypethatthefunctiongeneratorusestomodulatetheoutputsignal.ThispropertyaffectsfunctiongeneratorbehavioronlywhentheIviFgenAMSource[AM]propertyissettoIVIFGEN_VAL_AM_INTERNAL.PropertyNodePathIviFgen»AmplitudeModulation»AMInternalWaveform[AM]DefinedValuesIVIFGEN_VAL_AM_INTERNAL_SINEIVIFGEN_VAL_AM_INTERNAL_SQUAREIVIFGEN_VAL_AM_INTERNAL_TRIANGLEIVIFGEN_VAL_AM_INTERNAL_RAMP_UPIVIFGEN_VAL_AM_INTERNAL_RAMP_DOWN
IviFgenAMSource[AM]IviFgenModulateAMProperty[AM]DataType Access Appliesto Coercion HighLevelVIs
R/W Channel N/A IviFgenConfigureAMSource
DescriptionThischannel-basedpropertyspecifiesthesignalthatthefunctiongeneratorusestomodulatetheoutputsignal.PropertyNodePathIviFgen»AmplitudeModulation»AMSource[AM]DefinedValuesIVIFGEN_VAL_AM_INTERNALIVIFGEN_VAL_AM_EXTERNAL
IviFgenArbFrequency[AF]IviFgenArbFrequencyProperty[AF]DataType Access Applies
to Coercion HighLevelVIs
R/W Channel N/A IviFgenConfigureArbFrequency
DescriptionSpecifiestherateatwhichthefunctiongeneratoroutputsanentirearbitrarywaveform.Theunitsarearbitrarywaveformspersecond.YouusethispropertywhentheIviFgenOutputModepropertyissettoIVIFGEN_VAL_OUTPUT_ARB.PropertyNodePathIviFgen»ArbitraryWaveformOutput»ArbitraryWaveformFrequency»ArbFrequency[AF]
IviFgenArbSampleRate[ARB]IviFgenArbWfmProperty[ARB]DataType Access Applies
to Coercion HighLevelVIs
R/W N/A N/A IviFgenConfigureSampleRate[ARB]
DescriptionSpecifiestherateatwhichthefunctiongeneratoroutputsthepointsinarbitrarywaveforms.Theunitsaresamplespersecond.YouusethispropertywhentheIviFgenOutputModepropertyissettoIVIFGEN_VAL_OUTPUT_ARBorIVIFGEN_VAL_OUTPUT_SEQ.PropertyNodePathIviFgen»ArbitraryWaveformOutput»ArbSampleRate[ARB]
IviFgenArbitrarySequenceHandle[SEQ]IviFgenArbSeqProperty[SEQ]DataType Access Applies
to Coercion HighLevelVIs
R/W Channel N/A IviFgenConfigureArbitrarySequence
DescriptionThischannel-basedpropertyidentifieswhichsequencethefunctiongeneratorproduces.YoucancreatemultiplesequencesusingtheIviFgenCreateArbitrarySequence[SEQ]VI.TheCreateArbitrarySequence[SEQ]VIreturnsahandlethatyouusetoidentifytheparticularsequence.Toconfigurethefunctiongeneratortoproduceaparticularsequence,yousetthispropertytothesequence'shandle.YouusethispropertyonlywhentheIviFgenOutputModepropertyissettoIVIFGEN_VAL_OUTPUT_SEQ.PropertyNodePathIviFgen»ArbitrarySequenceOutput»ArbitrarySequenceHandle[SEQ]
IviFgenArbitraryWaveformGain[ARB]IviFgenArbWfmProperty[ARB]DataType Access Applies
to Coercion HighLevelVIs
R/W Channel N/A IviFgenConfigureArbitraryWaveform[ARB]
DescriptionThischannel-basedpropertyspecifiesthefactorbywhichthefunctiongeneratorscalesthearbitrarywaveformdata.Whenyoucreatearbitrarywaveforms,youmustfirstnormalizethedatapointstotherange–1.0to+1.0.Youusethispropertytoscalethearbitrarywaveformtootherranges.Forexample,whenyousetthispropertyto2.0,theoutputsignalrangesfrom–2.0to+2.0V.YouusethispropertywhentheIviFgenOutputModepropertyissettoIVIFGEN_VAL_OUTPUT_ARBorIVIFGEN_VAL_OUTPUT_SEQ.PropertyNodePathIviFgen»ArbitraryWaveformOutput»ArbitraryWaveformGain[ARB]
IviFgenArbitraryWaveformHandle[ARB]IviFgenArbWfmProperty[ARB]DataType Access Applies
to Coercion HighLevelVIs
R/W Channel N/A IviFgenConfigureArbitraryWaveform[ARB]
DescriptionThischannel-basedpropertyidentifieswhicharbitrarywaveformthefunctiongeneratorproduces.YoucancreatemultiplearbitrarywaveformsusingtheIviFgenCreateArbitraryWaveformVI.TheCreateArbitraryWaveform[ARB]VIreturnsahandlethatyouusetoidentifytheparticularwaveform.Toconfigurethefunctiongeneratortoproduceaparticularwaveform,yousetthispropertytothewaveform'shandle.YouusethispropertyonlywhentheIviFgenOutputModepropertyissettoIVIFGEN_VAL_OUTPUT_ARB.PropertyNodePathIviFgen»ArbitraryWaveformOutput»ArbitraryWaveformHandle[ARB]
IviFgenArbitraryWaveformOffset[ARB]IviFgenArbWfmProperty[ARB]DataType Access Applies
to Coercion HighLevelVIs
R/W Channel N/A IviFgenConfigureArbitraryWaveform[ARB]
DescriptionThischannel-basedpropertyspecifiesthevaluethefunctiongeneratoraddstothearbitrarywaveformdata.Whenyoucreatearbitrarywaveforms,youmustfirstnormalizethedatapointstotherange–1.0to+1.0.Youusethispropertytoshiftthearbitrarywaveform'srange.Theunitsarevolts(V).Forexample,whenyousetthispropertyto1.0,theoutputsignalrangesfrom2.0Vto0.0V.YouusethispropertywhentheIviFgenOutputModepropertyissettoIVIFGEN_VAL_OUTPUT_ARBorIVIFGEN_VAL_OUTPUT_SEQ.PropertyNodePathIviFgen»ArbitraryWaveformOutput»ArbitraryWaveformOffset[ARB]
IviFgenBurstCount[BST]IviFgenBurstProperty[BST]DataType Access Applies
to Coercion HighLevelVIs
R/W Channel N/A IviFgenConfigureBurstCount
DescriptionThischannel-basedpropertyspecifiesthenumberofwaveformcyclesthatthefunctiongeneratorproducesafteritreceivesatrigger.ThispropertyaffectsfunctiongeneratorbehavioronlywhentheIviFgenOperationModepropertyissettoIVIFGEN_VAL_OPERATE_BURST.PropertyNodePathIviFgen»BurstOperation»BurstCount[BST]
IviFgenChannelCountIviFgenBasePropertyDataType Access Appliesto Coercion HighLevelVIs
RO N/A None None
DescriptionReturnsthenumberofchannelsavailableontheinstrument.PropertyNodePathIviFgen»InherentIVISettings»SpecificDriverCapabilities»ChannelCount
IviFgenDCOffset[STD]IviFgenStdFuncProperty[STD]DataType Access Applies
to Coercion HighLevelVIs
R/W Channel N/A IviFgenConfigureStandardWaveform
DescriptionThischannel-basedpropertyspecifiestheDCoffsetofthestandardwaveformthefunctiongeneratorproduces.Thisvalueistheoffsetattheoutputterminal.Theunitsarevolts(V).ThevalueistheoffsetfromgroundtothecenterofthewaveformyouspecifywiththeIviFgenWaveform[STD]property.Forexample,astandardwaveformrangingfrom+5.0Vto0.0VhasaDCoffsetof2.5V.YouusethispropertyonlywhentheIviFgenOutputModepropertyissettoIVIFGEN_VAL_OUTPUT_FUNC.PropertyNodePathIviFgen»StandardFunctionOutput»DCOffset[STD]
IviFgenDutyCycleHigh[STD]IviFgenStdFuncProperty[STD]DataType Access Appliesto Coercion HighLevelVIs
R/W Channel N/A None
DescriptionThischannel-basedpropertyspecifiesthelengthoftimetheoutputvoltagelevelremainshighinasquarewaveform.Youspecifythispropertyasapercentageofonewaveformcycle.YouusethispropertyonlywhentheIviFgenOutputModepropertyissettoIVIFGEN_VAL_OUTPUT_FUNCandtheIviFgenWaveform[STD]propertytoIVIFGEN_VAL_WFM_SQUARE.PropertyNodePathIviFgen»StandardFunctionOutput»DutyCycleHigh[STD]
IviFgenFMEnabled[FM]IviFgenModulateFMProperty[FM]DataType Access Applies
to Coercion HighLevelVIs
R/W Channel N/A IviFgenConfigureFMEnabled
DescriptionSpecifieswhetherthefunctiongeneratorappliesfrequencymodulationtotheoutputsignal.PropertyNodePathIviFgen»FrequencyModulation»FMEnabled[FM]
IviFgenFMInternalFrequency[FM]IviFgenModulateFMProperty[FM]DataType Access Appliesto Coercion HighLevelVIs
R/W N/A N/A IviFgenConfigureFMInternal
DescriptionSpecifiesthefrequencyofthestandardwaveformthatthefunctiongeneratorusestomodulatetheoutputsignal.Theunitsarehertz(Hz).ThispropertyaffectsfunctiongeneratorbehavioronlywhentheIviFgenFMSource[FM]propertyissettoIVIFGEN_VAL_FM_INTERNAL.PropertyNodePathIviFgen»FrequencyModulation»FMInternalFrequency[FM]
IviFgenFMInternalWaveformIviFgenModulateFMPropertyDataType Access Appliesto Coercion HighLevelVIs
R/W N/A N/A IviFgenConfigureFMInternal
DescriptionSpecifiesthestandardwaveformtypethatthefunctiongeneratorusestomodulatetheoutputsignal.ThispropertyaffectsfunctiongeneratorbehavioronlywhentheIviFgenFMSourcepropertyissettoIVIFGEN_VAL_FM_INTERNAL.PropertyNodePathIviFgen»FrequencyModulation»FMInternalWaveformDefinedValuesIVIFGEN_VAL_FM_INTERNAL_SINEIVIFGEN_VAL_FM_INTERNAL_SQUAREIVIFGEN_VAL_FM_INTERNAL_TRIANGLEIVIFGEN_VAL_FM_INTERNAL_RAMP_UPIVIFGEN_VAL_FM_INTERNAL_RAMP_DOWN
IviFgenFMInternalDeviation[FM]IviFgenModulateFMProperty[FM]DataType Access Appliesto Coercion HighLevelVIs
R/W N/A N/A IviFgenConfigureFMInternal
DescriptionSpecifiesthemaximumfrequencydeviationthemodulatingwaveformappliestothecarrierwaveform.Thisdeviationcorrespondstothemaximumamplitudelevelofthemodulatingsignal.Theunitsarehertz(Hz).ThispropertyaffectsfunctiongeneratorbehavioronlywhentheIviFgenFMSource[FM]propertyissettoIVIFGEN_VAL_FM_INTERNAL.PropertyNodePathIviFgen»FrequencyModulation»FMInternalDeviation[FM]
IviFgenFMSource[FM]IviFgenModulateFMProperty[FM]DataType Access Appliesto Coercion HighLevelVIs
R/W Channel N/A IviFgenConfigureFMSource
DescriptionSpecifiesthesignalthefunctiongeneratorusestomodulatetheoutputsignal.PropertyNodePathIviFgen»FrequencyModulation»FMSource[FM]DefinedValuesIVIFGEN_VAL_FM_INTERNALIVIFGEN_VAL_FM_EXTERNAL
IviFgenFrequency[STD]IviFgenStdFuncProperty[STD]DataType Access Applies
to Coercion HighLevelVIs
R/W Channel N/A IviFgenConfigureStandardWaveform
DescriptionThischannel-basedpropertyspecifiesthefrequencyofthestandardwaveformthefunctiongeneratorproduces.Theunitsarehertz(Hz).YouusethispropertyonlywhentheIviFgenOutputModepropertyissettoIVIFGEN_VAL_OUTPUT_FUNC.ThispropertydoesnotaffectfunctiongeneratorbehaviorwhenyousettheIviFgenWaveform[STD]propertytoIVIFGEN_VAL_WFM_DC.PropertyNodePathIviFgen»StandardFunctionOutput»Frequency[STD]
IviFgenFuncAmplitude[STD]IviFgenStdFuncProperty[STD]DataType Access Applies
to Coercion HighLevelVIs
R/W Channel N/A IviFgenConfigureStandardWaveform
DescriptionThischannel-basedpropertyspecifiestheamplitudeofthestandardwaveformthefunctiongeneratorproduces.Thisvalueistheamplitudeattheoutputterminal.Theunitsarevoltspeak-to-peak(Vpp).Forexample,toproduceawaveformrangingfrom–5.0to+5.0V,yousetthisvalueto10.0V.YouusethispropertyonlywhentheIviFgenOutputModepropertyissettoIVIFGEN_VAL_OUTPUT_FUNC.ThispropertydoesnotaffectfunctiongeneratorbehaviorwhenyousettheIviFgenWaveform[STD]propertytoIVIFGEN_VAL_WFM_DC.PropertyNodePathIviFgen»StandardFunctionOutput»FuncAmplitude[STD]
IviFgenInternalTriggerRate[IT]IviFgenInternalTriggerProperty[ITRG]DataType Access Applies
to Coercion HighLevelVIs
R/W Channel N/A IviFgenConfigureInternalTriggerRate
DescriptionThispropertyspecifiestherateatwhichthefunctiongenerator'sinternaltriggersourceproducesatrigger,intriggerspersecond.ThispropertyaffectsfunctiongeneratorbehavioronlywhentheIviFgenTriggerSource[TRG]propertyissettoIVIFGEN_VAL_INTERNAL_TRIGGERonachannel.PropertyNodePathIviFgen»Triggering»InternalTrigger»InternalTriggerRate[IT]
IviFgenMaxLoopCount[SEQ]IviFgenArbSeqProperty[SEQ]DataType Access Applies
to Coercion HighLevelVIs
RO N/A N/A IviFgenQueryArbSequenceCapabilities
DescriptionReturnsthemaximumnumberoftimesthefunctiongeneratorcanrepeatawaveforminasequence.Typically,thisvalueisconstantforthefunctiongenerator.PropertyNodePathIviFgen»ArbitrarySequenceOutput»MaxLoopCount
IviFgenMaxNumberofSequences[SEQ]IviFgenArbSeqProperty[SEQ]DataType Access Applies
to Coercion HighLevelVIs
RO N/A N/A IviFgenQueryArbSequenceCapabilities
DescriptionReturnsthemaximumnumberofarbitrarysequencesthefunctiongeneratorallows.Typically,thisvalueisconstantforthefunctiongenerator.PropertyNodePathIviFgen»ArbitrarySequenceOutput»MaxNumberofSequences[SEQ]
IviFgenMaxNumberofWaveforms[ARB]IviFgenArbWfmProperty[ARB]DataType Access Applies
to Coercion HighLevelVIs
RO N/A N/A IviFgenQueryArbWaveformCapabilities
DescriptionReturnsthemaximumnumberofarbitrarywaveformsthatthefunctiongeneratorallows.Typically,thisvalueisconstantforthefunctiongenerator.PropertyNodePathIviFgen»ArbitraryWaveformOutput»MaxNumberofWaveforms[ARB]
IviFgenMaxSequenceLength[SEQ]IviFgenArbSeqProperty[SEQ]DataType Access Applies
to Coercion HighLevelVIs
RO N/A N/A IviFgenQueryArbSequenceCapabilities
DescriptionReturnsthemaximumnumberofarbitrarywaveformsthefunctiongeneratorallowsinasequence.Typically,thisvalueisconstantforthefunctiongenerator.PropertyNodePathIviFgen»ArbitrarySequenceOutput»MaxSequenceLength[SEQ]
IviFgenMaxWaveformSize[ARB]IviFgenArbWfmProperty[ARB]DataType Access Applies
to Coercion HighLevelVIs
RO N/A N/A IviFgenQueryArbWaveformCapabilities
DescriptionReturnsthemaximumnumberofpointsthefunctiongeneratorallowsinanarbitrarywaveform.Typically,thisvalueisconstantforthefunctiongenerator.PropertyNodePathIviFgen»ArbitraryWaveformOutput»MaxWaveformSize[ARB]
IviFgenMinSequenceLength[SEQ]IviFgenArbSeqProperty[SEQ]DataType Access Applies
to Coercion HighLevelVIs
RO N/A N/A IviFgenQueryArbSequenceCapabilities
DescriptionReturnstheminimumnumberofarbitrarywaveformsthefunctiongeneratorallowsinasequence.Typically,thisvalueisconstantforthefunctiongenerator.PropertyNodePathIviFgen»ArbitrarySequenceOutput»MinSequenceLength[SEQ]
IviFgenMinWaveformSize[ARB]IviFgenArbWfmProperty[ARB]DataType Access Applies
to Coercion HighLevelVIs
RO N/A N/A IviFgenQueryArbWaveformCapabilities
DescriptionReturnstheminimumnumberofpointsthefunctiongeneratorallowsinanarbitrarywaveform.Typically,thisvalueisconstantforthefunctiongenerator.PropertyNodePathIviFgen»ArbitraryWaveformOutput»MinWaveformSize[ARB]
IviFgenOperationModeIviScopeBasePropertyDataType Access Applies
to Coercion HighLevelVIs
R/W Channel N/A IviFgenConfigureOperationMode
DescriptionThispropertyspecifieshowthefunctiongeneratorproduceswaveforms.Forexample,youcanconfiguretheinstrumenttogenerateoutputcontinuously,ortogenerateadiscretenumberofwaveformcyclesbasedonatriggerevent.PropertyNodePathIviFgen»BasicOperation»OperationModeDefinedValuesIVIFGEN_VAL_OPERATE_CONTINUOUSIVIFGEN_VAL_OPERATE_BURST
IviFgenOutputEnabledIviScopeBasePropertyDataType Access Applies
to Coercion HighLevelVIs
R/W Channel N/A IviFgenConfigureOutputEnabled
DescriptionThischannel-basedpropertyspecifieswhetherthesignalthefunctiongeneratorproducesappearsattheoutputconnector.PropertyNodePathIviFgen»BasicOperation»OutputEnabled
IviFgenOutputImpedanceIviScopeBasePropertyDataType Access Applies
to Coercion HighLevelVIs
R/W Channel N/A IviFgenConfigureOutputImpedance
DescriptionThischannel-basedpropertyspecifiesthefunctiongenerator'soutputimpedanceattheoutputconnector.PropertyNodePathIviFgen»BasicOperation»OutputImpedance
IviFgenOutputModeIviScopeBasePropertyDataType Access Applies
to Coercion HighLevelVIs
R/W N/A N/A IviFgenConfigureOperationMode
DescriptionDeterminesthekindofwaveformthefunctiongeneratorproduces.ThevalueyouspecifydetermineswhichVIsandpropertiesyouusetoconfigurethewaveformthefunctiongeneratorproduces.WhenyousetthispropertytoIVIFGEN_VAL_OUTPUT_FUNC,usethefollowingpropertiesandVIstoconfigurestandardwaveforms:IviFgenWaveform[STD]IviFgenFuncAmplitude[STD]IviFgenDCOffset[STD]IviFgenFrequency[STD]IviFgenStartPhase[STD]IviFgenDutyCycleHigh[STD]IviFgenConfigureStandardWaveform[STD]WhenyousetthispropertytoIVIFGEN_VAL_OUTPUT_ARB,usethefollowingpropertiesandVIstoconfigurearbitrarywaveforms:IviFgenArbitraryWaveformHandle[ARB]IviFgenArbitraryWaveformGain[ARB]IviFgenArbitraryWaveformOffset[ARB]IviFgenConfigureSampleRate[ARB]IviFgenCreateArbitraryWaveform[ARB]IviFgenClearArbitraryWaveform[ARB]IviFgenConfigureArbitraryWaveform[ARB]Ifyourinstrumentallowsyoutospecifytherateatwhichanentirearbitrarywaveformisgenerated,youcanalsousethefollowing
propertiesandVIstoconfigurearbitrarywaveforms:IviFgenArbFrequency[AF]IviFgenConfigureArbFrequency[AF]WhenyousetthispropertytoIVIFGEN_VAL_OUTPUT_SEQ,usethefollowingpropertiesandVIstoconfiguresequences:IviFgenArbitrarySequenceHandle[SEQ]IviFgenArbitraryWaveformGain[ARB]IviFgenArbitraryWaveformOffset[ARB]IviFgenConfigureSampleRate[ARB]IviFgenCreateArbitrarySequence[SEQ]IviFgenClearArbitrarySequence[SEQ]IviFgenClearArbitraryMemory[SEQ]IviFgenConfigureArbitrarySequence[SEQ]PropertyNodePathIviFgen»BasicOperation»OutputModeDefinedValuesIVIFGEN_VAL_OUTPUT_FUNCIVIFGEN_VAL_OUTPUT_ARBIVIFGEN_VAL_OUTPUT_SEQ
IviFgenReferenceClockSourceIviScopeBasePropertyDataType Access Applies
to Coercion HighLevelVIs
R/W N/A N/A IviFgenConfigureRefClockSource
DescriptionSpecifiesthereferenceclocksource.Thefunctiongeneratorderivesfrequenciesandsampleratesthatitusestogeneratewaveformsfromthesourceyouspecify.PropertyNodePathIviFgen»BasicOperation»ReferenceClockSourceDefinedValuesIVIFGEN_VAL_REF_CLOCK_INTERNALIVIFGEN_VAL_REF_CLOCK_EXTERNALIVIFGEN_VAL_REF_CLOCK_RTSI_CLOCK
IviFgenStartPhase[STD]IviFgenStdFuncProperty[STD]DataType Access Applies
to Coercion HighLevelVIs
R/W Channel N/A IviFgenConfigureStandardWaveform
DescriptionThischannel-basedpropertyspecifiesthehorizontaloffsetofthestandardwaveformthefunctiongeneratorproduces.Youspecifythispropertyindegreesofonewaveformcycle.Forexample,a180degreephaseoffsetmeansoutputgenerationbeginshalfwaythroughthewaveform.Astartphaseof360degreesoffsetstheoutputbyanentirewaveformcycle.Itisthereforeidenticaltoastartphaseof0degrees.YouusethispropertyonlywhentheIviFgenOutputModepropertyissettoIVIFGEN_VAL_OUTPUT_FUNC.ThispropertydoesnotaffectfunctiongeneratorbehaviorwhenyousettheIviFgenWaveform[STD]propertytoIVIFGEN_VAL_WFM_DC.PropertyNodePathIviFgen»StandardFunctionOutput»StartPhase[STD]
IviFgenTriggerSource[TRG]IviFgenTriggerProperty[TRG]DataType Access Applies
to Coercion HighLevelVIs
R/W Channel N/A IviFgenConfigureTriggerSource
DescriptionThischannel-basedpropertyspecifiesthetriggersource.Afterthefunctiongeneratorreceivesatrigger,itgeneratesanoutputsignalbasedontheoperationmode.PropertyNodePathIviFgen»Triggering»TriggerSource[TRG]DefinedValuesIVIFGEN_VAL_EXTERNALIVIFGEN_VAL_INTERNAL_TRIGGERIVIFGEN_VAL_TTL0IVIFGEN_VAL_TTL1IVIFGEN_VAL_TTL2IVIFGEN_VAL_TTL3IVIFGEN_VAL_TTL4IVIFGEN_VAL_TTL5IVIFGEN_VAL_TTL6IVIFGEN_VAL_TTL7IVIFGEN_VAL_ECL0IVIFGEN_VAL_ECL1IVIFGEN_VAL_PXI_STARIVIFGEN_VAL_RTSI_0IVIFGEN_VAL_RTSI_1IVIFGEN_VAL_RTSI_2
IVIFGEN_VAL_RTSI_3IVIFGEN_VAL_RTSI_4IVIFGEN_VAL_RTSI_5IVIFGEN_VAL_RTSI_6
IviFgenWaveform[STD]IviFgenStdFuncProperty[STD]DataType Access Applies
to Coercion HighLevelVIs
R/W Channel N/A IviFgenConfigureStandardWaveform
DescriptionThischannel-basedpropertyspecifieswhichstandardwaveformthefunctiongeneratorproduces.Refertothediagramsofstandardwaveforms.YouusethispropertyonlywhentheIviFgenOutputModepropertyissettoIVIFGEN_VAL_OUTPUT_FUNC.PropertyNodePathIviFgen»StandardFunctionOutput»Waveform[STD]DefinedValuesIVIFGEN_VAL_WFM_SINEIVIFGEN_VAL_WFM_SQUAREIVIFGEN_VAL_WFM_TRIANGLEIVIFGEN_VAL_WFM_RAMP_UPIVIFGEN_VAL_WFM_RAMP_DOWNIVIFGEN_VAL_WFM_DC
IviFgenWaveformQuantum[ARB]IviFgenArbWfmProperty[ARB]DataType Access Applies
to Coercion HighLevelVIs
RO N/A N/A IviFgenQueryArbWaveformCapabilities
DescriptionThesizeofeacharbitrarywaveformmustbeamultipleofaquantumvalue.Thispropertyreturnsthequantumvaluethefunctiongeneratorallows.Forexample,whenthispropertyreturnsavalueof8,allwaveformsizesmustbeamultipleof8.Typically,thisvalueisconstantforthefunctiongenerator.PropertyNodePathIviFgen»ArbitraryWaveformOutput»WaveformQuantum[ARB]
IviFgenDefinedValuesExpandthisbooktoviewanalphabetizedlistofIviFgendefinedvalues.
IVIFGEN_VAL_AM_EXTERNALThefunctiongeneratorusesawaveformfromanexternalsourcetoamplitudemodulatetheoutputsignal.DefinedValue:1
IVIFGEN_VAL_AM_INTERNALThefunctiongeneratorusesaninternallygeneratedwaveformtoamplitudemodulatetheoutputsignal.DefinedValue:0
IVIFGEN_VAL_AM_INTERNAL_RAMP_DOWNThefunctiongeneratoramplitudemodulatesthecarriersignalwithanegativerampwaveform.DefinedValue:5
IVIFGEN_VAL_AM_INTERNAL_RAMP_UPThefunctiongeneratoramplitudemodulatesthecarriersignalwithapositiverampwaveform.DefinedValue:4
IVIFGEN_VAL_AM_INTERNAL_SINEThefunctiongeneratoramplitudemodulatesthecarriersignalwithasinusoidwaveform.DefinedValue:1
IVIFGEN_VAL_AM_INTERNAL_SQUAREThefunctiongeneratoramplitudemodulatesthecarriersignalwithasquarewaveform.DefinedValue:2
IVIFGEN_VAL_AM_INTERNAL_TRIANGLEThefunctiongeneratoramplitudemodulatesthecarriersignalwithatriangularwaveform.DefinedValue:3
IVIFGEN_VAL_ECL0ThefunctiongeneratorwaitsuntilitreceivesatriggerontheECL0line.DefinedValue:119
IVIFGEN_VAL_ECL1ThefunctiongeneratorwaitsuntilitreceivesatriggerontheECL1line.DefinedValue:120
IVIFGEN_VAL_EXTERNALThefunctiongeneratordoesnotproduceanoutputsignaluntilitreceivesatriggeronitsexternaltriggerinputterminal.DefinedValue:1
IVIFGEN_VAL_FM_EXTERNALThefunctiongeneratorusesawaveformfromanexternalsourcetofrequencymodulatetheoutputsignal.DefinedValue:1
IVIFGEN_VAL_FM_INTERNALThefunctiongeneratorusesaninternallygeneratedwaveformtofrequencymodulatetheoutputsignal.DefinedValue:0
IVIFGEN_VAL_FM_INTERNAL_RAMP_DOWNThefunctiongeneratorfrequencymodulatesthecarriersignalwithanegativerampwaveform.DefinedValue:5
IVIFGEN_VAL_FM_INTERNAL_RAMP_UPThefunctiongeneratorfrequencymodulatesthecarriersignalwithapositiverampwaveform.DefinedValue:4
IVIFGEN_VAL_FM_INTERNAL_SINEThefunctiongeneratorfrequencymodulatesthecarriersignalwithasinusoidwaveform.DefinedValue:1
IVIFGEN_VAL_FM_INTERNAL_SQUAREThefunctiongeneratorfrequencymodulatesthecarriersignalwithasquarewaveform.DefinedValue:2
IVIFGEN_VAL_FM_INTERNAL_TRIANGLEThefunctiongeneratorfrequencymodulatesthecarriersignalwithatriangularwaveform.DefinedValue:3
IVIFGEN_VAL_INTERNAL_TRIGGERThefunctiongeneratorwaitsuntilitreceivesatriggerfromitsinternaltriggersource.DefinedValue:3
IVIFGEN_VAL_OPERATE_BURSTThefunctiongeneratorproducesadiscreetnumberofwaveformswhenatriggereventoccurs.DefinedValue:1
IVIFGEN_VAL_OPERATE_CONTINUOUSThefunctiongeneratorproducesoutputcontinuously.DefinedValue:0
IVIFGEN_VAL_OUTPUT_ARBThedriverusesthepropertiesandfunctionsoftheIviFgenArbWfmExtensionGrouptoconfigurethefunctiongenerator'soutputsignal.DefinedValue:1
IVIFGEN_VAL_OUTPUT_FUNCThedriverusesthepropertiesandfunctionsoftheIviFgenStdFuncextensiongrouptoconfigurethefunctiongenerator'soutputsignal.DefinedValue:0
IVIFGEN_VAL_OUTPUT_SEQThedriverusesthepropertiesandfunctionsoftheIviFgenArbWfmandIviFgenArbSeqExtensionGroupstogethertoconfigurethefunctiongenerator'soutputsignal.DefinedValue:2
IVIFGEN_VAL_PXI_STARThefunctiongeneratorwaitsuntilitreceivesatriggeronthePXIStarbus.DefinedValue:131
IVIFGEN_VAL_REF_CLOCK_EXTERNALThefunctiongeneratorreceivesthereferenceclocksignalfromanexternalsource.DefinedValue:1
IVIFGEN_VAL_REF_CLOCK_INTERNALThefunctiongeneratorproducesthereferenceclocksignalinternally.DefinedValue:0
IVIFGEN_VAL_REF_CLOCK_RTSI_CLOCKThefunctiongeneratorreceivesthereferenceclocksignalfromtheRTSIclocksource.DefinedValue:101
IVIFGEN_VAL_REF_CLOCK_RTSI_CLOCKThefunctiongeneratorreceivesthereferenceclocksignalfromtheRTSIclocksource.DefinedValue:101
IVIFGEN_VAL_RTSI_0ThefunctiongeneratorwaitsuntilitreceivesatriggerontheRTSI0line.DefinedValue:141
IVIFGEN_VAL_RTSI_1ThefunctiongeneratorwaitsuntilitreceivesatriggerontheRTSI1line.DefinedValue:142
IVIFGEN_VAL_RTSI_2ThefunctiongeneratorwaitsuntilitreceivesatriggerontheRTSI2line.DefinedValue:143
IVIFGEN_VAL_RTSI_3ThefunctiongeneratorwaitsuntilitreceivesatriggerontheRTSI3line.DefinedValue:144
IVIFGEN_VAL_RTSI_4ThefunctiongeneratorwaitsuntilitreceivesatriggerontheRTSI4line.DefinedValue:145
IVIFGEN_VAL_RTSI_5ThefunctiongeneratorwaitsuntilitreceivesatriggerontheRTSI5line.DefinedValue:146
IVIFGEN_VAL_RTSI_6ThefunctiongeneratorwaitsuntilitreceivesatriggerontheRTSI6line.DefinedValue:147
IVIFGEN_VAL_SOFTWARE_TRIGThefunctiongeneratordoesnotproduceanoutputsignaluntiltheIviFgen_SendSoftwareTriggerfunctioniscalled.IfyousettheIVIFGEN_ATTR_TRIGGER_SOURCEpropertytothisvalue,theinstrumentcanonlybetriggeredbycallingtheIviFgen_SendSoftwareTriggerfunction.DefinedValue:2
IVIFGEN_VAL_TTL0ThefunctiongeneratorwaitsuntilitreceivesatriggerontheTLL0line.DefinedValue:111
IVIFGEN_VAL_TTL1ThefunctiongeneratorwaitsuntilitreceivesatriggerontheTLL1line.DefinedValue:112
IVIFGEN_VAL_TTL2ThefunctiongeneratorwaitsuntilitreceivesatriggerontheTLL2line.DefinedValue:113
IVIFGEN_VAL_TTL3ThefunctiongeneratorwaitsuntilitreceivesatriggerontheTLL3line.DefinedValue:114
IVIFGEN_VAL_TTL4ThefunctiongeneratorwaitsuntilitreceivesatriggerontheTLL4line.DefinedValue:115
IVIFGEN_VAL_TTL5ThefunctiongeneratorwaitsuntilitreceivesatriggerontheTLL5line.DefinedValue:116
IVIFGEN_VAL_TTL6ThefunctiongeneratorwaitsuntilitreceivesatriggerontheTTL6line.DefinedValue:117
IVIFGEN_VAL_TTL7ThefunctiongeneratorwaitsuntilitreceivesatriggerontheTTL7line.DefinedValue:118
IVIFGEN_VAL_WFM_DCConfiguresthefunctiongeneratortoproduceaconstantvoltage.DefinedValue:6
IVIFGEN_VAL_WFM_RAMP_DOWNConfiguresthefunctiongeneratortoproduceanegativerampwaveform.DefinedValue:5
IVIFGEN_VAL_WFM_RAMP_UPConfiguresthefunctiongeneratortoproduceapositiverampwaveform.DefinedValue:4
IVIFGEN_VAL_WFM_SINEConfiguresthefunctiongeneratortoproduceasinusoidwaveform.DefinedValue:1
IVIFGEN_VAL_WFM_SQUAREConfiguresthefunctiongeneratortoproduceasquarewaveform.DefinedValue:2
IVIFGEN_VAL_WFM_TRIANGLEConfiguresthefunctiongeneratortoproduceatriangularwaveform.DefinedValue:3
PropertiesforControllingIviFgenSimulationNoteYoucansetSimulationAttributesinMAXontheInitialSettingstabofIVIDrivers»Advanced»SimulationDriverSessions»nisIviClassorinthesimulationinteractivepanels.RefertoNationalInstrumentsIVIDriverHelp»ConfiguringYourSystemformoreinformation.
TwosetsofpropertiesexistforusewiththeIviFgenSimulationDriver.Thefollowingtabledescribespropertiesthatcontrolbehaviorofthedriver.AnothertablelistspropertiesthatsimulatethestatusofspecificdriverVIs.
PropertiesforControllingIviFgenSimulationName Data
TypeAccess Applies
toDescription
INTERACTIVE_SIMULATION Boolean W No Specifieswhethertosetthedrivertointeractivemode.Ininteractivemode,thesimulationdriverusespop-upuserinterfacepanelsforgettinginformationfromyou.Non-interactivemodeisusefulwhenyoudonotwanttheinteractivepanelstointerruptyourtestprogram.
SELF_TEST_CODE Integer W No Specifiestheself-testcode.WhentheIviFgenSelf-TestVIiscalled,theself-testresultparameterreturnsthis
value.SELF_TEST_MSG String W No Specifiesthe
self-testmessage.WhentheIviFgenSelf-TestVIiscalled,theself-testmessageparameterreturnsthisstring.
ERROR_QUERY_CODE Integer W No Specifiestheerror-querycode.WhentheIviFgenError-QueryVIiscalled,theerrorcodeparameterreturnsthisvalue.
ERROR_QUERY_MSG String W No Specifiestheerror-querymessage.WhentheIviFgenError-QueryVIiscalled,theerrormessageparameterreturnsthisstring.
DRIVER_REV_QUERY String W No Specifiestheinstrument
driverrevisionmessage.WhentheIviFgenRevisionQueryVIiscalled,theinstrumentdriverrevisionparameterreturnsthisstring.
INSTR_REV_QUERY String W No Specifiesthefirmwarerevisionmessage.WhentheIviFgenRevisionQueryVIiscalled,thefirmwarerevisionparameterreturnsthisstring.
SIMULATE_STATUS_CODE Boolean W No SpecifieswhethertosimulatereturncodesfromtheIviFgendriverVIs.RefertotheIviFgenPropertiesforStatusSimulation
table.
RelatedTopicsSettingUpSimulatedErrorsSettingUpSimulationforVXIplug&playVIs
PropertiesforStatusSimulationinIviFgenWhenanIviFgendriverVIiscalled,thedriverquerieswhetherNISFGEN_ATTR_SIMULATE_STATUS_CODEisenabled.Ifenabled,thedrivergetstheappropriateVI'ssimulationstatuscode.Ifthevalueofthesimulationstatuscoderepresentsawarning(hasapositivevalue),thenitisreturnedastheVI'sreturnstatusonlyifnoothererrororwarningoccurredbeforetheVIends.Ifthevalueofthesimulationstatuscoderepresentsanerror(hasanegativevalue),thenitisreturnedastheVI'sreturnstatusonlyifnoothererroroccurredbeforetheVIends.ThefollowingIviFgenVIsdonotsupportstatuscodesimulation:
IviFgenGetErrorIviFgenClearErrorIviFgenGetNextInterchangeWarningIviFgenResetNextInterchangeWarningIviFgenClearNextInterchangeWarningIviFgenGetNextCoercionRecord
EachVIsupportedbytheIviFgenclassdriverhasacorrespondingpropertythatdeterminesthestatuscodetoreturnwhenstatuscodesimulationisenabled.ThefollowingtableliststhestatuscodepropertiesandtheVIforwhichtheyreturnavalue.ThesepropertiesarealloftypeViInt32,non-readable,andnon-channelbased.
NoteInthefollowingtable,theliteralstringNISFGENprecedesallpropertynames.
IviFgenPropertiesforStatusSimulationProperty VIINIT_STATUS IviFgen
Initialize,IviFgenInitializeWithOptions
CLOSE_STATUS IviFgenCloseRESET_STATUS IviFgenResetSELF_TEST_STATUS IviFgenSelf-TestERROR_QUERY_STATUS IviFgenError-
QueryERROR_MESSAGE_STATUS IviFgenError
MessageREVISION_QUERY_STATUS IviFgenRevision
QueryRESET_DEFAULT_STATUS IviFgenResetWith
DefaultsDISABLE_STATUS IviFgenDisableINVALIDATE_STATUS IviFgenInvalidate
AllAttributesGET_CH_NAME_STATUS IviFgenGet
ChannelNameABORT_GENERATION_STATUS IviFgenAbort
GenerationCONFIGURE_OPERATION_MODE_STATUS IviFgenConfigure
OperationModeCONFIGURE_OUTPUT_ENABLED_STATUS IviFgenConfigure
OutputEnabledCONFIGURE_OUTPUT_IMPEDANCE_STATUS IviFgenConfigure
OutputImpedanceCONFIGURE_OUTPUT_MODE_STATUS IviFgenConfigure
OutputModeCONFIGURE_REF_CLOC_SOURCE_STATUS IviFgenConfigure
RefClockSourceINITIATE_GENERATION_STATUS IviFgenInitiate
GenerationCONFIGURE_STANDARD_WAVEFORM_STATUS IviFgenConfigure
StandardWaveform
CLEAR_ARB_WAVEFORM_STATUS IviFgenClearArbitraryWfm
CONFIGURE_ARB_WAVEFORM_STATUS IviFgenConfigureArbitraryWfm
CONFIGURE_SAMPLE_RATE_STATUS IviFgenConfigureSampleRate
CREATE_ARB_WAVEFORM_STATUS IviFgenCreateArbitraryWfm
QUERY_ARB_WFM_CAPABILITIES_STATUS IviFgenQueryArbWaveformCapabilities
CONFIGURE_ARB_FREQUENCY_STATUS IviFgenConfigureArbFrequency
CLEAR_ARB_MEMORY_STATUS IviFgenClearArbitraryMemory
CLEAR_ARB_SEQUENCE_STATUS IviFgenClearArbitrarySequence
CONFIGURE_ARB_SEQUENCE_STATUS IviFgenConfigureArbitrarySequence
CREATE_ARB_SEQUENCE_STATUS IviFgenCreateArbitrarySequence
QUERY_ARB_SEQ_CAPABILITIES_STATUS IviFgenQueryArbSequenceCapabilities
CONFIGURE_TRIGGER_SOURCE_STATUS IviFgenConfigureTriggerSource
CONFIGURE_INTERNAL_TRIGGER_RATE_STATUS IviFgenConfigureInternalTriggerRate
SEND_SOFTWARE_TRIGGER_STATUS IviFgenSendSoftwareTrigger
CONFIGURE_BURST_COUNT_STATUS IviFgenConfigureBurstCount
CONFIGURE_AM_ENABLED_STATUS IviFgenConfigureAMEnabled
CONFIGURE_AM_INTERNAL_STATUS IviFgenConfigureAMInternal
CONFIGURE_AM_SOURCE_STATUS IviFgenConfigure
AMSourceCONFIGURE_FM_ENABLED_STATUS IviFgenConfigure
FMEnabledCONFIGURE_FM_INTERNAL_STATUS IviFgenConfigure
FMInternalCONFIGURE_FM_SOURCE_STATUS IviFgenConfigure
FMSource
IviPwrMeterClassDriverReferenceforLabVIEWIviPwrMeterVIandPropertyReferenceVITreePropertiesbyGroupErrorandCompletionCodes
IviPwrMeterClassDriverOverviewThisinstrumentdriverprovidesprogrammingsupportfortheIviPwrMeterClass.TheIviPwrMeterclassisdesignedtosupportthetypicalpowermeteraswellascommonextendedfunctionalityfoundinmorecomplexinstruments.TheIviPwrMeterclassconceptualizesapowermeterasaninstrumentthatcanmeasuretheaverageRFpowerofaninputsignalandcanbeappliedtoseveraldifferentinstruments.ThedrivercontainsalltheVIsrequiredintheIviPwrMeterspecificationdefinedbytheIVIFoundation.ThisdriverrequiresNI-VISAandtheIVICompliancePackagetobeinstalled.TheIviPwrMeterclassisdividedintoabasecapabilitygroupandseveralextensioncapabilitygroups.Thebasecapabilitygroupisusedtoconfigureapowermeterforatypicalmeasurement(thisincludessettingtheunits,theautorangemode,theautoaveragingmode,andthecorrectionfrequency),initiatingameasurement,andreturningameasuredvalue.Thebasecapabilitygroupsupportsbothsingleanddualchannelmeasurements.TheIviPwrMeterclassalsocontainsextensiongroupsthatconfiguretheadvancedtriggersettings,themanualrange,theaveragingcount,andthereferenceoscillatorofthepowermeter.Theclassalsocontainsextensiongroupsthatperformzerocorrectionandcalibration.
IviPwrMeterExtensionCapabilityGroupsTheIviPwrMeterclassdriveridentifiesVIsandpropertiesthatbelongtoanextensiongroupwiththefollowingabbreviations.Instrumentspecificdriversarenotrequiredtoimplementanyoftheextensioncapabilitygroups.IfyouuseVIsandpropertiesthatbelongtoextensioncapabilitygroups,everyinstrumentspecificdriverthatyouusemustimplementthoseextensions.
GroupName DescriptionIviPwrMeterChannelAcquisition Supportspowermetersthatcan
performsimultaneousmeasurementsontwoormorechannelsandfetchthemeasurementfromeachspecifiedchannel.IncludespropertiesforenablingachannelformeasurementandVIsforacquiringmeasurementsonaspecifiedchannel
IviPwrMeterManualRange Supportspowermetersthatcanmanuallyspecifytheupperandlowerlimitsofthemeasurementrange.IncludesVIsforconfiguringthemeasurementrange.
IviPwrMeterTriggerSource Supportspowermetersthatcanspecifyatriggersourceandatriggereventonwhichtotriggerameasurement.IncludesVIsforconfiguringthetriggersource.
IviPwrMeterInternalTrigger Supportspowermetersthatcantriggerinternallyonthemeasurementsignal.Itspecifiespropertiestoconfiguretheinternaltriggereventsource,triggerlevel,andthetriggerslope.IncludesVIsforconfiguringtheseproperties.
IviPwrMeterSoftwareTrigger Supportspowermetersthatcaninitiateameasurementbasedona
softwaretriggersignal.Youcansendasoftwaretriggertocausethepowermetertotriggerameasurement.
IviPwrMeterAveragingCount Supportspowermetersthatcanfilterasignalbyaveragingitaspecifiednumberoftimesinmanualaveragingmode.DefinesanpropertyandVItospecifytheaveragingcount.
IviPwrMeterZeroCorrection Supportspowermetersthatcanperformazerocorrectiononaninputchannel.DefinesVIstoperformthezerocorrection.
IviPwrMeterDutyCycleCorrection Supportspowermetersthatperformadutycyclecorrection.IncludesVIsforenablingandconfiguringthedutycyclecorrection.
IviPwrMeterCalibration Supportspowermetersthatcanperformcalibrationforagivenpowersensor.DefinesVIstoperformthecalibration.
IviPwrMeterReferenceOscillator Supportspowermetersthatcanenableaninternalreferenceoscillator.DefinespropertiesthatconfigurethereferenceoscillatorandtheVIsthatsettheseproperties.
RelatedTopicIVIInherentClassCapabilities
IviPwrMeterExtensionCapabilityGroupsTheIviPwrMeterclassdriveridentifiesVIsandpropertiesthatbelongtoanextensiongroupwiththefollowingabbreviations.Instrumentspecificdriversarenotrequiredtoimplementanyoftheextensioncapabilitygroups.IfyouuseVIsandthatbelongtoextensioncapabilitygroups,everyinstrumentspecificdriverthatyouusemustimplementthoseextensions.
GroupName DescriptionIviPwrMeterChannelAcquisition Supportspowermetersthatcan
performsimultaneousmeasurementsontwoormorechannelsandfetchthemeasurementfromeachspecifiedchannel.IncludespropertiesforenablingachannelformeasurementandVIsforacquiringmeasurementsonaspecifiedchannel.
IviPwrMeterManualRange Supportspowermetersthatcanmanuallyspecifytheupperandlowerlimitsofthemeasurementrange.IncludesVIsforconfiguringthemeasurementrange.
IviPwrMeterTriggerSource Supportspowermetersthatcanspecifyatriggersourceandatriggereventonwhichtotriggerameasurement.IncludesVIsforconfiguringthetriggersource.
IviPwrMeterInternalTrigger Supportspowermetersthatcantriggerinternallyonthemeasurementsignal.Itspecifiestoconfiguretheinternaltriggereventsource,triggerlevel,andthetriggerslope.IncludesVIsforconfiguringtheseproperties.
IviPwrMeterSoftwareTrigger Supportspowermetersthatcaninitiateameasurementbasedonasoftwaretriggersignal.Youcansend
asoftwaretriggertocausethepowermetertotriggerameasurement.
IviPwrMeterAveragingCount Supportspowermetersthatcanfilterasignalbyaveragingitaspecifiednumberoftimesinmanualaveragingmode.DefinesanpropertyandVItospecifytheaveragingcount.
IviPwrMeterZeroCorrection Supportspowermetersthatcanperformazerocorrectiononaninputchannel.DefinesVIstoperformthezerocorrection.
IviPwrMeterDutyCycleCorrection Supportspowermetersthatperformadutycyclecorrection.IncludesVIsforenablingandconfiguringthedutycyclecorrection.
IviPwrMeterCalibration Supportspowermetersthatcanperformcalibrationforagivenpowersensor.DefinesVIstoperformthecalibration.
IviPwrMeterReferenceOscillator Supportspowermetersthatcanenableaninternalreferenceoscillator.DefinesthatconfigurethereferenceoscillatorandtheVIsthatsettheseproperties.
IviPwrMeterAveragingCountExtensionGroupTheIviPwrMeterAveragingCountextensioncapabilitygroupsupportspowermetersthatcanfilterasignalbyaveragingitaspecifiednumberoftimesinmanualaveragingmode.TheIviPwrMeterAveragingCountextensiongroupdefinesanpropertyandVItospecifytheaveragingcount.
IviPwrMeterAveragingCountVIIviPwrMeter_ConfigureAveragingCount
IviPwrMeterAveragingCountPropertyIVIPWRMETER_ATTR_AVERAGING_COUNT
IviPwrMeterBaseExtensionGroupTheIviPwrMeterBasecapabilitygroupsupportspowermetersthattakeasinglemeasurementononechannelaswellasinstrumentsthatcantakesynchronousmeasurementsontwochannels.TheIviPwrMeterBasecapabilitygroupdefinespropertiesandtheirvaluestoconfigurethetypeofmeasurementandhowthemeasurementistobeperformed.Thesepropertiesincludetheunits,theauto-rangemode,theauto-averagingmode,thecorrectionfrequency,andtheoffset.TheIviPwrMeterBasecapabilitygroupalsoincludesVIsforconfiguringthepowermeterandforinitiatingandretrievingmeasurements.
IviPwrMeterBasePropertiesIVIPWRMETER_ATTR_AVERAGING_AUTO_ENABLEDIVIPWRMETER_ATTR_CORRECTION_FREQUENCYIVIPWRMETER_ATTR_OFFSETIVIPWRMETER_ATTR_RANGE_AUTO_ENABLEDIVIPWRMETER_ATTR_UNITSRelatedTopicsIVIInherentVIsIVIInherentPropertiesIviPwrMeterbehaviormodel
IviPwrMeterCalibrationExtensionGroupTheIviPwrMeterCalibrationextensioncapabilitygroupsupportspowermetersthatcanperformcalibrationforagivenpowersensor.TheIviPwrMeterCalibrationcapabilitygroupdefinesfunctionstoperformthecalibration.
IviPwrMeterCalibrationVIsIviPwrMeter_CalibrateIviPwrMeter_IsCalibrationComplete
IviPwrMeterChannelAcquisitionExtensionGroupTheIviPwrMeterChannelAcquisitionextensioncapabilitygroupsupportspowermetersthatcanperformsimultaneousmeasurementsontwoormorechannelsandfetchthemeasurementfromeachspecifiedchannel.TheIviPwrMeterChannelAcquisitionextensioncapabilityalsoincludespropertiesforenablingachannelformeasurementandVIsforacquiringmeasurementsonaspecifiedchannel.
IviPwrMeterChannelAcquisitionVIsIviPwrMeter_ConfigureChannelEnabledIviPwrMeter_FetchChannelIviPwrMeter_ReadChannel
IviPwrMeterChannelAcquisitionPropertyIVIPWRMETER_ATTR_CHANNEL_ENABLED
IviPwrMeterDutyCycleCorrectionExtensionGroupTheIviPwrMeterDutyCycleCorrectionextensioncapabilitygroupsupportspowermetersthatperformadutycyclecorrection.TheIviPwrMeterDutyCycleCorrectionextensioncapabilityalsoincludesVIsforenablingandconfiguringthedutycyclecorrection.
IviPwrMeterDutyCycleCorrectionVIIviPwrMeter_ConfigureDutyCycleCorrection
IviPwrMeterDutyCycleCorrectionPropertiesIVIPWRMETER_ATTR_DUTY_CYCLE_CORRECTIONIVIPWRMETER_ATTR_DUTY_CYCLE_CORRECTION_ENABLED
IviPwrMeterInternalTriggerExtensionGroupTheIviPwrMeterInternalTriggerextensioncapabilitygroupsupportspowermetersthatcantriggerinternallyonthemeasurementsignal.TheIviPwrMeterInternalTriggerextensioncapabilitygroupalsospecifiespropertiestoconfiguretheinternaltriggereventsource,triggerlevel,andthetriggerslope.TheIviPwrMeterInternalTriggerextensioncapabilitygroupalsoincludesVIsforconfiguringtheseproperties.
IviPwrMeterInternalTriggerVIIviPwrMeter_Configure_Internal_Trigger
IviPwrMeterInternalTriggerPropertiesIVIPWRMETER_ATTR_INTERNAL_TRIGGER_EVENT_SOURCEIVIPWRMETER_ATTR_INTERNAL_TRIGGER_LEVELIVIPWRMETER_ATTR_INTERNAL_TRIGGER_SLOPE
IviPwrMeterManualRangeExtensionGroupTheIviPwrMeterManualRangeextensioncapabilitygroupsupportspowermetersthatcanmanuallyspecifytheupperandlowerlimitsofthemeasurementrange.TheIviPwrMeterManualRangeextensioncapabilityalsoincludesVIsforconfiguringthemeasurementrange.
IviPwrMeterManualRangeVIIviPwrMeter_ConfigureRange
IviPwrMeterManualRangePropertiesIVIPWRMETER_ATTR_RANGE_LOWERIVIPWRMETER_ATTR_RANGE_UPPER
IviPwrMeterReferenceOscillatorExtensionGroupTheIviPwrMeterReferenceOscillatorextensioncapabilitygroupsupportspowermetersthatcanenableaninternalreferenceoscillator.TheIviPwrMeterReferenceOscillatorcapabilitygroupdefinespropertiesthatconfigurethereferenceoscillator.ItalsodefinesVIStosettheseproperties.
IviPwrMeterReferenceOscillatorVIsIviPwrMeter_ConfigureRefOscillatorIviPwrMeter_ConfigureRefOscillatorEnabled
IviPwrMeterReferenceOscillatorPropertiesIVIPWRMETER_ATTR_REF_OSCILLATOR_ENABLEDIVIPWRMETER_ATTR_REF_OSCILLATOR_FREQUENCYIVIPWRMETER_ATTR_REF_OSCILLATOR_LEVEL
IviPwrMeterSoftwareTriggerExtensionGroupTheIviPwrMeterSoftwareTriggerextensiongroupsupportspowermetersthatcaninitiateameasurementbasedonasoftwaretriggersignal.Youcansendasoftwaretriggertocausethepowermetertotriggerameasurement.
IviPwrMeterSoftwareTriggerVIIviPwrMeter_SendSoftwareTrigger
IviPwrMeterTriggerSourceExtensionGroupTheIviPwrMeterTriggerSourceextensioncapabilitygroupsupportspowermetersthatcanspecifyatriggersourceandatriggereventonwhichtotriggerameasurement.TheIviPwrMeterTriggerSourceextensioncapabilityalsoincludesVIsforconfiguringthetriggersource.
IviPwrMeterTriggerSourceVIIviPwrMeter_Configure_Trigger_Source
IviPwrMeterTriggerSourcePropertyIVIPWRMETER_ATTR_TRIGGER_SOURCE
IviPwrMeterZeroCorrectionExtensionGroupTheIviPwrMeterZeroCorrectionextensioncapabilitygroupsupportspowermetersthatcanperformazerocorrectiononaninputchannel.TheIviPwrMeterZeroCorrectioncapabilitygroupdefinesVIstoperformthezerocorrection.
IviPwrMeterZeroCorrectionVIsIviPwrMeter_Is_Zero_Correction_CompleteIviPwrMeter_ZeroIviPwrMeter_ZeroAllChannels
IviPwrMeterBehaviorModelsIviPwrMeterAveragingCountIviPwrMeterBaseIviPwrMeterCalibrationIviPwrMeterChannelAcquisitionIviPwrMeterDutyCycleCorrectionIviPwrMeterInternalTriggerIviPwrMeterManualRangeIviPwrMeterReferenceOscillatorIviPwrMeterSoftwareTriggerIviPwrMeterTriggerSourceIviPwrMeterZeroCorrection
IviPwrMeterAveragingCountBehaviorModelTheIviPwrMeterAveragingCountextensiongroupfollowsthesamebehaviormodelastheIviPwrMeterBasecapabilitygroup.
IviPwrMeterBaseBehaviorModelThefollowingstatediagramshowsrelationshipsbetweentheIviPwrMeterBasecapabilitygroupandpowermeterbehavior.
ThemainstateintheIviPwrMeterClassistheIdlestate.ThepowermeterenterstheIdlestateastheresultofbeing"powered-on",successfullycompletingameasurement,orbybeingabortedfromapreviousmeasurementbyyouwiththeAbortVI.Typically,youconfigurethepowermeterwhileitisintheIdlestate.IviPwrMeterattributescanbeconfiguredindividuallybysettingpropertiesorwiththehigh-levelconfigurationVIsdefinedintheIviPwrMeterBasecapabilitygroup.TheReadandInitiateVIscausethepowermetertoleavetheIdlestateandtakeameasurementonallenabledchannels.TheReadVIdoesnotreturnuntilthemeasurementprocessiscompleteandthepowermeterhasreturnedtotheIdlestate.TheInitiateVIreturnsassoonasthepowermeterleavestheIdlestate.TheFetchVIisusedtoretrievemeasurementsthatwereinitiatedbytheInitiateVI.AssoonasthepowermeterleavestheIdlestate,itimmediatelytakesameasurementonallenabledchannels.YouenablechannelsbycallingtheConfigureMeasurementVIbeforeinitiatingthemeasurement.ThepowermetertakesameasurementonthechannelsspecifiedintheConfigureMeasurementVIandperformsthespecifiedmathoperationontheresults.Afterallmeasurementshavebeentaken,thepowermeter(ifitiscapable
ofdoingso)generatestheMeasurementCompletesignalandreturnstotheIdlestate.TheIviPwrMeterBasecapabilitygroupdoesnotrequirethatapowermeterbeabletogenerateaMeasurementCompletesignal.TheIviPwrMeterBasecapabilitygroupdoesnotdefinehowaMeasurementCompletesignalisconfigured.TheMeasurementCompletesignalispresentedintheIviPwrMeterbehaviormodeldiagramtodefinewhenthesignalisgeneratedasmostpowermetersgeneratethissignalbutmaynotbeabletoconfigureit.
IviPwrMeterCalibrationBehaviorModelTheIviPwrMeterCalibrationextensiongroupfollowsthesamebehaviormodelastheIviPwrMeterBasecapabilitygroup.
IviPwrMeterChannelAcquisitionBehaviorModelTheIviPwrMeterChannelAcquisitionbehaviormodelleveragesthebehaviormodeloftheIviPwrMeterBasecapabilitygroup.
IviPwrMeterDutyCycleCorrectionBehaviorModelTheIviPwrMeterDutyCycleCorrectionextensiongroupfollowsthesamebehaviormodelastheIviPwrMeterBasecapabilitygroup.
IviPwrMeterInternalTriggerBehaviorModelTheIviPwrMeterInternalTriggerbehaviormodelleveragesthebehaviormodeloftheIviPwrMeterBasecapabilitygroupandtheIviPwrMeterTriggerSourceextensiongroup.Furthermore,itdefinesanadditionaltriggereventforthetriggersource.ThepowermeterleavestheWait-For-Triggerstatewhenitreceivesaninternaltriggerevent.WhentheTriggerSourcepropertyissettotheInternaldefinedvalue,andthemeasurementsignalonthechannelspecifiedbytheInternalTriggerEventSourcepropertycrossesthelevelspecifiedbytheInternalTriggerLevelpropertyinthedirectionspecifiedbytheInternalTriggerSlopeproperty,thepowermeterleavestheWait-For-Triggerstateandtakesameasurementonallenabledchannels.
IviPwrMeterManualRangeBehaviorModelTheIviPwrMeterManualRangebehaviormodelleveragesthebehaviormodeloftheIviPwrMeterBasecapabilitygroup.
IviPwrMeterReferenceOscillatorBehaviorModelTheIviPwrMeterReferenceOscillatorextensiongroupfollowsthesamebehaviormodelastheIviPwrMeterBasecapabilitygroup.
IviPwrMeterSoftwareTriggerBehaviorModelTheIviPwrMeterSoftwareTriggerbehaviormodelleveragesthebehaviormodeloftheIviPwrMeterBasecapabilitygroupandtheIviPwrMeterTriggerSourceextensiongroup.Furthermore,itdefinesanadditionaltriggereventforthetriggersource.ThepowermeterleavestheWait-For-TriggerstatewhenitreceivesatriggereventspecifiedbytheTriggerSourceproperty.WhenthetriggersourceissettoSoftware,theSendSoftwareTriggerVIisusedtogeneratethetriggerevent.CallingthisVIcausesthepowermetertoleavetheWait-For-Triggerstateandtakeameasurementonallenabledchannels.
IviPwrMeterTriggerSourceBehaviorModelTheIviPwrMeterTriggerSourcebehaviormodelleveragesthebehaviormodeloftheIviPwrMeterBasecapabilitygroup.Furthermore,itdefinesanadditionalWait-For-TriggerstateaftertheIdlestate.ThefollowingstatediagramshowstherelationshipbetweenIviPwrMeterTriggerSourcecapabilitiesandtheIviPwrMeterBasecapabilitybehaviormodel.
TheInitiateandReadVIscausethepowermetertoleavetheIdlestateandtransitiontotheWait-For-Triggerstate.TheReadVIdoesnotreturnuntilthemeasurementprocessiscompleteandthepowermeterreturnstotheIdlestate.TheInitiateVIreturnsassoonasthepowermeterleavestheIdlestate.IntheWait-For-Triggerstate,thepowermeterwaitsforatriggerevent.ThetypeoftriggereventisspecifiedbytheTriggerSourceproperty.Whenthespecifiedtriggereventoccurs,thepowermeterleavestheWait-For-Triggerstateandtakesameasurementonallenabledchannels.
IviPwrMeterZeroCorrectionBehaviorModelTheIviPwrMeterZeroCorrectionextensiongroupfollowsthesamebehaviormodelastheIviPwrMeterBasecapabilitygroup.
IviPwrMeterVITreeClass/PanelName VIName
ConfigurationConfigureUnits IviPwrMeter_Configure
Units.viConfigureMeasurement IviPwrMeter_Configure
Measurement.viConfigureRangeAutoEnabled IviPwrMeter_Configure
RangeAutoEnabled.viConfigureAveragingAutoEnabled IviPwrMeter_Configure
AveragingAutoEnabled.vi
ConfigureCorrectionFrequency IviPwrMeter_ConfigureCorrectionFrequency.vi
ConfigureOffset IviPwrMeter_ConfigureOffset.vi
ConfigureRange[RNG] IviPwrMeter_ConfigureRange[RNG].vi
ConfigureAveragingCount[AVG] IviPwrMeter_ConfigureAveragingCount[AVG].vi
ConfigureDutyCycleCorrection[DC] IviPwrMeter_ConfigureDutyCycleCorrection[DC].vi
GetChannelName IviPwrMeter_GetChannelName.vi
ConfigureChannelEnabled[CH] IviPwrMeter_ConfigureChannelEnabled[CH].vi
TriggerConfigureTriggerSource[TRG] IviPwrMeter_Configure
TriggerSource[TRG].viConfigureInternalTrigger[IT] IviPwrMeter_Configure
InternalTrigger[IT].vi
ConfigureInternalTriggerLevel[IT] IviPwrMeter_ConfigureInternalTriggerLevel[IT].vi
ReferenceOscillatorConfigureReferenceOscillatorEnabled[RO] IviPwrMeter_Configure
ReferenceOscillatorEnabled[RO].vi
ConfigureReferenceOscillator[RO] IviPwrMeter_ConfigureReferenceOscillator[RO].vi
ZeroingZero[ZC] IviPwrMeter_Zero[ZC].viZeroAllChannels[ZC] IviPwrMeter_ZeroAll
Channels[ZC].viIsZeroCorrectionComplete[ZC] IviPwrMeter_IsZero
CorrectionComplete[ZC].vi
CalibrationCalibrate[CAL] IviPwrMeter_Calibrate
[CAL].viIsCalibrationComplete[CAL] IviPwrMeter_Is
CalibrationComplete[CAL].vi
MeasurementRead IviPwrMeter_Read.viReadChannel[CH] IviPwrMeter_Read
Channel[CH].viLow-LevelMeasurementInitiate IviPwrMeter_Initiate.viIsMeasurementComplete IviPwrMeter_Is
MeasurementComplete.vi
Fetch IviPwrMeter_Fetch.viFetchChannel[CH] IviPwrMeter_Fetch
Channel[CH].viQueryResultRangeType IviPwrMeter_Query
ResultRangeType.viAbort IviPwrMeter_Abort.viSendSoftwareTrigger[SWT] IviPwrMeter_Send
SoftwareTrigger[SWT].vi
IviPwrMeterPropertiesGroup/AttributeName PropertyLabel
BasicOperationAveragingAutoEnabled IviPwrMeter»Basic
Operation»AveragingAutoEnabled
CorrectionFrequency IviPwrMeter»BasicOperation»CorrectionFrequency
Offset IviPwrMeter»BasicOperation»Offset
RangeAutoEnabled IviPwrMeter»BasicOperation»RangeAutoEnabled
Units IviPwrMeter»BasicOperation»Units
ChannelAcquisitionChannelEnabled[CH] IviPwrMeter»Basic
Operation»ChannelAcquisition»ChannelEnabled[CH]
ManualRangeRangeLower[RNG] IviPwrMeter»Manual
Range»RangeLower[RNG]RangeUpper[RNG] IviPwrMeter»Manual
Range»RangeUpper[RNG]TriggerTriggerSource[TRG] IviPwrMeter»Trigger»Trigger
Source[TRG]InternalTriggerInternalTriggerEventSource[IT] IviPwrMeter»Trigger»Internal
Trigger»InternalTriggerEventSource[IT]
InternalTriggerLevel[IT] IviPwrMeter»Trigger»InternalTrigger»InternalTriggerLevel[IT]
InternalTriggerSlope[IT] IviPwrMeter»Trigger»InternalTrigger»InternalTriggerSlope[IT]
DutyCycleDutyCycleCorrection[DC] IviPwrMeter»DutyCycle»Duty
CycleCorrection[DC]DutyCycleCorrectionEnabled[DC] IviPwrMeter»DutyCycle»Duty
CycleCorrectionEnabled[DC]AveragingCountAverageCount[AVG] IviPwrMeter»Averaging
Count»AverageCount[AVG]ReferenceOscillatorRefOscillatorEnabled[RO] IviPwrMeter»Reference
Oscillator»RefOscillatorEnabled[RO]
RefOscillatorFrequency[RO] IviPwrMeter»ReferenceOscillator»RefOscillatorFrequency[RO]
RefOscillatorLevel[RO] IviPwrMeter»ReferenceOscillator»RefOscillatorLevel[RO]
IviPwrMeterErrorandWarningCodesStatusCodeRangesStatusCodeType NumericRange(inHex)IviPwrMeterErrors 0xBFFA2001to0xBFFA3FFFIviPwrMeterWarnings 0x3FFA2001to0x3FFA3FFFIVISpecificDriverErrors 0xBFFA4000to0xBFFA5FFFIVISpecificDriverWarnings 0x3FFA4000to0x3FFA5FFFIVIErrors 0xBFFA0000to0xBFFA1FFFIVIWarnings 0x3FFA0000to0x3FFA1FFFCommonInstrumentDriverErrors 0xBFFC0000to0xBFFCFFFFCommonInstrumentDriverWarnings 0x3FFC0000to0x3FFCFFFFVISAErrors 0xBFFF0000to0xBFFFFFFFVISAWarnings 0x3FFF0000to0xFFFFFFF
TheIviPwrMeterclassdriverdefinestheerrorcodesshowninthefollowingtableinadditiontotheIVIdefinederrorcodes.
IviPwrMeterErrorCodesError Value MessageIVIPWRMETER_ERROR_CHANNEL_NOT_ENABLED 0xBFFA2001 Channel
nameisnotenabledformeasurement.
IVIPWRMETER_ERROR_MAX_TIME_EXCEEDED 0xBFFA2020 Maximumtimeoutexceededbeforeoperationcouldcomplete.
IVIPWRMETER_ERROR_TRIGGER_NOT_SOFTWARE 0xBFFA1001 Maximumtimeoutexceededbeforeoperationcouldcomplete.
IviPwrMeterWarningCodeWarning Value MessageIVIPWRMETER_WARN_UNDER_RANGE 0x3FFA2001 UnderRange
warningIVIPWRMETER_WARN_OVER_RANGE 0x3FFA2002 OverRange
warning
RelatedTopicIVIStatusCodes
IviPwrMeterVIsExpandthisbooktoviewanalphabetizedlistofIviPwrMeterVIs.
IviPwrMeterAbortIviPwrMeterBaseCapabilityGroupThisVIabortsallpreviouslyinitiatedmeasurementsandreturnsthepowermetertotheIdlestate.Youinitiatemeasurementwiththe.
Notes
(1)ThisVIdoesnotchecktheinstrumentstatus.Typically,youcallthisVIonlyinasequenceofcallstootherlow-leveldriverVIs.Thesequenceperformsoneoperation.Youusethelow-levelVIstooptimizeoneormoreaspectsofinteractionwiththeinstrument.Ifyouwanttochecktheinstrumentstatus,calltheattheconclusionofthesequence.
(2)Iftheinstrumentcannotabortaninitiatedacquisition,thisVIreturnstheIVI_ERROR_FUNCTION_NOT_SUPPORTEDerror.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.
Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviPwrMeterCalibrate[CAL]IviPwrMeterCalibrationCapabilityGroupThisVIperformscalibrationonthespecifiedsensor.ThisVIreturnsonlyafterthesensorhasbeencalibrated.Youmayusethetodeterminewhenthecalibrationiscomplete.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.channelnameThenameofthechanneltocalibrate.
PassthevirtualchannelnamethatyouassigntotheinstrumentintheConfigurationUtility.
Virtualchannelnamesarealiasesforinstrument-specificchannelstrings.Theinstrument-specificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.Youassignavirtualchannelnametoaninstrument-specificchannelthroughtheConfigurationUtility.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrument-specificchannelnames.
DefaultValue:""errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtain
fromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviPwrMeterConfigureAveragingAutoEnabledIviPwrMeterBaseCapabilityGroupThisVIenablesordisablestheauto-averagingmodeforagivenchannel.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.channelnameThenameofthechanneltobeconfigured.
PassthevirtualchannelnamethatyouassigntotheinstrumentintheConfigurationUtility.
Virtualchannelnamesarealiasesforinstrument-specificchannelstrings.Theinstrument-specificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.Youassignavirtualchannelnametoaninstrument-specificchannelthroughtheConfigurationUtilityinMAX.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrument-specificchannelnames.
DefaultValue:""autoaveragingenabledTheauto-averagingmode.PassTRUEtoturnauto-averagingon.PassFALSEtoturnauto-averagingoff.Thedriversetsthepropertytothisvalue.
ValidValues:TRUE-"On"FALSE-"Off"
DefaultValue:TRUE-"On"errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviPwrMeterConfigureAveragingCount[AVG]IviPwrMeterAveragingCountCapabilityGroupThisVIsetstheaveragecountthattheinstrumentusesinmanualaveragingmode.Theaveragingcountspecifiesthenumberofsamplesthattheinstrumenttakesbeforethemeasurementiscomplete.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.channelnameThenameofthechanneltoconfigure.
PassthevirtualchannelnamethatyouassigntotheinstrumentintheConfigurationUtility.
Virtualchannelnamesarealiasesforinstrument-specificchannelstrings.Theinstrument-specificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.Youassignavirtualchannelnametoaninstrument-specificchannelthroughtheConfigurationUtility.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrument-specificchannelnames.
DefaultValue:""averagingcountSpecifiestheaveragingcount.Thedriversetsthepropertytothisvalue.
DefaultValue:5errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviPwrMeterConfigureChannelEnabled[CH]IviPwrMeterChannelAcquisitionCapabilityGroupThisVIenablesordisablesaspecifiedchannelformeasurement.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.channelnamePassthevirtualchannelnamethatyouassigntotheinstrumentintheConfigurationUtility.
Virtualchannelnamesarealiasesforinstrument-specificchannelstrings.Theinstrument-specificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.Youassignavirtualchannelnametoaninstrument-specificchannelthroughtheConfigurationUtility.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrument-specificchannelnames.
DefaultValue:""channelenabledPassTRUEtoenablethechannel.PassFALSEtodisablethechannel.Thedriversetsthepropertytothisvalue.
ValidValues:TRUE-"On"FALSE-"Off"
DefaultValue:TRUE-"On"errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviPwrMeterConfigureCorrectionFrequencyIviPwrMeterBaseCapabilityGroupThisVIspecifiesthefrequencyoftheinputsignalinHertz.Theinstrumentusesthisvaluetodeterminetheappropriatecorrectionfactorforthesensor.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.channelnameThenameofthechanneltobeconfigured.
PassthevirtualchannelnamethatyouassigntotheinstrumentintheConfigurationUtility.
Virtualchannelnamesarealiasesforinstrument-specificchannelstrings.Theinstrument-specificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.Youassignavirtualchannelnametoaninstrument-specificchannelthroughtheConfigurationUtility.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrument-specificchannelnames.
DefaultValue:""frequencySpecifiestheexpectedfrequencyoftheinputsignalinHertz.Theinstrumentusesthisparametertodeterminetheappropriatecorrectionfactorforthesensor.Thedriversetsthepropertytothisvalue.
Units:Hz
DefaultValue:50MHzerrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviPwrMeterConfigureDutyCycleCorrection[DC]IviPwrMeterDutyCycleCorrectionCapabilityGroupThisVIenablesordisablesthedutycyclecorrectionandsetsthedutycyclecorrectionforpulsepowermeasurements.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.channelnameThenameofthechannelforwhichtospecifythedutycyclecorrection.
PassthevirtualchannelnamethatyouassigntotheinstrumentintheConfigurationUtility.
Virtualchannelnamesarealiasesforinstrument-specificchannelstrings.Theinstrument-specificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.Youassignavirtualchannelnametoaninstrument-specificchannelthroughtheConfigurationUtility.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrument-specificchannelnames.
DefaultValue:""correctionenabledEnablesordisablesthedutycyclecorrection.Thedriversetsthe_ENABLEDpropertytothisvalue.
ValidValues:TRUE-"On"FALSE-"Off"
DefaultValue:FALSE-"Off"correctionvalueSpecifiesthedutycyclecorrectionthepowermeterusestocalculatethepulsepowerofapulse-modulatedsignal.Thedriversetsthepropertytothisvalue.
Thepowermetermeasurestheaveragepowerofthepulsedinputsignalandthendividestheresultbythedutycyclecorrectionvaluetoobtainapulsepowerreading.
Thevalueofthispropertyisspecifiedasapercentage.Forapulsewithadutycycleof10%,thispropertyshouldbegiventhevalue0.1.
Units:percentage(%).
DefaultValue:100%errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviPwrMeterConfigureInternalTriggerLevel[IT]IviPwrMeterInternalTriggerCapabilityGroupThisVIconfigurestheinternaltriggerlevelofthepowermeter.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.triggerlevelThesignaltriggerlevel.Thedriversetsthepropertytothisvalue.
Thevalueofthispropertyisspecifiedinthesameunitasthevalueofthepropertywhichyoucansetbycallingthe.
DefaultValue:0.001errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviPwrMeterConfigureInternalTrigger[IT]IviPwrMeterInternalTriggerCapabilityGroupThisVIconfigurestheinternaltriggereventsourceandtheinternaltriggerslopeofthepowermeter.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.eventsourceThenameofthechanneltouseastheinternaltriggereventsource.Thedriversetsthepropertytothisvalue.
PassthevirtualchannelnamethatyouassigntotheinstrumentintheConfigurationUtility.
Virtualchannelnamesarealiasesforinstrument-specificchannelstrings.Theinstrument-specificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.Youassignavirtualchannelnametoaninstrument-specificchannelthroughtheConfigurationUtility.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrument-specificchannelnames.
DefaultValue:""slopeTheinternaltriggerslope.Thedriversetsthepropertytothisvalue.
ValidValues:
IVIPWRMETER_VAL_POSITIVE-Setsthetriggereventtooccurontherisingedgeofthetriggerpulse.
IVIPWRMETER_VAL_NEGATIVE(Difference)-Setsthetriggereventtooccuronthefallingedgeofthetriggerpulse.
DefaultValue:
IVIPWRMETER_VAL_POSITIVEerrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviPwrMeterConfigureMeasurementIviPwrMeterBaseCapabilityGroupThisVIconfigurestheinstrumenttotakesingleordualchannelmeasurements.
Forsinglechannelmeasurements,thisVIenablesthechannelspecifiedbyOperand1anddisablesallotherchannels.TheresultreturnedbytheFetchorReadVIsisthemeasurementtakenatthechannelspecifiedbyOperand1.Although,thedrivermeasuresthepowerinWatts,theresultisconvertedtothesameunitasthevalueoftheproperty.
Fordualchannelmeasurements,thisVIenablesthechannelsspecifiedbyOperand1andOperand2anddisablesallotherchannels.TheresultreturnedbytheFetchorReadVIsistheresultofthespecifiedmathoperationappliedtothemeasurementsonthechannelsspecifiedbyOperand1andOperand2.
Although,themathoperationisperformedonthemeasuredvaluesinWatts,theresultisconvertedtotheappropriateunitsdependingonthevalueoftheUnitspropertyandthevalueoftheOperator.
ForDifferenceandSumoperations,theresultingunitsisthesameastheUnitsproperty.
ForQuotientoperations,theresultingunitsareindB,exceptwhenUnitsaresettoWatts.WhensettoWatts,theresultingmeasurementiswithoutunits.
instrumenthandleTheinstrumenthandlethatyouobtainfromthe
IviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.operatorThemathVIappliedtotheoperands.
Toconfigurethepowermetertotakesinglechannelmeasurements,passNoneastheOperatorvalue.Toconfigurethepowermetertotakesimultaneousdualchannelmeasurements,passoneoftheotherdefinedmathoperatorsastheOperatorvalue.
ValidValues:
IVIPWRMETER_VAL_NONE(NoOperator)-Takeasinglechannelmeasurement.ReturnthemeasuredvalueforOperand1.Operand2isignored.
IVIPWRMETER_VAL_DIFFERENCE(Difference)-SubtractthepowermeasuredonOperand2fromthepowermeasuredonOperand1.
IVIPWRMETER_VAL_SUM(Sum)-AddthepowermeasuredonOperand2tothepowermeasuredonOperand1.
IVIPWRMETER_VAL_QUOTIENT(Quotient)-DividethepowermeasuredonOperand1bythepowermeasuredonOperand2.
DefaultValue:IVIPWRMETER_VAL_DIFFERENCE(Difference)operand1Thenameofthechannelfromwhichthevalueforthefirstoperandofthemathoperatorismeasured.
DefaultValue:""operand2Thenameofthechannelfromwhichthevalueforthesecondoperandofthemathoperatorismeasured.
DefaultValue:""errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.Usethisinformationtodecideif
anyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviPwrMeterConfigureOffsetIviPwrMeterBaseCapabilityGroupThisVIspecifiestheoffsettobeaddedtothemeasuredvalueinunitsofdB.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.channelnameThenameofthechannelforwhichtosettheOffset.
PassthevirtualchannelnamethatyouassigntotheinstrumentintheConfigurationUtility.
Virtualchannelnamesarealiasesforinstrument-specificchannelstrings.Theinstrument-specificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.Youassignavirtualchannelnametoaninstrument-specificchannelthroughtheConfigurationUtility.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrument-specificchannelnames.
DefaultValue:""offsetSpecifiesanoffsettobeaddedtothemeasuredvalue.TheunitsofthispropertyaredB.Thispropertycanbeusedtocompensateforsystemlossesorgainsbetweentheunitundertestandthesensorofthepowermeter.Thedriversetsthepropertytothisvalue.
Forexample,acablelossof2dBcouldbecompensatedforby
settingthispropertyto2.Similarly,againstageof10dBcouldbeaccountedforbysettingthevalueofthispropertyto-10.Inbothcases,thereadingfromthepowermeterwillindicatethepowerattheunitundertestratherthanpoweratthepowermeter'ssensor.
Unit:dB
DefaultValue:0.0dBerrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviPwrMeterConfigureRangeAutoEnabledIviPwrMeterBaseCapabilityGroupThisVIenablesordisablestheautorangemodeforagivenchannel.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.channelnameThenameofthechanneltoconfigure.
PassthevirtualchannelnamethatyouassigntotheinstrumentintheConfigurationUtility.
Virtualchannelnamesarealiasesforinstrument-specificchannelstrings.Theinstrument-specificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.Youassignavirtualchannelnametoaninstrument-specificchannelthroughtheConfigurationUtility.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrument-specificchannelnames.
DefaultValue:""rangeautoenabledSpecifiestheautorangemode.PassTRUEtoturnautorangingon.PassFALSEtoturnautorangingoff.Thedriversetsthepropertytothisvalue.
ValidValues:TRUE-"On"FALSE-"Off"
DefaultValue:TRUE-"On"errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviPwrMeterConfigureRange[RNG]IviPwrMeterManualRangeCapabilityGroupThisVIconfigureslowerandupperrangevaluesforagivenchannel.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.channelnameThenameofthechanneltoconfigure.
PassthevirtualchannelnamethatyouassigntotheinstrumentintheConfigurationUtility.
Virtualchannelnamesarealiasesforinstrument-specificchannelstrings.Theinstrument-specificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.Youassignavirtualchannelnametoaninstrument-specificchannelthroughtheConfigurationUtility.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrument-specificchannelnames.
DefaultValue:""rangelowerSpecifythelowerlimitoftheexpectedvalueofthemeasurement.ThedriversetstheIviPwrMeter>>ManualRange>>RangeLower[R]propertytothisvalue.
Unit:Watt
DefaultValue:1.0e-6(W)rangeupperSpecifytheupperlimitoftheexpectedvalueofthemeasurement.ThedriversetstheIviPwrMeter>>ManualRange>>RangeUpper[R]propertytothisvalue.
Unit:Watt
DefaultValue:0.01(W)errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviPwrMeterConfigureReferenceOscillatorEnabled[RO]IviPwrMeterReferenceOscillatorCapabilityGroupThisVIenablesordisablesthereferenceoscillator.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.referenceoscillatorenabledPassTRUEtoenablethereferenceoscillator.PassFALSEtodisablethereferenceoscillator.Thedriversetsthepropertytothisvalue.
ValidValues:TRUE-"On"FALSE-"Off"
DefaultValue:TRUE-"On"errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.
Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviPwrMeterConfigureReferenceOscillator[RO]IviPwrMeterReferenceOscillatorCapabilityGroupThisVIsetsthefrequencyandpowerlevelofthesignalgeneratedbythereferenceoscillator.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.frequencyThefrequencyofthereferenceoscillator.Thedriversetsthepropertytothisvalue.
Units:Hertz.
DefaultValue:50MHzlevelThepowerlevelofthereferenceoscillator.Thedriversetsthepropertytothisvalue.
Units:dBm.
DefaultValue:0dBmerrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviPwrMeterConfigureTriggerSource[TRG]IviPwrMeterTriggerSourceCapabilityGroupThisVIconfiguresthetriggersourceofthepowermeter.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.triggersourceSpecifiesthetriggersource.Afteryoucalleithertheorthe,thePowerMeterwaitsforthetriggeryouspecify.Thedriversetsthepropertytothisvalue.
DefinedValues:
IVIPWRMETER_VAL_IMMEDIATE(Immediate)-ThepowermeterexitstheWait-For-Triggerstateimmediatelyafterentering.Itdoesnotwaitforatriggerofanykind.
IVIPWRMETER_VAL_EXTERNAL(External)-ThepowermeterexitstheWait-For-Triggerstatewhenaninternaltriggereventoccursonthemeasurementsignal.
IVIPWRMETER_VAL_INTERNAL(Internal)-ThepowermeterexitstheWait-For-Triggerstatewhenatriggeroccursontheexternaltriggerinput.
IVIPWRMETER_VAL_SOFTWARE_TRIG(Software)-ThepowermeterexitstheWait-For-Triggerstatewhenitreceivessoftwaretrigger.
IVIPWRMETER_VAL_TTL0(TTL0)-ThepowermeterexitstheWait-For-Triggerstatewhenitreceivesa
triggeronTTL0.
IVIPWRMETER_VAL_TTL1(TTL1)-ThepowermeterexitstheWait-For-TriggerstatewhenitreceivesatriggeronTTL1.
IVIPWRMETER_VAL_TTL2(TTL2)-ThepowermeterexitstheWait-For-TriggerstatewhenitreceivesatriggeronTTL2.
IVIPWRMETER_VAL_TTL3(TTL3)-ThepowermeterexitstheWait-For-TriggerstatewhenitreceivesatriggeronTTL3.
IVIPWRMETER_VAL_TTL4(TTL4)-ThepowermeterexitstheWait-For-TriggerstatewhenitreceivesatriggeronTTL4.
IVIPWRMETER_VAL_TTL5(TTL5)-ThepowermeterexitstheWait-For-TriggerstatewhenitreceivesatriggeronTTL5.
IVIPWRMETER_VAL_TTL6(TTL6)-ThepowermeterexitstheWait-For-TriggerstatewhenitreceivesatriggeronTTL6.
IVIPWRMETER_VAL_TTL7(TTL7)-ThepowermeterexitstheWait-For-TriggerstatewhenitreceivesatriggeronTTL7.
IVIPWRMETER_VAL_ECL0(ECL0)-ThepowermeterexitstheWait-For-TriggerstatewhenitreceivesatriggeronECL0.
IVIPWRMETER_VAL_ECL1(ECL1)-ThepowermeterexitstheWait-For-TriggerstatewhenitreceivesatriggeronECL1.
IVIPWRMETER_VAL_PXI_STAR(PXIStar)-Thepowermeter
exitstheWait-For-TriggerstatewhenitreceivesatriggeronPXIStartriggerbus.
IVIPWRMETER_VAL_RTSI_0(RTSI0)-ThepowermeterexitstheWait-For-TriggerstatewhenitreceivesatriggeronRTSI0line.
IVIPWRMETER_VAL_RTSI_1(RTSI1)-ThepowermeterexitstheWait-For-TriggerstatewhenitreceivesatriggeronRTSI1line.
IVIPWRMETER_VAL_RTSI_2(RTSI2)-ThepowermeterexitstheWait-For-TriggerstatewhenitreceivesatriggeronRTSI2line.
IVIPWRMETER_VAL_RTSI_3(RTSI3)-ThepowermeterexitstheWait-For-TriggerstatewhenitreceivesatriggeronRTSI3line.
IVIPWRMETER_VAL_RTSI_4(RTSI4)-ThepowermeterexitstheWait-For-TriggerstatewhenitreceivesatriggeronRTSI4line.
IVIPWRMETER_VAL_RTSI_5(RTSI5)-ThepowermeterexitstheWait-For-TriggerstatewhenitreceivesatriggeronRTSI5line.
IVIPWRMETER_VAL_RTSI_6(RTSI6)-ThepowermeterexitstheWait-For-TriggerstatewhenitreceivesatriggeronRTSI6line.
DefaultValue:IVIPWRMETER_VAL_IMMEDIATE(Immediate)errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmore
informationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviPwrMeterConfigureUnitsIviPwrMeterBaseCapabilityGroupThisVIconfigurestheunittowhichtheRFpowerisconvertedaftermeasurement.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.measurementunitsSpecifiestheunitsattheinputterminalsofthepowermeter.Thedriversetsthepropertytothisvalue.
DefinedValues:IVIPWRMETER_VAL_DBM(dBm)IVIPWRMETER_VAL_DBMV(dBmV)IVIPWRMETER_VAL_DBUV(dBuV)IVIPWRMETER_VAL_WATTS(Watts)
DefaultValue:IVIPWRMETER_VAL_WATTS(Watts)errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.
Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviPwrMeterFetchIviPwrMeterBaseCapabilityGroupThisVIreturnstheresultfromapreviouslyinitiatedsingleordualchannelmeasurement.CallthetoinitiateameasurementbeforecallingthisVI.
AfterthisVIexecutes,thevalueofReadingdependsonthemathoperationspecifiedinthe.
Notes
(1)ThisVIdoesnotchecktheinstrumentstatus.Typically,youcallthisVIonlyinasequenceofcallstootherlow-leveldriverVIs.Thesequenceperformsoneoperation.Youusethelow-levelVIstooptimizeoneormoreaspectsofinteractionwiththeinstrument.Ifyouwanttochecktheinstrumentstatus,calltheattheconclusionofthesequence.
(2)Ifanout-of-rangeconditionoccursononeormoreenabledchannels,theresultisavalueindicatingthatanoutofrangeconditionoccurred.Insuchacase,ReadingcontainsanIEEEdefined-Inf(NegativeInfinity)or+Inf(PositiveInfinity)valueandtheVIreturnstheUnderRange(0x3FFA2001)orOverRange(0x3FFA2002)warning.Testifthemeasurementvalueisoutofrangewiththe.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.
Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.readingReturnsthemeasuredvalue.
Forsinglechannelmeasurements,Readingcontainsanactualreadingonthechannelspecifiedbythe.TheunitoftheresultisthesameasthevalueoftheUnitsproperty.
Fordualchannelmeasurements,Readingcontainstheresultofthemathoperationappliedtothechannelsspecifiedinthe.Theunitoftheresultdependsonthevalueofthepropertyandthespecifiedoperator.
ForDifferenceandSumoperations,theresultingunitsisthesameastheUnitsproperty.
ForQuotientoperations,theresultingunitsareindB,exceptwhenUnitsaresettoWatts.WhensettoWatts,theresultingmeasurementiswithoutunits.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviPwrMeterFetchChannel[CH]IviPwrMeterChannelAcquisitionCapabilityGroupThisVIreturnstheresultfromapreviouslyinitiatedmeasurementonaspecifiedchannel.CallthetoinitiateameasurementbeforecallingthisVI.
AfterthisVIexecutes,theReadingparametercontainsanactualreadingonthechannelspecifiedbytheChannelparameter.Ifthespecifiedchannelisnotenabledformeasurement,thisVIreturnstheChannelNotEnabled(0xBFFA2001)error.TheresultisinthesameunitasthevalueoftheUnitsproperty.
Notes
(1)ThisVIdoesnotchecktheinstrumentstatus.Typically,youcallthisVIonlyinasequenceofcallstootherlow-leveldriverVIs.Thesequenceperformsoneoperation.Youusethelow-levelVIstooptimizeoneormoreaspectsofinteractionwiththeinstrument.Ifyouwanttochecktheinstrumentstatus,calltheattheconclusionofthesequence.
(2)Ifanoutofrangeconditionoccurs,theresultisavalueindicatingthatanout-of-rangeconditionoccurred.Insuchacase,theReadingparametercontainsanIEEEdefined-Inf(NegativeInfinity)or+Inf(PositiveInfinity)valueandtheVIreturnstheUnderRange(0x3FFA2001)orOverRange(0x3FFA2002)warning.Testifthemeasurementvalueisoutofrangewiththe.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.
channelnameThenameofthechannelfromwhichtofetchthemeasurement.
PassthevirtualchannelnamethatyouassigntotheinstrumentintheActionUtility.
Virtualchannelnamesarealiasesforinstrument-specificchannelstrings.Theinstrument-specificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.Youassignavirtualchannelnametoaninstrument-specificchannelthroughtheConfigurationUtility.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrument-specificchannelnames.
DefaultValue:""errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.readingThedatareadfromthepowermeter.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviPwrMeterGetChannelNameIviPwrMeterBaseCapabilityGroupThisVIreturnsthephysicalchannelidentifierthatcorrespondstotheone-basedindexspecifiedbytheChannelIndexparameter.
Notes
(1)IfyoupassinavaluefortheChannelIndexparameterthatislessthanoneorgreaterthanthevalueoftheChannelCountproperty,theVIreturnsanemptystringintheChannelNameparameterandreturnsanerror.
(2)Bypassing0forthebuffersize,youcanascertainthebuffersizerequiredtogettheentirechannelnamestringandthencalltheVIagainwithasufficientlylargebuffer.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.indexA1-basedindexintothechanneltable.
ValidRange:1tonumberofchannels.
DefaultValue:1buffersizePassthenumberofbytesintheViChararrayyouspecifyfortheChannelNameparameter.
Ifthechannelname,includingtheterminatingNULbyte,containsmorebytesthanyouindicateinthisparameter,theVIcopiesBufferSize-1bytesintothebuffer,placesanASCIINULbyteattheendofthebuffer,andreturnsthebuffersizeyoumustpassto
gettheentirevalue.Forexample,ifthevalueis"123456"andtheBufferSizeis4,theVIplaces"123"intothebufferandreturns7.
Ifyoupassanegativenumber,theVIcopiesthevaluetothebufferregardlessofthenumberofbytesinthevalue.
Ifyoupass0,youcanpassVI_NULLfortheChannelNamebufferparameter.
DefaultValue:Noneerrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.channelnameReturnsthehighest-levelchannelnamethatcorrespondstothespecificdriverchannelstringthatisinthechanneltableatanindexyouspecify..
ThebuffermustcontainatleastasmanyelementsasthevalueyouspecifywiththeBufferSizeparameter.Ifthechannelnamedescription,includingtheterminatingNULbyte,containsmorebytesthanyouindicatewiththeBufferSizeparameter,theVIcopiesBufferSize-1bytesintothebuffer,placesanASCIINULbyteattheendofthebuffer,andreturnsthebuffersizeyoumustpasstogettheentirevalue.Forexample,ifthevalueis"123456"andtheBufferSizeis4,theVIplaces"123"intothebufferandreturns7.
Ifyoupass0fortheBufferSize,youcanpassVI_NULLforthisparameter.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.
Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviPwrMeterInitiateIviPwrMeterBaseCapabilityGroupThisVIinitiatesameasurementonallenabledchannels.WhenthisVIexecutes,thepowermeterleavestheIdlestateandtakesameasurementonallenabledchannels.Usetheortoobtaintheresultofthemeasurements.
Notes
(1)ThisVIdoesnotchecktheinstrumentstatus.Typically,youcallthisVIonlyinasequenceofcallstootherlow-leveldriverVIs.Thesequenceperformsoneoperation.Youusethelow-levelVIstooptimizeoneormoreaspectsofinteractionwiththeinstrument.Ifyouwanttochecktheinstrumentstatus,calltheattheconclusionofthesequence.
(2)ThisVIperformsinterchangeabilitycheckingwhentheIviPwrMeter>>InherentIVISettings>>UserOptions>>InterchangeCheckpropertyissettoTRUE.YoumayusetheNISpyutilitytoviewinterchangeabilitywarnings.Alternatively,youmayusethetoretrieveinterchangeabilitywarnings.Forinformationoninterchangeabilitychecking,refertotheonlinehelpmanual.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviPwrMeterIsCalibrationComplete[CAL]IviPwrMeterCalibrationCapabilityGroupThisVIqueriestheinstrumenttodeterminethestatusofallcalibrationoperationsinitiatedbythe.ThisVIreturnstheIVIPWRMETER_VAL_CALIBRATION_COMPLETE(1)valueintheStatusparameteronlywhencalibrationiscompleteonallchannels.
Ifsomecalibrationoperationsarestillinprogressononeormorechannels,thedriverreturnstheIVIPWRMETER_VAL_CALIBRATION_IN_PROGRESS(0)value.Ifthedrivercannotquerytheinstrumenttodetermineitsstate,thedriverreturnstheIVIPWRMETER_VAL_CALIBRATION_STATUS_UNKNOWN(-1)value.
Note:
ThisVIdoesnotchecktheinstrumentstatus.Typically,youcallthisVIonlyinasequenceofcallstootherlow-leveldriverVIs.Thesequenceperformsoneoperation.Youusethelow-levelVIstooptimizeoneormoreaspectsofinteractionwiththeinstrument.Ifyouwanttochecktheinstrumentstatus,calltheattheconclusionofthesequence.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmore
informationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.calibrationstatusReturnsthestatusofthecalibration.
Thisdriverdefinesthefollowingcalibrationstatus:
IVIPWRMETER_VAL_CALIBRATION_COMPLETE(1)-Thepowermeterhascompletedthecalibrationonallenabledchannels.
IVIPWRMETER_VAL_CALIBRATION_IN_PROGRESS(0)-Thepowermeterisstilltakingacalibrationononeormoreenabledchannels.
IVIPWRMETER_VAL_CALIBRATION_STATUS_UNKNOWN(-1)-Thepowermetercannotdeterminethestatusofthecalibration.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviPwrMeterIsMeasurementCompleteIviPwrMeterBaseCapabilityGroupThisVIqueriestheinstrumenttodeterminethestatusofthemeasurementinitiatedbythe.ThisVIreturnstheIVIPWRMETER_VAL_MEAS_COMPLETE(1)valueintheStatusparameteronlywhenmeasurementsarecompleteonallenabledchannels.
Ifsomemeasurementsarestillinprogressononeormorechannels,thedriverreturnstheIVIPWRMETER_VAL_MEAS_IN_PROGRESS(0)value.Ifthedrivercannotquerytheinstrumenttodetermineitsstate,thedriverreturnstheIVIPWRMETER_VAL_MEAS_STATUS_UNKNOWN(-1)value.
Note:
ThisVIdoesnotchecktheinstrumentstatus.Typically,youcallthisVIonlyinasequenceofcallstootherlow-leveldriverVIs.Thesequenceperformsoneoperation.Youusethelow-levelVIstooptimizeoneormoreaspectsofinteractionwiththeinstrument.Ifyouwanttochecktheinstrumentstatus,calltheattheconclusionofthesequence.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmore
informationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.measurementstatusReturnsthestatusofthemeasurement.
Thisdriverdefinesthefollowingmeasurementstatus:
IVIPWRMETER_VAL_MEAS_COMPLETE(1)-Thepowermeterhascompletedthemeasurementonallenabledchannels.
IVIPWRMETER_VAL_MEAS_IN_PROGRESS(0)-Thepowermeterisstilltakingameasurementononeormoreenabledchannels.
IVIPWRMETER_VAL_MEAS_STATUS_UNKNOWN(-1)-Thepowermetercannotdeterminethestatusofthemeasurement.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviPwrMeterIsZeroCorrectionComplete[ZC]IviPwrMeterZeroCorrectionCapabilityGroupThisVIqueriestheinstrumenttodeterminethestatusofallzerocorrectionoperationsinitiatedbytheorVIs.ThisVIreturnstheIVIPWRMETER_VAL_ZERO_COMPLETE(1)valueintheStatusparameteronlywhenzerocorrectionsarecompleteonallenabledchannels.
Ifsomezerocorrectionoperationsarestillinprogressononeormorechannels,thisVIreturnstheIVIPWRMETER_VAL_ZERO_IN_PROGRESS(0)value.Ifthedrivercannotquerytheinstrumenttodetermineitsstate,thedriverreturnstheIVIPWRMETER_VAL_ZERO_STATUS_UNKNOWN(-1)value.
Note:
ThisVIdoesnotchecktheinstrumentstatus.Typically,youcallthisVIonlyinasequenceofcallstootherlow-leveldriverVIs.Thesequenceperformsoneoperation.Youusethelow-levelVIstooptimizeoneormoreaspectsofinteractionwiththeinstrument.Ifyouwanttochecktheinstrumentstatus,calltheattheconclusionofthesequence.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmore
informationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.zerocorrectionstatusReturnsthestatusofthezerocorrection.
Thisdriverdefinesthefollowingzerocorrectionstatus:
IVIPWRMETER_VAL_ZERO_COMPLETE(1)-Thepowermeterhascompletedallzerocorrectionoperations.
IVIPWRMETER_VAL_ZERO_IN_PROGRESS(0)-Thepowermeterisstillperformingazerocorrectionononeormoreenabledchannels.
IVIPWRMETER_VAL_ZERO_STATUS_UNKNOWN(-1)-Thepowermetercannotdeterminethestatusofthezerocorrection.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviPwrMeterQueryResultRangeTypeIviPwrMeterBaseCapabilityGroupThisVItakesameasurementvaluethatisreturnedfromoneoftheFetch,FetchChannel,Read,orReadChannelVIsanddeterminesifthevalueisavalidmeasurementvalueoravalueindicatingthatanout-of-rangeconditionoccurred.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.measurementvaluePassthemeasurementvaluethatyouobtainfromoneoftheFetchorReadVIs.Thedriverteststhisvaluetodetermineifthevalueisavalidmeasurementvalueoravalueindicatinganout-of-rangeconditionoccurred.
DefaultValue:0.0errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.rangetypeReturnswhetherthemeasurementvalueisavalidmeasurementoravalueindicatingthatthepowermeterencounteredanout-of-rangecondition.
Thisdriverdefinesthefollowingrangetype:
IVIPWRMETER_VAL_IN_RANGE(0)-Themeasurementiswithinthecurrentrangelimits.
IVIPWRMETER_VAL_UNDER_RANGE(-1)-Themeasurementisbelowthecurrentlowerrangelimits.
IVIPWRMETER_VAL_OVER_RANGE(1)-Themeasurementisabovethecurrentupperrangelimits.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviPwrMeterReadIviPwrMeterBaseCapabilityGroupThisVIinitiatesameasurement,waitsuntilthepowermeterhasreturnedtotheIdlestate,andreturnstheresultofthemeasurement.
AfterthisVIexecutes,thevalueoftheReadingparameterdependsonthemathoperationspecifiedinthe.
Ifanoutofrangeconditionoccursononeormoreenabledchannels,thereadingisavalueindicatingthatanoutofrangeconditionoccurred.Insuchacase,ReadingcontainsanIEEEdefined-Inf(NegativeInfinity)or+Inf(PositiveInfinity)valueandtheVIreturnstheUnderRange(0x3FFA2001)orOverRange(0x3FFA2002)warning.Testifthemeasurementvalueisoutofrangewiththe.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.maximumtime(ms)Passthemaximumlengthoftimeinwhichtoallowthereadoperationtocomplete.Expressthisvalueinmilliseconds.
Iftheoperationdoesnotcompletewithinthistimeinterval,theVIreturnstheIVIPWRMETER_ERROR_MAX_TIME_EXCEEDED(0xBFFA2020)errorcode.Whenthisoccurs,youcancalltocancelthereadoperationandreturntheinstrumenttotheIdlestate.
DefinedValues:IVIPWRMETER_VAL_MAX_TIME_INFINITE(-1)-Waitindefinitelyforatimeout.IVIPWRMETER_VAL_MAX_TIME_IMMEDIATE(0)-Donotwaitforatimeout.
DefaultValue:5000
Notes
(1)TheMaximumTimeparameteraffectsonlythisVI.Ithasnoeffectonothertimeoutparametersorproperties.
(2)SomespecificinstrumentdriversdonotsupporttheImmediateTimeoutortheInfiniteTimeoutdefinedvalues.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.readingReturnsthemeasuredvalue.
Forsinglechannelmeasurements,Readingcontainsanactualreadingonthechannelspecifiedbythe.Theunitoftheresultisthesameasthevalueoftheproperty.
Fordualchannelmeasurements,Readingcontainstheresultofthemathoperationappliedtothechannelsspecifiedinthe.TheunitoftheresultdependsonthevalueoftheUnitspropertyandthespecifiedoperator.
ForDifferenceandSumoperations,theresultingunitsisthesameastheUnitsproperty.
ForQuotientoperations,theresultingunitsareindB,exceptwhenUnitsaresettoWatts.WhensettoWatts,theresultingmeasurementiswithoutunits.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.
Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviPwrMeterReadChannel[CH]IviPwrMeterChannelAcquisitionCapabilityGroupThisVIinitiatesameasurement,waitsuntilthepowermeterhasreturnedtotheIdlestate,andreturnstheresultofthemeasurementonthespecifiedchannel.
AfterthisVIexecutes,theReadingparametercontainsanactualreadingonthechannelspecifiedbytheChannelparameter.Ifthespecifiedchannelisnotenabledformeasurement,thisVIreturnstheChannelNotEnabled(0xBFFA2001)error.TheReadingresultisinthesameunitasthevalueoftheUnitsproperty.
AfterthisVIexecutes,theReadingparametermaycontainavalueindicatingthatanout-of-rangeconditionoccurred.Ifanout-of-rangeconditionoccurs,theResultparametercontainsanIEEEdefined-Inf(NegativeInfinity)or+Inf(PositiveInfinity)valueandtheVIreturnstheUnderRange(0x3FFA2001)orOverRange(0x3FFA2002)warning.Testifthemeasurementvalueisoutofrangewiththe.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.channelnameThenameofthechannelfromwhichtoreadthemeasurement.
PassthevirtualchannelnamethatyouassigntotheinstrumentintheActionUtility.
Virtualchannelnamesarealiasesforinstrument-specificchannelstrings.Theinstrument-specificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseand
swapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.Youassignavirtualchannelnametoaninstrument-specificchannelthroughtheConfigurationUtility.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrument-specificchannelnames.
DefaultValue:""maximumtime(ms)Passthemaximumlengthoftimeinwhichtoallowthereadoperationtocomplete.Expressthisvalueinmilliseconds.
Iftheoperationdoesnotcompletewithinthistimeinterval,theVIreturnstheIVIPWRMETER_ERROR_MAX_TIME_EXCEEDED(0xBFFA2020)errorcode.Whenthisoccurs,youcancalltocancelthereadoperationandreturntheinstrumenttotheIdlestate.
DefinedValues:IVIPWRMETER_VAL_MAX_TIME_INFINITE(-1)-Waitindefinitelyforatimeout.IVIPWRMETER_VAL_MAX_TIME_IMMEDIATE(0)-Donotwaitforatimeout.
DefaultValue:5000
Notes
(1)TheMaximumTimeparameteraffectsonlythisVI.Ithasnoeffectonothertimeoutparametersorproperties.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptions
VIs.readingThedatareadfromthepowermeter.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviPwrMeterSendSoftwareTrigger[SWT]ThisVIsendsacommandtotriggerthepowermeter.CallthisVIifyoupassIVIPWRMETER_VAL_SOFTWARE_TRIGforthepropertyortheTriggerSourceparameterofthe.
Notes
(1)IftheisnotsettotheIVIPWRMETER_VAL_SOFTWARE_TRIGvalue,thisVIreturnsaTriggerNotSoftware(0xBFFA1001)error.
(2)ThisVIdoesnotchecktheinstrumentstatus.Typically,youcallthisVIonlyinasequenceofcallstootherlow-leveldriverVIs.Thesequenceperformsoneoperation.Youusethelow-levelVIstooptimizeoneormoreaspectsofinteractionwiththeinstrument.Ifyouwanttochecktheinstrumentstatus,calltheattheconclusionofthesequence.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.
Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviPwrMeterZero[ZC]IviPwrMeterZeroCorrectionCapabilityGroupThisVIperformsazerocorrectiononthespecifiedchannel.Youmayusethetodeterminewhenthezerocorrectioniscomplete.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.channelnameThenameforthechannelforwhichtoperformthezerocorrection.
PassthevirtualchannelnamethatyouassigntotheinstrumentintheActionUtility.
Virtualchannelnamesarealiasesforinstrument-specificchannelstrings.Theinstrument-specificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.Youassignavirtualchannelnametoaninstrument-specificchannelthroughtheConfigurationUtility.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrument-specificchannelnames.
DefaultValue:""errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtain
fromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviPwrMeterZeroAllChannels[ZC]IviPwrMeterZeroCorrectionCapabilityGroupThisVIperformsazerocorrectiononallenabledchannels.Youmayusethetodeterminewhenthezerocorrectioniscomplete.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviPwrMeterInitializeorIviPwrMeterInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviPwrMeterPropertiesExpandthisbooktoviewanalphabetizedlistofIviPwrMeterproperties.
IviPwrMeterAverageCount[AVG]IviPwrMeterAveragingCountPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W Channels Up IviPwrMeterConfigureAveragingCount[AVG]
DescriptionThischannel-basedpropertyspecifiestheaveragecountthattheinstrumentusesinmanualaveragingmode.WhentheIviPwrMeter>>BasicOperation>>AveragingAutoEnabledpropertyissettoFALSE,thedriverfilterstheinputsignalbyaveragingitthenumberoftimesspecifiedbythisproperty.
PropertyNodePathIviPwrMeter»AveragingCount>>AverageCount[AVG]
IviPwrMeterAveragingAutoEnabledIviPwrMeterBasePropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W Channels None IviPwrMeterConfigureAveragingAutoEnabled
DescriptionThischannel-basedpropertyspecifiestheauto-averagingmodeusedbytheinstrumentforthespecifiedinputchannel.Ifautoaveragingisenabled,theinstrumentdeterminesthebestvaluefortheaveragingcountautomatically.Theaveragingcountspecifiesthenumberofsamplesthattheinstrumenttakesbeforethemeasurementiscomplete.Ifautoaveragingisdisabled,specifytheaveragingcountexplicitlybysettingtheIviPwrMeter>>AveragingCount>>AverageCount[AVG]property.
PropertyNodePathIviPwrMeter»BasicOperation>>AveragingAutoEnabled
DefinedValuesVI_TRUEVI_FALSE
IviPwrMeterChannelCountIviPwrMeterBasePropertyDatatype Access Appliesto Coercion HighLevelVIs
R/W Channels None None
DescriptionReturnsthenumberofavailablechannels.
PropertyNodePathIviPwrMeter»InherentIVISettings»SpecificDriverCapabilities»ChannelCount
IviPwrMeterChannelEnabled[CH]IviPwrMeterChannelAcquisitionPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W Channels None IviPwrMeterConfigureChannelEnabled[CH]
DescriptionThischannel-basedpropertyspecifiesifthepowermetertakesameasurementonthespecifiedinputchannel.Thepowermeterwilltakeameasurementonachannelonlyifthatchannelisenabled.ChannelsarealsoenabledwhenyoucalltheIviPwrMeterConfigureMeasurement.vi.SeetheVIdescriptionformoredetails.
PropertyNodePathIviPwrMeter»BasicOperation>>ChannelAcquisition>>ChannelEnabled[CH]
DefinedValuesVI_TRUEVI_FALSE
IviPwrMeterCorrectionFrequencyIviPwrMeterBasePropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W Channels None IviPwrMeterConfigureCorrectionFrequency
DescriptionThischannel-basedpropertyspecifiesthefrequencyoftheinputsignalinHertz.Theinstrumentusesthisvaluetodeterminetheappropriatecorrectionfactorforthesensor.Toobtainthemostaccuratemeasurement,specifythecorrectionfrequencyascloseaspossibletotheactualfrequencyoftheinputsignal.
PropertyNodePathIviPwrMeter»BasicOperation>>CorrectionFrequency
IviPwrMeterDutyCycleCorrectionEnabled[DC]IviPwrMeterDutyCycleCorrectionPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W Channels None IviPwrMeterConfigureDutyCycleCorrection[DC]
DescriptionThischannel-basedpropertyspecifiesifthepowermeterperformsadutycyclecorrectiononthespecifiedchannel.
PropertyNodePathIviPwrMeter»DutyCycle>>DutyCycleCorrectionEnabled[DC]
DefinedValuesVI_TRUEVI_FALSE
IviPwrMeterDutyCycleCorrection[DC]IviPwrMeterDutyCycleCorrectionPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W Channels Up IviPwrMeterConfigureDutyCycleCorrection[DC]
DescriptionThischannel-basedpropertyspecifiesthedutycyclecorrectionthepowermeterusestocalculatethepulsepowerofapulse-modulatedsignal.Thepowermetermeasurestheaveragepowerofthepulsedinputsignalandthendividestheresultbythevaluespecifiedforthispropertytoobtainapulsepowerreading.Thevalueofthispropertyisspecifiedasapercentage.
PropertyNodePathIviPwrMeter»DutyCycle>>DutyCycleCorrection[DC]
IviPwrMeterInternalTriggerEventSource[IT]IviPwrMeterInternalTriggerPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviPwrMeterConfigureInternalTrigger[IT]
DescriptionSpecifiesthechannelthatthepowermeterusestomonitortheinternaltriggerevent.ThepowermeterleavestheIdlestatewhenthemeasurementsignalonthischannelmeetstheconditionssetbytheIviPwrMeter>>Trigger>>InternalTrigger>>InternalTriggerLevel[IT]andtheIviPwrMeter>>Trigger>>InternalTrigger>>InternalTriggerSlope[IT]properties.ThispropertyaffectsthebehavioroftheinstrumentonlyiftheIviPwrMeter>>Trigger>>TriggerSource[TRG]propertyissettoInternal.
PropertyNodePathIviPwrMeter»Trigger>>InternalTrigger>>InternalTriggerEventSource[IT]
IviPwrMeterInternalTriggerLevel[IT]IviPwrMeterInternalTriggerPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviPwrMeterConfigureInternalTriggerLevel[IT]
DescriptionSpecifiesthetriggerlevelforthemeasurementsignal.ThepowermeterleavestheIdlestatewhenthemeasurementsignalonthechannelspecifiedbytheIviPwrMeter>>Trigger>>InternalTrigger>>InternalTriggerEventSource[IT]propertycrossesthevaluespecifiedbythisproperty.ThevalueofthispropertyisspecifiedinthesameunitasthevalueoftheIviPwrMeter>>BasicOperation>>Units.ThispropertyaffectsthebehavioroftheinstrumentonlyiftheIviPwrMeter>>Trigger>>TriggerSource[TRG]propertyissettoInternal.
PropertyNodePathIviPwrMeter»Trigger>>InternalTrigger>>InternalTriggerLevel[IT]
IviPwrMeterInternalTriggerSlope[IT]IviPwrMeterInternalTriggerPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviPwrMeterConfigureInternalTrigger[IT]
DescriptionSpecifiesthepolarityoftheinternaltriggerslope.Thepowermetertriggersontherisingorfallingedgeoftheinternaltriggersourcedependingonthevalueofthisproperty.ThispropertyaffectsthebehavioroftheinstrumentonlyiftheIviPwrMeter>>Trigger>>TriggerSource[TRG]propertyissettoInternal.
PropertyNodePathIviPwrMeter»Trigger>>InternalTrigger>>InternalTriggerSlope[IT]
DefinedValuesIVIPWRMETER_VAL_POSITIVEIVIPWRMETER_VAL_NEGATIVE
IviPwrMeterOffsetIviPwrMeterBasePropertyDatatype Access Appliesto Coercion HighLevelVIs
R/W Channels None None
DescriptionThischannel-basedpropertyspecifiesanoffsettobeaddedtothemeasuredvalueonachannelinunitsofdB.Thispropertycanbeusedtocompensateforsystemlossesorgainsbetweentheunitundertestandthesensorofthepowermeter.Apositivevalueisusedforlosscompensation.Anegativevalueisusedforgaincompensation.Forexample,acablelossof2dBcouldbecompensatedforbysettingthispropertyto+2.Similarly,againstageof10dBcouldbeaccountedforbysettingthevalueofthispropertyto-10.Inbothcases,thereadingfromthepowermeterwillindicatethepowerattheunitundertestratherthanpoweratthepowermeter'ssensor.
PropertyNodePathIviPwrMeter»BasicOperation>>Offset
IviPwrMeterRangeAutoEnabledIviPwrMeterBasePropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W Channels None IviPwrMeterConfigureRangeAutoEnabled
DescriptionThischannel-basedpropertyspecifiesifthepowermetershouldautomaticallydeterminethebestrangeforthemeasurement.IfthispropertyissettoTRUE,theinstrumentautomaticallydeterminesthebestrangeforthemeasurement.IfthispropertyissettoFALSE,specifythelowerandupperlimitsofthemeasurementrangebyexplicitlysettingtheIviPwrMeter>>ManualRange>>RangeLower[RNG]andIviPwrMeter>>ManualRange>>RangeUpper[RNG]properties.
PropertyNodePathIviPwrMeter»BasicOperation>>RangeAutoEnabled
DefinedValuesVI_TRUEVI_FALSE
IviPwrMeterRangeLower[RNG]IviPwrMeterManualRangePropertyDatatype Access Appliesto Coercion HighLevelVIs
R/W Channels Down IviPwrMeterConfigureRange[RNG]
DescriptionThischannel-basedpropertyspecifiesthelowerlimit(minimum)oftheexpectedvalueofthemeasurement.Thespecificdrivercoercesthisvaluetotheappropriaterangefortheinstrument.ThevalueofthispropertyisspecifiedinthesameunitsasthevalueoftheIviPwrMeter>>BasicOperation>>Unitsproperty.ThispropertyaffectsthebehavioroftheinstrumentonlywhentheIviPwrMeter>>BasicOperation>>RangeAutoEnabledpropertyissettoFALSE.
PropertyNodePathIviPwrMeter»ManualRange>>RangeLower[RNG]
IviPwrMeterRangeUpper[RNG]IviPwrMeterManualRangePropertyDatatype Access Appliesto Coercion HighLevelVIs
R/W Channels Up IviPwrMeterConfigureRange[RNG]
DescriptionThischannel-basedpropertyspecifiestheupperlimit(maximum)oftheexpectedvalueofthemeasurement.Thespecificdrivercoercesthisvaluetotheappropriaterangefortheinstrument.ThevalueofthispropertyisspecifiedinthesameunitsasthevalueoftheIviPwrMeter>>BasicOperation>>Units.ThispropertyaffectsthebehavioroftheinstrumentonlywhentheIviPwrMeter>>BasicOperation>>RangeAutoEnabledpropertyissettoFALSE.
PropertyNodePathIviPwrMeter»ManualRange>>RangeUpper[RNG]
IviPwrMeterRefOscillatorEnabled[RO]IviPwrMeterReferenceOscillatorPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviPwrMeterConfigureReferenceOscillatorEnabled[RO]
DescriptionSpecifiesiftheinternalreferenceoscillatorisenabled.
PropertyNodePathIviPwrMeter»ReferenceOscillator>>RefOscillatorEnabled[RO]
DefinedValuesVI_TRUEVI_FALSE
IviPwrMeterRefOscillatorFrequency[RO]IviPwrMeterReferenceOscillatorPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviPwrMeterConfigureReferenceOscillator[RO]
DescriptionSpecifiesthefrequencyofthesignalgeneratedbythereferenceoscillatorinHertz.ThispropertyaffectsthebehavioroftheinstrumentonlyiftheIviPwrMeter>>ReferenceOscillator>>RefOscillatorEnabled[RO]propertyissettoTRUE.
PropertyNodePathIviPwrMeter»ReferenceOscillator>>RefOscillatorFrequency[RO]
IviPwrMeterRefOscillatorLevel[RO]IviPwrMeterReferenceOscillatorPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviPwrMeterConfigureReferenceOscillator[RO]
DescriptionSpecifiesthepowerlevelofthesignalgeneratedbythereferenceoscillatorindBm.ThispropertyaffectsthebehavioroftheinstrumentonlyiftheIviPwrMeter>>ReferenceOscillator>>RefOscillatorEnabled[RO]propertyissettoTRUE.
PropertyNodePathIviPwrMeter»ReferenceOscillator>>RefOscillatorLevel[RO]
IviPwrMeterTriggerSource[TRG]IviPwrMeterTriggerSourcePropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviPwrMeterConfigureTriggerSource[TRG]
DescriptionSpecifiesthetriggersourcethepowermetermonitorsforthetriggerevent.Whenthetriggereventoccursonthesourcespecifiedbythisproperty,thepowermeterleavestheWait-For-Triggerstateandtakesameasurementonallenabledchannels.IfthispropertyissettotheInternaldefinedvalue,thepowermeterusesthechannelspecifiedbytheIviPwrMeter>>Trigger>>InternalTrigger>>InternalTriggerEventSource[IT]propertytomonitortheinternaltriggerevent.
PropertyNodePathIviPwrMeter»Trigger>>TriggerSource[TRG]
DefinedValuesIVIPWRMETER_VAL_IMMEDIATEIVIPWRMETER_VAL_EXTERNALIVIPWRMETER_VAL_INTERNALIVIPWRMETER_VAL_SOFTWARE_TRIGIVIPWRMETER_VAL_TTL0IVIPWRMETER_VAL_TTL1IVIPWRMETER_VAL_TTL2IVIPWRMETER_VAL_TTL3IVIPWRMETER_VAL_TTL4IVIPWRMETER_VAL_TTL5IVIPWRMETER_VAL_TTL6IVIPWRMETER_VAL_TTL7IVIPWRMETER_VAL_ECL0IVIPWRMETER_VAL_ECL1IVIPWRMETER_VAL_PXI_STARIVIPWRMETER_VAL_RTSI_0IVIPWRMETER_VAL_RTSI_1IVIPWRMETER_VAL_RTSI_2IVIPWRMETER_VAL_RTSI_3IVIPWRMETER_VAL_RTSI_4IVIPWRMETER_VAL_RTSI_5IVIPWRMETER_VAL_RTSI_6
IviPwrMeterUnitsIviPwrMeterBasePropertyDatatype Access Appliesto Coercion HighLevelVIs
R/W N/A None IviPwrMeterConfigureUnits
DescriptionSpecifiestheunittowhichtheRFpowerisconvertedaftermeasurement.TheactualRFpowerofthesignalonachannelisalwaysmeasuredinWatts.ThevalueofthispropertyisusedtodeterminetheunitsinwhichtheIviPwrMeter>>ManualRange>>RangeUpper[RNG]andIviPwrMeter>>ManualRange>>RangeLower[RNG]propertiesarespecified.TheunitofthemeasurementresultreturnedbytheReadandFetchVIsalsodependsonthevalueofthisproperty.
PropertyNodePathIviPwrMeter»BasicOperation>>Units
DefinedValuesIVIPWRMETER_VAL_DBMIVIPWRMETER_VAL_DBMVIVIPWRMETER_VAL_DBUVIVIPWRMETER_VAL_WATTS
IviPwrMeterDefinedValuesExpandthisbooktoviewanalphabetizedlistofIviPwrMeterdefinedvalues.
IVIPWRMETER_VAL_CALIBRATION_COMPLETEDescriptionThepowermeterhascompletedthecalibrationonallenabledchannels.
DefinedValue1
IVIPWRMETER_VAL_CALIBRATION_IN_PROGRESSDescriptionThepowermeterisstilltakingacalibrationononeormoreenabledchannels.
DefinedValue0
IVIPWRMETER_VAL_CALIBRATION_STATUS_UNKNOWNDescriptionThepowermetercannotdeterminethestatusofthecalibration.
DefinedValue-1
IVIPWRMETER_VAL_DBMDescriptionSetstheunitstodBm.
DefinedValue1
IVIPWRMETER_VAL_DBMVDescriptionSetstheunitstodBmillivolts.
DefinedValue2
IVIPWRMETER_VAL_DBUVDescriptionSetstheunitstodBmicrovolts.
DefinedValue3
IVIPWRMETER_VAL_DIFFERENCEDescriptionSubtractthepowermeasuredonOperand2fromthepowermeasuredonOperand1.
DefinedValue1
IVIPWRMETER_VAL_ECL0DescriptionThepowermeterexitstheWait-For-TriggerstatewhenitreceivesatriggeronECL0.
DefinedValue200
IVIPWRMETER_VAL_ECL1DescriptionThepowermeterexitstheWait-For-TriggerstatewhenitreceivesatriggeronECL1.
DefinedValue201
IVIPWRMETER_VAL_EXTERNALDescriptionThepowermeterexitstheWait-For-Triggerstatewhenatriggeroccursontheexternaltriggerinput.
DefinedValue2
IVIPWRMETER_VAL_IMMEDIATEDescriptionThepowermeterexitstheWait-For-Triggerstateimmediatelyafterentering.Itdoesnotwaitforatriggerofanykind.
DefinedValue1
IVIPWRMETER_VAL_INTERNALDescriptionThepowermeterexitstheWait-For-Triggerstatewhenaninternaltriggereventoccursonthemeasurementsignal.
DefinedValue3
IVIPWRMETER_VAL_MEAS_COMPLETEDescriptionThepowermeterhascompletedthemeasurementonallenabledchannels.
DefinedValue1
IVIPWRMETER_VAL_MEAS_IN_PROGRESSDescriptionThepowermeterisstilltakingameasurementononeormoreenabledchannels.
DefinedValue0
IVIPWRMETER_VAL_MEAS_STATUS_UNKNOWNDescriptionThepowermetercannotdeterminethestatusofthemeasurement.
DefinedValue-1
IVIPWRMETER_VAL_NEGATIVEDescriptionSetsthetriggereventtooccuronthefallingedgeofthetriggerpulse.
DefinedValue0
IVIPWRMETER_VAL_NONEDescriptionReturnthemeasuredvalueforOperand1.
DefinedValue0
IVIPWRMETER_VAL_POSITIVEDescriptionSetsthetriggereventtooccurontherisingedgeofthetriggerpulse.
DefinedValue1
IVIPWRMETER_VAL_PXI_STARDescriptionThepowermeterexitstheWait-For-TriggerstatewhenitreceivesatriggeronPXIStartriggerbus.
DefinedValue300
IVIPWRMETER_VAL_QUOTIENTDescriptionDividethepowermeasuredonOperand1bythepowermeasuredonOperand2.
DefinedValue3
IVIPWRMETER_VAL_RTSI_0DescriptionThepowermeterexitstheWait-For-TriggerstatewhenitreceivesatriggerontheRTSI0line.
DefinedValue400
IVIPWRMETER_VAL_RTSI_1DescriptionThepowermeterexitstheWait-For-TriggerstatewhenitreceivesatriggerontheRTSI1line.
DefinedValue401
IVIPWRMETER_VAL_RTSI_2DescriptionThepowermeterexitstheWait-For-TriggerstatewhenitreceivesatriggerontheRTSI2line.
DefinedValue402
IVIPWRMETER_VAL_RTSI_3DescriptionThepowermeterexitstheWait-For-TriggerstatewhenitreceivesatriggerontheRTSI3line.
DefinedValue403
IVIPWRMETER_VAL_RTSI_4DescriptionThepowermeterexitstheWait-For-TriggerstatewhenitreceivesatriggerontheRTSI4line.
DefinedValue404
IVIPWRMETER_VAL_RTSI_5DescriptionThepowermeterexitstheWait-For-TriggerstatewhenitreceivesatriggerontheRTSI5line.
DefinedValue405
IVIPWRMETER_VAL_RTSI_6DescriptionThepowermeterexitstheWait-For-TriggerstatewhenitreceivesatriggerontheRTSI6line.
DefinedValue406
IVIPWRMETER_VAL_SOFTWARE_TRIGDescriptionThepowermeterexitstheWait-For-Triggerstatewhenitreceivesasoftwaretrigger.
DefinedValue4
IVIPWRMETER_VAL_SUMDescriptionAddthepowermeasuredonOperand2tothepowermeasuredonOperand1.
DefinedValue2
IVIPWRMETER_VAL_TTL0DescriptionThepowermeterexitstheWait-For-TriggerstatewhenitreceivesatriggeronTTL0.
DefinedValue100
IVIPWRMETER_VAL_TTL1DescriptionThepowermeterexitstheWait-For-TriggerstatewhenitreceivesatriggeronTTL1.
DefinedValue101
IVIPWRMETER_VAL_TTL2DescriptionThepowermeterexitstheWait-For-TriggerstatewhenitreceivesatriggeronTTL2.
DefinedValue102
IVIPWRMETER_VAL_TTL3DescriptionThepowermeterexitstheWait-For-TriggerstatewhenitreceivesatriggeronTTL3.
DefinedValue103
IVIPWRMETER_VAL_TTL4DescriptionThepowermeterexitstheWait-For-TriggerstatewhenitreceivesatriggeronTTL4.
DefinedValue104
IVIPWRMETER_VAL_TTL5DescriptionThepowermeterexitstheWait-For-TriggerstatewhenitreceivesatriggeronTTL5.
DefinedValue105
IVIPWRMETER_VAL_TTL6DescriptionThepowermeterexitstheWait-For-TriggerstatewhenitreceivesatriggeronTTL6.
DefinedValue106
IVIPWRMETER_VAL_TTL7DescriptionThepowermeterexitstheWait-For-TriggerstatewhenitreceivesatriggeronTTL7.
DefinedValue107
IVIPWRMETER_VAL_WATTSDescriptionSetstheunitstoWatts.
DefinedValue4
IVIPWRMETER_VAL_ZERO_COMPLETEDescriptionThepowermeterhascompletedallzerocorrectionoperations.
DefinedValue1
IVIPWRMETER_VAL_ZERO_IN_PROGRESSDescriptionThepowermeterisstillperformingazerocorrectionononeormoreenabledchannels.
DefinedValue0
IVIPWRMETER_VAL_ZERO_STATUS_UNKNOWNDescriptionThepowermetercannotdeterminethestatusofthezerocorrection.
DefinedValue-1
IviRFSigGenClassDriverReferenceforLabVIEWIviRFSigGenVIandPropertyReferenceVITreePropertiesbyGroupErrorandCompletionCodes
IviRFSigGenClassDriverOverviewThisinstrumentdriverprovidesprogrammingsupportfortheIviRFSigGenClass.TheIviRFSigGenclassisdesignedtosupportthetypicalRFsignalgeneratoraswellascommonextendedfunctionalityfoundinmorecomplexinstruments.TheIviRFSigGenclassconceptualizesaRFsignalgeneratorasaninstrumentthatcangenerateasinusoidalcarrierwaveformwithawidevarietyofmodulationtypes.ThedrivercontainsalltheVIsrequiredintheIviRFSigGenspecificationdefinedbytheIVIFoundation.ThisdriverrequiresNI-VISAandtheIVICompliancePackagetobeinstalled.TheIviRFSigGenclassisdividedintoabasecapabilitygroupandseveralextensiongroups.Thebasecapabilitygroupisusedtoconfigurethecarrierwaveform.Thisincludessettingtheoutputfrequencyandamplitude,enablingordisablingtheALCandtheRFoutput.
IviRFSigGenExtensionCapabilityGroupsTheIviRFSigGenclassdriveridentifiesVIsandthatbelongtoanextensiongroupwiththefollowingabbreviations.Instrumentspecificdriversarenotrequiredtoimplementanyoftheextensioncapabilitygroups.IfyouuseVIsandthatbelongtoextensioncapabilitygroups,everyinstrumentspecificdriverthatyouusemustimplementthoseextensions.
GroupName Description
AnalogandPulseModulationExtensionGroups
IviRFSigGenModulateAM SupportssignalgeneratorsthatcanapplyamplitudemodulationtotheRFoutputsignal.Youcanenableordisableamplitudemodulation,specifythesourceandcouplingofthemodulatingsignalandthemodulationdepthwithlinearorlogarithmicattenuation.
IviRFSigGenModulateFM SupportssignalgeneratorsthatcanapplyfrequencymodulationtotheRFoutputsignal.Youcanenableordisablefrequencymodulation,specifythesourceandcouplingofthemodulatingsignalandthepeakfrequencydeviation.
IviRFSigGenModulatePM SupportssignalgeneratorsthatcanapplyphasemodulationtotheRFoutputsignal.Youcanenableordisablephasemodulation,specifythesourceandcouplingofthemodulatingsignalandthepeakphasedeviation.
IviRFSigGenAnalogModulationSource Thesourceofthemodulatingsignalisarepeatedcapability.Oneor
moreinternalsources(LFGenerators)and/oroneandmoreexternalsourcescanbecombined.ThevoltageofallsignalsissummedbeforemodulatingtheRFSignal.
IviRFSigGenModulatePulse SupportssignalgeneratorsthatcanapplypulsemodulationtotheRFoutputsignal.Youcanenableordisablepulsemodulation,andspecifythesourceandthepolarityofthemodulatingsignal.
IviRFSigGenLFGenerator SupportstheLFgenerator(withintheRFsignalgenerator),thatisnormallyusedasasourceforthemodulators.TousetheLFgeneratorasamodulationsource,themodulationsourceintheModulateAMextensionsgroup,ModulateFMextensiongrouporModulatePMextensiongroupshouldbeconfigured.TheusercansetthefrequencyandthewaveformoftheLFsignal.
IviRFSigGenLFGeneratorOutput SupportstheoutputoftheLFgenerator,ifitisusedasasourceforexternaldevices.Youcansettheamplitudeandenableordisabletheoutput.RequirestheLFGeneratorextensiongroup.
IviRFSigGenPulseGenerator Supportsthepulsegeneratorwithinthesignalgeneratorthatisnormallyusedasasourceforthepulsemodulator.Youcansetthepulseperiod,widthanddelay.Thepulsecanbetriggered,sosourceandexternaltriggerpolaritycanbeset.
DoublepulsecanbesetwiththefunctionsandattributesoftheIviRFSigGenPulseDoubleGeneratorextensiongroup.TheoutputofthepulsegeneratorcanbesetwiththefunctionsandattributesoftheIviRFSigGenPulseOutputextensiongroup.
IviRFSigGenPulseDoubleGenerator ExtendstheIviRFSigGenPulseGeneratorextensiongrouptosupportdoublepulsegeneration.
IviRFSigGenPulseGeneratorOutput RequirestheIviRFSigGenPulseGeneratorextensiongroup.Theoutputofthepulsegeneratorcanbeenabledordisabledanditspolarityset.
SweepExtensionGroups
IviRFSigGenSweep Supportssignalgeneratorswiththeabilitytosweep(orstep)thefrequencyorthepoweroftheRFoutputsignal.
IviRFSigGenFrequencySweep Supportssignalgeneratorsthatcanapplyafrequencysweeptotheoutputsignal.Youmayconfigurethesweepwithstartandstop,orcenterandspanfrequencies.Thesweeptimeisalsoconfigurable.InordertosupporttheIviRFSigGenFrequencySweepextensiongroup,adrivershallfirstsupporttheIviRFSigGenSweepextensiongroup.ThisextensiongroupisactivewhentheSweepModeattributeissettoFrequency
Sweep.IviRFSigGenPowerSweep Supportssignalgeneratorsthatcan
applyapowersweeptotheoutputsignal.Youmayconfigurethesweepwithstartandstoppower.Thesweeptimeisalsoconfigurable.Inordertosupportthisextensiongroup,adrivershallfirstsupporttheIviRFSigGenSweepextensiongroup.ThisextensiongroupisactivewhentheSweepModeattributeissettoPowerSweep.
IviRFSigGenFrequencyStep Supportssignalgeneratorsthatcanvary(sweep)thefrequencyoftheRFoutputsignalinsteps.Youcanspecifythestart,stopandstepfrequencyandsetlinearorlogarithmicspacing.Settingsinglestepanddwelltimearealsoincluded.ThisextensiongrouprequirestheIviRFSigGenSweepextensiongroup.FrequencysteppingisenabledbysettingtheSweepModetoFrequencyStepintheIviRFSigGenSweepextensiongroup.
IviRFSigGenPowerStep Supportssignalgeneratorsthatcanvary(sweep)thepoweroftheRFoutputsignalinsteps.Theusercanenableordisablestepping,specifythestart,stopandsteppower.Settingsinglestepanddwelltimearealsoincluded.ThisextensiongrouprequirestheSweepextensiongroup.PowersteppingisenabledbysettingtheSweepModetoPowerStepinthe
IviRFSigGenSweepextensiongroup.
IviRFSigGenList SupportssignalgeneratorsthatcansetthefrequencyandpoweroftheRFoutputsignaltovaluesgivenasalistofvalues.Youcanenableordisablesteppingthefrequencyandpowerlist,specifythenameofthelistandsetitsvalues.Theactivelistcanbeselectedusingthelistname.Settingsinglestepanddwelltimearealsoincluded.ThisextensiongrouprequirestheSweepextensiongroup.ListsteppingisenabledbysettingtheSweepModetoListintheIviRFSigGenSweepextensiongroup.
DigitalModulationExtensionGroups
IviRFSigGenModulateIQ SupportssignalgeneratorsthatcanapplyIQ(vector)modulationtotheRFoutputsignal.YoucanenableordisableIQmodulationandspecifythesourceofthemodulatingsignal.Acalibrationisexecutedwithaneventfunction.
IviRFSigGenImpairmentIQ SupportssignalgeneratorsthatcanapplyIQ(vector)modulationtotheRFoutputsignal.YoucanenableordisableIQmodulationandspecifythesourceofthemodulatingsignal.Acalibrationisexecutedwithaneventfunction.
IviRFSigGenArbGenerator Controlstheinternalarbitrarywaveformgenerator.Thetwo
outputsoftheArbgeneratorareusedwiththeIQ(vector)modulationtosimulatedigitalmodulation.ThisgroupisanextensionoftheIviRFSigGenModulateIQextensiongroup.
IviRFSigGenDigitalModulationBase Usingthisextensiongroup,youcangeneratesignalsconformingtowirelesscommunicationstandards(e.g.mobilecellularstandards).ThegeneratedsignalsdonothaveTDMAframingnorCDMAchannelcoding.ThefunctionalitycoversbasicmodulationpropertiessuchasIQconstellation,symbolmapping,etc.withinaspecifiedcommunicationstandard.
IviRFSigGenCDMABase Usethisextensiongrouptosimulatemobile(cell)phonemodulationbasedonCodeDivisionMultipleAccess(CDMA)standards.
IviRFSigGenTDMABase Usethisextensiongrouptosimulatemobile(cell)phonemodulationbasedonTimeDivisionMultipleAccess(TDMA)standards.
RemainingExtensionGroups
IviRFSigGenALC ForgeneratorswithconfigurableAutomaticLevelControl.
IviRFSigGenReferenceOscillator Supportssignalgeneratorswithaconfigurablefrequencyreference.
IviRFSigGenSoftwareTrigger SupportsRFsignalgeneratorsthatcangenerateoutputbasedonasoftwaretriggersignal.Youcansendasoftwaretriggertocausesignaloutputtooccur,tostarta
sweep(frequencyorpower),ortoinitiatethenextstep(frequencyand/orpower).
RelatedTopicIVIInherentClassCapabilities
IviRFSigGenExtensionCapabilityGroupsTheIviRFSigGenclassdriveridentifiesVIsandthatbelongtoanextensiongroupwiththefollowingabbreviations.Instrumentspecificdriversarenotrequiredtoimplementanyoftheextensioncapabilitygroups.IfyouuseVIsandthatbelongtoextensioncapabilitygroups,everyinstrumentspecificdriverthatyouusemustimplementthoseextensions.
GroupName DescriptionIviRFSigGenModulateAM Supportssignalgeneratorsthatcan
applyamplitudemodulationtotheRFoutputsignal.Youcanenableordisableamplitudemodulation,specifythesourceandcouplingofthemodulatingsignalandthemodulationdepthwithlinearorlogarithmicattenuation.
IviRFSigGenModulateFM SupportssignalgeneratorsthatcanapplyfrequencymodulationtotheRFoutputsignal.Youcanenableordisablefrequencymodulation,specifythesourceandcouplingofthemodulatingsignalandthepeakfrequencydeviation.
IviRFSigGenModulatePM SupportssignalgeneratorsthatcanapplyphasemodulationtotheRFoutputsignal.Youcanenableordisablephasemodulation,specifythesourceandcouplingofthemodulatingsignalandthepeakphasedeviation.
IviRFSigGenAnalogModulationSource Thesourceofthemodulatingsignalisarepeatedcapability.Oneormoreinternalsources(LFGenerators)and/oroneandmoreexternalsourcescanbecombined.
ThevoltageofallsignalsissummedbeforemodulatingtheRFSignal.
IviRFSigGenModulatePulse SupportssignalgeneratorsthatcanapplypulsemodulationtotheRFoutputsignal.Youcanenableordisablepulsemodulation,andspecifythesourceandthepolarityofthemodulatingsignal.
IviRFSigGenLFGenerator SupportstheLFgenerator(withintheRFsignalgenerator),thatisnormallyusedasasourceforthemodulators.TousetheLFgeneratorasamodulationsource,themodulationsourceintheModulateAMextensionsgroup,ModulateFMextensiongrouporModulatePMextensiongroupshouldbeconfigured.TheusercansetthefrequencyandthewaveformoftheLFsignal.
IviRFSigGenLFGeneratorOutput SupportstheoutputoftheLFgenerator,ifitisusedasasourceforexternaldevices.Youcansettheamplitudeandenableordisabletheoutput.RequirestheLFGeneratorextensiongroup.
IviRFSigGenPulseGenerator Supportsthepulsegeneratorwithinthesignalgeneratorthatisnormallyusedasasourceforthepulsemodulator.Youcansetthepulseperiod,widthanddelay.Thepulsecanbetriggered,sosourceandexternaltriggerpolaritycanbeset.DoublepulsecanbesetwiththeVIsandoftheIviRFSigGenPulseDoubleGenerator
extensiongroup.TheoutputofthepulsegeneratorcanbesetwiththeVIsandoftheIviRFSigGenPulseOutputextensiongroup.
IviRFSigGenPulseDoubleGenerator ExtendstheIviRFSigGenPulseGeneratorextensiongrouptosupportdoublepulsegeneration.
IviRFSigGenPulseGeneratorOutput RequirestheIviRFSigGenPulseGeneratorextensiongroup.Theoutputofthepulsegeneratorcanbeenabledordisabledanditspolarityset.
IviRFSigGenSweep Supportssignalgeneratorswiththeabilitytosweep(orstep)thefrequencyorthepoweroftheRFoutputsignal.
IviRFSigGenFrequencySweep Supportssignalgeneratorsthatcanapplyafrequencysweeptotheoutputsignal.Youmayconfigurethesweepwithstartandstop,orcenterandspanfrequencies.Thesweeptimeisalsoconfigurable.InordertosupporttheIviRFSigGenFrequencySweepextensiongroup,adrivershallfirstsupporttheIviRFSigGenSweepextensiongroup.ThisextensiongroupisactivewhentheSweepModepropertyissettoFrequencySweep.
IviRFSigGenPowerSweep Supportssignalgeneratorsthatcanapplyapowersweeptotheoutputsignal.Youmayconfigurethesweepwithstartandstoppower.Thesweeptimeisalso
configurable.Inordertosupportthisextensiongroup,adrivershallfirstsupporttheIviRFSigGenSweepextensiongroup.ThisextensiongroupisactivewhentheSweepModepropertyissettoPowerSweep.
IviRFSigGenFrequencyStep Supportssignalgeneratorsthatcanvary(sweep)thefrequencyoftheRFoutputsignalinsteps.Youcanspecifythestart,stopandstepfrequencyandsetlinearorlogarithmicspacing.Settingsinglestepanddwelltimearealsoincluded.ThisextensiongrouprequirestheIviRFSigGenSweepextensiongroup.FrequencysteppingisenabledbysettingtheSweepModetoFrequencyStepintheIviRFSigGenSweepextensiongroup.
IviRFSigGenPowerStep Supportssignalgeneratorsthatcanvary(sweep)thepoweroftheRFoutputsignalinsteps.Theusercanenableordisablestepping,specifythestart,stopandsteppower.Settingsinglestepanddwelltimearealsoincluded.ThisextensiongrouprequirestheIviRFSigGenSweepextensiongroup.PowersteppingisenabledbysettingtheSweepModeattributetoPowerStepintheIviRFSigGenSweepextensiongroup.
IviRFSigGenList SupportssignalgeneratorsthatcansetthefrequencyandpoweroftheRFoutputsignaltovaluesgivenas
alistofvalues.Youcanenableordisablesteppingthefrequencyandpowerlist,specifythenameofthelistandsetitsvalues.Theactivelistcanbeselectedusingthelistname.Settingsinglestepanddwelltimearealsoincluded.ThisextensiongrouprequirestheIviRFSigGenSweepextensiongroup.ListsteppingisenabledbysettingtheSweepModetoListintheIviRFSigGenSweepExtensionGroup.
IviRFSigGenALC ForgeneratorswithconfigurableAutomaticLevelControl.
IviRFSigGenReferenceOscillator Supportssignalgeneratorswithaconfigurablefrequencyreference.
IviRFSigGenSoftwareTrigger SupportsRFsignalgeneratorsthatcangenerateoutputbasedonasoftwaretriggersignal.Youcansendasoftwaretriggertocausesignaloutputtooccur,tostartasweep(frequencyorpower),ortoinitiatethenextstep(frequencyand/orpower).ThisextensionaffectsinstrumentbehaviorwhentheTriggerSourcepropertyissettoSoftwareTrigger.
IviRFSigGenModulateIQ SupportssignalgeneratorsthatcanapplyIQ(vector)modulationtotheRFoutputsignal.YoucanenableordisableIQmodulationandspecifythesourceofthemodulatingsignal.AcalibrationisexecutedwithaneventVI.
IviRFSigGenIQImpairment SimulatesorcorrectsimpairmentonIQ(vector)modulation.This
groupisanextensionoftheIviRFSigGenModulateIQExtensionGroup.
IviRFSigGenArbGenerator Controlstheinternalarbitrarywaveformgenerator.ThetwooutputsoftheArbgeneratorareusedwiththeIQ(vector)modulationtosimulatedigitalmodulation.ThisgroupisanextensionoftheIviRFSigGenModulateIQExtensionGroup.
IviRFSigGenDigitalModulationBase Usingthisextensiongroup,youcangeneratesignalsconformingtowirelesscommunicationstandards(e.g.mobilecellularstandards).ThegeneratedsignalsdonothaveTDMAframingnorCDMAchannelcoding.ThefunctionalitycoversbasicmodulationpropertiessuchasIQconstellation,symbolmapping,etc.withinaspecifiedcommunicationstandard.
IviRFSigGenCDMABase Usethisextensiongrouptosimulatemobile(cell)phonemodulationbasedonCodeDivisionMultipleAccess(CDMA)standards.
IviRFSigGenTDMABase Usethisextensiongrouptosimulatemobile(cell)phonemodulationbasedonTimeDivisionMultipleAccess(TDMA)standards.
IviRFSigGenALCExtensionGroupForgeneratorswithconfigurableAutomaticLevelControl.
IviRFSigGenALCVIIviRFSigGen_ConfigureALC
IviRFSigGenALCPropertiesIVIRFSIGGEN_ATTR_ALC_SOURCEIVIRFSIGGEN_ATTR_ALC_BANDWIDTH
IviRFSigGenAnalogModulationSourceExtensionGroupThesourceofthemodulatingsignalisarepeatedcapability,whichisreferredtoasAnalogModulationSource.Oneormoreinternalsources(LFGenerators)and/oroneandmoreexternalsourcescanbecombined.ThevoltageofallsignalsissummedbeforemodulatingtheRFSignal.Thisappliestothefollowingextensiongroups:
IviRFSigGenModulateAMIviRFSigGenModulateFMIviRFSigGenModulatePM
Typically,alltheLFGeneratorsdefinedintheIviRFSigGenLFGeneratorextensiongrouphaveacorrespondingAnalogModulationSource(orrepeatedcapability).
IviRFSigGenAnalogModulationSourceVIIviRFSigGen_Get_Analog_Modulation_Source_Name
IviRFSigGenAnalogModulationSourceAttributeIVIRFSIGGEN_ATTR_ANALOG_MODULATION_SOURCE_COUNT
IviRFSigGenArbGeneratorExtensionGroupTheIviRFSigGenArbGeneratorextensiongroupcontrolstheinternalarbitrarywaveformgenerator.ThetwooutputsoftheArbgeneratorareusedwiththeIQ(vector)modulationtosimulatedigitalmodulation.SothisgroupisanextensionoftheIviRFSigGenModulateIQextensiongroup.
IviRFSigGenArbGeneratorVIsIviRFSigGen_Configure_ArbIviRFSigGen_Write_Arb_WaveformIviRFSigGen_Select_Arb_WaveformIviRFSigGen_Clear_All_Arb_WaveformsIviRFSigGen_Query_Arb_Waveform_CapabilitiesIviRFSigGen_Configure_Arb_Trigger_SourceIviRFSigGen_Configure_Arb_External_Trigger_Slope
IviRFSigGenArbGeneratorPropertiesIVIRFSIGGEN_ATTR_ARB_SELECTED_WAVEFORMIVIRFSIGGEN_ATTR_ARB_CLOCK_FREQUENCYIVIRFSIGGEN_ATTR_ARB_FILTER_FREQUENCYIVIRFSIGGEN_ATTR_ARB_MAX_NUMBER_WAVEFORMSIVIRFSIGGEN_ATTR_ARB_WAVEFORM_QUANTUMIVIRFSIGGEN_ATTR_ARB_WAVEFORM_SIZE_MINIVIRFSIGGEN_ATTR_ARB_WAVEFORM_SIZE_MAXIVIRFSIGGEN_ATTR_ARB_TRIGGER_SOURCEIVIRFSIGGEN_ATTR_ARB_EXTERNAL_TRIGGER_SLOPE
IviRFSigGenBaseCapabilityGroupTheIviRFSigGenBasecapabilitiesgroupsupportsthebasicsignalgeneratorcapabilities.
IviRFSigGenVIsIviRFSigGen_ConfigureRFIviRFSigGen_ConfigureALCEnabledIviRFSigGen_ConfigureOutputEnabledIviRFSigGen_DisableAllModulationIviRFSigGen_WaitUntilSettledIviRFSigGen_IsSettled
IviRFSigGenPropertiesIVIRFSIGGEN_ATTR_FREQUENCYIVIRFSIGGEN_ATTR_POWER_LEVELIVIRFSIGGEN_ATTR_ALC_ENABLEDIVIRFSIGGEN_ATTR_OUTPUT_ENABLEDRelatedTopicsIVIInherentVIsIVIInherentProperties
IviRFSigGenCDMABaseExtensionGroupWiththeIviRFSigGenCDMABaseextensiongroupyoucansimulatemobile(cell)phonemodulationbasedonCodeDivisionMultipleAccess(CDMA)standards.
IviRFSigGenTDMABaseVIsIviRFSigGen_SelectCDMAStandardviRFSigGen_ConfigureCDMAClockSourceIviRFSigGen_ConfigureCDMATriggerSourceIviRFSigGen_ConfigureCDMAExternalTriggerSlopeIviRFSigGen_GetCDMATestModelNameIviRFSigGen_SelectCDMATestModel
IviRFSigGenCDMABasePropertiesIVIRFSIGGEN_ATTR_CDMA_STANDARD_COUNTVIRFSIGGEN_ATTR_CDMA_SELECTED_STANDARDIVIRFSIGGEN_ATTR_CDMA_TRIGGER_SOURCEIVIRFSIGGEN_ATTR_CDMA_EXTERNAL_TRIGGER_SLOPEIVIRFSIGGEN_ATTR_CDMA_TEST_MODEL_COUNTIVIRFSIGGEN_ATTR_CDMA_SELECTED_TEST_MODELIVIRFSIGGEN_ATTR_CDMA_CLOCK_SOURCE
IviRFSigGenDigitalModulationBaseExtensionGroupWiththeIviRFSigGenDigitalModulationBaseextensiongroupyoucangeneratesignalsconformingtowirelesscommunicationstandards(e.g.mobilecellularstandards).ThegeneratedsignalsdonothaveTDMAframingnorCDMAchannelcoding.ThefunctionalitycoversbasicmodulationpropertiessuchasIQconstellation,symbolmapping,etc.withinaspecifiedcommunicationstandard.
IviRFSigGenDigitalModulationBaseVIsIviRFSigGen_GetDigitalModulationBaseStandardNameIviRFSigGen_SelectDigitalModulationBaseStandardIviRFSigGen_Configure_DigitalModulationBase_Clock_SourceIviRFSigGen_ConfigureDigitalModulationBaseDataSourceIviRFSigGen_ConfigureDigitalModulationBasePRBSTypeIviRFSigGen_WriteDigitalModulationBaseBitSequenceIviRFSigGen_SelectDigitalModulationBaseBitSequenceIviRFSigGen_ClearAllDigitalModulationBaseBitSequences
IviRFSigGenDigitalModulationBasePropertiesIVIRFSIGGEN_ATTR_DIGITAL_MODULATION_BASE_STANDARD_COUNTIVIRFSIGGEN_ATTR_DIGITAL_MODULATION_BASE_SELECTED_STANDARDIVIRFSIGGEN_ATTR_DIGITAL_MODULATION_BASE_DATA_SOURCEIVIRFSIGGEN_ATTR_DIGITAL_MODULATION_BASE_PRBS_TYPEIVIRFSIGGEN_ATTR_DIGITAL_MODULATION_BASE_SELECTED_BIT_SEQUENCEIVIRFSIGGEN_ATTR_DIGITAL_MODULATION_BASE_CLOCK_SOURCEIVIRFSIGGEN_ATTR_DIGITAL_MODULATION_BASE_EXTERNAL_CLOCK_TYPE
IviRFSigGenFrequencyStepExtensionGroupTheIviRFSigGenFrequencyStepExtensionGroupsupportssignalgeneratorsthatcanvary(sweep)thefrequencyoftheRFoutputsignalinsteps.Youcanspecifythestart,stopandstepfrequencyandsetlinearorlogarithmicspacing.Settingsinglestepanddwelltimearealsoincluded.ThisextensiongrouprequirestheIviRFSigGenSweepextensiongroup.FrequencysteppingisenabledbysettingtheSweepModetoFrequencyStepintheIviRFSigGenSweepextensiongroup.
IviRFSigGenFrequencyStepVIsIviRFSigGen_Configure_Frequency_Step_Start_StopIviRFSigGen_ConfigureFrequencyStepDwellIviRFSigGen_ResetFrequencyStep
IviRFSigGenFrequencyStepPropertiesIVIRFSIGGEN_ATTR_FREQUENCY_STEP_STARTIVIRFSIGGEN_ATTR_FREQUENCY_STEP_STOPIVIRFSIGGEN_ATTR_FREQUENCY_STEP_SCALINGIVIRFSIGGEN_ATTR_FREQUENCY_STEP_SIZEIVIRFSIGGEN_ATTR_FREQUENCY_STEP_SINGLE_STEP_ENABLEDIVIRFSIGGEN_ATTR_FREQUENCY_STEP_DWELL
IviRFSigGenFrequencySweepExtensionGroupTheIviRFSigGenFrequencySweepextensiongroupsupportssignalgeneratorsthatcanapplyafrequencysweeptotheoutputsignal.Youmayconfigurethesweepwithstartandstop,orcenterandspanfrequencies.Thesweeptimeisalsoconfigurable.InordertosupporttheIviRFSigGenFrequencySweepextensiongroup,adrivershallfirstsupporttheIviRFSigGenSweepextensiongroup.TheIviRFSigGenSweepextensiongroupisactivewhentheSweepModepropertyissettoFrequencySweep.
IviRFSigGenFrequencySweepVIsIviRFSigGen_ConfigureFrequencySweepStartStopIviRFSigGen_ConfigureFrequencySweepCenterSpanIviRFSigGen_ConfigureFrequencySweepTime
IviRFSigGenFrequencySweepPropertiesIVIRFSIGGEN_ATTR_FREQUENCY_SWEEP_STARTIVIRFSIGGEN_ATTR_FREQUENCY_STEP_STOPIVIRFSIGGEN_ATTR_FREQUENCY_SWEEP_TIME
IviRFSigGenIQImpairmentExtensionGroupWiththeIviRFSigGenIQImpairmentextensiongroupyoucansimulateorcorrectimpairmentonIQ(vector)modulation.TheIviRFSigGenIQImpairmentextensiongroupisanextensionoftheIviRFSigGenModulateIQextensiongroup.
IviRFSigGenIQImpairmentVIsIviRFSigGen_ConfigureIQImpairmentEnabledIviRFSigGen_ConfigureIQImpairment
IviRFSigGenIQImpairmentPropertiesIVIRFSIGGEN_ATTR_IQ_IMPAIRMENT_ENABLEDIVIRFSIGGEN_ATTR_IQ_I_OFFSETIVIRFSIGGEN_ATTR_IQ_Q_OFFSETIVIRFSIGGEN_ATTR_IQ_RATIOIVIRFSIGGEN_ATTR_IQ_SKEW
IviRFSigGenLFGeneratorExtensionGroupTheIviRFSigGenLFGeneratorextensiongroupsupportstheLFgenerator(withintheRFsignalgenerator),thatisnormallyusedasasourceforthemodulators.TousetheLFgeneratorasamodulationsource,themodulationsourceintheIviRFSigGenModulateAMextensionsgroup,IviRFSigGenModulateFMextensiongrouporIviRFSigGenModulatePMextensiongroupshouldbeconfigured.YoucansetthefrequencyandthewaveformoftheLFsignal.
IviRFSigGenLFGeneratorVIsIviRFSigGen_GetLFGeneratorNameIviRFSigGen_SetActiveLFGeneratorIviRFSigGen_ConfigureLFGeneratorOutput
IviRFSigGenLFGeneratorPropertiesIVIRFSIGGEN_ATTR_ACTIVE_LF_GENERATORIVIRFSIGGEN_ATTR_LF_GENERATOR_COUNTIVIRFSIGGEN_ATTR_LF_GENERATOR_FREQUENCYIVIRFSIGGEN_ATTR_LF_GENERATOR_WAVEFORM
IviRFSigGenLFGeneratorOutputExtensionGroupTheIviRFSigGenLFGeneratorOutputextensiongroupsupportstheoutputoftheLFgenerator,ifitisusedasasourceforexternaldevices.Youcansettheamplitudeandenableordisabletheoutput.TheIviRFSigGenLFGeneratorOutputrequirestheIviRFSigGenLFGeneratorextensiongroup.
IviRFSigGenLFGeneratorOutputVIIviRFSigGen_ConfigureLFGeneratorOutput
IviRFSigGenLFGeneratorOutputPropertiesIVIRFSIGGEN_ATTR_LF_GENERATOR_OUTPUT_AMPLITUDEIVIRFSIGGEN_ATTR_LF_GENERATOR_OUTPUT_ENABLED
IviRFSigGenListExtensionGroupTheIviRFSigGenListextensiongroupsupportssignalgeneratorsthatcansetthefrequencyandpoweroftheRFoutputsignaltovaluesgivenasalistofvalues.Youcanenableordisablesteppingthefrequencyandpowerlist,specifythenameofthelistandsetitsvalues.Theactivelistcanbeselectedusingthelistname.Settingsinglestepanddwelltimearealsoincluded.TheIviRFSigGenListextensiongrouprequirestheIviRFSigGenSweepextensiongroup.ListsteppingisenabledbysettingtheSweepModeattributetoListintheIviRFSigGenSweepextensiongroup.
IviRFSigGenListVIsIviRFSigGen_CreateFrequencyListIviRFSigGen_CreatePowerListIviRFSigGen_CreateFrequencyPowerListIviRFSigGen_SelectListIviRFSigGen_ClearAllListsIviRFSigGen_ConfigureListDwellIviRFSigGen_ResetList
IviRFSigGenListPropertiesIVIRFSIGGEN_ATTR_LIST_SELECTED_NAMEIVIRFSIGGEN_ATTR_LIST_SINGLE_STEP_ENABLEDIVIRFSIGGEN_ATTR_LIST_DWELL
IviRFSigGenModulateAMExtensionGroupTheIviRFSigGenModulateAMextensiongroupsupportssignalgeneratorsthatcanapplyamplitudemodulationtotheRFoutputsignal.Youcanenableordisableamplitudemodulation,specifythesourceandcouplingofthemodulatingsignalandthemodulationdepthwithlinearorlogarithmicattenuation.
IviRFSigGenModulateAMVIsIviRFSigGen_ConfigureAMEnabledIviRFSigGen_ConfigureAMExternalCouplingIviRFSigGen_ConfigureAM
IviRFSigGenModulateAMPropertiesIVIRFSIGGEN_ATTR_AM_ENABLEDIVIRFSIGGEN_ATTR_AM_SOURCEIVIRFSIGGEN_ATTR_AM_SCALINGIVIRFSIGGEN_ATTR_AM_EXTERNAL_COUPLINGIVIRFSIGGEN_ATTR_AM_NOMINAL_VOLTAGEIVIRFSIGGEN_ATTR_AM_DEPTH
IviRFSigGenModulateFMExtensionGroupTheIviRFSigGenModulateFMextensiongroupsupportssignalgeneratorsthatcanapplyfrequencymodulationtotheRFoutputsignal.Youcanenableordisablefrequencymodulation,specifythesourceandcouplingofthemodulatingsignalandthepeakfrequencydeviation.
IviRFSigGenModulateFMVIsIviRFSigGen_ConfigureFMEnabledIviRFSigGen_ConfigureFMExternalCouplingIviRFSigGen_ConfigureFM
IviRFSigGenModulateFMPropertiesIVIRFSIGGEN_ATTR_FM_ENABLEDIVIRFSIGGEN_ATTR_FM_SOURCEIVIRFSIGGEN_ATTR_FM_EXTERNAL_COUPLINGIVIRFSIGGEN_ATTR_FM_NOMINAL_VOLTAGEIVIRFSIGGEN_ATTR_FM_DEVIATION
IviRFSigGenModulateIQExtensionGroupTheIviRFSigGenModulateIQextensiongroupsupportssignalgeneratorsthatcanapplyIQ(vector)modulationtotheRFoutputsignal.TheusercanenableordisableIQmodulationandspecifythesourceofthemodulatingsignal.AcalibrationisexecutedwithaneventVI.
IviRFSigGenModulateIQVIsIviRFSigGen_ConfigureIQEnabledIviRFSigGen_ConfigureIQIviRFSigGen_CalibrateIQ
IviRFSigGenModulateIQPropertiesIVIRFSIGGEN_ATTR_IQ_ENABLEDIVIRFSIGGEN_ATTR_IQ_SOURCEIVIRFSIGGEN_ATTR_IQ_NOMINAL_VOLTAGEIVIRFSIGGEN_ATTR_IQ_SWAP_ENABLED
IviRFSigGenModulatePMExtensionGroupTheIviRFSigGenModulatePMextensiongroupsupportssignalgeneratorsthatcanapplyphasemodulationtotheRFoutputsignal.Youcanenableordisablephasemodulation,specifythesourceandcouplingofthemodulatingsignalandthepeakphasedeviation.
IviRFSigGenModulatePMVIsIviRFSigGen_ConfigurePMEnabledIviRFSigGen_ConfigurePMExternalCouplingIviRFSigGen_ConfigurePM
IviRFSigGenModulatePMPropertiesIVIRFSIGGEN_ATTR_PM_ENABLEDIVIRFSIGGEN_ATTR_PM_SOURCEIVIRFSIGGEN_ATTR_PM_EXTERNAL_COUPLINGIVIRFSIGGEN_ATTR_PM_NOMINAL_VOLTAGEIVIRFSIGGEN_ATTR_PM_DEVIATION
IviRFSigGenModulatePulseExtensionGroupTheIviRFSigGenModulatePulseextensiongroupsupportssignalgeneratorsthatcanapplypulsemodulationtotheRFoutputsignal.Youcanenableordisablepulsemodulation,andspecifythesourceandthepolarityofthemodulatingsignal.
IviRFSigGenModulatePulseVIsIviRFSigGen_ConfigurePulseModulationEnabledIviRFSigGen_ConfigurePulseModulationSourceIviRFSigGen_ConfigurePulseModulationExternalPolarity
IviRFSigGenModulatePulsePropertiesIVIRFSIGGEN_ATTR_PULSE_MODULATION_ENABLEDIVIRFSIGGEN_ATTR_PULSE_MODULATION_SOURCEIVIRFSIGGEN_ATTR_PULSE_MODULATION_EXTERNAL_POLARITY
IviRFSigGenPowerStepExtensionGroupTheIviRFSigGenPowerStepextensiongroupsupportssignalgeneratorsthatcanvary(sweep)thepoweroftheRFoutputsignalinsteps.Youcanenableordisablestepping,specifythestart,stopandsteppower.Settingsinglestepanddwelltimearealsoincluded.TheIviRFSigGenPowerStepextensiongrouprequirestheIviRFSigGenSweepextensiongroup.PowersteppingisenabledbysettingtheSweepModepropertytoPowerStepintheIviRFSigGenSweepextensiongroup.
IviRFSigGenPowerStepVIsIviRFSigGen_ConfigurePowerStepStartStopIviRFSigGen_ConfigurePowerStepDwellIviRFSigGen_ResetPowerStep
IviRFSigGenPowerStepPropertiesIVIRFSIGGEN_ATTR_POWER_STEP_STARTIVIRFSIGGEN_ATTR_POWER_STEP_STOPIVIRFSIGGEN_ATTR_POWER_STEP_SIZEIVIRFSIGGEN_ATTR_POWER_STEP_SINGLE_STEP_ENABLEDIVIRFSIGGEN_ATTR_POWER_STEP_DWELL
IviRFSigGenPowerSweepExtensionGroupTheIviRFSigGenPowerSweepextensiongroupsupportssignalgeneratorsthatcanapplyapowersweeptotheoutputsignal.Youmayconfigurethesweepwithstartandstoppower.Thesweeptimeisalsoconfigurable.InordertosupporttheIviRFSigGenPowerSweepextensiongroup,adrivershallfirstsupporttheIviRFSigGenSweepextensiongroup.TheIviRFSigGenSweepextensiongroupisactivewhentheSweepModepropertyissettoPowerSweep.
IviRFSigGenPowerSweepVIsIviRFSigGen_ConfigurePowerSweepStartStopIviRFSigGen_ConfigurePowerSweepTime
IviRFSigGenPowerSweepPropertiesIVIRFSIGGEN_ATTR_POWER_SWEEP_STARTIVIRFSIGGEN_ATTR_POWER_SWEEP_STOPIVIRFSIGGEN_ATTR_POWER_SWEEP_TIME
IviRFSigGenPulseDoubleGeneratorExtensionGroupTheIviRFSigGenPulseDoubleGeneratorextensiongroupextendstheIviRFSigGenPulseGeneratorextensiongrouptosupportdoublepulsegeneration.
IviRFSigGenPulseDoubleGeneratorVIIviRFSigGen_ConfigurePulseDouble
IviRFSigGenPulseDoubleGeneratorPropertiesIVIRFSIGGEN_ATTR_PULSE_DOUBLE_ENABLEDIVIRFSIGGEN_ATTR_PULSE_DOUBLE_DELAY
IviRFSigGenPulseGeneratorExtensionGroupTheIviRFSigGenPulseGeneratorextensiongroupsupportsthepulsegeneratorwithinthesignalgeneratorthatisnormallyusedasasourceforthepulsemodulator.Youcansetthepulseperiod,widthanddelay.Thepulsecanbetriggered,sosourceandexternaltriggerpolaritycanbeset.DoublepulsecanbesetwiththeVIsandpropertiesoftheIviRFSigGenPulseDoubleGeneratorextensiongroup.TheoutputofthepulsegeneratorcanbesetwiththeVIsandpropertiesoftheIviRFSigGenPulseGeneratorOutputextensiongroup.
IviRFSigGenPulseGeneratorVIsIviRFSigGen_ConfigurePulseExternalTriggerIviRFSigGen_ConfigurePulseInternalTriggerIviRFSigGen_ConfigurePulse
IviRFSigGenPulseGeneratorPropertiesIVIRFSIGGEN_ATTR_PULSE_INTERNAL_TRIGGER_PERIODIVIRFSIGGEN_ATTR_PULSE_WIDTHIVIRFSIGGEN_ATTR_PULSE_GATING_ENABLEDIVIRFSIGGEN_ATTR_PULSE_TRIGGER_SOURCEIVIRFSIGGEN_ATTR_PULSE_EXTERNAL_TRIGGER_SLOPEIVIRFSIGGEN_ATTR_PULSE_EXTERNAL_TRIGGER_DELAY
IviRFSigGenPulseGeneratorOutputExtensionGroupTheIviRFSigGenPulseGeneratorOutputextensiongrouprequirestheIviRFSigGenPulseGeneratorextensiongroup.Theoutputofthepulsegeneratorcanbeenabledordisabledanditspolarityset.
IviRFSigGenPulseGeneratorOutputPropertiesIVIRFSIGGEN_ATTR_PULSE_OUTPUT_POLARITYIVIRFSIGGEN_ATTR_PM_SOURCE
IviRFSigGenReferenceOscillatorExtensionGroupTheIviRFSigGenReferenceOscillatorextensiongroupsupportssignalgeneratorswithaconfigurablefrequencyreference.
IviRFSigGenReferenceOscillatorVIIviRFSigGen_ConfigureReferenceOscillator
IviRFSigGenReferenceOscillatorPropertiesIVIRFSIGGEN_ATTR_REFERENCE_OSCILLATOR_SOURCEIVIRFSIGGEN_ATTR_REFERENCE_OSCILLATOR_EXTERNAL_FREQUENCY
IviRFSigGenSoftwareTriggerExtensionGroupTheIviRFSigGenSoftwareTriggerextensiongroupsupportsRFsignalgeneratorsthatcangenerateoutputbasedonasoftwaretriggersignal.Youcansendasoftwaretriggertocausesignaloutputtooccur,tostartasweep(frequencyorpower),ortoinitiatethenextstep(frequencyand/orpower).TheIviRFSigGenSoftwareTriggerextensiongroupaffectsinstrumentbehaviorwhentheTriggerSourcepropertyissettoSoftwareTrigger.
IviRFSigGenSoftwareTriggerVIIviRFSigGen_SendSoftwareTrigger
IviRFSigGenSweepExtensionGroupTheIviRFSigGenSweepextensiongroupsupportssignalgeneratorswiththeabilitytosweep(orstep)thefrequencyorthepoweroftheRFoutputsignal.
IviRFSigGenSweepVIIviRFSigGen_ConfigureSweep
IviRFSigGenSweepPropertiesIVIRFSIGGEN_ATTR_SWEEP_MODEIVIRFSIGGEN_ATTR_SWEEP_TRIGGER_SOURCE
IviRFSigGenTDMABaseExtensionGroupWithIviRFSigGenTDMABaseExtensionGroupyoucansimulatemobile(cell)phonemodulationbasedonTimeDivisionMultipleAccess(TDMA)standards.
IviRFSigGenTDMABaseVIsIviRFSigGen_GetTDMAStandardNameviRFSigGen_SelectTDMAStandardIviRFSigGen_ConfigureTDMAClockSourceIviRFSigGen_ConfigureTDMATriggerSourceIviRFSigGen_ConfigureTDMAExternalTriggerSlopeIviRFSigGen_GetTDMAFrameNameIviRFSigGen_SelectTDMAFrame
IviRFSigGenTDMABasePropertiesVIRFSIGGEN_ATTR_TDMA_SELECTED_STANDARDIVIRFSIGGEN_ATTR_TDMA_TRIGGER_SOURCEIVIRFSIGGEN_ATTR_TDMA_EXTERNAL_TRIGGER_SLOPEIVIRFSIGGEN_ATTR_TDMA_SELECTED_FRAMEIVIRFSIGGEN_ATTR_TDMA_CLOCK_SOURCEIVIRFSIGGEN_ATTR_TDMA_EXTERNAL_CLOCK_TYPE
IviRFSigGenBehaviorModelsIviRFSigGenALCIviRFSigGenAnalogModulationSourceIviRFSigGenArbGeneratorIviRFSigGenBaseIviRFSigGenCDMABaseIviRFSigGenDigitalModulationBaseIviRFSigGenFrequencyStepIviRFSigGenFrequencySweepIviRFSigGenIQImpairmentIviRFSigGenIviRFSigGenIviRFSigGenLFGeneratorIviRFSigGenLFGeneratorOutputIviRFSigGenListIviRFSigGenModulateAMIviRFSigGenModulateFMIviRFSigGenModulateIQIviRFSigGenModulatePMIviRFSigGenModulatePulseIviRFSigGenPowerStepIviRFSigGenPowerSweepIviRFSigGenPulseDoubleGeneratorIviRFSigGenPulseGeneratorIviRFSigGenPulseGeneratorOutputIviRFSigGenReferemceOscillatorIviRFSigGenSoftwareTriggerIviRFSigGenSweepIviRFSigGenTDMABase
IviRFSigGenALCBehaviorModelTheIviRFSigGenALCextensiongroupfollowsthebehaviormodeloftheIviRFSigGenBasecapabilitygroup.TheonlymodificationtothebehaviormodelfromtheIviRFSigGenBasecapabilitygroupistheabilitytoconfigureIviRFSigGenALCsettings.
IviRFSigGenAnalogModulationSourceBehaviorModelTheIviRFSigGenAnalogModulationSourceextensiongroupfollowsthebehaviormodeloftheIviRFSigGenBasecapabilitygroup.
IviRFSigGenArbGeneratorBehaviorModelTheIviRFSigGenArbGeneratorextensiongroupfollowsthebehaviormodeloftheIviRFSigGenBasecapabilitygroup.TheonlymodificationtothebehaviormodelfromtheIviRFSigGenBasecapabilitygroupistheabilitytoconfigureIviRFSigGenArbGeneratorsettings.
IviRFSigGenBaseBehaviorModelAfteryoucalltheInitializeorResetVIs,theRFsignalgeneratorproducesanoutputsignalbasedonitscurrentconfiguration.AllchangestotheRFsignalgenerator'sIviRFSigGenBaseVIsandtakeplaceimmediately.IfyouexecutetheWaitUntilSettledVI,thedriverwillblockanyfurtheroperationuntiltheVIcompletes(suchas,thesignalattheoutputoftheRFsignalgeneratorhassettled).
IviRFSigGenCDMABaseBehaviorModelTheIviRFSigGenCDMABaseextensiongroupfollowsthebehaviormodeloftheIviRFSigGenBasecapabilitygroup.TheonlymodificationtothebehaviormodelfromtheIviRFSigGenBasecapabilitygroupistheabilitytoconfigureIviRFSigGenCDMABasesettings.
IviRFSigGenDigitalModulationBaseBehaviorModelTheIviRFSigGenDigitalModulationBaseextensiongroupfollowsthebehaviormodeloftheIviRFSigGenBasecapabilitygroup.TheonlymodificationtothebehaviormodelfromtheIviRFSigGenBasecapabilitygroupistheabilitytoconfigureIviRFSigGenDigitalModulationBasesettings.
IviRFSigGenFrequencyStepBehaviorModelTheIviRFSigGenFrequencyStepextensiongroupfollowsthebehaviormodeloftheIviRFSigGenSweepcapabilitygroup.
IviRFSigGenFrequencySweepBehaviorModelTheIviRFSigGenFrequencySweepextensiongroupfollowsthebehaviormodeloftheIviRFSigGenSweepcapabilitygroup.
IviRFSigGenIQImpairmentBehaviorModelTheIviRFSigGenIQImpairmentextensiongroupfollowsthebehaviormodeloftheIviRFSigGenBasecapabilitygroup.TheonlymodificationtothebehaviormodelfromtheIviRFSigGenBasecapabilitygroupistheabilitytoconfigureIviRFSigGenIQImpairmentsettings.
IviRFSigGenLFGeneratorBehaviorModelTheIviRFSigGenLFGeneratorextensiongroupfollowsthebehaviormodeloftheIviRFSigGenBasecapabilitygroup.TheonlymodificationtothebehaviormodelfromtheIviRFSigGenBasecapabilitygroupistheabilitytoconfigureIviRFSigGenLFGeneratorsettings.
IviRFSigGenLFGeneratorOutputBehaviorModelTheIviRFSigGenLFGeneratorOutputextensiongroupfollowsthebehaviormodeloftheIviRFSigGenBasecapabilitygroup.TheonlymodificationtothebehaviormodelfromtheIviRFSigGenBasecapabilitygroupistheabilitytoconfigureIviRFSigGenLFGeneratorOutputsettings.
IviRFSigGenListBehaviorModelTheIviRFSigGenListextensiongroupfollowsthebehaviormodeloftheIviRFSigGenSweepcapabilitygroup.
IviRFSigGenModulateAMBehaviorModelTheIviRFSigGenModulateAMextensiongroupfollowsthebehaviormodeloftheIviRFSigGenBasecapabilitygroup.TheonlymodificationtothebehaviormodelfromtheIviRFSigGenBasecapabilitygroupistheabilitytoconfigureIviRFSigGenModulateAMsettings.
IviRFSigGenModulateFMBehaviorModelTheIviRFSigGenModulateFMextensiongroupfollowsthebehaviormodeloftheIviRFSigGenBasecapabilitygroup.TheonlymodificationtothebehaviormodelfromtheIviRFSigGenBasecapabilitygroupistheabilitytoconfigureIviRFSigGenModulateFMsettings.
IviRFSigGenModulateIQBehaviorModelTheIviRFSigGenModulateIQextensiongroupfollowsthebehaviormodeloftheIviRFSigGenBasecapabilitygroup.TheonlymodificationtothebehaviormodelfromtheIviRFSigGenBasecapabilitygroupistheabilitytoconfigureIviRFSigGenModulateIQsettings.
IviRFSigGenModulatePMBehaviorModelTheIviRFSigGenModulatePMextensiongroupfollowsthebehaviormodeloftheIviRFSigGenBasecapabilitygroup.TheonlymodificationtothebehaviormodelfromtheIviRFSigGenBasecapabilitygroupistheabilitytoconfigureIviRFSigGenModulatePMsettings.
IviRFSigGenModulatePulseBehaviorModelTheIviRFSigGenModulatePulseextensiongroupfollowsthebehaviormodeloftheIviRFSigGenBasecapabilitygroup.TheonlymodificationtothebehaviormodelfromtheIviRFSigGenBasecapabilitygroupistheabilitytoconfigureIviRFSigGenModulatePulsesettings.
IviRFSigGenPowerStepBehaviorModelTheIviRFSigGenPowerStepextensiongroupfollowsthebehaviormodeloftheIviRFSigGenSweepcapabilitygroup.
IviRFSigGenPowerSweepBehaviorModelTheIviRFSigGenPowerSweepextensiongroupfollowsthebehaviormodeloftheIviRFSigGenSweepcapabilitygroup.
IviRFSigGenPulseDoubleGeneratorBehaviorModelTheIviRFSigGenPulseDoubleGeneratorextensiongroupfollowsthebehaviormodeloftheIviRFSigGenBasecapabilitygroup.TheonlymodificationtothebehaviormodelfromtheIviRFSigGenBasecapabilitygroupistheabilitytoconfigureIviRFSigGenPulseDoubleGeneratorsettings.
IviRFSigGenPulseGeneratorBehaviorModelTheIviRFSigGenPulseGeneratorextensiongroupfollowsthebehaviormodeloftheIviRFSigGenBasecapabilitygroup.TheonlymodificationtothebehaviormodelfromtheIviRFSigGenBasecapabilitygroupistheabilitytoconfigureIviRFSigGenPulseGeneratorsettings.
IviRFSigGenPulseGeneratorOutputBehaviorModelTheIviRFSigGenPulseGeneratorOutputextensiongroupfollowsthebehaviormodeloftheIviRFSigGenBasecapabilitygroup.TheonlymodificationtothebehaviormodelfromtheIviRFSigGenBasecapabilitygroupistheabilitytoconfigureIviRFSigGenPulseGeneratorOutputsettings.
IviRFSigGenReferenceOscillatorBehaviorModelTheIviRFSigGenReferenceOscillatorextensiongroupfollowsthebehaviormodeloftheIviRFSigGenBasecapabilitygroup.TheonlymodificationtothebehaviormodelfromtheIviRFSigGenBasecapabilitygroupistheabilitytoconfigureIviRFSigGenReferenceOscillatorsettings.
IviRFSigGenSoftwareTriggerBehaviorModelTheIviRFSigGenSoftwareTriggerextensiongroupfollowsthebehaviormodeloftheIviRFSigGenSweepcapabilitygroup.TheonlymodificationtothebehaviormodelfromtheIviRFSigGenSweepcapabilitygroupistheabilitytosendsoftwaretriggers.
ThefollowingbehaviormodelsshowtherelationshipbetweentheIviRFSigGenSweepextensiongroupandRFSignalGeneratorbehavior.
FrequencySweep/PowerSweep
IviRFSigGenSweepBehaviorModelSettingtheSweepTriggerSourcepropertytoImmediatewillcontinuouslygeneratesweeps(eitherfrequencyorpowersweeps).ThedurationofonesweepfromstarttostopisdefinedwithFrequencySweepTimeorPowerSweepTime.SettingtheSweepTriggerSourcepropertytoExternalorSoftwareTriggerwilldelaythestartofthenextsweepuntilthespecifiedtriggereventoccurs.
TriggerImmediate:TriggerExternal/Software:
FrequencyStep/PowerStep/List
SettingtheSweepTriggerpropertytoImmediatewillcontinuouslygeneratesteps(frequencyorpower)eitherfromstarttostopwithfixedincrements(steps)orfromalistofarbitraryvalues.ThedurationofonestepisdefinedwithDwellTime.SettingtheSweepTriggerpropertytoExternalorSoftwareTriggerwilldelaythestartofthenextstepuntilthespecifiedtriggereventoccurs.
TriggerImmediate:TriggerExternal/Software:
SingleStepandTrigger
External/Software:
IviRFSigGenSweepBehaviorModelSettingtheSweepTriggerSourcepropertytoImmediatewillcontinuouslygeneratesteps(frequencyorpower)eitherfromstarttostopwithfixedincrements(steps)orfromalistofarbitraryvalues.ThedurationofonestepisdefinedwithDwellTime.SettingtheSweepTriggerSourcepropertytoExternalorSoftwareTriggerwilldelaythestartofthenextstepuntilthespecifiedtriggereventoccurs.ThefollowingbehaviormodelsshowtherelationshipbetweentheIviRFSigGenSweepextensiongroupandRFSignalGeneratorbehavior.
FrequencySweep/PowerSweep
IviRFSigGenSweepBehaviorModelSettingtheSweepTriggerSourcepropertytoImmediatewillcontinuouslygeneratesweeps(eitherfrequencyorpowersweeps).ThedurationofonesweepfromstarttostopisdefinedwithFrequencySweepTimeorPowerSweepTime.SettingtheSweepTriggerSourcepropertytoExternalorSoftwareTriggerwilldelaythestartofthenextsweepuntilthespecifiedtriggereventoccurs.
TriggerImmediate: TriggerExternal/Software:
FrequencyStep/PowerStep/List
SettingtheSweepTriggerpropertytoImmediatewillcontinuouslygeneratesteps(frequencyorpower)eitherfromstarttostopwithfixedincrements(steps)orfromalistofarbitraryvalues.ThedurationofonestepisdefinedwithDwellTime.SettingtheSweepTriggerpropertytoExternalorSoftwareTriggerwilldelaythestartofthenextstepuntilthespecifiedtriggereventoccurs.
TriggerImmediate:TriggerExternal/Software:
SingleStepandTriggerExternal/Software:
IviRFSigGenTDMABaseBehaviorModelTheIviRFSigGenTDMABaseextensiongroupfollowsthebehaviormodeloftheIviRFSigGenBasecapabilitygroup.TheonlymodificationtothebehaviormodelfromtheIviRFSigGenBasecapabilitygroupistheabilitytoconfigureIviRFSigGenTDMABasesettings.
IviRFSigGenVITreeClass/PanelName VIName
ConfigurationFunctionsRFConfigureRF IviRFSigGen_Configure
RF.viConfigureALCEnabled IviRFSigGen_Configure
ALCEnabled.viConfigureOutputEnabled IviRFSigGen_Configure
OutputEnabled.viAnalogModulationConfigureAMEnabled[AM] IviRFSigGen_Configure
AMEnabled[AM].viConfigureAMExternalCoupling[AM] IviRFSigGen_Configure
AMExternalCoupling[AM].vi
ConfigureAM[AM] IviRFSigGen_ConfigureAM[AM].vi
ConfigureFMEnabled[FM] IviRFSigGen_ConfigureFMEnabled[FM].vi
ConfigureFMExternalCoupling[FM] IviRFSigGen_ConfigureFMExternalCoupling[FM].vi
ConfigureFM[FM] IviRFSigGen_ConfigureFM[FM].vi
ConfigurePMEnabled[PM] IviRFSigGen_ConfigurePMEnabled[PM].vi
ConfigurePMExternalCoupling[PM] IviRFSigGen_ConfigurePMExternalCoupling[PM].vi
ConfigurePM[PM] IviRFSigGen_ConfigurePM[PM].vi
GetAnalogModulationSourceName[MS] IviRFSigGen_GetAnalogModulationSourceName[MS].vi
PulseModulationConfigurePulseModulationEnabled[PULM] IviRFSigGen_Configure
PulseModulationEnabled[PULM].vi
ConfigurePulseModulationSource[PULM] IviRFSigGen_ConfigurePulseModulationSource[PULM].vi
ConfigurePulseModulationExternalPolarity[PULM] IviRFSigGen_ConfigurePulseModulationExternalPolarity[PULM].vi
LFGeneratorConfigureLFGenerator[LF] IviRFSigGen_Configure
LFGenerator[LF].viGetLFGeneratorName[LF] IviRFSigGen_GetLF
GeneratorName[LF].viSetActiveLFGenerator[LF] IviRFSigGen_Set
ActiveLFGenerator[LF].vi
ConfigureLFGeneratorOutput[LFO] IviRFSigGen_ConfigureLFGeneratorOutput[LFO].vi
PulseGeneratorConfigurePulseExternalTrigger[PG] IviRFSigGen_Configure
PulseExternalTrigger[PG].vi
ConfigurePulseInternalTrigger[PG] IviRFSigGen_ConfigurePulseInternalTrigger[PG].vi
ConfigurePulse[PG] IviRFSigGen_ConfigurePulse[PG].vi
ConfigurePulseDouble[DPG] IviRFSigGen_ConfigurePulseDouble[DPG].vi
ConfigurePulseOutput[PGO] IviRFSigGen_ConfigurePulseOutput[PGO].vi
SweepConfigureSweep IviRFSigGen_Configure
Sweep.viConfigureFrequencySweepStartStop[FSW] IviRFSigGen_Configure
FrequencySweepStartStop[FSW].vi
ConfigureFrequencySweepCenterSpan[FSW] IviRFSigGen_ConfigureFrequencySweepCenterSpan[FSW].vi
ConfigureFrequencySweepTime[FSW] IviRFSigGen_ConfigureFrequencySweepTime[FSW].vi
ConfigurePowerSweepStartStop[PSW] IviRFSigGen_ConfigurePowerSweepStartStop[PSW].vi
ConfigurePowerSweepTime[PSW] IviRFSigGen_ConfigurePowerSweepTime[PSW].vi
ConfigureFrequencyStepStartStop[FST] IviRFSigGen_ConfigureFrequencyStepStartStop[FST].vi
ConfigureFrequencyStepDwell[FST] IviRFSigGen_ConfigureFrequencyStepDwell[FST].vi
ResetFrequencyStep[FST] IviRFSigGen_ResetFrequencyStep[FST].vi
ConfigurePowerStepStartStop[PST] IviRFSigGen_ConfigurePowerStepStartStop[PST].vi
ConfigurePowerStepDwell[PST] IviRFSigGen_ConfigurePowerStepDwell[PST].vi
ResetPowerStep[PST] IviRFSigGen_ResetPowerStep[PST].vi
ListCreateFrequencyList[LST] IviRFSigGen_Create
FrequencyList[LST].viCreatePowerList[LST] IviRFSigGen_Create
PowerList[LST].viCreateFrequencyPowerList[LST] IviRFSigGen_Create
FrequencyPowerList[LST].vi
SelectList[LST] IviRFSigGen_SelectList[LST].vi
ClearAllLists[LST] IviRFSigGen_ClearAllLists[LST].vi
ConfigureListDwell[LST] IviRFSigGen_ConfigureListDwell[LST].vi
ResetList[LST] IviRFSigGen_ResetList[LST].vi
ALCConfigureALC[ALC] IviRFSigGen_Configure
ALC[ALC].viReferenceOscillatorConfigureReferenceOscillator[RO] IviRFSigGen_Configure
ReferenceOscillator[RO].vi
IQConfigureIQEnabled[MIQ] IviRFSigGen_Configure
IQEnabled[MIQ].viConfigureIQ[MIQ] IviRFSigGen_Configure
IQ[MIQ].vi
CalibrateIQ[MIQ] IviRFSigGen_CalibrateIQ[MIQ].vi
ConfigureIQImpairmentEnabled[IQI] IviRFSigGen_ConfigureIQImpairmentEnabled[IQI].vi
ConfigureIQImpairment[IQI] IviRFSigGen_ConfigureIQImpairment[IQI].vi
ARBGeneratorConfigureArb[ARB] IviRFSigGen_Configure
Arb[ARB].viWriteArbWaveform[ARB] IviRFSigGen_WriteArb
Waveform[ARB].viSelectArbWaveform[ARB] IviRFSigGen_Select
ArbWaveform[ARB].viClearAllArbWaveforms[ARB] IviRFSigGen_ClearAll
ArbWaveforms[ARB].vi
QueryArbWaveformCapabilities[ARB] IviRFSigGen_QueryArbWaveformCapabilities[ARB].vi
ConfigureArbTriggerSource[ARB] IviRFSigGen_ConfigureArbTriggerSource[ARB].vi
ConfigureArbExternalTriggerSlope[ARB] IviRFSigGen_ConfigureArbExternalTriggerSlope[ARB].vi
DigitalModulationBaseGetDigitalModulationBaseStandardName[DMB] IviRFSigGen_Get
DigitalModulationBaseStandardName[DMB].vi
SelectDigitalModulationBaseStandard[DMB] IviRFSigGen_SelectDigitalModulationBaseStandard[DMB].vi
ConfigureDigitalModulationBaseClockSource[DMB] IviRFSigGen_ConfigureDigitalModulationBaseClockSource[DMB].vi
ConfigureDigitalModulationBaseDataSource[DMB] IviRFSigGen_ConfigureDigitalModulationBaseDataSource[DMB].vi
ConfigureDigitalModulationBasePRBSType[DMB] IviRFSigGen_ConfigureDigitalModulationBasePRBSType[DMB].vi
WriteDigitalModulationBaseBitSequence[DMB] IviRFSigGen_WriteDigitalModulationBaseBitSequence[DMB].vi
SelectDigitalModulationBaseBitSequence[DMB] IviRFSigGen_SelectDigitalModulationBaseBitSequence[DMB].vi
ClearAllDigitalModulationBaseBitSequences[DMB] IviRFSigGen_ClearAllDigitalModulationBaseBitSequences[DMB].vi
CDMAGetCDMAStandardName[CDMA] IviRFSigGen_Get
CDMAStandardName[CDMA].vi
SelectCDMAStandard[CDMA] IviRFSigGen_SelectCDMAStandard[CDMA].vi
ConfigureCDMAClockSource[CDMA] IviRFSigGen_ConfigureCDMAClockSource[CDMA].vi
ConfigureCDMATriggerSource[CDMA] IviRFSigGen_ConfigureCDMATriggerSource[CDMA].vi
ConfigureCDMAExternalTriggerSlope[CDMA] IviRFSigGen_ConfigureCDMAExternalTriggerSlope[CDMA].vi
GetCDMATestModelName[CDMA] IviRFSigGen_GetCDMATestModelName[CDMA].vi
SelectCDMATestModel[CDMA] IviRFSigGen_SelectCDMATestModel[CDMA].vi
TDMAGetTDMAStandardName[TDMA] IviRFSigGen_Get
TDMAStandardName[TDMA].vi
SelectTDMAStandard[TDMA] IviRFSigGen_SelectTDMAStandard[TDMA].vi
ConfigureTDMAClockSource[TDMA] IviRFSigGen_ConfigureTDMAClockSource[TDMA].vi
ConfigureTDMATriggerSource[TDMA] IviRFSigGen_ConfigureTDMATriggerSource[TDMA].vi
ConfigureTDMAExternalTriggerSlope[TDMA] IviRFSigGen_ConfigureTDMAExternalTriggerSlope[TDMA].vi
GetTDMAFrameName[TDMA] IviRFSigGen_GetTDMAFrameName[TDMA].vi
SelectTDMAFrame[TDMA] IviRFSigGen_SelectTDMAFrame[TDMA].vi
ActionFunctionsDisableAllModulation IviRFSigGen_Disable
AllModulation.viWaitUntilSettled IviRFSigGen_WaitUntil
Settled.viIsSettled IviRFSigGen_Is
Settled.viSendSoftwareTrigger[SWT] IviRFSigGen_Send
SoftwareTrigger[SWT].vi
IviRFSigGenPropertiesGroup/AttributeName PropertyLabel
RFFrequency IviRFSigGen»RF»FrequencyPowerLevel IviRFSigGen»RF»PowerLevelALCEnabled IviRFSigGen»RF»ALCEnabledOutputEnabled IviRFSigGen»RF»OutputEnabledAnalogModulationAMAMEnabled[AM] IviRFSigGen»Analog
Modulation»AM»AMEnabled[AM]AMSource[AM] IviRFSigGen»Analog
Modulation»AM»AMSource[AM]AMScaling[AM] IviRFSigGen»Analog
Modulation»AM»AMScaling[AM]AMExternalCoupling[AM] IviRFSigGen»Analog
Modulation»AM»AMExternalCoupling[AM]
AMNominalVoltage[AM] IviRFSigGen»AnalogModulation»AM»AMNominalVoltage[AM]
AMDepth[AM] IviRFSigGen»AnalogModulation»AM»AMDepth[AM]
FMFMEnabled[FM] IviRFSigGen»Analog
Modulation»FM»FMEnabled[FM]FMSource[FM] IviRFSigGen»Analog
Modulation»FM»FMSource[FM]FMExternalCoupling[FM] IviRFSigGen»Analog
Modulation»FM»FMExternalCoupling[FM]
FMNominalVoltage[FM] IviRFSigGen»AnalogModulation»FM»FMNominalVoltage[FM]
FMDeviation[FM] IviRFSigGen»AnalogModulation»FM»FMDeviation[FM]
PMPMEnabled[PM] IviRFSigGen»Analog
Modulation»PM»PMEnabled[PM]PMSource[PM] IviRFSigGen»Analog
Modulation»PM»PMSource[PM]PMExternalCoupling[PM] IviRFSigGen»Analog
Modulation»PM»PMExternalCoupling[PM]
PMNominalVoltage[PM] IviRFSigGen»AnalogModulation»PM»PMNominalVoltage[PM]
PMDeviation[PM] IviRFSigGen»AnalogModulation»PM»PMDeviation[PM]
SourceModulationSourceCount[MS] IviRFSigGen»Analog
Modulation»Source»ModulationSourceCount[MS]
PulseModulationPulseModulationEnabled[PULM] IviRFSigGen»Pulse
Modulation»PulseModulationEnabled[PULM]
PulseModulationSource[PULM] IviRFSigGen»PulseModulation»PulseModulationSource[PULM]
PulseModulationExternalPolarity[PULM] IviRFSigGen»PulseModulation»PulseModulationExternalPolarity[PULM]
LFGenerator
ActiveLFGenerator[LF] IviRFSigGen»LFGenerator»ActiveLFGenerator[LF]
LFGeneratorCount[LF] IviRFSigGen»LFGenerator»LFGeneratorCount[LF]
LFGeneratorFrequency[LF] IviRFSigGen»LFGenerator»LFGeneratorFrequency[LF]
LFGeneratorWaveform[LF] IviRFSigGen»LFGenerator»LFGeneratorWaveform[LF]
LFGeneratorOutputsLFGeneratorOutputAmplitude[LFO] IviRFSigGen»LFGenerator»LF
GeneratorOutputs»LFGeneratorOutputAmplitude[LFO]
LFGeneratorOutputEnabled[LFO] IviRFSigGen»LFGenerator»LFGeneratorOutputs»LFGeneratorOutputEnabled[LFO]
PulseGeneratorPulseInternalTriggerPeriod[PG] IviRFSigGen»Pulse
Generator»PulseInternalTriggerPeriod[PG]
PulseWidth[PG] IviRFSigGen»PulseGenerator»PulseWidth[PG]
PulseGatingEnabled[PG] IviRFSigGen»PulseGenerator»PulseGatingEnabled[PG]
PulseTriggerSource[PG] IviRFSigGen»PulseGenerator»PulseTriggerSource[PG]
PulseExternalTriggerSlope[PG] IviRFSigGen»PulseGenerator»PulseExternalTriggerSlope[PG]
PulseExternalTriggerDelay[PG] IviRFSigGen»PulseGenerator»PulseExternalTriggerDelay[PG]
DoublePulseGenerators
PulseDoubleEnabled[DPG] IviRFSigGen»PulseGenerator»DoublePulseGenerators»PulseDoubleEnabled[DPG]
PulseDoubleDelay[DPG] IviRFSigGen»PulseGenerator»DoublePulseGenerators»PulseDoubleDelay[DPG]
PulseGeneratorOutputPulseOutputEnabled[PGO] IviRFSigGen»Pulse
Generator»PulseGeneratorOutput»PulseOutputEnabled[PGO]
PulseOutputPolarity[PGO] IviRFSigGen»PulseGenerator»PulseGeneratorOutput»PulseOutputPolarity[PGO]
SweepSweepMode[SWP] IviRFSigGen»Sweep»SweepMode
[SWP]SweepTriggerSource[SWP] IviRFSigGen»Sweep»SweepTrigger
Source[SWP]FrequencySweepFrequencySweepStart[FSW] IviRFSigGen»Sweep»Frequency
Sweep»FrequencySweepStart[FSW]
FrequencySweepStop[FSW] IviRFSigGen»Sweep»FrequencySweep»FrequencySweepStop[FSW]
FrequencySweepTime[FSW] IviRFSigGen»Sweep»FrequencySweep»FrequencySweepTime[FSW]
PowerSweepPowerSweepStart[PSW] IviRFSigGen»Sweep»Power
Sweep»PowerSweepStart[PSW]
PowerSweepStop[PSW] IviRFSigGen»Sweep»PowerSweep»PowerSweepStop[PSW]
PowerSweepTime[PSW] IviRFSigGen»Sweep»PowerSweep»PowerSweepTime[PSW]
FrequencyStepFrequencyStepStart[FST] IviRFSigGen»Sweep»Frequency
Step»FrequencyStepStart[FST]FrequencyStepStop[FST] IviRFSigGen»Sweep»Frequency
Step»FrequencyStepStop[FST]FrequencyStepScaling[FST] IviRFSigGen»Sweep»Frequency
Step»FrequencyStepScaling[FST]FrequencyStepSize[FST] IviRFSigGen»Sweep»Frequency
Step»FrequencyStepSize[FST]FrequencyStepSingleStepEnabled[FST] IviRFSigGen»Sweep»Frequency
Step»FrequencyStepSingleStepEnabled[FST]
FrequencyStepDwell[FST] IviRFSigGen»Sweep»FrequencyStep»FrequencyStepDwell[FST]
PowerStepPowerStepStart[PST] IviRFSigGen»Sweep»Power
Step»PowerStepStart[PST]PowerStepStop[PST] IviRFSigGen»Sweep»Power
Step»PowerStepStop[PST]PowerStepSize[PST] IviRFSigGen»Sweep»Power
Step»PowerStepSize[PST]SingleStepEnabled[PST] IviRFSigGen»Sweep»Power
Step»SingleStepEnabled[PST]PowerStepDwell[PST] IviRFSigGen»Sweep»Power
Step»PowerStepDwell[PST]ListListSelectedName[LST] IviRFSigGen»Sweep»List»List
SelectedName[LST]ListSingleStepEnabled[LST] IviRFSigGen»Sweep»List»List
SingleStepEnabled[LST]ListDwell[LST] IviRFSigGen»Sweep»List»ListDwell
[LST]ALCALCSource[ALC] IviRFSigGen»ALC»ALCSource
[ALC]ALCBandwidth[ALC] IviRFSigGen»ALC»ALCBandwidth
[ALC]ReferenceOscillatorReferenceOscillatorSource[RO] IviRFSigGen»Reference
Oscillator»ReferenceOscillatorSource[RO]
ReferenceOscillatorExternalFrequency[RO] IviRFSigGen»ReferenceOscillator»ReferenceOscillatorExternalFrequency[RO]
IQIQEnabled[MIQ] IviRFSigGen»IQ»IQEnabled[MIQ]IQNominalVoltage[MIQ] IviRFSigGen»IQ»IQNominal
Voltage[MIQ]IQSource[MIQ] IviRFSigGen»IQ»IQSource[MIQ]IQSwapEnabled[MIQ] IviRFSigGen»IQ»IQSwapEnabled
[MIQ]IQImpairmentIQImpairmentEnabled[IQI] IviRFSigGen»IQ»IQImpairment»IQ
ImpairmentEnabled[IQI]IQIOffset[IQI] IviRFSigGen»IQ»IQImpairment»IQ
IOffset[IQI]IQQOffset[IQI] IviRFSigGen»IQ»IQImpairment»IQ
QOffset[IQI]IQRatio[IQI] IviRFSigGen»IQ»IQImpairment»IQ
Ratio[IQI]IQSkew[IQI] IviRFSigGen»IQ»IQImpairment»IQ
Skew[IQI]ARBGeneratorARBClockFrequency[ARB] IviRFSigGen»ARBGenerator»ARB
ClockFrequency[ARB]ARBFilterFrequency[ARB] IviRFSigGen»ARBGenerator»ARB
FilterFrequency[ARB]WaveformARBSelectedWaveform[ARB] IviRFSigGen»ARB
Generator»Waveform»ARBSelectedWaveform[ARB]
ARBMaxNumberWaveforms[ARB] IviRFSigGen»ARBGenerator»Waveform»ARBMaxNumberWaveforms[ARB]
ARBWaveformQuantum[ARB] IviRFSigGen»ARBGenerator»Waveform»ARBWaveformQuantum[ARB]
ARBWaveformSizeMin[ARB] IviRFSigGen»ARBGenerator»Waveform»ARBWaveformSizeMin[ARB]
ARBWaveformSizeMax[ARB] IviRFSigGen»ARBGenerator»Waveform»ARBWaveformSizeMax[ARB]
TriggerARBTriggerSource[ARB] IviRFSigGen»ARB
Generator»Trigger»ARBTriggerSource[ARB]
ARBExternalTriggerSlope[ARB] IviRFSigGen»ARBGenerator»Trigger»ARBExternalTriggerSlope[ARB]
DigitalModulationDigitalModulationBaseStandardCount[DMB] IviRFSigGen»Digital
Modulation»DigitalModulationBaseStandardCount[DMB]
DigitalModulationBaseSelectedStandard[DMB] IviRFSigGen»DigitalModulation»DigitalModulationBaseSelectedStandard[DMB]
DigitalModulationBaseDataSource[DMB] IviRFSigGen»DigitalModulation»DigitalModulationBaseDataSource[DMB]
DigitalModulationBasePRBSType[DMB] IviRFSigGen»DigitalModulation»DigitalModulationBasePRBSType[DMB]
DigitalModulationBaseSelectedBitSequence[DMB] IviRFSigGen»DigitalModulation»DigitalModulationBaseSelectedBitSequence[DMB]
DigitalModulationBaseClockSource[DMB] IviRFSigGen»DigitalModulation»DigitalModulationBaseClockSource[DMB]
DigitalModulationBaseExternalClockType[DMB] IviRFSigGen»DigitalModulation»DigitalModulationBaseExternalClockType[DMB]
CDMACDMAStandardCount[CDMA] IviRFSigGen»CDMA»CDMA
StandardCount[CDMA]CDMASelectedStandard[CDMA] IviRFSigGen»CDMA»CDMA
SelectedStandard[CDMA]CDMATestModelCount[CDMA] IviRFSigGen»CDMA»CDMATest
ModelCount[CDMA]CDMASelectedTestModel[CDMA] IviRFSigGen»CDMA»CDMA
SelectedTestModel[CDMA]CDMAClockSource[CDMA] IviRFSigGen»CDMA»CDMAClock
Source[CDMA]TriggerCDMATriggerSource[CDMA] IviRFSigGen»CDMA»Trigger»CDMA
TriggerSource[CDMA]CDMAExternalTriggerSlope[CDMA] IviRFSigGen»CDMA»Trigger»CDMA
ExternalTriggerSlope[CDMA]
TDMATDMAStandardCount[TDMA] IviRFSigGen»TDMA»TDMA
StandardCount[TDMA]TDMASelectedStandard[TDMA] IviRFSigGen»TDMA»TDMA
SelectedStandard[TDMA]TDMAFrameCount[TDMA] IviRFSigGen»TDMA»TDMAFrame
Count[TDMA]TDMASelectedFrame[TDMA] IviRFSigGen»TDMA»TDMA
SelectedFrame[TDMA]TDMAClockSource[TDMA] IviRFSigGen»TDMA»TDMAClock
Source[TDMA]TDMAClockType[TDMA] IviRFSigGen»TDMA»TDMAClock
Type[TDMA]TriggerTDMATriggerSource[TDMA] IviRFSigGen»TDMA»Trigger»TDMA
TriggerSource[TDMA]TDMAExternalTriggerSlope[TDMA] IviRFSigGen»TDMA»Trigger»TDMA
ExternalTriggerSlope[TDMA]
IviRFSigGenErrorandWarningCodesStatusCodeRangesStatusCodeType NumericRange(inHex)IviRFSigGenErrors 0xBFFA2001to0xBFFA3FFFIviRFSigGenWarnings 0x3FFA2001to0x3FFA3FFFIVISpecificDriverErrors 0xBFFA4000to0xBFFA5FFFIVISpecificDriverWarnings 0x3FFA4000to0x3FFA5FFFIVIErrors 0xBFFA0000to0xBFFA1FFFIVIWarnings 0x3FFA0000to0x3FFA1FFFCommonInstrumentDriverErrors 0xBFFC0000to0xBFFCFFFFCommonInstrumentDriverWarnings 0x3FFC0000to0x3FFCFFFFVISAErrors 0xBFFF0000to0xBFFFFFFFVISAWarnings 0x3FFF0000to0xFFFFFFF
TheIviRFSigGenclassdriverdefinestheerrorcodesshowninthefollowingtableinadditiontotheIVIdefinederrorcodes.
IviRFSigGenErrorCodesError Value MessageIVIRFSIGGEN_ERROR_TRIGGER_NOT_SOFTWARE 0xBFFA1001 Thetrigger
sourceisnotsoftwaretrigger.
IVIRFSIGGEN_ERROR_MAX_TIME_EXCEEDED 0xBFFA2003 Maximumtimeexceededbeforetheoperationcompleted.
IVIRFSIGGEN_ERROR_LIST_UNKNOWN 0xBFFA200A Listisunknown.
RelatedTopicIVIStatusCodes
IviRFSigGenVIsExpandthisbooktoviewanalphabetizedlistofIviRFSigGenVIs.
IviRFSigGenCalibrateIQ[MIQ]IviRFSigGenModulateIQCapabilityGroupThisVIcalibratestheIQmodulator.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenClearAllArbWaveforms[ARB]IviRFSigGenArbGeneratorCapabilityGroupThisVIdeletesallthecurrentlydefinedarbwaveforms.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenClearAllDigitalModulationBaseBitSequences[DMB]IviRFSigGenDigitalModulationBaseCapabilityGroupThisVIclears(deletes)allnamedbitsequences.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenClearAllLists[LST]IviRFSigGenListCapabilityGroupThisVIdeletesalllistsfromthepoolofdefinedlists.ThefollowingVIscreatelistnames:,,or.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenConfigureALCEnabledIviRFSigGenBaseCapabilityGroupThisVIenablestheAutomaticLevelControl.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.alcenabledSpecifieswhethertoenableordisableAutomaticLevelControl(ALC).Thedriverusesthisvaluetosettheproperty.
ValidValues:TRUE(1)-EnablestheAutomaticLevelControl(ALC)FALSE(0)-DisablestheAutomaticLevelControl(ALC)
DefaultValue:TRUE(1)errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenConfigureALC[ALC]IviRFSigGenALCCapabilityGroupThisVIconfigurestheALC(AutomaticLevelControl)ofthesignalgenerator'sRFoutput.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.sourceSpecifiesthesourceofthecontrollingvoltagefortheAutomaticLevelControl.TheRFlevelatthesensorpointisheldconstant.ThedriverusesthisvaluetosettheIviRFSigGen>>ALC>>ALCSourceproperty.
DefinedValues:IVIRFSIGGEN_VAL_ALC_SOURCE_INTERNAL-TheALCiscontrolledbyaninternalmeasurementsource.
IVIRFSIGGEN_VAL_ALC_SOURCE_EXTERNAL-TheALCiscontrolledbyanexternalvoltage.
DefaultValue:IVIRFSIGGEN_VAL_ALC_SOURCE_INTERNALbandwidthSpecifiesthebandwidthofAutomaticLevelControl(ALC).NarrowbandwidthimpovesnoiseandallowsAMwithmodulationfrequenciesbeyondbandwidthfrequency.ThevalueiscoercedtoreflecttheabilityofthecurrentRFsignalgenerator.ThedriverusesthisvaluetosettheIviRFSigGen>>ALC>>ALCBandwidthproperty.
Units:Hertz
DefaultValue:0.0errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenConfigureAMEnabled[AM]IviRFSigGenModulateAMCapabilityGroupThisVIconfiguresthesignalgeneratortoapplyamplitudemodulationtotheRFoutputsignal.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.amenabledSpecifieswhetherthesignalgeneratorappliesamplitudemodulationtotheRFoutputsignalornot.ThedriverusesthisvaluetosettheIviRFSigGen>>AnalogModulation>>AM>>AMEnabledproperty.
ValidValues:TRUE(1)-AmplitudemodulationOnFALSE(0)-AmplitudemodulationOff
DefaultValue:FALSE(0)errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.
Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenConfigureAMExternalCoupling[AM]IviRFSigGenModulateAMCapabilityGroupThisVIconfiguresthecouplingofanexternalsourceforamplitudemodulation.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.amexternalcouplingSpecifiesthecouplingoftheexternalsourceofthemodulatingsignal.ThedriverusesthisvaluetosettheIviRFSigGen>>AnalogModulation>>AM>>AMExternalCouplingproperty.
DefinedValues:
IVIRFSIGGEN_VAL_AM_EXTERNAL_COUPLING_AC-ACCouplingIVIRFSIGGEN_VAL_AM_EXTERNAL_COUPLING_DC-DCCoupling
DefaultValue:IVIRFSIGGEN_VAL_AM_EXTERNAL_COUPLING_ACerrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtain
fromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenConfigureAM[AM]IviRFSigGenModulateAMCapabilityGroupThisVIconfiguresthemodulationsource,scaling,anddepthforthesignalgenerator'samplitudemodulation.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.sourceSpecifiesthesourceofthesignalthatisusedasthemodulatingsignal.Ifmorethanonesourceisspecified,thevoltagesofallsources(internalandexternal)aresummed.Multiplesourcenamesareseparatedbycommas.ThedriverusesthisvaluetosettheIviRFSigGen>>AnalogModulation>>AM>>AMSourceproperty.
DefaultValue:""scalingSpecifieslinearorlogarithmicattenuationforamplitudemodulation.TheunitoftheIviRFSigGen>>AnalogModulation>>AM>>AMDepthpropertyischangedwiththissetting.ThedriverusesthisvaluetosettheIviRFSigGen>>AnalogModulation>>AM>>AMScalingproperty.
DefinedValues:IVIRFSIGGEN_VAL_AM_SCALING_LINEARIVIRFSIGGEN_VAL_AM_SCALING_LOGARITHMIC
DefaultValue:IVIRFSIGGEN_VAL_AM_SCALING_LINEARdepthSpecifiestheextentofmodulationthesignalgeneratorappliestotheRF-signal(carrierwaveform)withthemodulatingsignalasaresultofsummingallsources,internalandexternal.ThedriverusesthisvaluetosettheIviRFSigGen>>Analog
Modulation>>AM>>AMDepthproperty.
Units:IftheIviRFSigGen>>AnalogModulation>>AM>>AMScalingpropertyissettoLinear,thentheunitsarepercent(%).IftheIviRFSigGen>>AnalogModulation>>AM>>AMScalingpropertyissettologarithmic,thentheunitsaredBm.
DefaultValue:0.0errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenConfigureArbExternalTriggerSlope[ARB]IviRFSigGenArbGeneratorCapabilityGroupThisVIconfiguresthetriggereventtooccurontherisingorfallingedgeoftheinputsignal.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.slopeSpecifieswhetherthetriggereventoccursontherisingorfallingedgeoftheinputsignal.ThedriverusesthisvaluetosettheIviRFSigGen>>ARBGenerator>>Trigger>>ARBExternalTriggerSlopeproperty.
DefinedValues:
IVIRFSIGGEN_VAL_ARB_EXTERNAL_TRIGGER_SLOPE_POSITIVE-Enablesrisingedgetriggering.
IVIRFSIGGEN_VAL_ARB_EXTERNAL_TRIGGER_SLOPE_NEGATIVE-Enablesfallingedgetriggering.
DefaultValue:IVIRFSIGGEN_VAL_ARB_EXTERNAL_TRIGGER_SLOPE_POSITIVEerrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromthe
IviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenConfigureArbTriggerSource[ARB]IviRFSigGenArbGeneratorCapabilityGroupThisVIconfiguresthetriggersourceforthewaveformgeneration.Theoutputwaveformisgeneratedcontinuouslyifthesourceisimmediate.Otherwise,theoutputistriggered.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.sourceSpecifieshowtheArbwaveformisstarted.ThedriverusesthisvaluetosettheIviRFSigGen>>ARBGenerator>>Trigger>>ARBTriggerSourceproperty.
DefinedValues:
IVIRFSIGGEN_VAL_ARB_TRIGGER_SOURCE_IMMEDIATE-TheARBgeneratorsystemdoesnotwaitforatrigger.TheARBrunscontinuously.
IVIRFSIGGEN_VAL_ARB_TRIGGER_SOURCE_EXTERNAL-Thesweepisstartedwithanexternalsignal.
IVIRFSIGGEN_VAL_ARB_TRIGGER_SOURCE_SOFTWARE-Thesweepisstartedwithasoftwareprogrammabletrigger.
DefaultValue:IVIRFSIGGEN_VAL_ARB_TRIGGER_SOURCE_IMMEDIATEerrorin(noerror)Theerrorinclustercanaccepterrorinformation
wiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenConfigureArb[ARB]IviRFSigGenArbGeneratorCapabilityGroupThisVIconfigurestheARBgeneratorbyspecifyingthesamplefrequencyandfilterfrequency.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.clockfrequencySpecifiesthesamplefrequency.Thewaveformisgeneratedwiththisclockfrequency.ThedriverusesthisvaluetosettheIviRFSigGen>>ARBGenerator>>ARBClockFrequencyproperty.
Units:Hertz
DefaultValue:100.0MHzfilterfrequencySpecifythefilterfrequencywhichisthecut-offfrequencyofthelowpassfilterusedforantialiasingtheoutputwaveform.Thefilterfrequencynormallyislowerthantheclockfrequency.ThedriverusesthisvaluetosettheIviRFSigGen>>ARBGenerator>>ARBFilterFrequencyproperty.
Units:Hertz
DefaultValue:10.0KHzerrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmore
informationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenConfigureCDMAClockSource[CDMA]IviRFSigGenCDMABaseCapabilityGroupThisVIconfigurestheCDMAclocksource.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.sourceSpecifiesthesourceoftheclocksignalusedtogeneratethedigitalmodulationaccordingtotheselectedstandard.ThedriverusesthisvaluetosettheIviRFSigGen>>CDMA>>CDMAClockSourceproperty.
DefinedValues:IVIRFSIGGEN_VAL_CDMA_CLOCK_SOURCE_INTERNAL-Theinternalclockgeneratorisused.
IVIRFSIGGEN_VAL_CDMA_CLOCK_SOURCE_EXTERNAL-Aconnectedexternalclockgenerator(bitorsymbolclockfrequency)isused.
DefaultValue:IVIRFSIGGEN_VAL_CDMA_CLOCK_SOURCE_INTERNALerrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtain
fromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenConfigureCDMAExternalTriggerSlope[CDMA]IviRFSigGenCDMABaseCapabilityGroupThisVIconfiguresthetriggereventtooccurontherisingorfallingedgeoftheinputsignal.ThissettingisusedonlyifIviRFSigGen>>CDMA>>Trigger>>CDMATriggerSourceissettoExternal.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.slopeSpecifieswhetherthetriggereventoccursontherisingorfallingedgeoftheinputsignal.ThedriverusesthisvaluetosettheIviRFSigGen>>CDMA>>Trigger>>CDMAExternalTriggerSlopeproperty.
DefinedValues:
IVIRFSIGGEN_VAL_CDMA_EXTERNAL_TRIGGER_SLOPE_POSITIVE-Enablesrisingedgetriggering.
IVIRFSIGGEN_VAL_CDMA_EXTERNAL_TRIGGER_SLOPE_NEGATIVE-Enablesfallingedgetriggering.
DefaultValue:IVIRFSIGGEN_VAL_CDMA_EXTERNAL_TRIGGER_SLOPE_POSITIVEerrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenConfigureCDMATriggerSource[CDMA]IviRFSigGenCDMABaseCapabilityGroupThisVIconfigurestheCDMAtriggersourceforstartingorsynchronizingthegenerationofthechannelcodings.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.sourceSpecifiesthesourceofthetriggersignalthatstartsthechannelcodinggeneration.ThedriverusesthisvaluetosettheIviRFSigGen>>CDMA>>Trigger>>CDMATriggerSourceproperty.
DefinedValues:
IVIRFSIGGEN_VAL_CDMA_TRIGGER_SOURCE_IMMEDIATE-TheCDMAgeneratorsystemdoesnotwaitforatrigger.Eachchannelcodingisruncontinuously.
IVIRFSIGGEN_VAL_CDMA_TRIGGER_SOURCE_EXTERNAL-Eachchannelcodingisstartedwithanexternalsignal.
IVIRFSIGGEN_VAL_CDMA_TRIGGER_SOURCE_SOFTWARE-Eachchannelcodingisstartedwithasoftwareprogrammabletrigger.
DefaultValue:IVIRFSIGGEN_VAL_CDMA_TRIGGER_SOURCE_IMMEDIATE
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenConfigureDigitalModulationBaseClockSource[DMB]IviRFSigGenDigitalModulationBaseCapabilityGroupThisVIconfigurestheDigitalModulationBaseclocksource.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeIviRFSigGenInitializeWithOptionsVIs.sourceSpecifiesthesourceoftheclocksignalusedtogeneratethedigitalmodulationaccordingtotheselectedstandard.ThedriverusesthisvaluetosettheIviRFSigGen>>DigitalModulation>>DigitalModulationBaseClockSourceproperty.
DefinedValues:IVIRFSIGGEN_VAL_DIGITAL_MODULATION_BASE_CLOCK_SOURCE_INTERNAL-Theinternalclockgeneratorisused.
IVIRFSIGGEN_VAL_DIGITAL_MODULATION_BASE_CLOCK_SOURCE_EXTERNAL-Aconnectedexternalclockgenerator(bitorsymbolclockfrequency)isused.
DefaultValue:IVIRFSIGGEN_VAL_DIGITAL_MODULATION_BASE_CLOCK_SOURCE_INTERNALtypeSpecifiesthetypeoftheexternalclocksignalusedtogeneratethedigitalmodulation.ThisvalueisusedonlyiftheIviRFSigGen>>DigitalModulation>>DigitalModulationBaseClockSourcepropertyissettoExternal.ThedriverusesthisvaluetosettheIviRFSigGen>>DigitalModulation>>DigitalModulationBaseExternalClockTypeproperty.
DefinedValues:
IVIRFSIGGEN_VAL_DIGITAL_MODULATION_BASE_EXTERNAL_CLOCK_TYPE_BIT-Theexternalclockfrequencyisequaltothebitclockfrequencyofthedigitalmodulation.
IVIRFSIGGEN_VAL_DIGITAL_MODULATION_BASE_EXTERNAL_CLOCK_TYPE_SYMBOL-Theexternalclockfrequencyisequaltothesymbolclockfrequencyofthedigitalmodulation.
DefaultValue:IVIRFSIGGEN_VAL_DIGITAL_MODULATION_BASE_EXTERNAL_CLOCK_TYPE_BITerrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenConfigureDigitalModulationBaseDataSource[DMB]IviRFSigGenDigitalModulationBaseCapabilityGroupThisVIconfiguresthesourceofthedataforthedigitalmodulation.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.sourceSpecifiesthesourceofdata.ThedataisusedtomodulatetheRFsignalaccordingtothestandardselectedwiththeIviRFSigGen>>DigitalModulation>>DigitalModulationBaseSelectedStandardproperty.ThedriverusesthisvaluetosettheIviRFSigGen>>DigitalModulation>>DigitalModulationBaseDataSourceproperty.
DefinedValues:IVIRFSIGGEN_VAL_DIGITAL_MODULATION_BASE_DATA_SOURCE_EXTERNAL-Thedatafromanexternaldeviceconnectedtotheinstrumentisused.
IVIRFSIGGEN_VAL_DIGITAL_MODULATION_BASE_DATA_SOURCE_PRBS-TheinternalPRBS(PseudoRandomBinarySequence)generatorisusedasdatasource.
IVIRFSIGGEN_VAL_DIGITAL_MODULATION_BASE_DATA_SOURCE_BIT_SEQUENCE-Aconstantbitsequenceisusedasdatasourceandrepeatedcontinuously.
DefaultValue:IVIRFSIGGEN_VAL_DIGITAL_MODULATION_BASE_DATA_SOURCE_EXTERNALerrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIs
previouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenConfigureDigitalModulationBasePRBSType[DMB]IviRFSigGenDigitalModulationBaseCapabilityGroupThisVIconfiguresthetypeofthePRBSusedasdataforthedigitalmodulation.ThesettingisusedonlyifIviRFSigGen>>DigitalModulation>>DigitalModulationBaseDataSourceissettoPRBS.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.typeSpecifiesthetypeofthePRBSasdefinedintheCCITT-V.52standard.ThePRBS(PseudoRandomBinarySequence)isusedonlyiftheIviRFSigGen>>DigitalModulation>>DigitalModulationBaseDataSourcepropertyissettoPRBS.ThedriverusesthisvaluetosettheIviRFSigGen>>DigitalModulation>>DigitalModulationBasePRBSTypeproperty.
DefinedValues:IVIRFSIGGEN_VAL_DIGITAL_MODULATION_BASE_PRBS_TYPE_PRBS9-LengthofPRBSsequenceis2E9-1.
IVIRFSIGGEN_VAL_DIGITAL_MODULATION_BASE_PRBS_TYPE_PRBS11-LengthofPRBSsequenceis2E11-1.
IVIRFSIGGEN_VAL_DIGITAL_MODULATION_BASE_PRBS_TYPE_PRBS15-LengthofPRBSsequenceis2E15-1.
IVIRFSIGGEN_VAL_DIGITAL_MODULATION_BASE_PRBS_TYPE_PRBS16
-LengthofPRBSsequenceis2E16-1.
IVIRFSIGGEN_VAL_DIGITAL_MODULATION_BASE_PRBS_TYPE_PRBS20-LengthofPRBSsequenceis2E20-1
IVIRFSIGGEN_VAL_DIGITAL_MODULATION_BASE_PRBS_TYPE_PRBS21-LengthofPRBSsequenceis2E21-1.
IVIRFSIGGEN_VAL_DIGITAL_MODULATION_BASE_PRBS_TYPE_PRBS23-LengthofPRBSsequenceis2E23-1.
DefaultValue:IVIRFSIGGEN_VAL_DIGITAL_MODULATION_BASE_PRBS_TYPE_PRBS9errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenConfigureFMEnabled[FM]IviRFSigGenModulateFMCapabilityGroupThisVIconfiguresthesignalgeneratortoapplyfrequencymodulationtotheRFoutputsignal.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.fmenabledSpecifieswhetherthesignalgeneratorappliesfrequencymodulationtotheRFoutputsignalornot.ThedriverusesthisvaluetosettheIviRFSigGen>>AnalogModulation>>FM>>FMEnabledproperty.
ValidValues:TRUE(1)-FrequencymodulationOnFALSE(0)-FrequencymodulationOff
DefaultValue:FALSE(0)errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.
Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenConfigureFMExternalCoupling[FM]IviRFSigGenModulateFMCapabilityGroupThisVIconfiguresthecouplingofanexternalsourceforfrequencymodulation.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.fmexternalcouplingSpecifiesthecouplingoftheexternalsourceofthemodulatingsignal.ThedriverusesthisvaluetosettheIviRFSigGen>>AnalogModulation>>FM>>FMExternalCouplingproperty.
DefinedValues:
IVIRFSIGGEN_VAL_FM_EXTERNAL_COUPLING_AC-ACCouplingIVIRFSIGGEN_VAL_FM_EXTERNAL_COUPLING_DC-DCCoupling
DefaultValue:IVIRFSIGGEN_VAL_FM_EXTERNAL_COUPLING_ACerrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtain
fromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenConfigureFM[FM]IviRFSigGenModulateFMCapabilityGroupThisVIconfiguresthemodulationdeviationandmodulationsourceforthesignalgenerator'sfrequencymodulation.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.sourceSpecifiesthesourceofthesignalthatisusedasthemodulatingsignal.Ifmorethanonesourceisspecified,thevoltagesofallsources(internalandexternal)aresummed.Multiplesourcenamesareseparatedbycommas.ThedriverusesthisvaluetosettheIviRFSigGen>>AnalogModulation>>FM>>FMSourceproperty.
DefaultValue:""deviationSpecifiestheextentofmodulation(peakfrequencydeviation)thesignalgeneratorappliestotheRF-signal(carrierwaveform)withthemodulatingsignalasaresultofsummingallsources,internalandexternal.ThedriverusesthisvaluetosettheIviRFSigGen>>AnalogModulation>>FM>>FMDeviationproperty.
Units:Hertz
DefaultValue:0.0errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenConfigureFrequencyStepDwell[FST]IviRFSigGenFrequencyStepCapabilityGroupThisVIconfigureshowthefrequencysweepadvances.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.singleenabledSpecifyifthefrequencysweepadvancesafterthenexttriggerevent(TRUE)orimmediatelyafterthedwelltimeends(FALSE).ThedriverusesthisvaluetosettheIviRFSigGen>>Sweep>>FrequencyStep>>Frequency_STEP_SINGLE_STEP_ENABLEDproperty.
ValidValues:TRUE;FALSE
DefaultValue:FALSEdwellSpecifythedurationtimeofonestep.Dwelltimestartsimmediateafteratriggerorthenextstep;nosettlingtimeisadded.ThedriverusesthisvaluetosettheIviRFSigGen>>Sweep>>FrequencyStep>>Frequency_STEP_DWELLproperty.
Units:Seconds
DefaultValue:2.0ms
Note:
ThispropertyisignorediftheIviRFSigGen>>Sweep>>FrequencyStep>>Frequency_STEP_SINGLE_STEP_ENABLEDpropertyis
settoTRUE.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenConfigureFrequencyStepStartStop[FST]IviRFSigGenFrequencyStepCapabilityGroupThisVIconfiguresthesettingsthatcontrolthestepfrequenciesofthegenerator'sRFoutputsignal.Thesesettingsarestartandstopfrequency,stepsize,andlin/logscaling.Ifthestopfrequencyislessthanthestartfrequency,thefrequencydecreasesduringthesweep.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.startSpecifiesthestartfrequencyofthesteppedsweep.Ifthestopfrequencyislessthanthestartfrequency,thefrequencydecreasesduringthesweep.ThedriverusesthisvaluetosettheIviRFSigGen>>Sweep>>FrequencyStep>>Frequency_STEP_STARTproperty.
Units:Hertz
DefaultValue:500.0KHzstopSpecifiesthestopfrequencyofthesteppedsweep.Ifthestopfrequencyislessthanthestartfrequency,thefrequencydecreasesduringthesweep.ThedriverusesthisvaluetosettheIviRFSigGen>>Sweep>>FrequencyStep>>Frequency_STEP_STOPproperty.
Units:Hertz
DefaultValue:5.0MHzscalingSpecifiesthespacingofthesteps.Thedriverusesthisvalue
tosettheIviRFSigGen>>Sweep>>FrequencyStep>>Frequency_STEP_SCALINGproperty.
DefinedValues:IVIRFSIGGEN_VAL_FREQUENCY_STEP_SCALING_LINEAR-Linearscaling
IVIRFSIGGEN_VAL_FREQUENCY_STEP_SCALING_LOGARITHMIC-Logarithmicscaling
DefaultValue:IVIRFSIGGEN_VAL_FREQUENCY_STEP_SCALING_LINEARstepsizeSpecifiesthestepsize.ThedriverusesthisvaluetosettheIviRFSigGen>>Sweep>>FrequencyStep>>Frequency_STEP_SIZEproperty.
Units:TheunitsareHzwhentheIviRFSigGen>>Sweep>>FrequencyStep>>Frequency_STEP_SCALINGpropertyissettoIVIRFSIGGEN_VAL_FREQUENCY_STEP_SCALING_LINEARThevalueisunitless(factor)whentheIviRFSigGen>>Sweep>>FrequencyStep>>Frequency_STEP_SCALINGpropertyissettoIVIRFSIGGEN_VAL_FREQUENCY_STEP_SCALING_LOGARITHMIC.
DefaultValue:100KHzerrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenConfigureFrequencySweepCenterSpan[FSW]IviRFSigGenFrequencySweepCapabilityGroupThisVIconfiguresthecenterfrequencyandspanforafrequencysweep.ThisVImodifiesthestartandstoppropertiesasfollows:
IviRFSigGen>>Sweep>>FrequencyStep>>Frequency_STEP_START=Center-Span/2IviRFSigGen>>Sweep>>FrequencyStep>>Frequency_STEP_STOP=Center+Span/2
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.centerSpecifiesthecenterfrequencyforafrequencysweep.
Units:Hertz
DefaultValue:50.0MHzspanSpecifiesthefrequencyspanforafrequencysweep.
Units:Hertz
DefaultValue:500.0KHzerrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.Usethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfrom
otherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenConfigureFrequencySweepStartStop[FSW]IviRFSigGenFrequencySweepCapabilityGroupThisVIconfiguresthestartandstopfrequenciesforafrequencysweep.Ifthestopfrequencyislessthanthestartfrequency,thefrequencydecreasesduringthesweep
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.startSpecifiesthestartfrequencyofthesweep.Ifthestopfrequencyislessthanthestartfrequency,thefrequencydecreasesduringthesweep.ThedriverusesthisvaluetosettheIviRFSigGen>>Sweep>>FrequencySweep>>Frequency_SWEEP_STARTproperty.
Units:Hertz
DefaultValue:100.0KHzstopSpecifiesthestopfrequencyofthesweep.Ifthestopfrequencyislessthanthestartfrequency,thefrequencydecreasesduringthesweep.ThedriverusesthisvaluetosettheIviRFSigGen>>Sweep>>FrequencySweep>>Frequency_SWEEP_STOPproperty.
Units:Hertz
DefaultValue:100.0MHzerrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenConfigureFrequencySweepTime[FSW]IviRFSigGenFrequencySweepCapabilityGroupThisVIconfiguresthedurationofonefrequencysweep.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.timeSpecifiesthedurationofonesweepfromstarttostopfrequency.ThedriverusesthisvaluetosettheIviRFSigGen>>Sweep>>FrequencySweep>>Frequency_SWEEP_TIMEproperty.
Units:Seconds
DefaultValue:1.0serrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmore
informationabouttheerrordisplayed.
IviRFSigGenConfigureIQEnabled[MIQ]IviRFSigGenModulateIQCapabilityGroupThisVIconfiguresthesignalgeneratortoapplyIQ(vector)modulationtotheRFoutputsignal.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.iqenabledEnablesIQ(vector)modulationoftheoutputRFsignal.ThedriverusesthisvaluetosettheIviRFSigGen>>IQ>>IQEnabledproperty.
ValidValues:TRUE;FALSE
DefaultValue:FALSEerrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenConfigureIQImpairmentEnabled[IQI]IviRFSigGenIQImpairmentCapabilityGroupThisVIenablestheIQ(vector)modulationtoallowcontrolledimpairmentfortestorexternalcorrections.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.iqimpairmentenabledEnablesIQimpairment.ThedriverusesthisvaluetosettheIviRFSigGen>>IQ>>IQImpairment>>IQImpairmentEnabledproperty.
ValidValues:TRUE;FALSE
WhensettoTRUE,thefollowingimpairmentpropertiesareapplied:
IviRFSigGen>>IQ>>IQImpairment>>IQIOffsetIviRFSigGen>>IQ>>IQImpairment>>IQQOffsetIviRFSigGen>>IQ>>IQImpairment>>IQRatioIviRFSigGen>>IQ>>IQImpairment>>IQSkew
DefaultValue:FALSEerrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenConfigureIQImpairment[IQI]IviRFSigGenIQImpairmentCapabilityGroupThisVIconfiguresthesettingsthatsimulateorcorrectimpairmentforthesignalgenerator'sIQmodulation.ThesesettingsareonlyusediftheIviRFSigGen>>IQ>>IQImpairment>>IQImpairmentEnabledpropertyissettoTRUE.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.ioffsetSpecifiesanoriginoffsetvoltagetotheIsignal.Therangeofallowablevaluesis-100%to+100%.ThedriverusesthisvaluetosettheIviRFSigGen>>IQ>>IQImpairment>>IQIOffsetproperty.
Units:Percent(%)
DefaultValue:0.0qoffsetSpecifiesanoriginoffsetvoltagetotheQsignal.Therangeofallowablevaluesis-100%to+100%.ThedriverusesthisvaluetosettheIQ_Q_OFFSETproperty.
Units:Percent(%)
DefaultValue:0.0ratioSpecifiesthegainimbalancebetweentheIandQchannels.Fornoimbalancethisvalueissetto0%.ThedriverusesthisvaluetosettheIviRFSigGen>>IQ>>IQImpairment>>IQRatioproperty.
Units:Percent(%)
DefaultValue:0.0skewSpecifiestheadjustmentofthephaseanglebetweentheIandQvectors.Ifthisskewiszero,thephaseangleis90degrees.ThedriverusesthisvaluetosettheIviRFSigGen>>IQ>>IQImpairment>>IQSkewproperty.
Units:Degrees
DefaultValue:0.0errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenConfigureIQ[MIQ]IviRFSigGenModulateIQCapabilityGroupThisVIconfiguresthesignalgeneratortoapplyIQ(vector)modulationtotheRFoutputsignal.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.sourceSpecifiesthesourceofthesignalthatthesignalgeneratorusesforIQmodulation.ThedriverusesthisvaluetosettheIviRFSigGen>>IQ>>IQSourceproperty.
DefinedValues:
IVIRFSIGGEN_VAL_IQ_SOURCE_DIGITAL_MODULATION_BASE-ThesignalgeneratorusestheinternallygenerateddigitalmodulationsignaltoapplyIQmodulationtotheoutputRFsignal.
IVIRFSIGGEN_VAL_IQ_SOURCE_CDMA_BASE-ThesignalgeneratorusestheinternallygeneratedCDMAsignaltoapplyIQmodulationtotheoutputRFsignal.
IVIRFSIGGEN_VAL_IQ_SOURCE_TDMA_BASE-ThesignalgeneratorusestheinternallygeneratedTDMAsignaltoapplyIQmodulationtotheoutputRFsignal.
IVIRFSIGGEN_VAL_IQ_SOURCE_EXTERNAL-ThesignalgeneratorusesdatafromanexternalsourceforIQmodulation.
IVIRFSIGGEN_VAL_IQ_SOURCE_ARB_GENERATOR-ThesignalgeneratorusestheinternallygeneratedArbsignaltoapplyIQmodulationtotheoutputRFsignal.
DefaultValue:IVIRFSIGGEN_VAL_IQ_SOURCE_EXTERNALswapenabledEnablestheinversephaserotationoftheIQsignalbyswappingtheIandQinputs.ThedriverusesthisvaluetosettheIviRFSigGen>>IQ>>IQSwapEnabledproperty.
ValidValues:
TRUE-TheRFsignalgeneratorappliesnon-inversephaserotationoftheIQsignal.
FALSE-TheRFsignalgeneratorappliesinversephaserotationoftheIQsignal.
DefaultValue:FALSEerrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenConfigureLFGeneratorOutput[LFO]IviRFSigGenLFGeneratorOutputCapabilityGroupThisVIsetstheoutputvoltageandenablestheLFgeneratorwithintheRFsignalgenerator.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.amplitudeSpecifiestheoutputvoltagetheoftheLFgenerator.ThedriverusesthisvaluetosettheIviRFSigGen>>LFGenerator>>LFGeneratorOutputs>>LFGeneratorOutputAmplitudeproperty.
Units:Voltspeaktopeak.
DefaultValue:0.0enabledSpecifieswhethertheLFgeneratorappliesanoutputsignalornot.ThedriverusesthisvaluetosettheIviRFSigGen>>LFGenerator>>LFGeneratorOutputs>>LFGeneratorOutputEnabledproperty.
ValidValues:TRUE;FALSE
DefaultValue:FALSEerrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.
Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenConfigureLFGenerator[LF]IviRFSigGenLFGeneratorCapabilityGroupThisVIconfigurestheLFgeneratorsoutputfrequencyandwaveform.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.frequencySpecifiesthefrequencyoftheactiveLFgenerator.ThedriverusesthisvaluetosettheIviRFSigGen>>LFGenerator>>LFGeneratorFrequencyproperty.
Units:Hertz
DefaultValue:500HzwaveformSpecifiesthewaveformoftheactiveLFgenerator.ThedriverusesthisvaluetosettheIviRFSigGen>>LFGenerator>>LFGeneratorWaveformproperty.
DefinedValues:
IVIRFSIGGEN_VAL_LF_GENERATOR_WAVEFORM_SINE-Sinusoidwaveform.
IVIRFSIGGEN_VAL_LF_GENERATOR_WAVEFORM_SQUARE-Squarewaveform.
IVIRFSIGGEN_VAL_LF_GENERATOR_WAVEFORM_TRIANGLE-Trianglewaveform.
IVIRFSIGGEN_VAL_LF_GENERATOR_WAVEFORM_RAMP_UP
-Risingrampwaveform.
IVIRFSIGGEN_VAL_LF_GENERATOR_WAVEFORM_RAMP_DOWN-Fallingrampwaveform.
DefaultValue:IVIRFSIGGEN_VAL_LF_GENERATOR_WAVEFORM_SINEerrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenConfigureListDwell[LST]IviRFSigGenListCapabilityGroupThisVIconfigureshowliststeppingadvances.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.singlestepenabledSpecifiesiftheliststepadvancesafterthenexttriggerevent(TRUE)orimmediatelyafterthedwelltimeends(FALSE).
ValidValues:
TRUE-Thelistadvanceswhenthenexttriggereventoccurs.FALSE-Thelistwilladvanceimmediatelyafterthedwelltimeends.
ThedriverusesthisvaluetosettheIviRFSigGen>>Sweep>>List>>ListSingleStepEnabledproperty.
DefaultValue:FALSEdwellSpecifiesthedurationtimeofonestep.ThedriverusesthisvaluetosettheIviRFSigGen>>Sweep>>List>>ListDwellproperty.
Units:Seconds
DefaultValue:2.0msNotes
(1)ThispropertyisignoredifListSingleStepEnabledissettoTRUE.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenConfigureOutputEnabledIviRFSigGenBaseCapabilityGroupThisVIenablestheRFoutputsignal.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.outputenabledSpecifieswhethertoenableordisabletheRFoutputsignal.ThedriverusesthisvaluetosettheIviRFSigGen>>RF>>OuptutEnabledproperty.
ValidValues:TRUE(1)-OutputenabledFALSE(0)-Outputdisabled
DefaultValue:FALSE(0)errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenConfigurePMEnabled[PM]IviRFSigGenModulatePMCapabilityGroupThisVIconfiguresthesignalgeneratortoapplyphasemodulationtotheRFoutputsignal.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.pmenabledSpecifieswhetherthesignalgeneratorappliesphasemodulationtotheRFoutputsignalornot.ThedriverusesthisvaluetosettheIviRFSigGen>>AnalogModulation>>PM>>PMEnabledproperty.
ValidValues:TRUE(1)-PhasemodulationOnFALSE(0)-PhasemodulationOff
DefaultValue:FALSE(0)errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.
Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenConfigurePMExternalCoupling[PM]IviRFSigGenModulatePMCapabilityGroupThisVIconfiguresthecouplingofanexternalsourceforphasemodulation.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.pmexternalcouplingSpecifiesthecouplingoftheexternalsourceofthemodulatingsignal.ThedriverusesthisvaluetosettheIviRFSigGen>>AnalogModulation>>PM>>PMExternalCouplingproperty.
DefinedValues:
IVIRFSIGGEN_VAL_PM_EXTERNAL_COUPLING_AC-TheexternalsourceiscoupledforAConly.IVIRFSIGGEN_VAL_PM_EXTERNAL_COUPLING_DC-TheexternalsourceiscoupledforbothDCandAC.
DefaultValue:IVIRFSIGGEN_VAL_PM_EXTERNAL_COUPLING_ACerrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtain
fromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenConfigurePM[PM]IviRFSigGenModulatePMCapabilityGroupConfiguresthepropertythatcontrolthesignalgenerator'sphasemodulation.Thepropertiesarethemodulationdeviationandthemodulatingsource(s).
ThisVIconfiguresthemodulationdeviationandmodulationsourceforthesignalgenerator'sphasemodulation.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.sourceSpecifiesthesourceofthesignalthatisusedasthemodulatingsignal.Ifmorethanonesourceisspecified,thevoltagesofallsources(internalandexternal)aresummed.Multiplesourcenamesareseparatedbycommas.ThedriverusesthisvaluetosettheIviRFSigGen>>AnalogModulation>>PM>>PMSourceproperty.
DefaultValue:""deviationSpecifiestheextentofmodulation(peakphasedeviation)thesignalgeneratorappliestotheRF-signal(carrierwaveform)withthemodulatingsignalasaresultofsummingallsources,internalandexternal.ThedriverusesthisvaluetosettheIviRFSigGen>>AnalogModulation>>PM>>PMDeviationproperty.
Units:radians
DefaultValue:0.0errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.Usethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfrom
otherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenConfigurePowerStepDwell[PST]IviRFSigGenPowerStepCapabilityGroupThisVIconfigureshowthepowersweepadvances.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.singleenabledSpecifiesifthefrequencysweepadvancesafterthenexttriggerevent(TRUE)orimmediatelyafterthedwelltimeends(FALSE).ThedriverusesthisvaluetosettheIviRFSigGen>>Sweep>>PowerStep>>SingleStepEnabledproperty.
ValidValues:TRUE;FALSE
DefaultValue:FALSEdwellSpecifiesthedurationtimeofonestep.Dwelltimestartsimmediateafteratriggerorthenextstep;nosettlingtimeisadded.ThedriverusesthisvaluetosettheIviRFSigGen>>Sweep>>PowerStep>>PowerStepDwellproperty.
Units:Seconds
DefaultValue:2.0ms
Note:
ThispropertyisignorediftheIviRFSigGen>>Sweep>>PowerStep>>SingleStepEnabledpropertyissettoTRUE.errorin(noerror)Theerrorinclustercanaccepterrorinformation
wiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenConfigurePowerStepStartStop[PST]IviRFSigGenPowerStepCapabilityGroupThisVIconfiguresthesettingsthatcontrolthepowerstepsofthegenerator'sRFoutputsignal.Thesesettingsarestartandstoppowerandstepsize.Ifthestoppowerislessthanthestartpower,thepowerdecreasesinvalueduringthesweep
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.startSpecifiesthestartpowerofthesteppedsweep.Ifthestoppowerislessthanthestartpower,thepowerdecreasesinvalueduringthesweep.ThedriverusesthisvaluetosettheIviRFSigGen>>Sweep>>PowerStep>>PowerStepStartproperty.
Units:dBm
DefaultValue:-50.0stopSpecifiesthestartpowerofthesteppedsweep.Ifthestoppowerislessthanthestartpower,thepowerdecreasesinvalueduringthesweep.ThedriverusesthisvaluetosettheIviRFSigGen>>Sweep>>PowerStep>>PowerStepStopproperty.
Units:dBm
DefaultValue:-10.0stepsizeSpecifiesthestepsize.ThedriverusesthisvaluetosettheIviRFSigGen>>Sweep>>PowerStep>>PowerStepSizeproperty.
Units:dBm
DefaultValue:0.1dBmerrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenConfigurePowerSweepStartStop[PSW]IviRFSigGenPowerSweepCapabilityGroupThisVIconfiguresthestartandstoppowerforapowersweep.Ifthestoppowerislessthanthestartpower,thepowerdecreasesinvalueduringthesweep.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.startSpecifiesthestartpowerofthesweep.Ifthestoppowerislessthanthestartpower,thepowerdecreasesinvalueduringthesweep.ThedriverusesthisvaluetosettheIviRFSigGen>>Sweep>>PowerSweep>>PowerSweepStartproperty.
Units:dBm
DefaultValue:-50.0dBmstopSpecifiesthestoppowerofthesweep.Ifthestoppowerislessthanthestartpower,thepowerdecreasesinvalueduringthesweep.ThedriverusesthisvaluetosettheIviRFSigGen>>Sweep>>PowerSweep>>PowerSweepStopproperty.
Units:dBm
DefaultValue:-10.0dBmerrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.Usethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfrom
otherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenConfigurePowerSweepTime[PSW]IviRFSigGenPowerSweepCapabilityGroupThisVIconfiguresthedurationofonepowersweep.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.timeSpecifiesthedurationofonesweepfromstarttostoppower.ThedriverusesthisvaluetosettheIviRFSigGen>>Sweep>>PowerSweep>>PowerSweepTimeproperty.
Units:Seconds
DefaultValue:1.0serrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenConfigurePulseDouble[DPG]IviRFSigGenPulseDoubleGeneratorCapabilityGroupThisVIsetsthedoublepulsestateanddelayforthepulsegeneratorwithintheRFsignalgenerator.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.enabledEnablesdoublepulsemode.ThedriverusesthisvaluetosettheIviRFSigGen>>PulseGenerator>>DoublePulseGenerators>>PulseDoubleEnabledproperty.
ValidValues:TRUE;FALSE
DefaultValue:FALSEdelaySpecifiesthedelayofthesecondpulse.ThedriverusesthisvaluetosettheIviRFSigGen>>PulseGenerator>>DoublePulseGenerators>>PulseDoubleDelayproperty.
Units:Seconds
DefaultValue:0.0errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenConfigurePulseExternalTrigger[PG]IviRFSigGenPulseGeneratorCapabilityGroupThisVIconfiguresthetriggeringofthepulsegeneratorwithintheRFsignalgenerator.ThisVIspecifiestheexternaltriggerslopeandthedelaytimeforstartingthepulseafterthetriggerpulse.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.externalslopeSpecifieswhethertheeventoccursontherisingorfallingedgeoftheinputsignal.ThedriverusesthisvaluetosettheIviRFSigGen>>PulseGenerator>>PulseExternalTriggerSlopeproperty.
DefinedValues:IVIRFSIGGEN_VAL_PULSE_EXTERNAL_TRIGGER_SLOPE_POSITIVE-Enablesrisingedgetriggering.
IVIRFSIGGEN_VAL_PULSE_EXTERNAL_TRIGGER_SLOPE_NEGATIVE-Enablesfallingedgetriggering.
DefaultValue:IVIRFSIGGEN_VAL_PULSE_EXTERNAL_TRIGGER_SLOPE_POSITIVEdelaySpecifiesthedelayforstartingtheoutputpulsewithrespecttothetriggerinput.
Units:Seconds
DefaultValue:0.0
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenConfigurePulseInternalTrigger[PG]IviRFSigGenPulseGeneratorCapabilityGroupThisVIspecifiesthetimeperiod(repetitionrate)ofthepulsegeneratorwhenusingtheinternaltrigger(freerun)mode.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.periodSpecifiestheperiodofthepulsegeneratoroutputsignalwhenthepropertyIviRFSigGen>>PulseGenerator>>PulseTriggerSourceissettoInternal.ThedriverusesthisvaluetosettheIviRFSigGen>>PulseGenerator>>PulseInternalTriggerPeriodproperty.
Units:Seconds
DefaultValue:1.0mserrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.
Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenConfigurePulseModulationEnabled[PULM]IviRFSigGenModulatePulseCapabilityGroupThisVIconfiguresthesignalgeneratortoapplypulsemodulationtotheRFoutputsignal.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.pulsemodulationenabledSpecifieswhetherthesignalgeneratorappliespulsemodulationtotheRFoutputsignalornot.ThedriverusesthisvaluetosettheIviRFSigGen>>PulseModulation>>PulseMod.Enabledproperty.
ValidValues:TRUE(1)-EnablespulsemodulationFALSE(0)-Disablespulsemodulation
DefaultValue:FALSEerrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.
Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenConfigurePulseModulationExternalPolarity[PULM]IviRFSigGenModulatePulseCapabilityGroupThisfunctionspecifiesthepolarityoftheexternalsourcesignal.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.externalpolaritySpecifiesthepolarityoftheexternalsourcesignal.ThedriverusesthisvaluetosettheIviRFSigGen>>PulseModulation>>PulseMod.ExternalPolarityproperty.
DefinedValues:
IVIRFSIGGEN_VAL_PULSE_MODULATION_EXTERNAL_POLARITY_NORMAL-Thesignalgeneratormodulatesthecarriersignalwithnormalpulsepolarity.IncreasingthepositivepulsevoltagelevelresultsinhigherRFlevel.
IVIRFSIGGEN_VAL_PULSE_MODULATION_EXTERNAL_POLARITY_INVERSE-Thesignalgeneratormodulatesthecarriersignalwithinvertedpulsepolarity.IncreasingthepositivepulsevoltagelevelresultsinlowerRFlevel.
DefaultValue:IVIRFSIGGEN_VAL_PULSE_MODULATION_EXTERNAL_POLARITY_NORMALerrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.
Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenConfigurePulseModulationSource[PULM]IviRFSigGenModulatePulseCapabilityGroupThisVIsetsthesourceforpulsemodulationoftheRFoutputsignal.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.sourceSpecifiesthesourceofthesignalthatisusedasthemodulatingsignal.ThedriverusesthisvaluetosettheIviRFSigGen>>PulseModulation>>PulseMod.Sourceproperty.
DefinedValues:IVIRFSIGGEN_VAL_PULSE_MODULATION_SOURCE_INTERNAL-Theinternalpulsegeneratorisusedformodulation.
IVIRFSIGGEN_VAL_PULSE_MODULATION_SOURCE_EXTERNAL-Anexternalgeneratorisusedformodulation
DefaultValue:IVIRFSIGGEN_VAL_PULSE_MODULATION_SOURCE_INTERNALerrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformation
outofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenConfigurePulseOutput[PGO]IviRFSigGenPulseGeneratorOutputCapabilityGroupThisVIconfigurestheoutputandpolarityofthepulsegeneratorwithintheRFsignalgenerator.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.polaritySpecifiesthepolarityoftheoutputsignal.ThedriverusesthisvaluetosettheIviRFSigGen>>PulseGenerator>>PulseGeneratorOutput>>PulseOutputPolarityproperty.
DefinedValues:IVIRFSIGGEN_VAL_PULSE_OUTPUT_POLARITY_NORMAL-Normalpolarity
IVIRFSIGGEN_VAL_PULSE_OUTPUT_POLARITY_INVERSE-Invertedpolarity
DefaultValue:IVIRFSIGGEN_VAL_PULSE_OUTPUT_POLARITY_NORMALenabledEnablesthepulsegeneratorexternaloutput.ThedriverusesthisvaluetosettheIviRFSigGen>>PulseGenerator>>PulseGeneratorOutput>>PulseOutputEnabledproperty.
ValidValues:TRUE;FALSE
DefaultValue:FALSE
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenConfigurePulse[PG]IviRFSigGenPulseGeneratorCapabilityGroupThisVIconfiguresthetriggersource,pulsewidth,andgatingenabledforthepulsegeneratorwithintheRFsignalgenerator.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.triggersourceSpecifiesthesourceofthesignalthepulsegeneratorusestogenerateonepulse.ThedriverusesthisvaluetosettheIviRFSigGen>>PulseGenerator>>PulseTriggerSourceproperty.
DefinedValues:IVIRFSIGGEN_VAL_PULSE_TRIGGER_SOURCE_INTERNAL-Noexternaltriggerisused.ThepulseperiodisspecifiedbytheIviRFSigGen>>PulseGenerator>>PulseInternalTriggerPeriodproperty.
IVIRFSIGGEN_VAL_PULSE_TRIGGER_SOURCE_EXTERNAL-ThepulseisstartedwithatriggerafterthedelaytimespecifiedbytheIviRFSigGen>>PulseGenerator>>PulseExternalTriggerDelayproperty.
DefaultValue:
IVIRFSIGGEN_VAL_PULSE_TRIGGER_SOURCE_INTERNALpulsewidthSpecifiesthewidthoftheoutputpulse.Thedriver
usesthisvaluetosettheIviRFSigGen>>PulseGenerator>>PulseWidthproperty.
Units:Seconds
DefaultValue:50.0e-6secondsgatingenabledEnablespulsegating.ThedriverusesthisvaluetosettheIviRFSigGen>>PulseGenerator>>PulseGatingEnabledproperty.
ValidValues:TRUE;FALSE
DefaultValue:FALSEerrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenConfigureReferenceOscillator[RO]IviRFSigGenReferenceOscillatorCapabilityGroupThisVIconfiguresthesignalgenerator'sreferenceoscillator.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.sourceSpecifiesthereferencefrequencysourceusedtogeneratetheexactRFoutputfrequency.ThedriverusesthisvaluetosettheIviRFSigGen>>ReferenceOscillator>>ReferenceOscillatorSourceproperty.
DefinedValues:IVIRFSIGGEN_VAL_REFERENCE_OSCILLATOR_SOURCE_INTERNAL-Theinternalreferenceoscillatorisused.
IVIRFSIGGEN_VAL_REFERENCE_OSCILLATOR_SOURCE_EXTERNAL-Anexternalreferenceoscillatorisused.
DefaultValue:IVIRFSIGGEN_VAL_REFERENCE_OSCILLATOR_SOURCE_INTERNALfrequencySpecifiesthefrequencyoftheexternalsignal,whichisusedasreferenceforinternalRFfrequencygeneration.ThedriverusesthisvaluetosettheIviRFSigGen>>ReferenceOscillator>>ReferenceOscillatorExternalFrequencyproperty.
Units:Hertz
DefaultValue:10.0E6
Note:ThisvalueisusedonlyiftheIviRFSigGen>>ReferenceOscillator>>ReferenceOscillatorSourcepropertyissettoExternal.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenConfigureRFIviRFSigGenBaseCapabilityGroupThisVIconfiguresthefrequencyandthepowerleveloftheRFoutputsignal.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.frequencySpecifiesthefrequencyofthegeneratedRFsignal.Thedriverusesthisvaluetosettheproperty.
Units:Hertz
DefaultValue:1.0MHzpowerlevelSpecifiesthepowerlevelofthegeneratedRFsignal.Thedriverusesthisvaluetosettheproperty.
Units:dBm
DefaultValue:0.0errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.
Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenConfigureSweepIviRFSigGenSweepCapabilityGroupThisVIconfiguresthesignalgeneratorsweepmodeandtriggersource.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.modeSpecifiesthesweepmodeappliedtotheoutputsignal.ThedriverusesthisvaluetosettheIviRFSigGen>>Sweep>>SweepModeproperty.
DefinedValues:
IVIRFSIGGEN_VAL_SWEEP_MODE_NONE-TheRFoutputofthesignalgeneratorisanon-sweptsignal(ContinuousWave)usingthefrequencyandpower/levelspecifiedinthe.
IVIRFSIGGEN_VAL_SWEEP_MODE_FREQUENCY_SWEEP-ThesignalgeneratorsweepstheRFoutputsignal'sfrequencyinananalogform(non-stepped).
IVIRFSIGGEN_VAL_SWEEP_MODE_POWER_SWEEP-ThesignalgeneratorsweepstheRFoutputsignal'spowerinananalogform(non-stepped).
IVIRFSIGGEN_VAL_SWEEP_MODE_FREQUENCY_STEP-ThesignalgeneratorsweepstheRFoutputsignalsfrequencyinsteps.
IVIRFSIGGEN_VAL_SWEEP_MODE_POWER_STEP-ThesignalgeneratorsweepstheRFoutputsignalspowerlevelinsteps.
IVIRFSIGGEN_VAL_SWEEP_MODE_LIST-ThesignalgeneratorusestwolistswithfrequencyandpowerlevelvaluestosweeptheRFoutputsignals.
DefaultValue:IVIRFSIGGEN_VAL_SWEEP_MODE_NONEtriggersourceSpecifiesthetriggerusedtostartasweepoperation.ThedriverusesthisvaluetosettheIviRFSigGen>>Sweep>>SweepTriggerSourceproperty.
DefinedValues:
IVIRFSIGGEN_VAL_SWEEP_TRIGGER_SOURCE_IMMEDIATE-Thesweepsystemdoesnotwaitforatriggerofanykind,soitisrunningcontinuously.
IVIRFSIGGEN_VAL_SWEEP_TRIGGER_SOURCE_EXTERNAL-Thesweepisstartedwithanexternalsignal.
IVIRFSIGGEN_VAL_SWEEP_TRIGGER_SOURCE_SOFTWARE-Thesweepisstartedwithasoftwareprogrammabletrigger.
DefaultValue:IVIRFSIGGEN_VAL_SWEEP_TRIGGER_SOURCE_IMMEDIATEerrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWith
OptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenConfigureTDMAClockSource[TDMA]IviRFSigGenTDMABaseCapabilityGroupThisVIconfigurestheTDMAclocksource.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.sourceSpecifiesthesourceoftheclocksignalusedtogeneratethedigitalmodulationaccordingtotheselectedstandard.ThedriverusesthisvaluetosettheIviRFSigGen>>TDMA>>TDMAClockSourceproperty.
DefinedValues:IVIRFSIGGEN_VAL_TDMA_CLOCK_SOURCE_INTERNAL-Theinternalclockgeneratorisused.
IVIRFSIGGEN_VAL_TDMA_CLOCK_SOURCE_EXTERNAL-Aconnectedexternalclockgenerator(bitorsymbolclockfrequency)isused.
DefaultValue:IVIRFSIGGEN_VAL_TDMA_CLOCK_SOURCE_INTERNALtypeSpecifiesthetypeoftheexternalclocksignalusedtogeneratethedigitalmodulation.ThisvalueisusedonlyiftheIviRFSigGen>>TDMA>>TDMAClockSourcepropertyissettoExternal.
TypeisignoredifSourceissettoInternal.
DefinedValues:
IVIRFSIGGEN_VAL_TDMA_EXTERNAL_CLOCK_TYPE_BIT-Theexternalclockfrequencyisequaltothebitclockfrequencyofthedigitalmodulation.
IVIRFSIGGEN_VAL_TDMA_EXTERNAL_CLOCK_TYPE_SYMBOL-Theexternalclockfrequencyisequaltothesymbolclockfrequencyofthedigitalmodulation.
DefaultValue:IVIRFSIGGEN_VAL_TDMA_EXTERNAL_CLOCK_TYPE_BITerrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenConfigureTDMAExternalTriggerSlope[TDMA]IviRFSigGenTDMABaseCapabilityGroupThisVIconfiguresthetriggereventtooccurontherisingorfallingedgeoftheinputsignal.ThissettingisusedonlyifIviRFSigGen>>TDMA>>Trigger>>TDMATriggerSourceissettoExternal
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.slopeSpecifieswhetherthetriggereventoccursontherisingorfallingedgeoftheinputsignal.ThedriverusesthisvaluetosettheIviRFSigGen>>TDMA>>Trigger>>TDMAExternalTriggerSlopeproperty.
DefinedValues:
IVIRFSIGGEN_VAL_TDMA_EXTERNAL_TRIGGER_SLOPE_POSITIVE-Enablesrisingedgetriggering.
IVIRFSIGGEN_VAL_TDMA_EXTERNAL_TRIGGER_SLOPE_NEGATIVE-Enablesfallingedgetriggering.
DefaultValue:IVIRFSIGGEN_VAL_TDMA_EXTERNAL_TRIGGER_SLOPE_POSITIVEerrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromthe
IviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenConfigureTDMATriggerSource[TDMA]IviRFSigGenTDMABaseCapabilityGroupThisVIconfigurestheTDMAtriggersourceforstartingorsynchronizingthegenerationoftheframes/slots.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.sourceSpecifiesthesourceofthetriggersignalthatstartstheframe/slotsgeneration.ThedriverusesthisvaluetosettheIviRFSigGen>>TDMA>>Trigger>>TDMATriggerSourceproperty.
DefinedValues:
IVIRFSIGGEN_VAL_TDMA_TRIGGER_SOURCE_IMMEDIATE-TheTDMAgeneratorsystemdoesnotwaitforatrigger.Eachframeisruncontinuously.
IVIRFSIGGEN_VAL_TDMA_TRIGGER_SOURCE_EXTERNAL-Eachframeisstartedwithanexternalsignal.
IVIRFSIGGEN_VAL_TDMA_TRIGGER_SOURCE_SOFTWARE-Eachframeisstartedwithasoftwareprogrammabletrigger.
DefaultValue:IVIRFSIGGEN_VAL_TDMA_TRIGGER_SOURCE_IMMEDIATE
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenCreateFrequencyList[LST]IviRFSigGenListCapabilityGroupThisVIcreatesanamedlistoffrequencyvalues.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.nameThenameofthelisttobecreated.
DefaultValue:""lengthThenumberofvaluesinthelistarray.
DefaultValue:0frequencyPassthearrayoffrequencyvaluestobecomeelementsofthelist.ThearraymusthaveatleastasmanyelementsasthevalueintheLengthparameter.
Units:Hertzerrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.
Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenCreateFrequencyPowerList[LST]ThisVIcreatesanamedlistoffrequencyandpowervalues.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.nameThenameofthelisttobecreated.
DefaultValue:""lengthThenumberofvaluesinthelistarray.
DefaultValue:0frequencyPassthearrayoffrequencyvaluestobecomeelementsofthelist.ThearraymusthaveatleastasmanyelementsasthevalueintheLengthparameter.
Units:HertzpowerPassthearrayofpowervaluestobecomeelementsofthelist.ThearraymusthaveatleastasmanyelementsasthevalueintheLengthparameter.
Units:dBmerrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtain
fromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenCreatePowerList[LST]IviRFSigGenListCapabilityGroupThisVIcreatesanamedlistofpowervalues.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.nameThenameofthelisttobecreated.
DefaultValue:""lengthThenumberofvaluesinthelistarray.
DefaultValue:0powerPassthearrayofpowervaluestobecomeelementsofthelist.ThearraymusthaveatleastasmanyelementsasthevalueintheLengthparameter.
Units:dBmerrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.
Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenDisableAllModulationIviRFSigGenBaseCapabilityGroupThisVIdisablesallcurrentlyenabledmodulations(e.g.analog,pulse,IQ,anddigitalmodulation).
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenGetAnalogModulationSourceName[MS]IviRFSigGenAnalogModulationSourceCapabilityGroupThisVIreturnsthespecificdriverdefinedanalogmodulationsourcenamethatcorrespondstotheone-basedindexspecifiedbytheIndexparameter.IfyoupassinavaluefortheIndexparameterthatislessthanoneorgreaterthanthevalueoftheIviRFSigGen>>AnalogModulation>>Source>>ModulationSourceCountproperty,theVIreturnsanemptystringintheNameparameterandreturnstheInvalidValueerror.
Note:Foraninstrumentwithonlyoneanalogmodulationsource,i.e.theIviRFSigGen>>AnalogModulation>>Source>>ModulationSourceCountpropertyisone,thedrivermayreturnanemptystring.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.indexTheindexoftheanalogmodulationsourcewhosenameisreturned.ThevaluemustbegreaterthanorequaltooneandlessthanorequaltoIviRFSigGen>>AnalogModulation>>Source>>ModulationSourceCount.
Note:
Zeroisnotalegalvalue.
DefaultValue:1namebuffersizeSpecifythebuffersizefortheNameparameter.
DefaultValue:0nameTheanalogmodulationsourcenamethatcorrespondstotheIndex.
TheNamebuffermustcontainatleastasmanyelementsasthevalueyouspecifywiththeNameBufferSizeparameter.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenGetCDMAStandardName[CDMA]IviRFSigGenCDMABaseCapabilityGroupThisVIreturnsthespecificdriverdefinedCDMAstandardnamethatcorrespondstotheone-basedindexspecifiedbytheIndexparameter.IfyoupassinavaluefortheIndexparameterthatislessthanoneorgreaterthanthevalueoftheIviRFSigGen>>CDMA>>CDMAStandardCountproperty,theVIreturnsanemptystringintheNameparameterandreturnstheInvalidValueerror.
Note:ForaninstrumentwithonlyoneCDMAstandard,i.e.theIviRFSigGen>>CDMA>>CDMAStandardCountpropertyisone,thedrivermayreturnanemptystring.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.indexSpecifiestheindexoftheCDMAStandardNametoreturn.
DefaultValue:0namebuffersizeSpecifythebuffersizefortheNameparameter.
DefaultValue:0errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtain
fromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.nameTheCDMAstandardnamethatcorrespondstotheIndex.
TheNamebuffermustcontainatleastasmanyelementsasthevalueyouspecifywiththeNameBufferSizeparameter.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenGetCDMATestModelName[CDMA]IviRFSigGenCDMABaseCapabilityGroupThisVIreturnsthespecificdriverdefinedCDMAtestmodelnamethatcorrespondstotheone-basedindexspecifiedbytheIndexparameter.IfyoupassinavaluefortheIndexparameterthatislessthanoneorgreaterthanthevalueoftheIviRFSigGen>>CDMA>>CDMATestModelCountproperty,theVIreturnsanemptystringintheNameparameterandreturnstheInvalidValueerror.
Note:ForaninstrumentwithonlyoneCDMAtestmodel,i.e.theIviRFSigGen>>CDMA>>CDMATestModelCountpropertyisone,thedrivermayreturnanemptystring.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.indexSpecifiestheindexoftheCDMAtestmodelnametoreturn.
DefaultValue:0namebuffersizeSpecifythebuffersizefortheNameparameter.
DefaultValue:0errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtain
fromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.nameTheCDMAtestmodelnamethatcorrespondstotheIndex.
TheNamebuffermustcontainatleastasmanyelementsasthevalueyouspecifywiththeNameBufferSizeparameter.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenGetDigitalModulationBaseStandardName[DMB]IviRFSigGenDigitalModulationBaseCapabilityGroupThisVIreturnsthespecificdriverdefinedDigitalModulationBasestandardnamethatcorrespondstotheone-basedindexspecifiedbytheIndexparameter.IfyoupassinavaluefortheIndexparameterthatislessthanoneorgreaterthanthevalueoftheIviRFSigGen>>DigitalModulation>>DigitalModulationBaseStandardCountproperty,theVIreturnsanemptystringintheNameparameterandreturnstheInvalidValueerror.
Note:ForaninstrumentwithonlyoneDigitalModulationBasestandard,i.e.theIviRFSigGen>>DigitalModulation>>DigitalModulationBaseStandardCountpropertyisone,thedrivermayreturnanemptystring.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.indexSpecifiestheindexoftheDigitalModulationBaseNametoreturn.
DefaultValue:0namebuffersizeSpecifythebuffersizefortheNameparameter.
DefaultValue:0errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.Usethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfrom
otherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.nameTheDigitalModulationBasenamethatcorrespondstotheIndex.
TheNamebuffermustcontainatleastasmanyelementsasthevalueyouspecifywiththeNameBufferSizeparameter.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenGetLFGeneratorName[LF]IviRFSigGenLFGeneratorCapabilityGroupThisVIreturnsthespecificdriverdefinedLFgeneratorsourcenamethatcorrespondstotheone-basedindexspecifiedbytheIndexparameter.IfyoupassinavaluefortheIndexparameterthatislessthanoneorgreaterthanthevalueoftheIviRFSigGen>>LFGenerator>>LFGeneratorCountproperty,theVIreturnsanemptystringintheNameparameterandreturnstheInvalidValueerror.
Note:ForaninstrumentwithonlyoneLFgeneratorsource,i.e.theIviRFSigGen>>LFGenerator>>LFGeneratorCountpropertyisone,thedrivermayreturnanemptystring.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.indexTheindexoftheanalogmodulationsourcewhosenameisreturned.ThevaluemustbegreaterthanorequaltooneandlessthanorequaltoIviRFSigGen>>LFGenerator>>LFGeneratorCount.
Note:
Zeroisnotalegalvalue.
DefaultValue:0namebuffersizeSpecifythebuffersizefortheNameparameter.
DefaultValue:0errorin(noerror)Theerrorinclustercanaccepterrorinformation
wiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.nameTheLFgeneratorsourcenamethatcorrespondstotheIndex.
TheNamebuffermustcontainatleastasmanyelementsasthevalueyouspecifywiththeNameBufferSizeparameter.
DefaultValue:""erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenGetTDMAFrameName[TDMA]IviRFSigGenTDMABaseCapabilityGroupThisVIreturnsthespecificdriverdefinedTDMAframenamethatcorrespondstotheone-basedindexspecifiedbytheIndexparameter.IfyoupassinavaluefortheIndexparameterthatislessthanoneorgreaterthanthevalueoftheIviRFSigGen>>TDMA>>TDMAFrameCountproperty,theVIreturnsanemptystringintheNameparameterandreturnstheInvalidValueerror.
Note:ForaninstrumentwithonlyoneTDMAframe,i.e.theIviRFSigGen>>TDMA>>TDMAFrameCountpropertyisone,thedrivermayreturnanemptystring.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.indexSpecifiestheindexoftheTDMAframenametoreturn.
DefaultValue:0namebuffersizeSpecifythebuffersizefortheNameparameter.
DefaultValue:0errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtain
fromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.nameTheTDMAframenamethatcorrespondstotheIndex.
TheNamebuffermustcontainatleastasmanyelementsasthevalueyouspecifywiththeNameBufferSizeparameter.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenGetTDMAStandardName[TDMA]IviRFSigGenTDMABaseCapabilityGroupThisVIreturnsthespecificdriverdefinedTDMAstandardnamethatcorrespondstotheone-basedindexspecifiedbytheIndexparameter.IfyoupassinavaluefortheIndexparameterthatislessthanoneorgreaterthanthevalueoftheTDMA_STANDARD_COUNTproperty,theVIreturnsanemptystringintheNameparameterandreturnstheInvalidValueerror.
Note:ForaninstrumentwithonlyoneCDMAstandard,i.e.theTDMA_STANDARD_COUNTpropertyisone,thedrivermayreturnanemptystring.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.indexSpecifiestheindexoftheTDMAStandardNametoreturn.
DefaultValue:0namebuffersizeSpecifythebuffersizefortheNameparameter.
DefaultValue:0errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtain
fromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.nameTheTDMAstandardnamethatcorrespondstotheIndex.
TheNamebuffermustcontainatleastasmanyelementsasthevalueyouspecifywiththeNameBufferSizeparameter.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenIsSettledIviRFSigGenBaseCapabilityGroupThisVIqueriesiftheRFoutputsignaliscurrentlysettled.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.settledReturnsTRUEiftheoutputsignalisinsettled,FALSEotherwise.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenQueryArbWaveformCapabilities[ARB]IviRFSigGenArbGeneratorCapabilityGroupThisVIreturnsthearbgeneratorsettingsthatarerelatedtocreatingarbitrarywaveforms.Thesepropertiesarethemaximumnumberofwaveforms,waveformquantum,minimumwaveformsize,andmaximumwaveformsize.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.maxnumberofwaveformsReturnsthemaximumnumberofwaveformstheinstrumentcanholdinthememory.Thenumbermaybedependentonthelengthofthewaveformalreadyinthepoolofwaveformssavedintheinstrument.ThedriverreturnsthevalueoftheIviRFSigGen>>ARBGenerator>>Waveform>>ARBMaxNumberWaveformsproperty.waveformquantumReturnsthewaveformquantumwherethewaveformlengthisamultipleofthisquantum.Ifthewaveformquantumis1,thereisnorestrictiononthewaveformlengthother
thanminandmaxsize.ThedriverreturnsvalueoftheIviRFSigGen>>ARBGenerator>>Waveform>>ARBWaveformQuantumproperty.minwaveformsizeReturnstheminimumsizeofthewaveformlengthinnumberofsamples.Thewaveformlengthmustbeequalorgreaterthanthisminsize.Iftheminimumsizeis1,thereisnorestrictiononthewaveformlengthotherthanmaxsizeandquantum.ThedriverreturnsthevalueoftheIviRFSigGen>>ARBGenerator>>Waveform>>ARBWaveformSizeMinproperty.maxwaveformsizeReturnsthemaximumwaveformlengthinthenumberofsamples.Thewaveformlengthmustbeequalorlessthanthismaximumsize.ThedriverreturnsthevalueoftheIviRFSigGen>>ARBGenerator>>Waveform>>ARBWaveformSizeMaxproperty.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenResetFrequencyStep[FST]IviRFSigGenFrequencyStepCapabilityGroupThisVIresetsthecurrentfrequencysteptothefrequencystepstartvalue.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenResetList[LST]IviRFSigGenListCapabilityGroupThisVIresetsthecurrentlisttothefirstentryvalue.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenResetPowerStep[PST]IviRFSigGenPowerStepCapabilityGroupThisVIresetsthecurrentpowersteptothepowerstepstartvalue.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenSelectArbWaveform[ARB]IviRFSigGenArbGeneratorCapabilityGroupThisVIsetsanamedwaveformtobetheactivewaveform.Createarbwaveformnamesusingthe.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.nameSpecifiestheselectedwaveformfromthepoolofavailablewaveforms.ThedriverusesthisvaluetosettheIviRFSigGen>>ARBGenerator>>Waveform>>ARBSelectedWaveformproperty.
DefaultValue:""errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenSelectCDMAStandard[CDMA]IviRFSigGenCDMABaseCapabilityGroupThisVIspecifiesthestandardusedbytheinstrument.Toobtainalistofavailablestandards,callthe.Manyinstrumentsettingsareaffectedbyselectinganinstrumentstandard.Thesesettingsinclude:modulationtype,bitclockfrequencyandfiltertogetherwiththeassociatedfilterparameters.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.nameSpecifythestandardtobeusedbytheinstrument.ThedriverusesthisvaluetosettheIviRFSigGen>>CDMA>>CDMASelectedStandardproperty.
DefaultValue:""errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenSelectCDMATestModel[CDMA]IviRFSigGenCDMABaseCapabilityGroupThisVIspecifiesthechannelcodingusedforthedigitalmodulation.ToobtainalistofavailableCDMAtestmodelsforchannelcoding,callthe.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.nameSpecifiestheactualtestmodelusedbytheinstrument.ThedriverusesthisvaluetosettheIviRFSigGen>>CDMA>>CDMASelectedTestModelproperty.
DefaultValue:""errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenSelectDigitalModulationBaseBitSequence[DMB]IviRFSigGenDigitalModulationBaseCapabilityGroupThisVIsetsabitsequencetobeusedasdigitalmodulationdata.Createbitsequencesusingthe.ThebitsequenceissetonlyiftheIviRFSigGen>>DigitalModulation>>DigitalModulationBaseDataSourcepropertyissettoBitSequence.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.nameSpecifiesnameofthebitsequence(stream)usedasdatafordigitalmodulation.ThesequenceisusedonlyiftheIviRFSigGen>>DigitalModulation>>DigitalModulationBaseDataSourcepropertyissettoBitSequence.ThedriverusesthisvaluetosettheIviRFSigGen>>DigitalModulation>>DigitalModulationBaseSelectedBitSequenceproperty.
DefaultValue:""errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtain
fromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenSelectDigitalModulationBaseStandard[DMB]IviRFSigGenDigitalModulationBaseCapabilityGroupThisVIspecifiestheactualstandardusedbytheinstrument.Toobtainalistofavailablestandards,callthe.Manyinstrumentsettingsareaffectedbyselectinganinstrumentstandard.Thesesettingsinclude:coding,mapping,symbolrateorbitclockfrequency,filtertogetherwiththeassociatedfilterparameters,andFSKdeviationorASKdepth(inthecaseofFSKorASKmodulation).
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.nameSpecifiesthestandardtobeusedbytheinstrument.ThedriverusesthisvaluetosettheIviRFSigGen>>DigitalModulation>>DigitalModulationBaseSelectedStandardproperty.
DefaultValue:""errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.
erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenSelectList[LST]IviRFSigGenListCapabilityGroupThisVIsetsanamedlisttobetheactivelist.CreatelistnamesusingthefollowingVIs:,,or.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.nameSpecifythenameofthelisttomakethislistactive.Thenamemustbeoneofthelistscreated.ThedriverusesthisvaluetosettheIviRFSigGen>>Sweep>>List>>ListSelectedNameproperty.
DefaultValue:""errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenSelectTDMAFrame[TDMA]IviRFSigGenTDMABaseCapabilityGroupThisVIspecifiestheframeusedforframeddigitalmodulation.ToobtainalistofavailableTDMAframes,callthe.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.nameSpecifiestheactualframes/slotusedbytheinstrument.ItisselectedwithoneofthenamesfromTDMAFrameNamesproperty.Theframes/slotaregeneratedonly,ifTDMAFramingEnabledissettoTRUE.ThispropertyisignoredifTDMAFramingEnabledissettoFALSE.ThedriverusesthisvaluetosettheIviRFSigGen>>TDMA>>TDMASelectedFrameproperty.
DefaultValue:""errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenSelectTDMAStandard[TDMA]IviRFSigGenTDMABaseCapabilityGroupThisVIspecifiesthestandardusedbytheinstrument.Toobtainalistofavailablestandards,callthe.Manyinstrumentsettingsareaffectedbyselectinganinstrumentstandard.Thesesettingsinclude:coding,mapping,symbolrateorbitclockfrequency,filtertogetherwiththeassociatedfilterparameters,andFSKdeviationorASKdepth(incaseofFSKorASKmodulation).
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.nameSpecifythestandardtobeusedbytheinstrument.ThedriverusesthisvaluetosettheIviRFSigGen>>TDMA>>TDMASelectedStandardproperty.
DefaultValue:""errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmore
informationabouttheerrordisplayed.
IviRFSigGenSendSoftwareTrigger[SWT]ThisVIsendsacommandtotriggertheRFsignalgenerator.CallthisVIifyousetatriggersourcetoasoftwaretriggervalue.BelowisalistofpropertiesandVIswhichcansetthetriggersourcetoasoftwaretrigger.
VIs:
Properties:IviRFSigGen>>ARBGenerator>>Trigger>>ARBTriggerSourceIviRFSigGen>>Sweep>>SweepTriggerSourceIviRFSigGen>>CDMA>>Trigger>>CDMATriggerSourceIviRFSigGen>>TDMA>>Trigger>>TDMATriggerSource
Notes
ThisVIdoesnotchecktheinstrumentstatus.Typically,youcallthisVIonlyinasequenceofcallstootherlow-leveldriverVIs.Thesequenceperformsoneoperation.Youusethelow-levelVIstooptimizeoneormoreaspectsofinteractionwiththeinstrument.Ifyouwanttochecktheinstrumentstatus,calltheattheconclusionofthesequence.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenSetActiveLFGenerator[LF]IviRFSigGenLFGeneratorCapabilityGroupThisVIselectsoneoftheavailableLFgeneratorsources,andmakesittheactiveLFGenerator.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.activelfgeneratorSpecifiestheLFgeneratorwhichiscurrentlyactive.ThevaluesforthisarttributecorrespondtotheLFGeneratorrepeatedcapability.ThedriverusesthisvaluetosettheIviRFSigGen>>LFGenerator>>ActiveLFGeneratorproperty.
DefaultValue:""errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenWaitUntilSettledIviRFSigGenBaseCapabilityGroupThisVIwaitsuntilthestateoftheRFoutputsignalhassettled.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.maxtimeSpecifiesthemaximumtimetowaitfortheoutputtosettle.
Iftheoutputdoesnotsettlewithinthistimeinterval,theVIreturnstheIVIRFSIGGEN_ERROR_MAX_TIME_EXCEEDED(0xBFFA2003)errorcode.
Units:milliseconds
DefinedValues:
IVIRFSIGGEN_VAL_MAX_TIME_INFINITE(-1)IVIRFSIGGEN_VAL_MAX_TIME_IMMEDIATE(0)
DefaultValue:5000(ms)
Notes
(1)TheMaximumTimeparameterappliesonlytothisVI.Ithasnoeffectonothertimeoutparametersorproperties.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmore
informationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenWriteArbWaveform[ARB]IviRFSigGenArbGeneratorCapabilityGroupThisVIstoresthetransmittedwaveforminthedrivers'sorinstrument'smemory.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.namePassthenamethewaveformtowrite.
DefaultValue:""numberofsamplesPassthenumberofsamplesinbothIandQarray.
DefaultValue:0dataiPassthearraycontainingtheIpartofthewaveform.
Youmustnormalizethedatapointsinthearraytobebetween-1.00and+1.00ofthefullIrange.
DefaultValue:NonedataqPassthearraycontainingtheQpartofthewaveform.
Youmustnormalizethedatapointsinthearraytobebetween-1.00and+1.00ofthefullQrange.
DefaultValue:NonemoredatapendingSetthevaluetoTRUEtowritemoredata.Tocompletethewaveform,usethesameNameforthenextdata.SetthevaluetoFALSEwhenthereisnomoredatatowrite.
ValidValues:FALSE-NomoredataTRUE-Moredata
DefaultValue:Nomoredata(FALSE)errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenWriteDigitalModulationBaseBitSequence[DMB]IviRFSigGenDigitalModulationBaseCapabilityGroupThisVIcreatesabitsequenceforuseasthedigitalmodulationdata.Thesequenceisrepeatedcontinuously.Thesequencestringconsistsofbinaryvalues(8bitin1char/byte).
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.namePassthenamethebitsequencetowrite.
DefaultValue:""bitcountPassthenumberofbitsinthesequence.Onechar/bytehas8bits,butthestreamofbitsdoesnotendnecessarilyonbyteboundaries.
DefaultValue:0sequencePassthearraythedriverwilluseasastreamofbits.ThesizeofthearrayisBitCount.
DefaultValue:NonemoredatapendingSetthevaluetoTRUEtowritemoredata.Tocompletethesequence,usethesameNameforthenextdata.SetthevaluetoFALSEwhenthereisnomoredatatowrite.
ValidValues:FALSE-NomoredataTRUE-Moredata
DefaultValue:Nomoredata(FALSE)errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviRFSigGenInitializeorIviRFSigGenInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviRFSigGenPropertiesExpandthisbooktoviewanalphabetizedlistofIviRFSigGenproperties.
IviRFSigGenActiveLFGenerator[LF]IviRFSigGenLFGeneratorPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenSetActiveLFGenerator[LF]
DescriptionSpecifiestheLFgeneratorwhichiscurrentlyactive.ThevaluesforthispropertycorrespondtotheLFGeneratorrepeatedcapability.
PropertyNodePathIviRFSigGen»LFGenerator>>ActiveLFGenerator[LF]
IviRFSigGenALCBandwidth[ALC]IviRFSigGenALCPropertyDatatype Access Appliesto Coercion HighLevelVIs
R/W N/A Up IviRFSigGenConfigureALC[ALC]
DescriptionSpecifiesthebandwidthofAutomaticLevelControl.
PropertyNodePathIviRFSigGen»ALC>>ALCBandwidth[ALC]
IviRFSigGenALCEnabledIviRFSigGenBasePropertyDatatype Access Appliesto Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureALCEnabled
DescriptionSpecifieswhethertoenableordisableAutomaticLevelControl(ALC).
PropertyNodePathIviRFSigGen»RF>>ALCEnabled
DefinedValuesVI_TRUEVI_FALSE
IviRFSigGenALCSource[ALC]IviRFSigGenALCPropertyDatatype Access Appliesto Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureALC[ALC]
DescriptionSpecifiesthesourceofthecontrollingvoltagefortheAutomaticLevelControl.
PropertyNodePathIviRFSigGen»ALC>>ALCSource[ALC]
DefinedValuesIVIRFSIGGEN_VAL_ALC_SOURCE_INTERNALIVIRFSIGGEN_VAL_ALC_SOURCE_EXTERNAL
IviRFSigGenAMDepth[AM]IviRFSigGenModulateAMPropertyDatatype Access Appliesto Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureAM[AM]
DescriptionSpecifiestheextendofmodulationthesignalgeneratorappliestotheRF-signal(carrierwaveform)withthemodulatingsignalasaresultofsummingallsources,internalandexternal.IftheIviRFSigGen>>AnalogModulation>>AM>>AMScaling[AM]propertyissettoLinear,thentheunitsarepercent(%).IftheIviRFSigGen>>AnalogModulation>>AM>>AMScaling[AM]propertyissettologarithmic,thentheunitsaredBm.
PropertyNodePathIviRFSigGen»AnalogModulation>>AM>>AMDepth[AM]
IviRFSigGenAMEnabled[AM]IviRFSigGenModulateAMPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureAMEnabled[AM]
DescriptionSpecifieswhetherthesignalgeneratorappliesamplitudemodulationtotheRFoutputsignal(VI_TRUE)ornot(VI_FALSE).
PropertyNodePathIviRFSigGen»AnalogModulation>>AM>>AMEnabled[AM]
DefinedValuesVI_TRUEVI_FALSE
IviRFSigGenAMExternalCoupling[AM]IviRFSigGenModulateAMPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureAMExternalCoupling[AM]
DescriptionSpecifiesthecouplingoftheexternalsourceofthemodulatingsignal.
PropertyNodePathIviRFSigGen»AnalogModulation>>AM>>AMExternalCoupling[AM]
DefinedValuesIVIRFSIGGEN_VAL_AM_EXTERNAL_COUPLING_ACIVIRFSIGGEN_VAL_AM_EXTERNAL_COUPLING_DC
IviRFSigGenAMNominalVoltage[AM]IviRFSigGenModulateAMPropertyDatatype Access Appliesto Coercion HighLevelVIs
RO N/A None None
DescriptionThisisthevoltageatwhichtheinstrumentachievestheamountofmodulationspecifiedbytheIviRFSigGen>>AnalogModulation>>AM>>AMDepth[AM]property.
Note:Thispropertyisreadonly.
PropertyNodePathIviRFSigGen»AnalogModulation>>AM>>AMNominalVoltage[AM]
IviRFSigGenAMScaling[AM]IviRFSigGenModulateAMPropertyDatatype Access Appliesto Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureAM[AM]
DescriptionSpecifieslinearorlogarithmicattenuationforamplitudemodulation.TheunitoftheIviRFSigGen>>AnalogModulation>>AM>>AMDepth[AM]propertyischangedwiththissetting.
PropertyNodePathIviRFSigGen»AnalogModulation>>AM>>AMScaling[AM]
DefinedValuesIVIRFSIGGEN_VAL_AM_SCALING_LINEARIVIRFSIGGEN_VAL_AM_SCALING_LOGARITHMIC
IviRFSigGenAMSource[AM]IviRFSigGenModulateAMPropertyDatatype Access Appliesto Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureAM[AM]
DescriptionSpecifiesthesourceofthesignalthatisusedasthemodulatingsignal.Ifmorethanonesourceisspecified,thevoltagesofallsources(internalandexternal)aresummed.Multiplesourcenamesareseparatedbycommas.
PropertyNodePathIviRFSigGen»AnalogModulation>>AM>>AMSource[AM]
IviRFSigGenARBClockFrequency[ARB]IviRFSigGenArbGeneratorPropertyDatatype Access Appliesto Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureArb[ARB]
DescriptionSpecifiesthesamplefrequency.Thewaveformisgeneratedwiththisclockfrequency.
PropertyNodePathIviRFSigGen»ARBGenerator>>ARBClockFrequency[ARB]
IviRFSigGenARBExternalTriggerSlope[ARB]IviRFSigGenArbGeneratorPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureArbExternalTriggerSlope[ARB]
DescriptionSpecifieswhetherthetriggereventoccursontherisingorfallingedgeoftheinputsignal.
PropertyNodePathIviRFSigGen»ARBGenerator>>Trigger>>ARBExternalTriggerSlope[ARB]
DefinedValuesIVIRFSIGGEN_VAL_ARB_EXTERNAL_TRIGGER_SLOPE_POSITIVEIVIRFSIGGEN_VAL_ARB_EXTERNAL_TRIGGER_SLOPE_NEGATIVE
IviRFSigGenARBFilterFrequency[ARB]IviRFSigGenArbGeneratorPropertyDatatype Access Appliesto Coercion HighLevelVIs
R/W N/A UP IviRFSigGenConfigureArb[ARB]
DescriptionSpecifiesthecut-offfrequencyofthelowpassfilter.Thewaveformisfilteredbeforeoutputwiththisfilterforantialiasing.Thefilterfrequencynormallyislowerthantheclockfrequency.TheunitsareHertz.
PropertyNodePathIviRFSigGen»ARBGenerator>>ARBFilterFrequency[ARB]
IviRFSigGenARBMaxNumberWaveforms[ARB]IviRFSigGenArbGeneratorPropertyDatatype Access Applies
to Coercion HighLevelVIs
RO N/A None IviRFSigGenQueryArbWaveformCapabilities[ARB]
DescriptionReturnsthemaxnumberofwaveformstheinstrumentcanholdinthememory.Thenumbermaydependonthelengthofthewaveformalreadyinthepoolofwaveformssavedintheinstrument.
PropertyNodePathIviRFSigGen»ARBGenerator>>Waveform>>ARBMaxNumberWaveforms[ARB]
IviRFSigGenARBSelectedWaveform[ARB]IviRFSigGenArbGeneratorPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenSelectArbWaveform[ARB]
DescriptionSpecifiestheselectedwaveformfromthepoolofavailablewaveforms.
PropertyNodePathIviRFSigGen»ARBGenerator>>Waveform>>ARBSelectedWaveform[ARB]
IviRFSigGenARBTriggerSource[ARB]IviRFSigGenArbGeneratorPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureArbTriggerSource[ARB]
DescriptionSpecifieshowtheArbwaveformisstarted(triggered).
PropertyNodePathIviRFSigGen»ARBGenerator>>Trigger>>ARBTriggerSource[ARB]
DefinedValuesIVIRFSIGGEN_VAL_ARB_TRIGGER_SOURCE_IMMEDIATEIVIRFSIGGEN_VAL_ARB_TRIGGER_SOURCE_EXTERNALIVIRFSIGGEN_VAL_ARB_TRIGGER_SOURCE_SOFTWARE
IviRFSigGenARBWaveformQuantum[ARB]IviRFSigGenArbGeneratorPropertyDatatype Access Applies
to Coercion HighLevelVIs
RO N/A None IviRFSigGenQueryArbWaveformCapabilities[ARB]
DescriptionReturnsthewaveformquantumwherethewaveformlengthisamultipleofthisquantum.Ifthewaveformquantumis1,thereisnorestrictiononthewaveformlengthotherthanminandmaxsize.
PropertyNodePathIviRFSigGen»ARBGenerator>>Waveform>>ARBWaveformQuantum[ARB]
IviRFSigGenARBWaveformSizeMax[ARB]IviRFSigGenArbGeneratorPropertyDatatype Access Applies
to Coercion HighLevelVIs
RO N/A None IviRFSigGenQueryArbWaveformCapabilities[ARB]
DescriptionReturnsthemaximumwaveformlengthinthenumberofsamples.Thewaveformlengthmustbeequalorlessthanthismaximumsize.
PropertyNodePathIviRFSigGen»ARBGenerator>>Waveform>>ARBWaveformSizeMax[ARB]
IviRFSigGenARBWaveformSizeMin[ARB]IviRFSigGenArbGeneratorPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenQueryArbWaveformCapabilities[ARB]
DescriptionReturnstheminimumsizeofthewaveformlengthinnumberofsamples.Thewaveformlengthmustequalorgreaterthanthisminimumsize.Iftheminimumsizeis1,thereisnorestrictiononthewaveformlengthotherthanmaxsizeandquantum.
PropertyNodePathIviRFSigGen»ARBGenerator>>Waveform>>ARBWaveformSizeMin[ARB]
IviRFSigGenCDMAClockSource[CDMA]IviRFSigGenCDMABasePropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureCDMAClockSource[CDMA]
DescriptionSpecifiesthesourceoftheclocksignalusedtogeneratethedigitalmodulationaccordingtotheselectedstandard.
PropertyNodePathIviRFSigGen»CDMA>>CDMAClockSource[CDMA]
DefinedValuesIVIRFSIGGEN_VAL_CDMA_CLOCK_SOURCE_INTERNALIVIRFSIGGEN_VAL_CDMA_CLOCK_SOURCE_EXTERNAL
IviRFSigGenCDMAExternalTriggerSlope[CDMA]IviRFSigGenCDMABasePropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureCDMAExternalTriggerSlope[CDMA]
DescriptionSpecifieswhetherthetriggereventoccursontherisingorfallingedgeoftheinputsignal.
PropertyNodePathIviRFSigGen»CDMA>>Trigger>>CDMAExternalTriggerSlope[CDMA]
DefinedValuesIVIRFSIGGEN_VAL_CDMA_EXTERNAL_TRIGGER_SLOPE_POSITIVEIVIRFSIGGEN_VAL_CDMA_EXTERNAL_TRIGGER_SLOPE_NEGATIVE
IviRFSigGenCDMASelectedStandard[CDMA]IviRFSigGenCDMABasePropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenSelectCDMAStandard[CDMA]
DescriptionSpecifiestheactualstandardusedbytheinstrument.Themodulationtype,bitclockfrequencyandfiltertogetherwiththeassociatedfiltersettingsaresetasdefinedintheselectedstandard.
PropertyNodePathIviRFSigGen»CDMA>>CDMASelectedStandard[CDMA]
IviRFSigGenCDMASelectedTestModel[CDMA]IviRFSigGenCDMABasePropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenSelectCDMATestModel[CDMA]
DescriptionSpecifiestheactualCDMAtestmodelusedbytheinstrument.
PropertyNodePathIviRFSigGen»CDMA>>CDMASelectedTestModel[CDMA]
IviRFSigGenCDMAStandardCount[CDMA]IviRFSigGenCDMABasePropertyDatatype Access Appliesto Coercion HighLevelVIs
RO N/A None None
DescriptionReturnsthenumberofCDMAstandardsavailableforaparticularinstrument.
PropertyNodePathIviRFSigGen»CDMA>>CDMAStandardCount[CDMA]
IviRFSigGenCDMATestModelCount[CDMA]IviRFSigGenCDMABasePropertyDatatype Access Appliesto Coercion HighLevelVIs
RO N/A None None
DescriptionReturnsthenumberofCDMAtestmodelsavailableforaparticularinstrument.
PropertyNodePathIviRFSigGen»CDMA>>CDMATestModelCount[CDMA]
IviRFSigGenCDMATriggerSource[CDMA]IviRFSigGenCDMABasePropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureCDMATriggerSource[CDMA]
DescriptionSpecifiesthesourceofthetriggersignalthatstartsthechannelcodinggeneration.
PropertyNodePathIviRFSigGen»CDMA>>Trigger>>CDMATriggerSource[CDMA]
DefinedValuesIVIRFSIGGEN_VAL_CDMA_TRIGGER_SOURCE_IMMEDIATEIVIRFSIGGEN_VAL_CDMA_TRIGGER_SOURCE_EXTERNALIVIRFSIGGEN_VAL_CDMA_TRIGGER_SOURCE_SOFTWARE
IviRFSigGenDigitalModulationBaseClockSource[DMB]IviRFSigGenDigitalModulationBasePropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureDigitalModulationBaseClockSource[DMB]
DescriptionSpecifiesthesourceoftheclocksignalusedtogeneratethedigitalmodulationaccordingtotheselectedstandard.
PropertyNodePathIviRFSigGen»DigitalModulation>>DigitalModulationBaseClockSource[DMB]
DefinedValuesIVIRFSIGGEN_VAL_DIGITAL_MODULATION_BASE_CLOCK_SOURCE_INTERNALIVIRFSIGGEN_VAL_DIGITAL_MODULATION_BASE_CLOCK_SOURCE_EXTERNAL
IviRFSigGenDigitalModulationBaseDataSource[DMB]IviRFSigGenDigitalModulationBasePropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureDigitalModulationBaseDataSource[DMB]
DescriptionSpecifiesthesourceofdata.ThedataisusedtomodulatetheRFsignalaccordingtothestandardselectedwiththeDigitalModulationBaseSelectedStandardproperty.
PropertyNodePathIviRFSigGen»DigitalModulation>>DigitalModulationBaseDataSource[DMB]
DefinedValuesIVIRFSIGGEN_VAL_DIGITAL_MODULATION_BASE_DATA_SOURCE_EXTERNALIVIRFSIGGEN_VAL_DIGITAL_MODULATION_BASE_DATA_SOURCE_PRBSIVIRFSIGGEN_VAL_DIGITAL_MODULATION_BASE_DATA_SOURCE_BIT_SEQUENCE
IviRFSigGenDigitalModulationBaseExternalClockType[DMB]IviRFSigGenDigitalModulationBasePropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureDigitalModulationBaseClockSource[DMB]
DescriptionSpecifiesthetypeoftheexternalclocksignalusedtogeneratethedigitalmodulation.ThisvalueisusedonlyiftheDigitalModulationBaseClockSourcepropertyissettoExternal.
PropertyNodePathIviRFSigGen»DigitalModulation>>DigitalModulationBaseExternalClockType[DMB]
DefinedValuesIVIRFSIGGEN_VAL_DIGITAL_MODULATION_BASE_EXTERNAL_CLOCK_TYPE_BITIVIRFSIGGEN_VAL_DIGITAL_MODULATION_BASE_EXTERNAL_CLOCK_TYPE_SYMBOL
IviRFSigGenDigitalModulationBasePRBSType[DMB]IviRFSigGenDigitalModulationBasePropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureDigitalModulationBasePRBSType[DMB]
DescriptionSpecifiesthetypeofthePRBSasdefinedintheCCITT-V.52standard.ThePRBS(PseudoRandomBinarySequence)isusedonlyifDigitalModulationBaseDataSourceissettoPRBS.
PropertyNodePathIviRFSigGen»DigitalModulation>>DigitalModulationBasePRBSType[DMB]
DefinedValuesIVIRFSIGGEN_VAL_DIGITAL_MODULATION_BASE_PRBS_TYPE_PRBS9IVIRFSIGGEN_VAL_DIGITAL_MODULATION_BASE_PRBS_TYPE_PRBS11IVIRFSIGGEN_VAL_DIGITAL_MODULATION_BASE_PRBS_TYPE_PRBS15IVIRFSIGGEN_VAL_DIGITAL_MODULATION_BASE_PRBS_TYPE_PRBS16IVIRFSIGGEN_VAL_DIGITAL_MODULATION_BASE_PRBS_TYPE_PRBS20IVIRFSIGGEN_VAL_DIGITAL_MODULATION_BASE_PRBS_TYPE_PRBS21IVIRFSIGGEN_VAL_DIGITAL_MODULATION_BASE_PRBS_TYPE_PRBS23
IviRFSigGenDigitalModulationBaseSelectedBitSequence[DMB]IviRFSigGenDigitalModulationBasePropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenSelectDigitalModulationBaseBitSequence[DMB]
DescriptionSpecifiesnameofthebitsequence(stream)usedasdatafordigitalmodulation.ThesequenceisusedonlyifDigitalModulationBaseDataSourceissettoBitSequence.
PropertyNodePathIviRFSigGen»DigitalModulation>>DigitalModulationBaseSelectedBitSequence[DMB]
IviRFSigGenDigitalModulationBaseSelectedStandard[DMB]IviRFSigGenDigitalModulationBasePropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenSelectDigitalModulationBaseStandard[DMB]
DescriptionSpecifiestheactualstandardusedbytheinstrument.Thecoding,mapping,symbolrateorbitclockfrequency,filtertogetherwiththeaccordingfilter.parameters,FSKdeviationorASKdepth(incaseofFSKorASKmodulation)aresetasdefinedintheselectedstandard.
PropertyNodePathIviRFSigGen»DigitalModulation>>DigitalModulationBaseSelectedStandard[DMB]
IviRFSigGenDigitalModulationBaseStandardCount[DMB]IviRFSigGenDigitalModulationBasePropertyDatatype Access Appliesto Coercion HighLevelVIs
RO N/A None None
DescriptionSpecifiesthenumberofDigitalModulationBasestandardsavailableforaparticularinstrument.
PropertyNodePathIviRFSigGen»DigitalModulation>>DigitalModulationBaseStandardCount[DMB]
IviRFSigGenFMDeviation[FM]IviRFSigGenModulateFMPropertyDatatype Access Appliesto Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureFM[FM]
DescriptionSpecifiestheextentofmodulation(peakfrequencydeviation)thesignalgeneratorappliestotheRF-signal(carrierwaveform)withthemodulatingsignalasaresultofsummingallsources,internalandexternal.TheunitsareHz.
PropertyNodePathIviRFSigGen»AnalogModulation>>FM>>FMDeviation[FM]
IviRFSigGenFMEnabled[FM]IviRFSigGenModulateFMPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureFMEnabled[FM]
DescriptionSpecifieswhetherthesignalgeneratorappliesfrequencymodulationtotheRFoutputsignal(VI_TRUE)ornot(VI_FALSE).
PropertyNodePathIviRFSigGen»AnalogModulation>>FM>>FMEnabled[FM]
DefinedValuesVI_TRUEVI_FALSE
IviRFSigGenFMExternalCoupling[FM]IviRFSigGenModulateFMPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureFMExternalCoupling[FM]
DescriptionSpecifiesthecouplingoftheexternalsourceofthemodulatingsignal.
PropertyNodePathIviRFSigGen»AnalogModulation>>FM>>FMExternalCoupling[FM]
DefinedValuesIVIRFSIGGEN_VAL_FM_EXTERNAL_COUPLING_ACIVIRFSIGGEN_VAL_FM_EXTERNAL_COUPLING_DC
IviRFSigGenFMNominalVoltage[FM]IviRFSigGenModulateFMPropertyDatatype Access Appliesto Coercion HighLevelVIs
RO N/A None None
DescriptionThisisthevoltageatwhichtheinstrumentachievestheamountofmodulationspecifiedbytheIviRFSigGen>>AnalogModulation>>FM>>FMDeviation[FM]property.
Note:Thispropertyisreadonly.
PropertyNodePathIviRFSigGen»AnalogModulation>>FM>>FMNominalVoltage[FM]
IviRFSigGenFMSource[FM]IviRFSigGenModulateFMPropertyDatatype Access Appliesto Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureFM[FM]
DescriptionSpecifiesthesourceofthesignalthatisusedasthemodulatingsignal.Ifmorethanonesourceisspecified,thevoltagesofallsources(internalandexternal)aresummed.Multiplesourcenamesareseparatedbycommas.
PropertyNodePathIviRFSigGen»AnalogModulation>>FM>>FMSource[FM]
IviRFSigGenFrequencyIviRFSigGenBasePropertyDatatype Access Appliesto Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureRF
DescriptionSpecifiesthefrequencyofthegeneratedRFoutputsignal.
PropertyNodePathIviRFSigGen»RF>>Frequency
IviRFSigGenFrequencyStepDwell[FST]IviRFSigGenFrequencyStepPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureFrequencyStepDwell[FST]
DescriptionSpecifiesthedurationtimeofonestep.Theunitsareinseconds.Dwelltimestartsimmediateaftertiggerornextstep;nosettlingtimeisadded.ThispropertyisignoredifFrequencyStepSingleStepEnabledissettoVI_TRUE.
PropertyNodePathIviRFSigGen»Sweep>>FrequencyStep>>FrequencyStepDwell[FST]
IviRFSigGenFrequencyStepScaling[FST]IviRFSigGenFrequencyStepPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureFrequencyStepStartStop[FST]
DescriptionSpecifiesthespacingofthesteps.
PropertyNodePathIviRFSigGen»Sweep>>FrequencyStep>>FrequencyStepScaling[FST]
DefinedValuesIVIRFSIGGEN_VAL_FREQUENCY_STEP_SCALING_LINEARIVIRFSIGGEN_VAL_FREQUENCY_STEP_SCALING_LOGARITHMIC
IviRFSigGenFrequencyStepSingleStepEnabled[FST]IviRFSigGenFrequencyStepPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureFrequencyStepDwell[FST]
DescriptionSpecifieswhetherthetriggerinitiatesthenextstep(VI_TRUE),orthenextstepistakenafterdwelltime(VI_FALSE).
PropertyNodePathIviRFSigGen»Sweep>>FrequencyStep>>FrequencyStepSingleStepEnabled[FST]
DefinedValuesVI_TRUEVI_FALSE
IviRFSigGenFrequencyStepSize[FST]IviRFSigGenFrequencyStepPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureFrequencyStepStartStop[FST]
DescriptionSpecifiesthestepsize.TheunitsareinHzwhentheIviRFSigGen>>Sweep>>FrequencyStep>>FrequencyStepScaling[FST]propertyissettoIVIRFSIGGEN_VAL_FREQUENCY_STEP_SCALING_LINEAR.Thevalueisunitless(factor)whentheIviRFSigGen>>Sweep>>FrequencyStep>>FrequencyStepScaling[FST]propertyissettoIVIRFSIGGEN_VAL_FREQUENCY_STEP_SCALING_LOGARITHMIC.
PropertyNodePathIviRFSigGen»Sweep>>FrequencyStep>>FrequencyStepSize[FST]
IviRFSigGenFrequencyStepStart[FST]IviRFSigGenFrequencyStepPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureFrequencyStepStartStop[FST]
DescriptionSpecifiesthestartfrequencyofthesteppedsweep.Ifthestopfrequencyislessthanthestartfrequency,thefrequencydecreasesduringthesweep.TheunitsareinHz.
PropertyNodePathIviRFSigGen»Sweep>>FrequencyStep>>FrequencyStepStart[FST]
IviRFSigGenFrequencyStepStop[FST]IviRFSigGenFrequencyStepPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureFrequencyStepStartStop[FST]
DescriptionSpecifiesthestopfrequencyofthesteppedsweep.Ifthestopfrequencyislessthanthestartfrequency,thefrequencydecreasesduringthesweep.TheunitsareinHz.
PropertyNodePathIviRFSigGen»Sweep>>FrequencyStep>>FrequencyStepStop[FST]
IviRFSigGenFrequencySweepStart[FSW]IviRFSigGenFrequencySweepPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureFrequencySweepStartStop[FSW]IviRFSigGenConfigureFrequencySweepCenterSpan[FSW]
DescriptionSpecifiesthestartfrequencyofthesweep.Ifthestopfrequencyislessthanthestartfrequency,thefrequencydecreasesduringthesweep.TheunitsareinHz.
PropertyNodePathIviRFSigGen»Sweep>>FrequencySweep>>FrequencySweepStart[FSW]
IviRFSigGenFrequencySweepStop[FSW]IviRFSigGenFrequencySweepPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureFrequencySweepStartStop[FSW]IviRFSigGenConfigureFrequencySweepCenterSpan[FSW]
DescriptionSpecifiesthestopfrequencyofthesweep.Ifthestopfrequencyislessthanthestartfrequency,thefrequencydecreasesduringthesweep.TheunitsareinHz.
PropertyNodePathIviRFSigGen»Sweep>>FrequencySweep>>FrequencySweepStop[FSW]
IviRFSigGenFrequencySweepTime[FSW]IviRFSigGenFrequencySweepPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureFrequencySweepTime[FSW]
DescriptionSpecifiesthedurationofonesweepfromstarttostopfrequency.Theunitsareinseconds.
PropertyNodePathIviRFSigGen»Sweep>>FrequencySweep>>FrequencySweepTime[FSW]
IviRFSigGenIQEnabled[MIQ]IviRFSigGenModulateIQPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureIQEnabled[MIQ]
DescriptionSpecifieswhetherthesignalgeneratorappliesIQ(vector)modulationtotheoutputRFsignal(VI_TRUE)ornot(VI_FALSE).
PropertyNodePathIviRFSigGen»IQ>>IQEnabled[MIQ]
DefinedValuesVI_TRUEVI_FALSE
IviRFSigGenIQImpairmentEnabled[IQI]IviRFSigGenIQImpairmentPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureIQImpairmentEnabled[IQI]
DescriptionEnablesIQimpairment.WhensettoVI_TRUE,thefollowingimpairmentpropertiesareapplied.
IviRFSigGen>>IQ>>IQImpairment>>IQI-Offset[IQI]IviRFSigGen>>IQ>>IQImpairment>>IQQ-Offset[IQI]IviRFSigGen>>IQ>>IQImpairment>>IQRatio[IQI]IviRFSigGen>>IQ>>IQImpairment>>IQSkew[IQI]
PropertyNodePathIviRFSigGen»IQ>>IQImpairment>>IQImpairmentEnabled[IQI]
DefinedValuesVI_TRUEVI_FALSE
IviRFSigGenIQNominalVoltage[MIQ]IviRFSigGenModulateIQPropertyDatatype Access Appliesto Coercion HighLevelVIs
RO N/A None None
DescriptionThisisthevoltageatwhichtheinstrumentachievesfullmodulation.ThevalueiscalculatedbySQRT(I^2+Q^2).
PropertyNodePathIviRFSigGen»IQ>>IQNominalVoltage[MIQ]
IviRFSigGenIQIOffset[IQI]IviRFSigGenIQImpairmentPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureIQImpairment[IQI]
DescriptionSpecifiesanoriginoffsetvoltagetotheIsignal.Therangeofvaluesallowedis-100%to+100%.Thevalueisexpressedaspercentage(%).
PropertyNodePathIviRFSigGen»IQ>>IQImpairment>>IQIOffset[IQI]
IviRFSigGenIQQOffset[IQI]IviRFSigGenIQImpairmentPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureIQImpairment[IQI]
DescriptionSpecifiesanoriginoffsetvoltagetotheQsignal.Therangeofvaluesallowedis-100%to+100%.Thevalueisexpressedaspercentage(%).
PropertyNodePathIviRFSigGen»IQ>>IQImpairment>>IQQOffset[IQI]
IviRFSigGenIQRatio[IQI]IviRFSigGenIQImpairmentPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureIQImpairment[IQI]
DescriptionSpecifiesthegainimbalancebetweentheIandQchannels.Fornoimbalancethisvalueissetto0%.Thevalueisexpressedaspercentage(%).
PropertyNodePathIviRFSigGen»IQ>>IQImpairment>>IQRatio[IQI]
IviRFSigGenIQSkew[IQI]IviRFSigGenIQImpairmentPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureIQImpairment[IQI]
DescriptionSpecifiestheadjustmentofthephaseanglebetweentheIandQvectors.Ifthisskewiszero,thephaseangleis90degrees.Theunitsaredegrees.
PropertyNodePathIviRFSigGen»IQ>>IQImpairment>>IQSkew[IQI]
IviRFSigGenIQSource[MIQ]IviRFSigGenModulateIQPropertyDatatype Access Appliesto Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureIQ[MIQ]
DescriptionSpecifiesthesourceofthesignalthatthesignalgeneratorusesforIQmodulation.
PropertyNodePathIviRFSigGen»IQ>>IQSource[MIQ]
DefinedValuesIVIRFSIGGEN_VAL_IQ_SOURCE_DIGITAL_MODULATION_BASEIVIRFSIGGEN_VAL_IQ_SOURCE_CDMA_BASEIVIRFSIGGEN_VAL_IQ_SOURCE_TDMA_BASEIVIRFSIGGEN_VAL_IQ_SOURCE_ARB_GENERATORIVIRFSIGGEN_VAL_IQ_SOURCE_EXTERNAL
IviRFSigGenIQSwapEnabled[MIQ]IviRFSigGenModulateIQPropertyDatatype Access Appliesto Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureIQ[MIQ]
DescriptionEnablesordisablestheinversephaserotationoftheIQsignalbyswappingtheIandQinputs.IfVI_TRUE,theRFsignalgeneratorappliesnon-inversephaserotationoftheIQsignal.IfVI_FALSE,theRFsignalgeneratorappliesinversephaserotationoftheIQsignal.
PropertyNodePathIviRFSigGen»IQ>>IQSwapEnabled[MIQ]
DefinedValuesVI_TRUEVI_FALSE
IviRFSigGenPowerSweepStop[PSW]IviRFSigGenPowerSweepPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigurePowerSweepStartStop[PSW]
DescriptionSpecifiesthestoppowerofthesweep.Ifthestoppowerislessthanthestartpower,thepowerdecreasesinvalueduringthesweep.TheunitsareindBm.
PropertyNodePathIviRFSigGen»Sweep>>PowerSweep>>PowerSweepStop[PSW]
IviRFSigGenLFGeneratorCount[LF]IviRFSigGenLFGeneratorPropertyDatatype Access Appliesto Coercion HighLevelVIs
RO N/A None None
DescriptionSpecifiesthenumberofLFgeneratorsourcesavailableforaparticularinstrument.
PropertyNodePathIviRFSigGen»LFGenerator>>LFGeneratorCount[LF]
IviRFSigGenLFGeneratorFrequency[LF]IviRFSigGenLFGeneratorPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureLFGenerator[LF]
DescriptionSpecifiesthefrequencyoftheactiveLFgenerator.TheunitisHz.
PropertyNodePathIviRFSigGen»LFGenerator>>LFGeneratorFrequency[LF]
IviRFSigGenLFGeneratorOutputAmplitude[LFO]IviRFSigGenLFGeneratorOutputPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureLFGeneratorOutput[LFO]
DescriptionSpecifiestheoutputvoltageoftheLFgenerator.TheunitisV.
PropertyNodePathIviRFSigGen»LFGenerator>>LFGeneratorOutputs>>LFGeneratorOutputAmplitude[LFO]
IviRFSigGenLFGeneratorOutputEnabled[LFO]IviRFSigGenLFGeneratorOutputPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureLFGeneratorOutput[LFO]
DescriptionSpecifieswhethertheLFgeneratorappliesanoutputsignal(VI_TRUE)ornot(VI_FALSE).
PropertyNodePathIviRFSigGen»LFGenerator>>LFGeneratorOutputs>>LFGeneratorOutputEnabled[LFO]
DefinedValuesVI_TRUEVI_FALSE
IviRFSigGenLFGeneratorWaveform[LF]IviRFSigGenLFGeneratorPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureLFGenerator[LF]
DescriptionSpecifiesthewaveformoftheactiveLFgenerator.
PropertyNodePathIviRFSigGen»LFGenerator>>LFGeneratorWaveform[LF]
DefinedValuesIVIRFSIGGEN_VAL_LF_GENERATOR_WAVEFORM_SINEIVIRFSIGGEN_VAL_LF_GENERATOR_WAVEFORM_SQUAREIVIRFSIGGEN_VAL_LF_GENERATOR_WAVEFORM_TRIANGLEIVIRFSIGGEN_VAL_LF_GENERATOR_WAVEFORM_RAMP_UPIVIRFSIGGEN_VAL_LF_GENERATOR_WAVEFORM_RAMP_DOWN
IviRFSigGenListDwell[LST]IviRFSigGenListPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureListDwell[LST]
DescriptionSpecifiesthedurationtimeofonestep.Theunitsareinsecontds.ThispropertyisignoredifListSingleStepEnabledissettoVI_TRUE.
PropertyNodePathIviRFSigGen»Sweep>>List>>ListDwell[LST]
IviRFSigGenListSelectedName[LST]IviRFSigGenListPropertyDatatype Access Appliesto Coercion HighLevelVIs
R/W N/A None IviRFSigGenSelectList[LST]
DescriptionSpecifiesthenameoftheselectedlisttobecomeactive.Thenamemustbeoneofthelistscreated.
PropertyNodePathIviRFSigGen»Sweep>>List>>ListSelectedName[LST]
IviRFSigGenListSingleStepEnabled[LST]IviRFSigGenListPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureListDwell[LST]
DescriptionEnablesordisablessinglestepmode.VI_TRUE:Thelistwilladvancewhenthenexttriggereventoccurs.VI_FALSE:Thelistwilladvanceimmediatlyafterthedwelltimeends.
PropertyNodePathIviRFSigGen»Sweep>>List>>ListSingleStepEnabled[LST]
DefinedValuesVI_TRUEVI_FALSE
IviRFSigGenModulationSourceCount[MS]IviRFSigGenAnalogModulationSourcePropertyDatatype Access Appliesto Coercion HighLevelVIs
RO N/A None None
DescriptionSpecifieshowmanyanalogmodulationsourcesareavailable.
PropertyNodePathIviRFSigGen»AnalogModulation>>Source>>ModulationSourceCount[MS]
IviRFSigGenOutputEnabledIviRFSigGenBasePropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureOutputEnabled
DescriptionSpecifieswhethertoenableordisabletheRFoutputsignal.
PropertyNodePathIviRFSigGen»RF>>OutputEnabled
DefinedValuesVI_TRUEVI_FALSE
IviRFSigGenPMDeviation[PM]IviRFSigGenModulatePMPropertyDatatype Access Appliesto Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigurePM[PM]
DescriptionSpecifiestheextentofmodulation(peakphasedeviation)thesignalgeneratorappliestotheRF-signal(carrierwaveform)withthemodulatingsignal.Theunitsareradians.
PropertyNodePathIviRFSigGen»AnalogModulation>>PM>>PMDeviation[PM]
IviRFSigGenPMEnabled[PM]IviRFSigGenModulatePMPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigurePMEnabled[PM]
DescriptionSpecifieswhetherthesignalgeneratorappliesphasemodulationtotheRFoutputsignal(VI_TRUE)ornot(VI_FALSE).
PropertyNodePathIviRFSigGen»AnalogModulation>>PM>>PMEnabled[PM]
DefinedValuesVI_TRUEVI_FALSE
IviRFSigGenPMExternalCoupling[PM]IviRFSigGenModulatePMPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigurePMExternalCoupling[PM]
DescriptionSpecifiesthecouplingoftheexternalsourceofthemodulatingsignal.
PropertyNodePathIviRFSigGen»AnalogModulation>>PM>>PMExternalCoupling[PM]
DefinedValuesIVIRFSIGGEN_VAL_PM_EXTERNAL_COUPLING_ACIVIRFSIGGEN_VAL_PM_EXTERNAL_COUPLING_DC
IviRFSigGenPMNominalVoltage[PM]IviRFSigGenModulatePMPropertyDatatype Access Appliesto Coercion HighLevelVIs
RO N/A None None
DescriptionThisisthevoltageatwhichtheinstrumentachievestheamountofmodulationspecifiedbytheIviRFSigGen>>AnalogModulation>>PM>>PMDeviation[PM]property.
Note:Thispropertyisreadonly.
PropertyNodePathIviRFSigGen»AnalogModulation>>PM>>PMNominalVoltage[PM]
IviRFSigGenPMSource[PM]IviRFSigGenModulatePMPropertyDatatype Access Appliesto Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigurePM[PM]
DescriptionSpecifiesthesourceofthesignalthatisusedasthemodulatingsignal.Ifmorethanonesourceisspecified,thevoltagesofallsources(internalandexternal)aresummed.Multiplesourcenamesareseparatedbycommas.
PropertyNodePathIviRFSigGen»AnalogModulation>>PM>>PMSource[PM]
IviRFSigGenPowerLevelIviRFSigGenBasePropertyDatatype Access Appliesto Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureRF
DescriptionSpecifiestheamplitude(powerlevel)oftheRFoutputsignal.ThevalueisindBm.
PropertyNodePathIviRFSigGen»RF>>PowerLevel
IviRFSigGenPowerStepDwell[PST]IviRFSigGenPowerStepPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigurePowerStepDwell[PST]
DescriptionSpecifiesthedurationtimeofonestep.Theunitsareinseconds.ThispropertyisignoredifFrequencyStepSingleStepEnabledissettoVI_TRUE.
PropertyNodePathIviRFSigGen»Sweep>>PowerStep>>PowerStepDwell[PST]
IviRFSigGenPowerStepSize[PST]IviRFSigGenPowerStepPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigurePowerStepStartStop[PST]
DescriptionSpecifiesthestepsize.TheunitsareindBm.
PropertyNodePathIviRFSigGen»Sweep>>PowerStep>>PowerStepSize[PST]
IviRFSigGenPowerStepStart[PST]IviRFSigGenPowerStepPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigurePowerStepStartStop[PST]
DescriptionSpecifiesthestartpowerofthesteppedsweep.Ifthestoppowerislessthanthestartpower,thepowerdecreasesinvalueduringthesweep.TheunitsareindBm.
PropertyNodePathIviRFSigGen»Sweep>>PowerStep>>PowerStepStart[PST]
IviRFSigGenPowerStepStop[PST]IviRFSigGenPowerStepPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigurePowerStepStartStop[PST]
DescriptionSpecifiesthestoppowerofthesteppedsweep.Ifthestoppowerislessthanthestartpower,thepowerdecreasesinvalueduringthesweep.TheunitsareindBm.
PropertyNodePathIviRFSigGen»Sweep>>PowerStep>>PowerStepStop[PST]
IviRFSigGenPowerSweepStart[PSW]IviRFSigGenPowerSweepPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigurePowerSweepStartStop[PSW]
DescriptionSpecifiesthestartpowerofthesweep.Ifthestoppowerislessthanthestartpower,thepowerdecreasesinvalueduringthesweep.TheunitsareindBm.
PropertyNodePathIviRFSigGen»Sweep>>PowerSweep>>PowerSweepStart[PSW]
IviRFSigGenPowerSweepTime[PSW]IviRFSigGenPowerSweepPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigurePowerSweepTime[PSW]
DescriptionSpecifiesthedurationofonesweepfromstarttostoppower.Theunitsareinseconds.
PropertyNodePathIviRFSigGen»Sweep>>PowerSweep>>PowerSweepTime[PSW]
IviRFSigGenPulseDoubleDelay[DPG]IviRFSigGenPulseDoubleGeneratorPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigurePulseDouble[DPG]
DescriptionSpecifiesthedelayofthesecondpulse.Theunitsareinseconds.
PropertyNodePathIviRFSigGen»PulseGenerator>>DoublePulseGenerators>>PulseDoubleDelay[DPG]
IviRFSigGenPulseDoubleEnabled[DPG]IviRFSigGenPulseDoubleGeneratorPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigurePulseDouble[DPG]
DescriptionSpecifieswhetherdoublepulsemodeisused(VI_TRUE)ornot(VI_FALSE).
PropertyNodePathIviRFSigGen»PulseGenerator>>DoublePulseGenerators>>PulseDoubleEnabled[DPG]
DefinedValuesVI_TRUEVI_FALSE
IviRFSigGenPulseExternalTriggerDelay[PG]IviRFSigGenPulseGeneratorPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigurePulseExternalTrigger[PG]
DescriptionSpecifiesthedelayforstartingtheoutputpulsewithrespecttothetriggerinput.Theunitsareinseconds.
PropertyNodePathIviRFSigGen»PulseGenerator>>PulseExternalTriggerDelay[PG]
IviRFSigGenPulseExternalTriggerSlope[PG]IviRFSigGenPulseGeneratorPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigurePulseExternalTrigger[PG]
DescriptionSpecifieswhethertheeventoccursontherisingorfallingedgeoftheinputsignal.
PropertyNodePathIviRFSigGen»PulseGenerator>>PulseExternalTriggerSlope[PG]
DefinedValuesIVIRFSIGGEN_VAL_PULSE_EXTERNAL_TRIGGER_SLOPE_POSITIVEIVIRFSIGGEN_VAL_PULSE_EXTERNAL_TRIGGER_SLOPE_NEGATIVE
IviRFSigGenPulseGatingEnabled[PG]IviRFSigGenPulseGeneratorPropertyDatatype Access Appliesto Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigurePulse[PG]
DescriptionSpecifieswhetherpulsegatingisenabled(VI_TRUE)ordisabled(VI_FALSE).
PropertyNodePathIviRFSigGen»PulseGenerator>>PulseGatingEnabled[PG]
DefinedValuesVI_TRUEVI_FALSE
IviRFSigGenPulseInternalTriggerPeriod[PG]IviRFSigGenPulseGeneratorPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigurePulseInternalTrigger[PG]
DescriptionSpecifiestheperiodofthepulsegeneratorsoutputsignal(ifPulseTriggerSourceissettoInternal).Theunitsareinseconds.
PropertyNodePathIviRFSigGen»PulseGenerator>>PulseInternalTriggerPeriod[PG]
IviRFSigGenPulseModulationEnabled[PULM]IviRFSigGenModulatePulsePropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigurePulseModulationEnabled[PULM]
DescriptionSpecifieswhetherthesignalgeneratorappliespulsemodulationtotheRFoutputsignal(VI_TRUE)ornot(VI_FALSE).
PropertyNodePathIviRFSigGen»PulseModulation>>PulseModulationEnabled[PULM]
DefinedValuesVI_TRUEVI_FALSE
IviRFSigGenPulseModulationExternalPolarity[PULM]IviRFSigGenModulatePulsePropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigurePulseModulationExternalPolarity[PULM]
DescriptionSpecifiesthepolarityoftheexternalsourcesignal.
PropertyNodePathIviRFSigGen»PulseModulation>>PulseModulationExternalPolarity[PULM]
DefinedValuesIVIRFSIGGEN_VAL_PULSE_MODULATION_EXTERNAL_POLARITY_NORMALIVIRFSIGGEN_VAL_PULSE_MODULATION_EXTERNAL_POLARITY_INVERSE
IviRFSigGenPulseModulationSource[PULM]IviRFSigGenModulatePulsePropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigurePulseModulationSource[PULM]
DescriptionSpecifiesthesourceofthesignalthatisusedasthemodulatingsignal.
PropertyNodePathIviRFSigGen»PulseModulation>>PulseModulationSource[PULM]
DefinedValuesIVIRFSIGGEN_VAL_PULSE_MODULATION_SOURCE_INTERNALIVIRFSIGGEN_VAL_PULSE_MODULATION_SOURCE_EXTERNAL
IviRFSigGenPulseOutputEnabled[PGO]IviRFSigGenPulseGeneratorOutputPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigurePulseOutput[PGO]
DescriptionSpecifieswhethertheoutputofthepulsegeneratorison(VI_TRUE)oroff(VI_FALSE).
PropertyNodePathIviRFSigGen»PulseGenerator>>PulseGeneratorOutput>>PulseOutputEnabled[PGO]
DefinedValuesVI_TRUEVI_FALSE
IviRFSigGenPulseOutputPolarity[PGO]IviRFSigGenPulseGeneratorOutputPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigurePulseOutput[PGO]
DescriptionSpecifiesthepolarityoftheoutputsignal.
PropertyNodePathIviRFSigGen»PulseGenerator>>PulseGeneratorOutput>>PulseOutputPolarity[PGO]
DefinedValuesIVIRFSIGGEN_VAL_PULSE_OUTPUT_POLARITY_NORMALIVIRFSIGGEN_VAL_PULSE_OUTPUT_POLARITY_INVERSE
IviRFSigGenPulseTriggerSource[PG]IviRFSigGenPulseGeneratorPropertyDatatype Access Appliesto Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigurePulse[PG]
DescriptionSpecifiesthesourceofthesignalthepulsegeneratorusestogenerateonepulse.
PropertyNodePathIviRFSigGen»PulseGenerator>>PulseTriggerSource[PG]
DefinedValuesIVIRFSIGGEN_VAL_PULSE_TRIGGER_SOURCE_INTERNALIVIRFSIGGEN_VAL_PULSE_TRIGGER_SOURCE_EXTERNAL
IviRFSigGenPulseWidth[PG]IviRFSigGenPulseGeneratorPropertyDatatype Access Appliesto Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigurePulse[PG]
DescriptionSpecifiesthewidthoftheoutputpulse.Theunitsareinseconds.
PropertyNodePathIviRFSigGen»PulseGenerator>>PulseWidth[PG]
IviRFSigGenReferenceOscillatorExternalFrequency[RO]IviRFSigGenReferenceOscillatorPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureReferenceOscillator[RO]
DescriptionSpecifiesthefrequencyoftheexternalsignal,whichisusedasreferenceforinternalRFfrequencygeneration.ThisvalueisusedonlyiftheIviRFSigGen>>ReferenceOscillator>>ReferenceOscillatorSource[RO]propertyissettoExternal.
PropertyNodePathIviRFSigGen»ReferenceOscillator>>ReferenceOscillatorExternalFrequency[RO]
IviRFSigGenReferenceOscillatorSource[RO]IviRFSigGenReferenceOscillatorPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureReferenceOscillator[RO]
DescriptionSpecifiesthereferencefrequencysourceusedtogeneratetheexactRFoutputfrequency.
PropertyNodePathIviRFSigGen»ReferenceOscillator>>ReferenceOscillatorSource[RO]
DefinedValuesIVIRFSIGGEN_VAL_REFERENCE_OSCILLATOR_SOURCE_INTERNALIVIRFSIGGEN_VAL_REFERENCE_OSCILLATOR_SOURCE_EXTERNAL
IviRFSigGenSingleStepEnabled[PST]IviRFSigGenPowerStepPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigurePowerStepDwell[PST]
DescriptionSpecifieswhetherthetriggerinitiatesthenextstep(VI_TRUE),orthenextstepistakenafterdwelltime(VI_FALSE).
PropertyNodePathIviRFSigGen»Sweep>>PowerStep>>SingleStepEnabled[PST]
DefinedValuesVI_TRUEVI_FALSE
IviRFSigGenSweepMode[SWP]IviRFSigGenSweepPropertyDatatype Access Appliesto Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureSweep
DescriptionSpecifiesthesweepmodeappliedtotheoutputsignal.
PropertyNodePathIviRFSigGen»Sweep>>SweepMode[SWP]
DefinedValuesIVIRFSIGGEN_VAL_SWEEP_MODE_NONEIVIRFSIGGEN_VAL_SWEEP_MODE_FREQUENCY_SWEEPIVIRFSIGGEN_VAL_SWEEP_MODE_POWER_SWEEPIVIRFSIGGEN_VAL_SWEEP_MODE_FREQUENCY_STEPIVIRFSIGGEN_VAL_SWEEP_MODE_POWER_STEPIVIRFSIGGEN_VAL_SWEEP_MODE_LIST
IviRFSigGenSweepTriggerSource[SWP]IviRFSigGenSweepPropertyDatatype Access Appliesto Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureSweep
DescriptionSpecifiesthetriggerusedtostartasweepoperation.
PropertyNodePathIviRFSigGen»Sweep>>SweepTriggerSource[SWP]
DefinedValuesIVIRFSIGGEN_VAL_SWEEP_TRIGGER_SOURCE_IMMEDIATEIVIRFSIGGEN_VAL_SWEEP_TRIGGER_SOURCE_EXTERNALIVIRFSIGGEN_VAL_SWEEP_TRIGGER_SOURCE_SOFTWARE
IviRFSigGenTDMAClockSource[TDMA]IviRFSigGenTDMABasePropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureTDMAClockSource[TDMA]
DescriptionSpecifiesthesourceoftheclocksignalusedtogeneratethedigitalmodulationaccordingtotheselectedstandard.
PropertyNodePathIviRFSigGen»TDMA>>TDMAClockSource[TDMA]
DefinedValuesIVIRFSIGGEN_VAL_TDMA_CLOCK_SOURCE_INTERNALIVIRFSIGGEN_VAL_TDMA_CLOCK_SOURCE_EXTERNAL
IviRFSigGenTDMAClockType[TDMA]IviRFSigGenTDMABasePropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureTDMAClockSource[TDMA]
DescriptionSpecifiesthetypeoftheexternalclocksignalusedtogeneratethedigitalmodulation.ThisvalueisusedonlyiftheIviRFSigGen>>TDMA>>TDMAClockSource[TDMA]propertyissettoExternal.
PropertyNodePathIviRFSigGen»TDMA>>TDMAClockType[TDMA]
DefinedValuesIVIRFSIGGEN_VAL_TDMA_EXTERNAL_CLOCK_TYPE_BITIVIRFSIGGEN_VAL_TDMA_EXTERNAL_CLOCK_TYPE_SYMBOL
IviRFSigGenTDMAExternalTriggerSlope[TDMA]IviRFSigGenTDMABasePropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureTDMAExternalTriggerSlope[TDMA]
DescriptionSpecifieswhetherthetriggereventoccursontherisingorfallingedgeoftheinputsignal.
PropertyNodePathIviRFSigGen»TDMA>>Trigger>>TDMAExternalTriggerSlope[TDMA]
DefinedValuesIVIRFSIGGEN_VAL_TDMA_EXTERNAL_TRIGGER_SLOPE_POSITIVEIVIRFSIGGEN_VAL_TDMA_EXTERNAL_TRIGGER_SLOPE_NEGATIVE
IviRFSigGenTDMAFrameCount[TDMA]IviRFSigGenTDMABasePropertyDatatype Access Appliesto Coercion HighLevelVIs
RO N/A None None
DescriptionSpecifiesthenumberofTDMAframesavailableforaparticularinstrument.
PropertyNodePathIviRFSigGen»TDMA>>TDMAFrameCount[TDMA]
IviRFSigGenTDMASelectedFrame[TDMA]IviRFSigGenTDMABasePropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenSelectTDMAFrame[TDMA]
DescriptionSpecifiestheactualframeusedbytheinstrument.ItisselectedfromthelistqueriedwiththeGetTDMAFrameNamesVI.
PropertyNodePathIviRFSigGen»TDMA>>TDMASelectedFrame[TDMA]
IviRFSigGenTDMASelectedStandard[TDMA]IviRFSigGenTDMABasePropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenSelectTDMAStandard[TDMA]
DescriptionSpecifiestheactualstandardusedbytheinstrument.Thecoding,mapping,symbolrateorbitclockfrequency,filtertogetherwiththeaccordingfilterparameters,FSKdeviationorASKdepth(incaseofFSKorASKmodulation)aresetasdefinedintheselectedstandard.
PropertyNodePathIviRFSigGen»TDMA>>TDMASelectedStandard[TDMA]
IviRFSigGenTDMAStandardCount[TDMA]Datatype Access Appliesto Coercion HighLevelVIs
RO N/A None None
DescriptionSpecifiesthenumberofTDMAstandardsavailableforaparticularinstrument.
PropertyNodePathIviRFSigGen»TDMA>>TDMAStandardCount[TDMA]
IviRFSigGenTDMATriggerSource[TDMA]IviRFSigGenTDMABasePropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviRFSigGenConfigureTDMATriggerSource[TDMA]
DescriptionSpecifiesthesourceofthetriggersignalthatstartstheframe/slotsgeneration.
PropertyNodePathIviRFSigGen»TDMA>>Trigger>>TDMATriggerSource[TDMA]
DefinedValuesIVIRFSIGGEN_VAL_TDMA_TRIGGER_SOURCE_IMMEDIATEIVIRFSIGGEN_VAL_TDMA_TRIGGER_SOURCE_EXTERNALIVIRFSIGGEN_VAL_TDMA_TRIGGER_SOURCE_SOFTWARE
IviRFSigGenDefinedValuesExpandthisbooktoviewanalphabetizedlistofIviRFSigGendefinedvalues.
IVIRFSIGGEN_VAL_ALC_SOURCE_EXTERNALDescriptionTheALCiscontrolledbyanexternalvoltage.
DefinedValue2
IVIRFSIGGEN_VAL_ALC_SOURCE_INTERNALDescriptionTheALCiscontrolledbyaninternalmeasurementsource.
DefinedValue1
IVIRFSIGGEN_VAL_AM_EXTERNAL_COUPLING_ACDescriptionTheexternalsourceiscoupledforAConly.
DefinedValue1
IVIRFSIGGEN_VAL_AM_EXTERNAL_COUPLING_DCDescriptionTheexternalsourceiscoupledforbothDCandAC
DefinedValue2
IVIRFSIGGEN_VAL_AM_SCALING_LINEARDescriptionEnableslinearattenuationforamplitudemodulation.
DefinedValue1
IVIRFSIGGEN_VAL_AM_SCALING_LOGARITHMICDescriptionEnableslogarithmicattenuationforamplitudemodulation.
DefinedValue2
IVIRFSIGGEN_VAL_ARB_EXTERNAL_TRIGGER_SLOPE_NEGATIVEDescriptionEnablesfallingedgetriggering.
DefinedValue2
IVIRFSIGGEN_VAL_ARB_EXTERNAL_TRIGGER_SLOPE_POSITIVEDescriptionEnablesrisingedgetriggering.
DefinedValue1
IVIRFSIGGEN_VAL_ARB_TRIGGER_SOURCE_EXTERNALDescriptionThesweepisstartedwithanexternalsignal.
DefinedValue2
IVIRFSIGGEN_VAL_ARB_TRIGGER_SOURCE_IMMEDIATEDescriptionTheARBgeneratorsystemdoesnotwaitforatrigger.TheARBrunscontinuously.
DefinedValue1
IVIRFSIGGEN_VAL_ARB_TRIGGER_SOURCE_SOFTWAREDescriptionThesweepisstartedwithasoftwareprogrammabletrigger.
DefinedValue3
IVIRFSIGGEN_VAL_CDMA_CLOCK_SOURCE_EXTERNALDescriptionAconnectedexternalclockgenerator(bitorsymbolclockfrequency)isused.
DefinedValue2
IVIRFSIGGEN_VAL_CDMA_CLOCK_SOURCE_INTERNALDescriptionTheinternalclockgeneratorisused.
DefinedValue1
IVIRFSIGGEN_VAL_CDMA_EXTERNAL_TRIGGER_SLOPE_NEGATIVEDescriptionEnablesfallingedgetriggering.
DefinedValue2
IVIRFSIGGEN_VAL_CDMA_EXTERNAL_TRIGGER_SLOPE_POSITIVEDescriptionEnablesrisingedgetriggering.
DefinedValue1
IVIRFSIGGEN_VAL_CDMA_TRIGGER_SOURCE_EXTERNALDescriptionEachchannelcodingisstartedwithanexternalsignal.
DefinedValue2
IVIRFSIGGEN_VAL_CDMA_TRIGGER_SOURCE_IMMEDIATEDescriptionTheCDMAgeneratorsystemdoesnotwaitforatrigger.Eachchannelcodingisruncontinuously.
DefinedValue1
IVIRFSIGGEN_VAL_CDMA_TRIGGER_SOURCE_SOFTWAREDescriptionEachchannelcodingisstartedwithasoftwareprogrammabletrigger.
DefinedValue3
IVIRFSIGGEN_VAL_DIGITAL_MODULATION_BASE_CLOCK_SOURCE_EXTERNALDescriptionAconnectedexternalclockgenerator(bitorsymbolclockfrequency)isused.
DefinedValue2
IVIRFSIGGEN_VAL_DIGITAL_MODULATION_BASE_CLOCK_SOURCE_INTERNALDescriptionAninternalclockgeneratorisused.
DefinedValue1
IVIRFSIGGEN_VAL_DIGITAL_MODULATION_BASE_DATA_SOURCE_BIT_SEQUENCEDescriptionAconstantbitsequenceisusedasdatasourceandrepeatedcontinuously.
DefinedValue3
IVIRFSIGGEN_VAL_DIGITAL_MODULATION_BASE_DATA_SOURCE_EXTERNALDescriptionThedatafromanexternaldeviceconnectedtotheinstrumentisused.
DefinedValue1
IVIRFSIGGEN_VAL_DIGITAL_MODULATION_BASE_DATA_SOURCE_PRBSDescriptionTheinternalPRBS(PseudoRandomBinarySequence)generatorisusedasdatasource.
DefinedValue2
IVIRFSIGGEN_VAL_DIGITAL_MODULATION_BASE_EXTERNAL_CLOCK_TYPE_BITDescriptionTheexternalclockfrequencyisequaltothebitclockfrequencyofthedigitalmodulation.
DefinedValue1
IVIRFSIGGEN_VAL_DIGITAL_MODULATION_BASE_EXTERNAL_CLOCK_TYPE_SYMBOLDescriptionTheexternalclockfrequencyisequaltothesymbolclockfrequencyofthedigitalmodulation.
DefinedValue2
IVIRFSIGGEN_VAL_DIGITAL_MODULATION_BASE_PRBS_TYPE_PRBS11DescriptionLengthofPRBSsequenceis2^11-1.
DefinedValue2
IVIRFSIGGEN_VAL_DIGITAL_MODULATION_BASE_PRBS_TYPE_PRBS15DescriptionLengthofPRBSsequenceis2^15-1.
DefinedValue3
IVIRFSIGGEN_VAL_DIGITAL_MODULATION_BASE_PRBS_TYPE_PRBS16DescriptionLengthofPRBSsequenceis2^16-1.
DefinedValue4
IVIRFSIGGEN_VAL_DIGITAL_MODULATION_BASE_PRBS_TYPE_PRBS20DescriptionLengthofPRBSsequenceis2^20-1.
DefinedValue5
IVIRFSIGGEN_VAL_DIGITAL_MODULATION_BASE_PRBS_TYPE_PRBS21DescriptionLengthofPRBSsequenceis2^21-1.
DefinedValue6
IVIRFSIGGEN_VAL_DIGITAL_MODULATION_BASE_PRBS_TYPE_PRBS23DescriptionLengthofPRBSsequenceis2^23-1.
DefinedValue7
IVIRFSIGGEN_VAL_DIGITAL_MODULATION_BASE_PRBS_TYPE_PRBS9DescriptionLengthofPRBSsequenceis2^9-1.
DefinedValue1
IVIRFSIGGEN_VAL_FM_EXTERNAL_COUPLING_ACDescriptionTheexternalsourceiscoupledforAConly.
DefinedValue1
IVIRFSIGGEN_VAL_FM_EXTERNAL_COUPLING_DCDescriptionTheexternalsourceiscoupledforbothDCandAC.
DefinedValue2
IVIRFSIGGEN_VAL_FREQUENCY_STEP_SCALING_LINEARDescriptionEnableslinearscaling.
DefinedValue1
IVIRFSIGGEN_VAL_FREQUENCY_STEP_SCALING_LOGARITHMICDescriptionEnableslogarithmicscaling.
DefinedValue2
IVIRFSIGGEN_VAL_IQ_SOURCE_ARB_GENERATORDescriptionThesignalgeneratorusestheinternallygeneratedArbsignaltoapplyIQmodulationtotheoutputRFsignal.
DefinedValue4
IVIRFSIGGEN_VAL_IQ_SOURCE_CDMA_BASEDescriptionThesignalgeneratorusestheinternallygeneratedCDMAsignaltoapplyIQmodulationtotheoutputRFsignal.
DefinedValue2
IVIRFSIGGEN_VAL_IQ_SOURCE_DIGITAL_MODULATION_BASEDescriptionThesignalgeneratorusestheinternallygenerateddigitalmodulationsignaltoapplyIQmodulationtotheoutputRFsignal.
DefinedValue1
IVIRFSIGGEN_VAL_IQ_SOURCE_EXTERNALDescriptionThesignalgeneratorusesdatafromanexternalsourceforIQmodulation.
DefinedValue5
IVIRFSIGGEN_VAL_IQ_SOURCE_TDMA_BASEDescriptionThesignalgeneratorusestheinternallygeneratedTDMAsignaltoapplyIQmodulationtotheoutputRFsignal.
DefinedValue3
IVIRFSIGGEN_VAL_LF_GENERATOR_WAVEFORM_RAMP_DOWNDescriptionConfigurestheLFgeneratortoproduceafallingrampwaveform.
DefinedValue5
IVIRFSIGGEN_VAL_LF_GENERATOR_WAVEFORM_RAMP_UPDescriptionConfigurestheLFgeneratortoproducearisingrampwaveform.
DefinedValue4
IVIRFSIGGEN_VAL_LF_GENERATOR_WAVEFORM_SINEDescriptionConfigurestheLFgeneratortoproduceasinusoidalwaveform.
DefinedValue1
IVIRFSIGGEN_VAL_LF_GENERATOR_WAVEFORM_SQUAREDescriptionConfigurestheLFgeneratortoproduceasquarewaveform.
DefinedValue2
IVIRFSIGGEN_VAL_LF_GENERATOR_WAVEFORM_TRIANGLEDescriptionConfigurestheLFgeneratortoproduceatrianglewaveform.
DefinedValue3
IVIRFSIGGEN_VAL_PM_EXTERNAL_COUPLING_ACDescriptionTheexternalsourceiscoupledforAConly.
DefinedValue1
IVIRFSIGGEN_VAL_PM_EXTERNAL_COUPLING_DCDescriptionTheexternalsourceiscoupledforbothDCandAC.
DefinedValue2
IVIRFSIGGEN_VAL_PULSE_EXTERNAL_TRIGGER_SLOPE_NEGATIVEDescriptionEnablesfallingedgetriggering.
DefinedValue2
IVIRFSIGGEN_VAL_PULSE_EXTERNAL_TRIGGER_SLOPE_POSITIVEDescriptionEnablesrisingedgetriggering.
DefinedValue1
IVIRFSIGGEN_VAL_PULSE_MODULATION_EXTERNAL_POLARITY_INVERSEDescriptionThesignalgeneratormodulatesthecarriersignalwithinvertedpulsepolarity.
DefinedValue2
IVIRFSIGGEN_VAL_PULSE_MODULATION_EXTERNAL_POLARITY_NORMALDescriptionThesignalgeneratormodulatesthecarriersignalwithnormalpulsepolarity.
DefinedValue1
IVIRFSIGGEN_VAL_PULSE_MODULATION_SOURCE_EXTERNALDescriptionAnexternalgeneratorisusedformodulation.
DefinedValue2
IVIRFSIGGEN_VAL_PULSE_MODULATION_SOURCE_INTERNALDescriptionAninternalpulsegenerator(IviRFSigGenPulseGeneratorExtensionGroup)isusedformodulation.
DefinedValue1
IVIRFSIGGEN_VAL_PULSE_OUTPUT_POLARITY_INVERSEDescriptionSpecifiesinvertedpolarity.
DefinedValue2
IVIRFSIGGEN_VAL_PULSE_OUTPUT_POLARITY_NORMALDescriptionSpecifiesnormalpolarity.
DefinedValue1
IVIRFSIGGEN_VAL_PULSE_TRIGGER_SOURCE_EXTERNALDescriptionThepulseisstartedwithatriggerafterthedelaytimespecifiedbytheIviRFSigGen>>PulseGenerator>>PulseExternalTriggerDelay[PG]property.
DefinedValue2
IVIRFSIGGEN_VAL_PULSE_TRIGGER_SOURCE_INTERNALDescriptionNoexternaltriggerisused.ThepulseperiodisspecifiedbytheIviRFSigGen>>PulseGenerator>>PulseInternalTriggerPeriod[PG]property.
DefinedValue1
IVIRFSIGGEN_VAL_REFERENCE_OSCILLATOR_SOURCE_EXTERNALDescriptionAnexternalreferenceoscillatorisused.
DefinedValue2
IVIRFSIGGEN_VAL_REFERENCE_OSCILLATOR_SOURCE_INTERNALDescriptionAninternalreferenceoscillatorisused.
DefinedValue1
IVIRFSIGGEN_VAL_SWEEP_MODE_FREQUENCY_STEPDescriptionThesignalgeneratorsweepstheRFoutputsignalsfrequencyinsteps.
DefinedValue4
IVIRFSIGGEN_VAL_SWEEP_MODE_FREQUENCY_SWEEPDescriptionThesignalgeneratorsweepstheRFoutputsignal'sfrequencyinananalogform(non-stepped).
DefinedValue2
IVIRFSIGGEN_VAL_SWEEP_MODE_LISTDescriptionThesignalgeneratorusestwolistswithfrequencyandpowerlevelvaluestosweeptheRFoutputsignals.
DefinedValue6
IVIRFSIGGEN_VAL_SWEEP_MODE_NONEDescriptionTheRFoutputofthesignalgeneratorisanon-sweptsignal(ContinuousWave).Frequencyandpowerlevelfrombasecapabilitygroupisused.
DefinedValue1
IVIRFSIGGEN_VAL_SWEEP_MODE_POWER_STEPDescriptionThesignalgeneratorsweepstheRFoutputsignalspowerlevelinsteps.
DefinedValue5
IVIRFSIGGEN_VAL_SWEEP_MODE_POWER_SWEEPDescriptionThesignalgeneratorsweepstheRFoutputsignal'spowerlevelinananalogform(non-stepped).
DefinedValue3
IVIRFSIGGEN_VAL_SWEEP_TRIGGER_SOURCE_EXTERNALDescriptionThesweepisstartedwithanexternalsignal.
DefinedValue2
IVIRFSIGGEN_VAL_SWEEP_TRIGGER_SOURCE_IMMEDIATEDescriptionThesweepsystemdoesnotwaitforatriggerofanykind,soitisrunningcontinuously.
DefinedValue1
IVIRFSIGGEN_VAL_SWEEP_TRIGGER_SOURCE_SOFTWAREDescriptionThesweepisstartedwithasoftwareprogrammabletrigger.
DefinedValue3
IVIRFSIGGEN_VAL_TDMA_CLOCK_SOURCE_EXTERNALDescriptionAconnectedexternalclockgenerator(bitorsymbolclockfrequency)isused.
DefinedValue2
IVIRFSIGGEN_VAL_TDMA_CLOCK_SOURCE_INTERNALDescriptionTheinternalclockgeneratorisused.
DefinedValue1
IVIRFSIGGEN_VAL_TDMA_EXTERNAL_CLOCK_TYPE_BITDescriptionTheexternalclockfrequencyisequaltothebitclockfrequencyofthedigitalmodulation.
DefinedValue1
IVIRFSIGGEN_VAL_TDMA_EXTERNAL_CLOCK_TYPE_SYMBOLDescriptionTheexternalclockfrequencyisequaltothesymbolclockfrequencyofthedigitalmodulation.
DefinedValue2
IVIRFSIGGEN_VAL_TDMA_EXTERNAL_TRIGGER_SLOPE_NEGATIVEDescriptionEnablesfallingedgetriggering.
DefinedValue2
IVIRFSIGGEN_VAL_TDMA_EXTERNAL_TRIGGER_SLOPE_POSITIVEDescriptionEnablesrisingedgetriggering.
DefinedValue1
IVIRFSIGGEN_VAL_TDMA_TRIGGER_SOURCE_EXTERNALDescriptionEachframeisstartedwithanexternalsignal.
DefinedValue2
IVIRFSIGGEN_VAL_TDMA_TRIGGER_SOURCE_IMMEDIATEDescriptionTheTDMAgeneratorsystemdoesnotwaitforatriggerofanykind,soitisrunningtheframescontinuously.
DefinedValue1
IVIRFSIGGEN_VAL_TDMA_TRIGGER_SOURCE_SOFTWAREDescriptionEachframeisstartedwithasoftwareprogrammabletrigger.
DefinedValue3
IviScopeClassDriverReferenceforLabVIEWConceptsIviScopeClassDriverOverviewIviScopeExtensionGroupsIviScopeBehaviorModels
IviScopeVIandPropertyReference
IviScopeVITreeIviScopePropertiesbyGroupIviScopePropertyValueDefinitionsIviScopeErrorandCompletionCodes
OtherReference
InterchangeabilityCheckingSimulation
IviScopeClassDriverOverviewThisinstrumentdriverprovidesprogrammingsupportfortheIviScopeClass.TheIviScopeclassdriverconceptualizesanoscilloscopeasaninstrumentthatcanacquireavoltagewaveformfromananaloginputsignal.Thepointsinthewaveformareacquiredataconfigurableintervalandcouldbeacquiredsequentiallyinreal-timesamplingorinterleavedfrommultiplewaveformacquisitionsinequivalent-timeorRISsampling.Apropertyofoneoftheinputsignals(typicallyarisingorfallingedge)isusedtotriggertheacquisition.Inaddition,theIviScopeclassdrivercansupportinstrumentsthathavemorecomplexacquisitionmodes(suchasaverage,envelope,andpeakdetect)andtriggertypes(suchasTV,runt,andglitch).ThedrivercontainsVIsforallthefunctionsthattheIVIFoundationrequiresfortheIviScopespecification.ThisdriverrequiresNI-VISAandtheIVICompliancePackagetobeinstalled.Usethisdrivertodevelopprogramsthatareindependentofaparticularoscilloscope.YoucanusethisclassdriverwithanyoscilloscopethathasanIVIinstrumentspecificdriverthatiscompliantwiththeIviScopeclass.TheIviScopeclassdriveraccessesthespecificdriverforyourinstrumentusingtheconfigurationinformationyousupplyinMAX.TheIviScopeclassdriverdividesinstrumentcapabilitiesintoabasecapabilitygroupandmultipleextensioncapabilitygroups.TheIviScopeBasecapabilitygroupsupportsoscilloscopesthatacquireonewaveformafterreceivingatriggersignal.TheVIsandpropertiesofthisgroupareimplementedbyalloscilloscopeinstrumentdriversthatarecompliantwiththeIviScopeclass.
ExtensionCapabilityGroupsTheIviScopeclassdriveridentifiesVIsandpropertiesthatbelongtoanextensiongroupwiththefollowingabbreviations.Instrumentspecificdriversarenotrequiredtoimplementanyoftheextensioncapabilitygroups.IfyouuseVIsandpropertiesthatbelongtoextensioncapabilitygroups,everyinstrumentspecificdriverthatyouusemustimplementthoseextensions.
GroupName Abbreviation DescriptionIviScopeTVTrigger [TV] Forinstrumentscapable
oftriggeringonstandardtelevisionsignals
IviScopeRuntTrigger [RT] Forinstrumentscapableoftriggeringonrunts
IviScopeGlitchTrigger [GT] Forinstrumentscapableoftriggeringonglitches
IviScopeWidthTrigger [WT] Forinstrumentscapableoftriggeringonavarietyofconditionsregardingpulsewidths
IviScopeWaveformMeasurement [WM] Forinstrumentscapableofcalculatingmeasurementsfromanacquiredwaveform,suchasrisetimeorfrequency
IviScopeMinMaxWaveform [MM] Forinstrumentscapableofacquiringminimumandmaximumwaveformsthatcorrespondtothesamerangeoftime
IviScopeInterpolation [I] Forinstrumentscapableofconfiguringtheacquisitionto
interpolatemissingpointsinawaveform
IviScopeAcLineTrigger [AT] Forinstrumentscapableoftriggeringonzerocrossingsofanetworksupplyvoltage
IviScopeProbeAutoSense [PAS] Forinstrumentscapableofautomaticallysensingtheprobeattenuationofanattachedprobe
IviScopeContinuousAcquisition [CA] Forinstrumentscapableofcontinuouslyacquiringdatafromtheinputanddisplayingitonthescreen
IviScopeAverageAcquisition [AA] Forinstrumentscapableofcreatingawaveformthatistheaverageofmultiplewaveformacquisitions
IviScopeSampleMode [SM] Forinstrumentscapableofreturningtheactualsamplemode
IviScopeTriggerModifier [TM] Forinstrumentscapableofmodifyingthebehaviorofthetriggeringsubsystemintheabsenceofanexpectedtrigger
IviScopeAutoSetup [AS] Forinstrumentswiththeautomaticconfigurationability
RelatedTopicsIVIInherentClassCapabilities
IviScopeExtensionCapabilityGroupsTheIviScopeclassdriveridentifiesVIsandpropertiesthatbelongtoanextensiongroupwiththefollowingabbreviations.Instrumentspecificdriversarenotrequiredtoimplementanyoftheextensioncapabilitygroups.IfyouuseVIsandpropertiesthatbelongtoextensioncapabilitygroups,everyinstrumentspecificdriverthatyouusemustimplementthoseextensions.
GroupName DescriptionIviScopeTVTrigger Forinstrumentscapableoftriggering
onstandardtelevisionsignalsIviScopeRuntTrigger Forinstrumentscapableoftriggering
onruntsIviScopeGlitchTrigger Forinstrumentscapableoftriggering
onglitchesIviScopeWidthTrigger Forinstrumentscapableoftriggering
onavarietyofconditionsregardingpulsewidths
IviScopeWaveformMeasurement Forinstrumentscapableofcalculatingmeasurementsfromanacquiredwaveform,suchasrisetimeorfrequency
IviScopeMinMaxWaveform Forinstrumentscapableofacquiringminimumandmaximumwaveformsthatcorrespondtothesamerangeoftime
IviScopeInterpolation Forinstrumentscapableofconfiguringtheacquisitiontointerpolatemissingpointsinawaveform
IviScopeAcLineTrigger Forinstrumentscapableoftriggeringonzerocrossingsofanetworksupplyvoltage
IviScopeProbeAutoSense Forinstrumentscapableofautomaticallysensingtheprobeattenuationofanattachedprobe
IviScopeContinuousAcquisition Forinstrumentscapableofcontinuouslyacquiringdatafromtheinputanddisplayingitonthescreen
IviScopeAverageAcquisition Forinstrumentscapableofcreatingawaveformthatistheaverageofmultiplewaveformacquisitions
IviScopeSampleMode Forinstrumentscapableofreturningtheactualsamplemode
IviScopeTriggerModifier Forinstrumentscapableofmodifyingthebehaviorofthetriggeringsubsystemintheabsenceofanexpectedtrigger
IviScopeAutoSetup Forinstrumentswiththeautomaticconfigurationability
IviScopeAcLineTriggerExtensionGroupInadditiontothefundamentalcapabilities,theIviScopeAcLineTriggerextensiongroupdefinesextensionsforoscilloscopesthatarecapableofsynchronizingthetriggerwiththeACLine.ACLinetriggeringoccurswhentheoscilloscopedetectsapositivezerocrossing,negativezerocrossing,oroptionallyeitherpositiveornegativezerocrossingonthenetworksupplyvoltage.
IviScopeAcLineTriggerVIIviScopeConfigureACLineTriggerSlope[AT]
IviScopeAcLineTriggerPropertyIviScopeACLineTriggerSlopeRelatedTopicsIviScopeVITreeIviScopePropertiesIviScopebehaviormodel
IviScopeAutoSetupExtensionGroupTheIviScopeAutoSetupextensiongroupprovidessupportforoscilloscopesthatcanperformanauto-setupoperation.
IviScopeAutoSetupVIIviScopeAutoSetupRelatedTopicsIviScopeVITreeIviScopePropertiesIviScopebehaviormodel
IviScopeAverageAcquisitionExtensionGroupTheIviScopeAverageAcquisitionextensiongroupdefinesextensionsforoscilloscopesthatcanperformaverageacquisition.
IviScopeAverageAcquisitionVIIviScopeConfigureInitiateContinuous[CA]
IviScopeAverageAcquisitionPropertyIviScopeInitiateContinuousRelatedTopicsIviScopeVITreeIviScopePropertiesIviScopebehaviormodel
IviScopeBaseCapabilityGroupTheIviScopeBasecapabilitygroupsupportsoscilloscopesthatcanacquirewaveformsfrommultiplechannelswithanedgetrigger.TheIviScopeBasecapabilitygroupdefinespropertiesandtheirvaluestoconfiguretheoscilloscope'schannel,acquisition,andtriggersub-systems.TheIviScopeBasecapabilitygroupalsoincludesVIsforconfiguringtheoscilloscopeaswellasinitiatingwaveformacquisitionandretrievingwaveforms.ScrolldowntoseeallbaseVIsandproperties.IVIInherentVIsIVIInherentPropertiesIviScopebehaviormodel
IviScopeSub-SystemsChannelSub-SystemAcquisitionSub-SystemTriggerSub-System
IviScopeBaseVIsIviScopeConfigureAcquisitionTypeIviScopeConfigureChannelIviScopeConfigureChannelCharacteristicsIviScopeConfigureAcquisitionRecordIviScopeActualRecordLengthIviScopeConfigureTriggerIviScopeConfigureTriggerCouplingIviScopeConfigureEdgeTriggerSourceIviScopeReadWaveformIviScopeAbortIviScopeInitiateAcquisitionIviScopeAcquisitionStatusIviScopeFetchWaveformIviScopeIsInvalidWaveformElementIviScopeActualSampleRate
IviScopeBasePropertiesIviScopeAcquisitionStartTimeIviScopeAcquisitionTypeIviScopeChannelEnabledIviScopeHorizontalMinimumNumberofPointsIviScopeHorizontalRecordLengthIviScopeHorizontalSampleRateIviScopeHorizontalTimePerRecordIviScopeInputImpedanceIviScopeMaximumInputFrequencyIviScopeProbeAttenuationIviScopeTriggerCouplingIviScopeTriggerHoldoffIviScopeTriggerLevelIviScopeTriggerSlopeIviScopeTriggerSourceIviScopeTriggerTypeIviScopeVerticalCouplingIviScopeVerticalOffsetIviScopeVerticalRangeRelatedTopicsIviScopeVITreeIviScopeProperties
IviScopeBaseExtensionCapabilitySub-SystemsExpandthistopictoviewbasesub-systemcapabilitygroups.
ChannelSub-SystemThechannelsub-systemconfigurestherangeofvoltagestheoscilloscopeacquiresandhowtheoscilloscopecouplestheinputsignaltotheacquisitionsub-system.Themainchannelsub-systempropertiesinclude:
IviScopeVerticalRangeIviScopeVerticalOffsetIviScopeVerticalCouplingIviScopeProbeAttenuationIviScopeChannelEnabled
Allofthechannelsub-systempropertiesarechannel-based.TheycanbesetindividuallyortheycanbesetasagroupwiththeIviScopeConfigureChannelVI.
ChannelSub-SystemPropertiesTheIviScopeVerticalRangepropertyspecifiestheabsolutevalueoftherangeofvoltagesthattheoscilloscopeacquires.TheIviScopeVerticalOffsetpropertyspecifiesthecenteroftherangespecifiedbytheIviScopeVerticalRangepropertywithrespecttoground.TheIviScopeVerticalCouplingpropertyspecifieshowtocoupletheinputsignaltothechannelsub-system.TheIviScopeProbeAttenuationpropertyspecifiesthescalingfactorbywhichtheprobeattenuatestheinputsignal.Typically,thevalueoftheIviScopeProbeAttenuationpropertydeterminestherangevaluesthedriveracceptsfortheIviScopeVerticalRangeandIviScopeVerticalOffsetproperties.TheIviScopeChannelEnabledpropertyspecifieswhethertheoscilloscopeacquiresawaveformforthechannel.
TriggerSub-SystemThetriggersub-systemconfiguresthetypeofeventthattriggerstheoscilloscope.Theglobaltriggersub-systempropertiesare:
IviScopeTriggerTypeIviScopeTriggerHoldoffIviScopeTriggerCoupling
TheIviScopeTriggerTypepropertyspecifiestheeventthattriggerstheoscilloscope.TheIviScopeTriggerHoldoffpropertyspecifiesthelengthoftimeaftertheoscilloscopedetectsatriggerduringwhichtheoscilloscopeignoresadditionaltriggers.TheIviScopeTriggerHoldoffpropertyonlyaffectsinstrumentoperationwhentheoscilloscoperequiresmultipleacquisitionstobuildacompletewaveform.Theoscilloscoperequiresmultiplewaveformacquisitionswhentheinstrumentusesequivalenttimesamplingortheacquisitiontypeissettoenvelopeoraverage.TheIviScopeTriggerCouplingpropertyspecifieshowtheoscilloscopecouplesthetriggersourcesignaltothetriggersub-system.ThepropertiesfromtheabovelistcanbesetindividuallyortheycanbesetasagroupwiththeIviScopeConfigureTriggerandIviScopeConfigureTriggerCouplingVIs.Thefollowingpropertiesconfiguretheedgetrigger.ThesepropertiescanbesetindividuallyorasagroupwiththeIviScopeConfigureEdgeTriggerSourceVI.
IviScopeTriggerSourceIviScopeTriggerLevelIviScopeTriggerSlope
EdgeTriggersTheIviScopeTriggerSourcepropertyspecifiesthesourcetheoscilloscopemonitorsforthetriggerevent.TheIviScopeTriggerLevelpropertyspecifiesthevoltagethresholdforthetriggersub-system.MostofthetriggertypesusethevalueheldintheIviScopeTriggerLevelproperty.TheIviScopeTriggerSlopepropertyspecifieswhetherapositiveornegativeedgetriggerstheoscilloscope.Whenthetriggertypeisedge,thevaluesheldintheIviScopeTriggerLevelandIviScopeTriggerSlopepropertiesdefinethetriggerevent.TheoscilloscopetriggerswhenthetriggersourcecrossesthethresholdlevelwiththepolaritytheIviScopeTriggerLevelandIVISCOPE_ATTR_TRIGGER_SLOPEpropertiesspecify.
TriggeringOverviewThefollowingfigureillustratestherelationshipoftheTriggereventandtheacqStartTimeparametertothedatatheoscilloscopeacquiresinthewaveformrecord.Forthisillustration,thetriggertypeisanedgetriggerandthetriggersourceisaseriesofpulses.Itisimportanttonotethatthetriggersourcecanbeananalogordigitalsignalandthetriggertypecanbeanytriggertypethatthisclassdriverdefines.
HoldoffOverviewThefollowingfigureshowshowtheholdoffeffectsthetriggersub-system.Ideallythetriggereventoccursatcondition'1',butsometimestheoscilloscopetriggersoncondition'2'becausethesignalcrossesthetriggerlevel.Whenyouspecifyaholdoff,theoscilloscopetriggersonconditions'1'and'3',andignoresconditions'2'and'4'.
ThisIviScopeBaseCapabilitygroupdefinesVIsthatretrievewaveformsfromtheoscilloscope.TheseVIsreturnthefollowinginformation:
Thewaveformrecordasanarrayofvoltage.ThetimethatcorrespondstothefirstpointinthewaveformarrayrelativetotheTriggerEven.Theeffectivetimeintervalbetweenpointsinthewaveformrecord
AcquisitionSub-SystemTheacquisitionsub-systemconfiguresthesizeofthewaveformrecord,thelengthoftimethatcorrespondstotheoverallwaveformrecord,andtheacquisitionstarttime.Theconfigurableacquisitionsub-systempropertiesinclude:
IviScopeAcquisitionStartTimeIviScopeHorizontalMinimumNumberofPointsIviScopeHorizontalTimePerRecord
YouspecifytheminimumnumberofpointstheyrequiretheoscilloscopetoacquirewiththeIviScopeHorizontalMinimumNumberofPointsproperty.TheIviScopeHorizontalTimePerRecordpropertyspecifiesthelengthoftimethatcorrespondstotheoverallwaveformrecord.YouspecifythelengthoftimefromthetriggereventtothefirstpointinthewaveformrecordwiththeIviScopeAcquisitionStartTime.Ifthevalueispositive,thefirstpointinthewaveformrecordoccursafterthetriggerevent.AlloftheacquisitionpropertiescanbesetindividuallyortheycanbesetasagroupwiththeIviScopeConfigureAcquisitionRecordVI.Inaddition,theacquisitionsub-systemincludestworead-onlyproperties:
IviScopeHorizontalRecordLengthIviScopeHorizontalSampleRate
TheIviScopeHorizontalRecordLengthpropertyreturnstheactualnumberofpointsinthewaveformrecord.TheIviScopeHorizontalSampleRatepropertyreturnstheeffectivesamplerateoftheoscilloscope.TheIviScopeclassdriverdefinesseparatepropertiesfortheminimumrecordsizeyourequestandtheactualrecordlength.Typically,oscilloscopeschangetherecordlengthdynamicallywhentheacquisitiontypechanges.Forexample,whenyouchangetheacquisitiontypefromnormaltoenvelope,manyoscilloscopesreducetherecordlengthbyhalf.Whenyouchangetheacquisitiontype,theinstrumentdriverusesthevalueheldintheIviScopeHorizontalMinimumNumberofPointspropertytocheckthatthenewrecordlengthisequaltoorgreaterthantheminimumrecordlengthyourequire.
IviScopeContinuousAcquisitionExtensionGroupTheIviScopeContinuousAcquisitionextensiongroupgroupprovidessupportforoscilloscopesthatcanperformacontinuousacquisition.
IviScopeContinuousAcquisitionVIIviScopeConfigureInitiateContinuous[CA]
IviScopeContinuousAcquisitionPropertyIviScopeInitiateContinuousRelatedTopicsIviScopeVITreeIviScopePropertiesIviScopebehaviormodelIviScopeContinuousAcquisitionbehaviormodel
IviScopeGlitchTriggerExtensionGroupInadditiontothebasecapabilities,theIviScopeGlitchTriggerextensiongroupdefinesextensionsforoscilloscopesthatcantriggeronglitchpulses.Aglitchoccurswhentheoscilloscopedetectsapulsewidththatislessthanorgreaterthanaspecifiedglitchtime.Thefigurebelowshowsbothpositiveandnegativeglitches,bothlessthanandgreaterthanaspecifiedglitchtime.
GlitchTriggersWiththeIviScopeGlitchTriggerextensiongroupyoucanselectwhetherapositiveglitch,negativeglitch,oreithertriggerstheacquisition.Youcanalsoselecttheglitchcondition—whetheryouwanttheoscilloscopetotriggeronpulseslessthanorgreaterthanthespecifiedglitchwidth.
IviScopeGlitchTriggerVIsIviScopeConfigureGlitchTriggerSource
IviScopeGlitchTriggerPropertiesIviScopeGlitchCondition[GT]IviScopeGlitchPolarity[GT]IviScopeGlitchWidth[GT]RelatedTopicsIviScopeVITreeIviScopePropertiesIviScopebehaviormodel
IviScopeInterpolationExtensionGroupTheIviScopeInterpolationextensiongroupdefinesextensionsforoscilloscopescapableofinterpolatingvaluesinthewaveformrecordthattheoscilloscope'sacquisitionsubsystemwasunabletodigitize.
IviScopeInterpolationVIIviScopeConfigureInterpolation[I]
IviScopeInterpolationPropertyIviScopeInterpolationRelatedTopicsIviScopeVITreeIviScopePropertiesIviScopebehaviormodel
IviScopeMinMaxWaveformExtensionGroupTheIviScopeMinMaxWaveformextensiongroupprovidessupportforoscilloscopesthatcanacquireminimumandmaximumwaveformsthatcorrespondtothesamerangeoftime.Thetwomostcommonacquisitiontypesinwhichoscilloscopesreturnminimumandmaximumwaveformsareenvelopeandpeakdetect.
IviScopeMinMaxWaveformVIsIviScopeReadMinMaxWaveformIviScopeConfigureNumberofEnvelopesIviScopeFetchMinMaxWaveform
IviScopeMinMaxWaveformPropertyIviScopeNumberofEnvelopes[MmW]RelatedTopicsIviScopeVITreeIviScopePropertiesIviScopebehaviormodel
IviScopeProbeAutoSenseExtensionGroupTheIviScopeProbeAutoSenseextensiongroupprovidessupportforoscilloscopesthatcansenseandreturntheprobeattenuationoftheattachedprobe.
IviScopeProbeAutoSenseVIIviScopeAutoProbeSenseValue
IviScopeProbeAutoSensePropertyIviScopeProbeSenseValueRelatedTopicsIviScopeVITreeIviScopePropertiesIviScopebehaviormodel
IviScopeRuntTriggerExtensionGroupInadditiontothebasecapabilities,theIviScopeRuntTriggerextensiongroupdefinesextensionsforoscilloscopeswiththecapabilitytotriggeronruntpulses.Aruntconditionoccurswhentheoscilloscopedetectsapositiveornegativegoingpulsethatcrossesonevoltagethresholdbutfailstocrossasecondthresholdbeforere-crossingthefirst.Thefigurebelowshowsbothpositiveandnegativeruntpolarities.
RuntTriggersWiththeIviScopeRuntTriggerextensiongroupyoucanselectwhetherapositiverunt,negativerunt,oreithertriggerstheacquisition.
IviScopeRuntTriggerVIsIviScopeConfigureRuntTriggerSource
IviScopeRuntTriggerPropertiesIviScopeRuntHighThreshold[RT]IviScopeRuntLowThreshold[RT]IviScopeRuntPolarity[RT]RelatedTopicsIviScopeVITreeIviScopePropertiesIviScopebehaviormodel
IviScopeSampleModeExtensionGroupTheIviScopeSampleModeextensiongroupprovidessupportforoscilloscopesthatcanreturnwhethertheyareusingequivalent-timeorreal-timesamplingtoacquirewaveforms.
IviScopeSampleModeVIIviScopeActualSampleModeRelatedTopicsIviScopeVITreeIviScopePropertiesIviScopeBehaviorModel
IviScopeTriggerModifierExtensionGroupTheIviScopeTriggerModifierextensiongroupprovidessupportforoscilloscopesthatcanspecifythebehaviorofthetriggeringsubsystemintheabsenceoftheconfiguredtrigger.
IviScopeTriggerModifierVIIviScopeConfigureTriggerModifier
IviScopeTriggerModifierPropertyIviScopeTriggerModifier[TM]RelatedTopicsIviScopeVITreeIviScopePropertiesIviScopebehaviormodel
IviScopeTVTriggerExtensionGroupInadditiontothebasecapabilities,theIviScopeTVTriggerextensiongroupdefinesextensionsforoscilloscopescapableoftriggeringonstandardTVsignals.
IviScopeTVTriggerVIsIviScopeConfigureTVTriggerSourceIviScopeConfigureTVTriggerLineNumber
IviScopeTVTriggerPropertiesIviScopeTVTriggerEventIviScopeTVTriggerLineNumber[TV]IviScopeTVTriggerPolarity[TV]IviScopeTVTriggerSignalFormat[TV]RelatedTopicsIviScopeVITreeIviScopePropertiesIviScopebehaviormodel
IviScopeWaveformMeasurementExtensionGroupOverviewTheIviScopeWaveformMeasurementextensiongroupdefinesextensionsforoscilloscopescapableofcalculatingvariousmeasurementssuchasrise-time,fall-time,period,andfrequencyfromanacquiredwaveform.
NoteInthefollowingtable,theliteralstringIVISCOPE_VAL_precedesthemeasurementname.
WaveformMeasurementDescriptionsMeasurementName Description
RISE_TIME Thelengthoftimeforthefirstrisingedgeofthesignaltorisefromthelowreferenceleveltothehighreferencelevel.
FALL_TIME Thelengthoftimeforthefirstfallingedgeofthesignaltofallfromthehighreferenceleveltothelowreferencelevel.
FREQUENCY Thefrequencyofonecompletecycleinthewaveform.
PERIOD Thelengthoftimeofonecompletecycleinthewaveform.
VOLTAGE_RMS ThetrueRootMeanSquarevoltageoftheentirewaveform.
VOLTAGE_CYCLE_RMS ThetrueRootMeanSquarevoltageoverthefirstcycleinthewaveform.
VOLTAGE_MAX Themaximumamplitudefoundintheentirewaveform.
VOLTAGE_MIN Theminimumamplitudefoundintheentirewaveform.
VOLTAGE_PEAK_TO_PEAK TheabsolutedifferencebetweentheVOLTAGE_MAXandtheVOLTAGE_MINinvolts.
VOLTAGE_HIGH Thevoltagethatcorrespondsto100%whenusingthereferencelevels.Theoscilloscopecalculatesthisvalueusingeitherthemin/maxorhistogrammethods.Themin/maxmethodusesthemaximumvaluefound.Thehistogrammethodusesthemostcommonvaluefoundabovethemiddleofthewaveform.
VOLTAGE_LOW Thevoltagethatcorrespondsto0%whenusingthereferencelevels.Theoscilloscopecalculatesthisvalueusingeitherthemin/maxorhistogrammethods.Themin/maxmethodusestheminimumvaluefound.Thehistogrammethodusesthemostcommonvaluefoundbelowthemiddleofthewaveform.
VOLTAGE_AVERAGE Thearithmeticaverageinvoltsmeasuredovertheentirewaveform.
VOLTAGE_CYCLE_AVERAGE Thearithmeticaverageinvoltsoverthefirstcycleinthewaveform.
WIDTH_NEG Thelengthoftimebetweenthemidreferencelevelpointsofthefirstnegativepulseinthewaveform.
WIDTH_POS Thelengthoftimebetweenthemidreferencelevelpointsofthefirstpositivepulseinthewaveform.
DUTY_CYCLE_NEG TheratiooftheWIDTH_NEGtothePERIODofthefirstcycleinthewaveformexpressedasapercentage.
DUTY_CYCLE_POS TheratiooftheWIDTH_POSwidthtothePERIODofthefirstcycleinthewaveformexpressedasapercentage.
AMPLITUDE TheVOLTAGE_HIGHlesstheVOLTAGE_LOWinvoltsovertheentirewaveform.AMPLITUDE=VOLTAGE_HIGH-VOLTAGE_LOW
OVERSHOOT Therelativewaveformdistortionwhichfollowsanedgetransition.Itiscalculatedusingthefollowing
formula:fortherisingedge:
wherethelocalmaximumisthemaximumvoltageofthesignalinthefirsthalfofthetimeperiodthatcommenceswhentherisingedgecrossesthehighreferencelevelandconcludeswhenthesubsequentfallingedgecrossesthehighreferencelevel.forthefallingedge:wherethelocalminimumistheminimumvalueofthesignalmeasuredinthefirsthalfofthetimeperiodthatcommenceswhenthefallingedgecrossesthelowreferencelevelandconcludeswhenthesubsequentrisingedgecrossesthelowreferencelevel.
Theinstrumentmakesthemeasurementontheedgeclosesttothebeginningofthewaveformrecord.Theunitsarethepercentageofthesignalamplitude.
PRESHOOT Therelativewaveformdistortionwhichprecedesanedgetransition.Itiscalculatedusingthefollowingformula:
fortherisingedge:
wherethelocalminimumis
theminimumvalueofthesignalmeasuredinthesecondhalfofthetimeperiodthatcommenceswhentheprecedingfallingedgecrossesthelowreferencelevelandconcludeswhentherisingedgecrossesthelowreferencelevel.forthefallingedge:
wherethelocalmaximumisthemaximumvoltageofthesignalinthesecondhalfofthetimeperiodthatcommenceswhentheprecedingrisingedgecrossesthehighreferencelevelandconcludeswhenthefallingedgecrossesthehighreferencelevel.
Theinstrumentmakesthemeasurementontheedgeclosesttothebeginningofthewaveformrecord.Theunitsarethepercentageofthesignalamplitude.
IviScopeWaveformMeasurementExtensionGroupTheIviScopeWaveformMeasurementextensiongroupdefinesasetofwaveformmeasurementdescriptions.Refertothebehaviormodelforthisextensiongroup.
IviScopeWaveformMeasurementVIsIviScopeConfigureReferenceLevelsIviScopeReadWaveformMeasurementIviScopeFetchWaveformMeasurement
IviScopeMeasWaveformPropertiesIviScopeMeasurementHighReference[WM]IviScopeMeasurementLowReference[WM]IviScopeMeasurementMidReference[WM]RelatedTopicsIviScopeVITreeIviScopeProperties
IviScopeWidthTriggerExtensionGroupThisgroupallowsyoutosetwidthtriggering.
IviScopeWidthTriggerVIIviScopeConfigureWidthTriggerSource
IviScopeWidthTriggerPropertiesIviScopeWidthCondition[WT]IviScopeWidthHighThreshold[WT]IviScopeWidthLowThreshold[WT]IviScopeWidthPolarity[WT]RelatedTopicsIviScopeVITreeIviScopePropertiesIviScopebehaviormodel
IviScopeWidthTriggerExtensionGroupOverviewInadditiontothebasecapabilities,theIviScopeWidthTriggerextensiongroupdefinesextensionsforoscilloscopescapableoftriggeringonuser-specifiedpulsewidths.Widthtriggeringoccurswhentheoscilloscopedetectsapositiveornegativepulsewithawidthwithin,oroptionallyoutside,thresholdsspecifiedbyyou.Thefigurebelowshowspositiveandnegativepulsesthatfallwithinthethresholdsspecifiedbyyou.
WidthTriggersWithintheThresholdsThefigurebelowshowspositiveandnegativepulsesthatarenotwithintheuser-specifiedthresholds.
WidthTriggersOutsidetheThresholds
IviScopeBehaviorModelsIviScopeContinuousAcquisition
IviScopeBehaviorModelThefollowingstatediagramshowsrelationshipsbetweentheIviScopeBasecapabilitygroupandoscilloscopebehavior.
IviScopeBehaviorModelNoteThefollowingextensiongroupsfollowtheIviScopebehaviormodel:IviScopeTVTrigger,IviScopeRuntTrigger,IviScopeGlitchTrigger,IviScopeWidthTrigger,IviScopeWaveformMeasurement,IviScopeProbeAutoSense,IviScopeSampleMode,IviScopeAcLineTrigger,IviScopeInterpolation,IviScopeAverageAcquisition,IviScopeTriggerModifier,IviScopeAutoSetup,andIviScopeMinMaxWaveform.
Typically,youconfiguretheoscilloscopewhileitisintheIdlestate.YoucanconfiguretheoscilloscopebyaccessingtheIviScopepropertiesindividuallyorbycallingthehigh-levelConfigureChannel,ConfigureAcquisitionRecord,ConfigureTrigger,andConfigureEdgeTriggerSourceVIs.Toacquirewaveforms,theIviScopeclassdriverpresentsthehigh-levelReadWaveformVI,aswellasthelow-levelVIsInitiateAcquisition,AcquisitionComplete,FetchWaveform,andAbort.TheReadWaveformVIinitiatesawaveformacquisitionandreturnstheacquiredwaveformaftertheoscilloscopehasreturnedtotheIdlestate.TheInitiateAcquisition,FetchWaveform,andAbortVIsgiveyoulow-levelcontroloverthemeasurementprocess.InitiateAcquisitionVI
initiatesawaveformacquisitionandmovestheinstrumentintotheWait-For-Triggerstate.Youconfigurethetypeoftriggerwiththetriggersub-systempropertiesorwiththeConfigureTriggerandConfigureEdgeTriggerSourceVIs.Afterthetriggereventoccurs,theoscilloscopeacquiresawaveformbasedonthechannelandacquisitionsub-systemproperties.Iftheoscilloscopewasabletofillallofthepointsinthewaveforminreal-timeitthenreturnstotheIdlestate.However,iftheoscilloscopemustacquiremultiplewaveformsinequivalent-timesamplingtobuildupthewaveformrecord,itthenmovestotheWait-For-Holdoffstate.TheoscilloscopethenwaitsconfigurableamountoftimebeforemovingtotheWait-For-Triggerstate.Afterenoughwaveformshavebeenacquiredtofillthewaveformrecord,theoscilloscopereturnstotheIdlestate.YoucanusetheAcquisitionStatusVItodetermineiftheacquisitioniscompleteorisstillinprogress.YoucanusetheFetchWaveformVItoreturnawaveformfromapreviouslyinitiatedacquisition.TheReadWaveformandFetchWaveformVIshavethefollowingoutputs:
AwaveformarrayThetimeofthefirstpointinthewaveformarrayrelativetothetriggereventTheeffectivetimeintervalbetweenpointsinthearray
IviScopeContinuousAcquisitionBehaviorModelThefollowingbehaviordiagramshowsrelationshipsbetweenIviScopeContinuousAcquisitioncapabilitiesandoscilloscopebehavior.
IviScopeContinuousAcquisitionBehaviorModelTheIviScopeContinuousAcquisitionextensiongroupaddsthepropertythatcontrolswhethertheinstrumentoperatesinasingle-shotmodeoritacquiresthedatacontinuously.Aftertheoscilloscopecompletesanacquisition,iftheIviScopeInitiateContinuous[CA]propertyissettoTRUE,theinstrumentgoestotheWait-for-TriggerstateinsteadofreturningtotheIdlestate.IntheWait-for-Triggerstate,theoscilloscopedisplayupdatescontinuously.ThisspecificationdoesnotdefinethebehaviorofthereadandfetchVIswhenthispropertyissettoTRUE.ThebehavioroftheseVIsisinstrumentspecific.
IviScopeVITreeTheVItreefortheIviScopeclassdriver,includingIVIandVXIplug&playrequiredVIs,isshownbelow.
NoteYouusetheLabVIEWPropertyNodetogetandsetproperties.
IviScopeVITreeNameorClass VIName RequiredBy
Initialize IviScopeInitialize VPP
InitializewithOptions
IviScopeInitializeWithOptions
IVI
Configuration
AutoSetup[AS] IviScopeAutoSetup
IviScopeAutoSetup
AcquisitionSubsystem
ConfigureAcquisitionType
IviScopeConfigureAcquisitionType
IviScope
ConfigureAcquisitionRecord
IviScopeConfigureAcquisitionRecord
IviScope
ConfigureNumberofAverages
IviScopeConfigureNumberofAverages
IviScopeAverageAcquisition
ConfigureNumberofEnvelopes[MnW]
IviScopeConfigureNumberofEnvelopes
IviScopeMinMaxWaveform
ConfigureInterpolation[I]
IviScopeConfigureInterpolation
IviScopeInterpolation
ConfigureInitiateContinuous[CA]
IviScopeConfigureInitiateContinuous
IviScopeContinuousAcquisition
Channel
ConfigureChannel
IviScopeConfigureChannel
IviScope
Configure IviScopeConfigure IviScope
ChannelCharacteristics
ChannelCharacteristics
Trigger
ConfigureTrigger IviScopeConfigureTrigger
IviScope
ConfigureTriggerCoupling
IviScopeConfigureTriggerCoupling
IviScope
ConfigureTriggerModifier[TM]
IviScopeConfigureTriggerModifier
IviScopeTriggerModifier
ConfigureEdgeTriggerSource
IviScopeConfigureEdgeTriggerSource
IviScope
ConfigureTVTriggerSource[TV]
IviScopeConfigureTVTriggerSource
IviScopeTVTrigger
ConfigureTVTriggerLineNumber[TV]
IviScopeConfigureTVTriggerLineNumber
IviScopeTVTrigger
ConfigureRuntTriggerSource[RT]
IviScopeConfigureRuntTriggerSource
IviScopeRuntTrigger
ConfigureGlitchTriggerSource[GT]
IviScopeConfigureGlitchTriggerSource
IviScopeGlitchTrigger
ConfigureWidthTriggerSource[WT]
IviScopeConfigureWidthTriggerSource
IviScopeWidthTrigger
ConfigureACLineTriggerSlope[AT]
IviScopeConfigureACLineTriggerSlope
IviScopeAcLineTrigger
Measurement
ConfigureReferenceLevels
IviScopeConfigureReferenceLevels
IviScopeWaveformMeas
ConfigurationInformation
ActualRecordLength
IviScopeActualRecordLength
IviScope
AutoProbeSenseValue[PAS]
IviScopeAutoProbeSenseValue
IviScopeProbeAutoSense
ActualSampleMode[SM]
IviScopeActualSampleMode
IviScopeSampleMode
ActualSampleRate
IviScopeSampleRate
IviScope
WaveformAcquisition
ReadWaveform IviScopeReadWaveform
IviScope
ReadMin/MaxWaveform
IviScopeReadMinMaxWaveform
IviScopeMinMaxWaveform
ReadWaveformMeasurement
IviScopeReadWaveformMeasurement
IviScopeWaveformMeas
Low-LevelAcquisition
Abort IviScopeAbort IviScope
AcquisitionStatus IviScopeAcquisitionStatus
IviScope
FetchMin/MaxWaveform[MmW]
IviScopeFetchMinMaxWaveform
MinMaxWaveform
FetchWaveform IviScopeFetch IviScope
Waveform
FetchWaveformMeasurement[WM]
IviScopeFetchWaveformMeasurement
IviScopeWaveformMeas
InitiateAcquisition
IviScopeInitiateAcquisition
IviScope
Utility
Reset IviScopeReset VPP
ResetWithDefaults
ResetWithDefaults
VPP
Self-Test IviScopeSelf-Test VPP
Disable Disable VPP
InvalidateAllAttributes
InvalidateAllAttributes
VPP
RevisionQuery IviScopeRevisionQuery
VPP
Error-Query IviScopeError-Query
VPP
ErrorMessage IviScopeErrorMessage
VPP
GetChannelName
GetChannelName VPP
IsInvalidWaveformElement
IviScopeIsInvalidWaveformElement
IviScope
InterchangeabilityInfo
GetNextInterchange
IviScopeGetNextInterchangeWarning
IVI
Warning
ResetInterchangeCheck
IviScopeResetInterchangeCheck
IVI
ClearInterchangeWarnings
IviScopeClearInterchangeWarnings
IVI
CoercionInfo
GetNextCoercionRecord
IviScopeGetNextCoercionRecord
IVI
Close IviScopeClose VPP
RelatedTopicsIviScopePropertiesIVIInherentClassCapabilities
IviScopePropertiesNoteYouusetheLabVIEWPropertyNodetogetandsetproperties.
IviScopeBasePropertiesIviScopeAcquisitionStartTimeIviScopeAcquisitionTypeIviScopeChannelEnabledIviScopeHorizontalMinimumNumberofPointsIviScopeHorizontalRecordLengthIviScopeHorizontalSampleRateIviScopeHorizontalTimePerRecordIviScopeInputImpedanceIviScopeMaximumInputFrequencyIviScopeProbeAttenuationIviScopeTriggerCouplingIviScopeTriggerHoldoffIviScopeTriggerLevelIviScopeTriggerSlopeIviScopeTriggerSourceIviScopeTriggerTypeIviScopeVerticalCouplingIviScopeVerticalOffsetIviScopeVerticalRange
IviScopeInterpolationIviScopeInterpolation
IviScopeTVTriggerPropertiesIviScopeTVTriggerEventIviScopeTVTriggerLineNumber[TV]IviScopeTVTriggerPolarity[TV]IviScopeTVTriggerSignalFormat[TV]
IviScopeRuntTriggerPropertiesIviScopeRuntHighThreshold[RT]IviScopeRuntLowThreshold[RT]IviScopeRuntPolarity[RT]
IviScopeGlitchTriggerPropertiesIviScopeGlitchCondition[GT]IviScopeGlitchPolarity[GT]IviScopeGlitchWidth[GT]
IviScopeWidthTriggerPropertiesIviScopeWidthCondition[WT]IviScopeWidthHighThreshold[WT]IviScopeWidthLowThreshold[WT]IviScopeWidthPolarity[WT]
IviScopeAcLineTriggerPropertiesIviScopeACLineTriggerSlope
IviScopeMeasWaveformPropertiesIviScopeMeasurementHighReference[WM]IviScopeMeasurementLowReference[WM]IviScopeMeasurementMidReference[WM]
IviScopeMinMaxWaveformPropertiesIviScopeNumberofEnvelopes[MM]IviScopeProbeSenseValue
IviScopeContinuousAcquisitionIviScopeInitiateContinuous
IviScopeAverageAcquisitionIviScopeNumberofAverages
IviScopeSampleModeIviScopeSampleMode
IviScopeTriggerModifierPropertiesIviScopeTriggerModifier
IviScopePropertyValueDefinitionsThefollowingtabledefinesthevalueforeachpropertyconstantintheIviScopeclassdriver.
IviScopePropertyDefinedValues
Property ValueName DefinedValue Description
VERTICALCOUPLING
AC 0 TheoscilloscopeACcouplestheinputsignal.
DC 1 TheoscilloscopeDCcouplestheinputsignal.
GND 2 Theoscilloscopegroundcouplestheinputsignal.
PROBEATTENUATION
ProbeSenseOn
–1 SettingthispropertytoIVISCOPE_VAL_PROBE_SENSE_ONconfigurestheoscilloscopetosensetheattenuationoftheprobeautomatically.Afteryouenabletheautomaticprobesense,subsequentqueriesofthispropertyreturnthevalueIVISCOPE_VAL_PROBE_SENSE_ONUsetheIviScopeProbeSenseValuepropertytoobtaintheactualprobeattenuation.Ifyousettheoscilloscopetosensetheprobeattenuationautomatically,theprobeattenuationvaluecanchangeatanytime.Whentheoscilloscopedetectsanewprobeattenuationvalue,othersettingsintheoscilloscopemightalsochange.Thedriverhasnowayofknowingwhenthesechangesoccur.Therefore,whenyouenabletheautomaticprobesensecapability,thedriverdisablescachingforpropertiesthatdependontheprobeattenuation.ThesepropertiesincludeIviScopeVerticalRange,IviScopeVerticalOffset,andallthepropertiesthatconfiguretriggerlevels.Tomaximize
performance,youshouldsetthispropertytoamanualprobeattenuationsetting.Iftheoscilloscopeissettosensetheprobeattenuationautomatically,settingthispropertytoapositivevaluedisablestheautomaticprobesenseandconfigurestheoscilloscopetousethemanualprobeattenuationyouspecify.
TRIGGERTYPE Edge 1 Configurestheoscilloscopeforedgetriggering.AnedgetriggeroccurswhenthetriggersignalpassesthroughthevoltagethresholdspecifiedbytheIviScopeTriggerLevelhastheslopespecifiedbytheTriggerSlopeproperty.
Width 2 Configurestheoscilloscopeforwidthtriggering.Awidthtriggeroccurswhentheoscilloscopedetectsapositiveornegativepulsewithawidthbetween,oroptionallyoutside,thewidththresholds.YouspecifythewidththresholdswiththeIviScopeWidthHighThresholdandIviScopeWidthLowThresholdproperties.YouspecifywhethertheoscilloscopetriggersonpulsewidthsthatarewithinoroutsidethewidththresholdswiththeIviScopeWidthConditionproperty.YouspecifythepolarityofthepulsewiththeIviScopeWidthPolarityproperty.Thetriggerdoesnotactuallyoccuruntiltheedgeofapulsethatcorrespondstothewidththresholds,widthcondition,andpolarityyouspecifycrossesthetriggerlevelthatyouspecifywiththeIviScope
TriggerLevelproperty.Runt 3 Configurestheoscilloscopeforrunt
triggering.Arunttriggeroccurswhenthetriggersignalcrossesoneoftheruntthresholdstwicewithoutcrossingtheotherruntthreshold.YouspecifytheruntthresholdswiththeRuntHighThresholdandRuntLowThresholdproperties.YouspecifythepolarityoftheruntwiththeIviScopeRuntPolarity
Glitch 4 4TV 5 Configurestheoscilloscopetotrigger
onTVsignals.TheuserconfiguresthetriggerwiththeIviScopeTVTriggerSignalFormat,IviScopeTVTriggerLineNumber,andIviScopeTVTriggerPolarity,properties.
Immediate 6 Theoscilloscopedoesnotwaitforatriggerofanykind.
ACLine 7 TheoscilloscopewaitsforatriggerontheACline.
TRIGGERSLOPE Positive 1 Apositive(rising)edgepassingthroughthetriggerleveltriggerstheoscilloscope.
Negative 0 Anegative(falling)edgepassingthroughthetriggerleveltriggerstheoscilloscope.
TRIGGERSOURCE
External "VAL_EXTERNAL" Theoscilloscopewaitsforatriggerontheexternaltrigger.
PXITRIG0orVXITTL0
"VAL_TTL0" TheoscilloscopewaitsuntilitreceivesatriggerontheTLL0line.
PXITRIG1orVXITTL1
"VAL_TTL1" TheoscilloscopewaitsuntilitreceivesatriggerontheTLL1line.
PXITRIG2orVXITTL2
"VAL_TTL2" TheoscilloscopewaitsuntilitreceivesatriggerontheTLL2line.
PXITRIG3orVXITTL3
"VAL_TTL3" TheoscilloscopewaitsuntilitreceivesatriggerontheTLL3line.
PXITRIG4orVXITTL4
"VAL_TTL4" TheoscilloscopewaitsuntilitreceivesatriggerontheTLL4line.
PXITRIG5orVXITTL5
"VAL_TTL5" TheoscilloscopewaitsuntilitreceivesatriggerontheTLL5line.
PXITRIG6orVXITTL6
"VAL_TTL6" TheoscilloscopewaitsuntilitreceivesatriggerontheTLL6line.
PXITRIG7orVXITTL7
"VAL_TTL7" TheoscilloscopewaitsuntilitreceivesatriggerontheTLL7line.
ECLO "VAL_ECL0" TheoscilloscopewaitsuntilitreceivesatriggerontheECL0line.
ECL1 "VAL_ECL1" TheoscilloscopewaitsuntilitreceivesatriggerontheECL1line.
PXIStar "VAL_PXI_STAR" TheoscilloscopewaitsuntilitreceivesatriggeronthePXIStarbus.
RTSI0 "VAL_RTSI_0" TheoscilloscopewaitsuntilitreceivesatriggerontheRTSI0line.
RTSI1 "VAL_RTSI_1" TheoscilloscopewaitsuntilitreceivesatriggerontheRTSI1line.
RTSI2 "VAL_RTSI_2" TheoscilloscopewaitsuntilitreceivesatriggerontheRTSI2line.
RTSI3 "VAL_RTSI_3" TheoscilloscopewaitsuntilitreceivesatriggerontheRTSI3line.
RTSI4 "VAL_RTSI_4" TheoscilloscopewaitsuntilitreceivesatriggerontheRTSI4line.
RTSI5 "VAL_RTSI_5" TheoscilloscopewaitsuntilitreceivesatriggerontheRTSI5line.
RTSI6 "VAL_RTSI_6" TheoscilloscopewaitsuntilitreceivesatriggerontheRTSI6line.
TRIGGERCOUPLING
AC 0 TheoscilloscopeACcouplesthetriggersignal.
DC 1 TheoscilloscopeDCcouplesthetriggersignal.
HFReject 3 Theoscilloscoperejectshighfrequenciesfromthetriggersignal.
LFReject 4 Theoscilloscoperejectslowfrequenciesfromthetriggersignal.
NoiseReject 5 Theoscilloscoperejectsnoiseformthetriggersignal.
INTERPOLATION NoInterpolation
1 Theoscilloscopedoesnotinterpolatepointsinthewaveform.Instead,thedriversetseveryelementinthewaveformarrayforwhichtheoscilloscopecannotresolveavaluetoanIEEE-definedNaN(NotaNumber)value.
sin(x)/x 2 Theoscilloscopeusesasine(x)/xcalculationtointerpolateavaluewhenitcannotresolveavoltageinthewaveformrecord.
LinearIntrepolation
3 Theoscilloscopeusesalinearapproximationtointerpolateavaluewhenitcannotresolveavoltageinthewaveformrecord.
TVTRIGGERSIGNALFORMAT
NTSC 1 SetstheTVtriggersignalformattoNTSC.
PAL 2 SetstheTVtriggersignalformattoPAL.
SECAM 3 SetstheTVtriggersignalformatto
SECAM.TVTRIGGEREVENT
Field1 1 Field1ofthevideosignal.
Field2 2 Field2ofthevideosignal.AnyField 3 Anyfieldofthevideosignal.AnyLine 4 Anylineofthevideosignal.LineNumber
5
TVTRIGGERPOLARITY
Positive 1 Positivevideosyncpulse.
Negative 1 Negativevideosyncpulse.RUNTPOLARITY
Positive 1 Theoscilloscopetriggersonapositiverunt.Apositiveruntoccurswhenarisingedgecrossesthelowruntthresholdanddoesnotcrossthehighruntthresholdbeforere-crossingthelowruntthreshold.
Negative 2 Theoscilloscopetriggersonanegativerunt.Anegativeruntoccurswhenafallingedgecrossesthehighruntthresholdanddoesnotcrossthelowruntthresholdbeforere-crossingthehighruntthreshold.
Either 3 Theoscilloscopetriggersoneitherapositiveornegativerunt.
GLITCHPOLARITY
Positive 1 Theoscilloscopetriggersonapositiveglitch.
Negative 2 Theoscilloscopetriggersonanegativeglitch.
Either 3 Theoscilloscopetriggersoneitherapositiveornegativeglitch.
GLITCHCONDITION
LessThan 1 Theoscilloscopetriggersonaless-thanglitch.
Greater 2 Theoscilloscopetriggersonagreater-
Than thanglitch.WIDTHPOLARITY
Positive 1 ConfigurestheoscilloscopetotriggeronpositivepulsesthathaveawidththatmeetstheconditionyouspecifywiththeIviScopeWidthConditionproperty.
Negative 2 ConfigurestheoscilloscopetotriggeronnegativepulsesthathaveawidththatmeetstheconditionyouspecifywiththeIviScopeWidthConditionproperty.
WIDTHCONDITION
Within 1 Configurestheoscilloscopetotriggeronpulsesthathaveawidththatislessthanthehighthresholdandgreaterthanthelowthreshold.YouspecifythehighandlowthresholdswiththeIviScopeWidthHighThresholdandIviScopeWidthLowThresholdproperties.
Outside 2 Configurestheoscilloscopetotriggeronpulsesthathaveawidththatiseithergreaterthanthehighthresholdorlessthanalowthreshold.YouspecifythehighandlowthresholdswiththeIviScopeWidthHighThresholdandIviScopeWidthLowThresholdproperties.
ACLINETRIGGERSLOPE
Positive 1 Configurestheoscilloscopeonpositiveslopezerocrossingsofthenetworksupplyvoltage.
Negative 2 Configurestheoscilloscopetotriggeronnegativeslopezerocrossingsofthenetworksupplyvoltage.
Either 3 Configurestheoscilloscopetotriggeroneitherpositiveornegativeslopezerocrossingsofthenetworksupplyvoltage.
ACQUISITIONTYPE
Normal 0 Configurestheoscilloscopetoacquireonesampleforeachpointinthewaveformrecord.Theoscilloscopeusesreal-timeorequivalenttimesampling.
PeakDetect 1 Setstheoscilloscopetothepeak-detectacquisitionmode.Theoscilloscopeoversamplestheinputsignalandkeepstheminimumandmaximumvaluesthatcorrespondtoeachpositioninthewaveformrecord.Theoscilloscopeusesonlyreal-timesampling.
HighResolution
2 ConfigurestheoscilloscopetooversampletheinputsignalTheoscilloscopecalculatestheaveragevaluethatcorrespondstoeachpositioninthewaveformrecord.Theoscilloscopeusesonlyreal-timesampling.
Envelope 3 Setstheoscilloscopetotheenvelopeacquisitionmode.Theoscilloscopeacquiresmultiplewaveformsandkeepstheminimumandmaximumvoltagesitacquiresforeachpointinthewaveformrecord.YouspecifythenumberofwaveformstheoscilloscopeacquireswiththeIviScopeNumberofEnvelopesproperty.Theoscilloscopecanusereal-timeorequivalent-timesampling.
Average 4 Configurestheoscilloscopetoacquiremultiplewaveformsandcalculatetheaveragevalueforeachpointinthewaveformrecord.YouspecifythenumberofwaveformstoacquirewiththeIviScopeNumberofAverages
property.Theoscilloscopeusesreal-timeorequivalenttimesampling.
TRIGGERMODIFIER
NoTriggerModifier
1 Theoscilloscopewaitsuntilthetriggeryouspecifyoccurs.
Auto 2 Theoscilloscopeautomaticallytriggersiftheconfiguredtriggerdoesnotoccurwithintheoscilloscope'stimeoutperiod.
AutoLevel 3 Theoscilloscopeadjuststhetriggerlevelifthetriggeryouspecifydoesnotoccur.
SAMPLEMODE RealTime 0 Indicatesthattheoscilloscopeisusingreal-timesampling.
EquivalentTime
1 Indicatesthattheoscilloscopeisusingequivalenttimesampling.
RelatedTopicsIviScopeVITreeIviScopeProperties
IviScopeErrorandWarningCodesStatusCodeRangesStatusCodeType NumericRange(inHex)IviScopeErrors 0xBFFA2001to0xBFFA2003IviScopeWarnings 0x3FFA2001to0xBFFA2004IVISpecificDriverErrors 0xBFFA4000to0xBFFA5FFFIVISpecificDriverWarnings 0x3FFA4000to0x3FFA5FFFIVIErrors BFFA0000toBFFA1FFFIVIWarnings 3FFA0000to3FFA1FFFCommonInstrumentDriverErrors BFFC0000toBFFCFFFFCommonInstrumentDriverWarnings 3FFC0000to3FFCFFFFVISAErrors BFFF0000toBFFFFFFFVISAWarnings 3FFF0000to3FFFFFFF
TheIviScopeclassdriverdefinesthefollowingerrorcodesinadditiontotheIVIdefinederrorcodes.
IviScopeErrorCodesError ValueIVISCOPE_ERROR_CHANNEL_NOT_ENABLED 0xBFFA2001
IVISCOPE_ERROR_UNABLE_TO_PERFORM_MEASUREMENT 0xBFFA2002
IVISCOPE_ERROR_MAX_TIME_EXCEEDED 0xBFFA2003
IVISCOPE_ERROR_INVALID_ACQ_TYPE 0xBFFA2004
IviScopeWarningCodeWarning Value MessageIVISCOPE_WARN_INVALID_WFM_ELEMENT 0x3FFA2001 Oneofthe
elementsinthewaveformarrayisinvalid.
RelatedTopicIVIStatusCodes
IviScopeVIsExpandthisbooktoviewanalphabetizedlistofIviScopeVIs.
IviScopeAbortIviScopeBaseCapabilityGroupThisVIabortsanacquisitionandreturnstheoscilloscopetotheIdlestate.YouinitiateanacquisitionwiththeIviScopeInitiateAcquisitionVI.
Notes
1. ThisVIdoesnotchecktheinstrumentstatus.Typically,youcallthisVIonlyinasequenceofcallstootherlow-leveldriverVIs.Thesequenceperformsoneoperation.Youusethelow-levelVIstooptimizeoneorinteractionwiththeinstrument.Ifyouwanttochecktheinstrumentstatus,calltheIviScopeError-QueryVIattheconclusionofthesequence.
2. Iftheinstrumentcannotabortaninitiatedacquisition,thisVIreturnstheIVI_ERROR_FUNCTION_NOT_SUPPORTEDerror.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.
Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviScopeAcquisitionStatusIviScopeBaseCapabilityGroupThisVIreturnswhetheranacquisitionisinprogress,complete,orifthestatusisunknown.
Notes
1. ThisVIdoesnotchecktheinstrumentstatus.Typically,youcallthisVIonlyinasequenceofcallstootherlow-leveldriverVIs.Thesequenceperformsoneoperation.Youusethelow-levelVIstooptimizeoneormoreaspectsofinteractionwiththeinstrument.Ifyouwanttochecktheinstrumentstatus,calltheIviScopeError-QueryVIattheconclusionofthesequence.
2. Iftheinstrumentcannotreturnitsacquisitionstatus,thisVIreturnstheIVISCOPE_VAL_ACQ_STATUS_UNKNOWNvalueintheAcquisitionStatusparameter.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.acquisitionstatusReturnstheacquisitionstatusoftheoscilloscope.Possiblevaluesthatthisparameterreturnsare:
IVISCOPE_VAL_ACQ_IN_PROGRESS(0)—Theoscilloscopeiscurrentlyacquiringawaveform.IVISCOPE_VAL_ACQ_COMPLETE(1)—Theacquisitioniscomplete.IVISCOPE_VAL_ACQ_STATE_UNKNOWN(-1)—Thedrivercannotdeterminethestatusoftheacquisition.
erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviScopeActualRecordLengthIviScopeBaseCapabilityGroupThisVIreturnstheactualnumberofpointstheoscilloscopeacquiresforeachchannel.Afteryouconfiguretheoscilloscopeforanacquisition,callthisVItodeterminethesizeofthewaveformsthattheoscilloscopeacquires.ThevalueisgreaterthanorequaltotheminimumnumberofpointsyouspecifyintheIviScopeConfigureAcquisitionRecordVI.YoumustallocateaViReal64arrayofthissizeorgreatertopassastheWaveformArrayparameteroftheIviScopeReadWaveformandIviScopeFetchWaveformVIs.
NoteTheoscilloscopemayuserecordsofdifferentsizedependingontheacquisitiontype.YouspecifytheacquisitiontypewiththeIviScopeConfigureAcquisitionTypeVI.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.actualrecordlengthReturnstheactualnumberofpointstheoscilloscopeacquiresforeachchannel.ThedriverreturnsthevalueoftheIviScopeHorizontalRecordLengthproperty.erroroutTheerroroutclusterpasseserrororwarninginformation
outofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviScopeActualSampleModeIviScopeSampleModeCapabilityGroupThisVIreturnsthesamplemodetheoscilloscopeiscurrentlyusing.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.samplemodeReturnsthesamplemodetheoscilloscopeiscurrentlyusing.ThedriverreturnsthevalueoftheIviScopeSampleMode[SM]property.DefinedValues:IVISCOPE_VAL_REAL_TIME(0)—Indicatesthattheoscilloscopeisusingreal-timesampling.IVISCOPE_VAL_EQUIVALENT_TIME(1)—Indicatesthattheoscilloscopeisusingequivalent-timesampling.
erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviScopeActualSampleRateIviScopeBaseCapabilityGroupThisVIreturnstheeffectivesamplerateoftheacquiredwaveformusingthecurrentconfigurationinsamplespersecond.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.samplerateReturnstheeffectivesamplerateoftheacquiredwaveformtheoscilloscopeacquiresforeachchannel.ThedriverreturnsthevalueoftheIviScopeHorizontalSampleRateproperty.Units:samplespersecond
erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviScopeAutoProbeSenseValueIviScopeProbeAutoSenseCapabilityGroupTheVIreturnstheprobeattenuationvaluetheoscilloscopesenses.YouenabletheautomaticprobesensecapabilitybysettingtheProbeAttenuationparameteroftheIviScopeConfigureVerticalVItoIVISCOPE_VAL_PROBE_SENSE_ON.
NoteIfyoudisabletheautomaticprobesensecapability,thisVIreturnsthemanualprobeattenuationsetting.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.channelname("CHANNEL1")PassthevirtualchannelnamethatyouassigntotheinstrumentinMAXforwhichyouwanttoquerytheprobesensevalue.Virtualchannelnamesarealiasesforinstrumentspecificchannelstrings.Theinstrumentspecificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.YouassignavirtualchannelnametoaninstrumentspecificchannelthroughMAX.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrumentspecificchannelnames.DefaultValue:"CHANNEL1"
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmore
informationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.autoprobesensevalueReturnstheprobeattenuationvaluetheoscilloscopesenses.ThedriverreturnsthevalueoftheIviScopeProbeSenseValueproperty.NoteIfyoudisabletheautomaticprobesensecapability,thisparameterreturnsthemanualprobeattenuationsetting.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviScopeAutoSetupIviScopeAutoSetupCapabilityGroup[AS]ThisVIautomaticallyconfigurestheinstrument.
NoteWhenyoucallthisVI,theoscilloscopesensestheinputsignalandautomaticallyconfiguresmanyoftheinstrumentsettings.Thesettingsnolongermatchthecachevaluesforthecorrespondingproperties.Therefore,thisVIinvalidatesallpropertycachevalues.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviScopeConfigureACLineTriggerSlopeIviScopeAcLineTriggerCapabilityGroup[AT]ThisVIconfigurestheslopeoftheACLinetrigger.
NoteThisVIaffectsinstrumentbehavioronlyifthetriggertypeisIVISCOPE_VAL_AC_LINE_TRIGGER.CalltheIviScopeConfigureTriggerVItosetthetriggertypebeforecallingthisVI.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.triggerslopeSpecifywhetheryouwanttheoscilloscopetotriggeronazerocrossingwithapositive,negative,oreitherslopeofthenetworksupplyvoltage.ThedriverusesthisvaluetosettheIviScopeACLineTriggerSlope[AT]property.DefinedValues:IVISCOPE_VAL_AC_LINE_POSITIVE—PositivecrossingIVISCOPE_VAL_AC_LINE_NEGATIVE—NegativecrossingIVISCOPE_VAL_AC_LINE_EITHER—EithercrossingDefaultvalue:IVISCOPE_VAL_AC_LINE_POSITIVE
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptions
VI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviScopeConfigureAcquisitionRecordIviScopeBaseCapabilityGroupThisVIconfiguresthemostcommonlyconfiguredpropertiesoftheoscilloscopeacquisitionsubsystem.Thesepropertiesarethetimeperrecord,minimumrecordlength,andtheacquisitionstarttime.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.timeperrecord(seconds)Passthetimeperrecord.ThedriverusesthisvaluetosettheIviScopeHorizontalTimePerRecordproperty.Units:seconds
minimumrecordlengthPasstheminimumnumberofpointsyouallowforinthewaveformrecorded.ThedriverusesthisvaluetosettheIviScopeHorizontalMinimumNumberofPointsproperty.CalltheIviScopeActualRecordLengthVItoobtaintheactualrecordlength.NoteTheoscilloscopemayuserecordsofdifferentsizedependingontheacquisitiontype.YouspecifytheacquisitiontypewiththeIviScopeConfigureAcquisitionTypeVI.starttime(seconds)Passthepositionofthefirstpointinthewaveformrecordrelativetothetriggerevent.ThedriverusesthisvaluetosettheIviScopeAcquisitionStartTimeproperty.Specifythelengthoftimefromthetriggereventtothefirstpointinthewaveformrecord.Ifthisvalueispositive,thefirstpointinthewaveformrecordoccursafterthetriggerevent.Ifthisvalueisnegative,thefirstpointinthewaveformrecordoccursbeforethe
triggerevent.Units:secondsDefault:0.0
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviScopeConfigureAcquisitionTypeIviScopeBaseCapabilityGroupThisVIconfigureshowtheoscilloscopeacquiresdataandhowitfillsthewaveformrecord.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.acquisitiontypeSpecifythemannerinwhichyouwanttheoscilloscopetoacquiredataandfillthewaveformrecord.ThedriversetstheIviScopeAcquisitionTypepropertytothisvalue.DefinedValues:IVISCOPE_VAL_NORMAL—Setstheoscilloscopetothenormalacquisitionmode.Theoscilloscopeacquiresonesampleforeachpointinthewaveformrecord.Theoscilloscopecanusereal-timeorequivalent-timesampling.IVISCOPE_VAL_PEAK_DETECT—Setstheoscilloscopetothepeak-detectacquisitionmode.Theoscilloscopeoversamplestheinputsignalandkeepstheminimumandmaximumvaluesthatcorrespondtoeachpositioninthewaveformrecord.Theoscilloscopeusesonlyreal-timesampling.IVISCOPE_VAL_HI_RES—Setstheoscilloscopetothehigh-resolutionacquisitionmode.Theoscilloscopeoversamplestheinputsignalandcalculatesanaveragevalueforeachpositioninthewaveformrecord.Theoscilloscopeusesonlyreal-timesampling.IVISCOPE_VAL_ENVELOPE—Setstheoscilloscopetotheenvelopeacquisitionmode.Theoscilloscopeacquiresmultiplewaveformsandkeepstheminimumandmaximumvoltagesitacquiresforeachpointinthewaveformrecord.Youspecifythe
numberofwaveformstheoscilloscopeacquireswiththeIviScopeConfigureNumberofEnvelopes[MmW]VI.Theoscilloscopecanusereal-timeorequivalent-timesampling.IVISCOPE_VAL_AVERAGE—Setstheoscilloscopetotheaverageacquisitionmode.Theoscilloscopeacquiresmultiplewaveformsandcalculatesanaveragevalueforeachpointinthewaveformrecord.YouspecifythenumberofwaveformstheoscilloscopeacquireswiththeIviScopeConfigureNumberofAverages[AA]VI.Theoscilloscopecanusereal-timeorequivalent-timesampling.Defaultvalue:IVISCOPE_VAL_NORMAL
NoteWhenyousetthisparametertoIVISCOPE_VAL_ENVELOPEorIVISCOPE_VAL_PEAK_DETECT,theoscilloscopeacquiresminimumandmaximumwaveforms.Toretrievetheminimumandmaximumwaveforms,usetheIviScopeReadMinMaxWaveform[MmW]andIviScopeFetchMinMaxWaveform[MmW]VIs.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviScopeConfigureChannelIviScopeBaseCapabilityGroupThisVIconfiguresthemostcommonlyconfiguredpropertiesoftheoscilloscopechannelsub-system.Thesepropertiesaretherange,offset,coupling,probeattenuation,andwhetherthechannelisenabled.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.channelnamePassthevirtualchannelnamethatyouassigntotheinstrumentinMAX.Virtualchannelnamesarealiasesforinstrumentspecificchannelstrings.Theinstrumentspecificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.YouassignavirtualchannelnametoaninstrumentspecificchannelthroughMAX.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrumentspecificchannelnames.DefaultValue:"CHANNEL1"
verticalrangePassthevalueoftheinputrangetheoscilloscopeusesforthechannel.ThedriversetstheIviScopeVerticalRangepropertytothisvalue.Forexample,toacquireasinewavethatspansbetween–5.0and5.0V,pass10.0asthevalueofthisparameter.Units:volts
verticaloffsetPassthelocationofthecenteroftherangethatyou
specifywiththeVerticalRangeparameter.Expressthevaluewithrespecttoground.ThedriversetstheIviScopeVerticalOffsettothisvalue.Forexample,toacquireasinewavethatspansbetween0.0and10.0V,pass5.0asthevalueofthisparameter.Units:voltsDefaultvalue:0.0
verticalcouplingSpecifyhowyouwanttheoscilloscopetocoupletheinputsignalforthechannel.ThedriversetstheIviScopeVerticalCouplingpropertytothisvalue.DefinedValues:IVISCOPE_VAL_AC—ACCouplingIVISCOPE_VAL_DC—DCCouplingIVISCOPE_VAL_GND—GroundCouplingDefaultvalue:IVISCOPE_VAL_DC
probeattenuationPassthescalingfactorbywhichtheprobeyouattachtothechannelattenuatestheinput.Forexample,whenyouusea10:1probe,setthisparameterto10.0.ThedriversetstheIviScopeProbeAttenuationpropertytothisvalue.Thisdriverreservesnegativevaluestocontroltheoscilloscope'sautomaticprobesensecapability.SettingthisparametertoIVISCOPE_VAL_PROBE_SENSE_ONconfigurestheoscilloscopetosensetheattenuationoftheprobeautomatically.DefinedValues:IVISCOPE_VAL_PROBE_SENSE_ONE—enablestheoscilloscope'sautomaticprobesensecapability.DefaultValue:1.0
Notes
1. Iftheoscilloscopeissettosensetheprobeattenuationautomatically,settingthisparametertoapositivevaluedisablestheautomaticprobesenseandconfigurestheoscilloscopetousethemanualprobeattenuationyouspecify.
2. Ifyouuseamanualprobeattenuation,youmustsettheprobeattenuationtoreflectthenewprobeattenuationeachtimeyouattachadifferentprobe.
3. UsetheIviScopeAutoProbeSenseValue[PAS]VItoobtaintheactualprobeattenuationwhiletheautomaticprobesensecapabilityisenabled.
4. Ifyousettheoscilloscopetosensetheprobeattenuationautomatically,theprobeattenuationvaluecanchangeatanytime.Whentheoscilloscopedetectsanewprobeattenuationvalue,othersettingsintheoscilloscopemightalsochange.Thedriverhasnowayofknowingwhenthesechangesoccur.Therefore,whenyouenabletheautomaticprobesensecapability,thisdriverdisablescachingforpropertiesthatdependontheprobeattenuation.ThesepropertiesincludeIviScopeVerticalRange,IviScopeVerticalOffset,andallthepropertiesthatconfiguretriggerlevels.Tomaximizeperformance,setthisparametertoamanualprobeattenuationsetting.
channelenabledSpecifywhetheryouwanttheoscilloscopetoacquireawaveformforthechannelwhenyoucalltheIviScopeInitiateAcquisition,IviScopeReadWaveform,IviScopeReadMinMaxWaveform[MmW],orIviScopeReadWaveformMeasurement[WM]VI.ThedriversetstheIviScopeChannelEnabledpropertytothisvalue.DefaultValue:TRUE
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.
Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviScopeConfigureChannelCharacteristicsIviScopeBaseCapabilityGroupThisVIconfiguresthepropertiesthatcontroltheelectricalcharacteristicsofthechannel.Thesepropertiesaretheinputimpedanceandthemaximumfrequencyoftheinputsignal.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.channelnamePassthevirtualchannelnamethatyouassigntotheinstrumentinMAX.Virtualchannelnamesarealiasesforinstrumentspecificchannelstrings.Theinstrumentspecificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.YouassignavirtualchannelnametoaninstrumentspecificchannelthroughMAX.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrumentspecificchannelnames.DefaultValue:"CHANNEL1"
inputimpedance(ohms)Passtheinputimpedanceyouwanttouseforthechannel.ThedriversetstheIviScopeInputImpedancetothisvalue.Units:ohmsDefaultValue:1000000.0
maxinputfrequency(hertz)Passthemaximumfrequencyfortheinputsignalyouwanttheinstrumenttoaccommodatewithout
attenuatingitbymorethan3dB.ThedriversetstheIviScopeMaximumInputFrequencytothisvalue.Units:hertz(Hz)
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviScopeConfigureEdgeTriggerSourceIviScopeBaseCapabilityGroupThisVIconfigurestheedgetrigger.AnedgetriggeroccurswhenthetriggersignalpassesthroughthevoltagethresholdthatyouspecifywiththeTriggerLevelparameterandhastheslopethatyouspecifywiththeTriggerSlopeparameter.
Notes
1. ThisVIaffectsinstrumentbehavioronlyifthetriggertypeisIVISCOPE_VAL_EDGE_TRIGGER.CalltheIviScopeConfigureTriggerandIviScopeConfigureTriggerCouplingVIstosetthetriggertypeandtriggercouplingbeforecallingthisVI.
2. Ifthetriggersourceisoneoftheanaloginputchannels,youmustconfiguretheverticalrange,verticaloffset,verticalcoupling,probeattenuation,andthemaximuminputfrequencybeforecallingthisVI.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.triggersourcePassthesourceyouwanttheoscilloscopetomonitorforatrigger.ThedriversetstheIviScopeTriggerSourcepropertytothisvalue.AfteryoucalloneoftheIviScopeReadWaveform,IviScopeReadMinMaxWaveform[MmW],IviScopeReadWaveformMeasurement[WM],orIviScopeInitiateAcquisitionVIs,theoscilloscopewaitsforthetriggerfromthesourceyouspecifyinthisparameter.
Thiscontrolacceptsoneofthevalidchannelnamesoradditionaltriggersourceslistedbelow.Virtualchannelnamesarealiasesforinstrumentspecificchannelstrings.Theinstrumentspecificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.YouassignavirtualchannelnametoaninstrumentspecificchannelthroughMAX.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrumentspecificchannelnames.
AdditionalTriggerSources
IVISCOPE_VAL_EXTERNALExternalIVISCOPE_VAL_TTL0—PXITRIG0orVXITTL0IVISCOPE_VAL_TTL1—PXITRIG1orVXITTL1IVISCOPE_VAL_TTL2—PXITRIG2orVXITTL2IVISCOPE_VAL_TTL3—PXITRIG3orVXITTL3IVISCOPE_VAL_TTL4—PXITRIG4orVXITTL4IVISCOPE_VAL_TTL5—PXITRIG5orVXITTL5IVISCOPE_VAL_TTL6—PXITRIG6orVXITTL6IVISCOPE_VAL_TTL7—PXITRIG7orVXITTL7IVISCOPE_VAL_ECL0—VXIECL0IVISCOPE_VAL_ECL1—VXIECL1IVISCOPE_VAL_PXI_STAR—PXIStarIVISCOPE_VAL_RTSI_0—RTSIline0IVISCOPE_VAL_RTSI_1—RTSIline1IVISCOPE_VAL_RTSI_2—RTSIline2IVISCOPE_VAL_RTSI_3—RTSIline3IVISCOPE_VAL_RTSI_4—RTSIline4IVISCOPE_VAL_RTSI_5—RTSIline5
IVISCOPE_VAL_RTSI_6—RTSIline6
NoteIVISCOPE_VAL_EXTERNAL—Theoscilloscopewaitsforatriggerontheexternaltriggerinput.triggerlevel(volts)Passthevoltagethresholdyouwanttheoscilloscopetouseforedgetriggering.ThedriversetstheIviScopeTriggerLevelpropertytothisvalue.TheoscilloscopetriggerswhenthetriggersignalpassesthroughthethresholdyouspecifywiththisparameterandhastheslopeyouspecifywiththeTriggerSlopeparameter.Units:voltsDefaultvalue:0.0
NoteThisparameteraffectsinstrumentbehavioronlywhenyouselectachannelortheexternaltriggerinputastheTriggerSource.Youcannotconfigurethetriggerlevelthattheoscilloscopeusesforothertriggersources.Forexample,ifyouselectIVISCOPE_VAL_AC_LINE_TRIGGERasthetriggersource,theoscilloscopetriggersonzerocrossings.triggerslopeSpecifywhetheryouwantarisingedgeorafallingedgepassingthroughtheTriggerLeveltotriggertheoscilloscope.ThedriversetstheIviScopeTriggerSlopepropertytothisvalue.DefinedValues:IVISCOPE_VAL_POSITIVERisingedgeIVISCOPE_VAL_NEGATIVEFallingedgeDefaultvalue:IVISCOPE_VAL_POSITIVE
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.
erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviScopeConfigureGlitchTriggerSourceIviScopeGlitchTriggerCapabilityGroup[GT]ThisVIconfigurestheglitchtrigger.Aglitchtriggeroccurswhenthetriggersignalhasapulsewithawidththatislessthantheglitchwidth.YouspecifytheglitchwidthintheGlitchWidthparameter.YouspecifythepolarityofthepulsewiththeGlitchPolarityparameter.ThetriggerdoesnotactuallyoccuruntiltheedgeofapulsethatcorrespondstotheGlitchWidthandGlitchPolaritycrossesthethresholdyouspecifyintheTriggerLevelparameter.
NoteThisVIaffectsinstrumentbehavioronlyifthetriggertypeisIVISCOPE_VAL_GLITCH_TRIGGER.CalltheIviScopeConfigureTriggerandIviScopeConfigureTriggerCouplingVIstosetthetriggertypeandtriggercouplingbeforecallingthisVI.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.triggersourcePassthesourceyouwanttheoscilloscopetomonitorforatrigger.ThedriversetstheIviScopeTriggerSourcepropertytothisvalue.AfteryoucalloneoftheIviScopeReadWaveform,IviScopeReadMinMaxWaveform[MmW],IviScopeReadWaveformMeasurement[WM],orIviScopeInitiateAcquisitionVIs,theoscilloscopewaitsforthetriggerfromthesourceyouspecifyinthisparameter.Thiscontrolacceptsoneofthevalidchannelnamesoradditionaltriggersourceslistedbelow.
Virtualchannelnamesarealiasesforinstrumentspecificchannelstrings.Theinstrumentspecificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.YouassignavirtualchannelnametoaninstrumentspecificchannelthroughMAX.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrumentspecificchannelnames.
AdditionalTriggerSources
IVISCOPE_VAL_EXTERNAL—ExternalIVISCOPE_VAL_TTL0—PXITRIG0orVXITTL0IVISCOPE_VAL_TTL1—PXITRIG1orVXITTL1IVISCOPE_VAL_TTL2—PXITRIG2orVXITTL2IVISCOPE_VAL_TTL3—PXITRIG3orVXITTL3IVISCOPE_VAL_TTL4—PXITRIG4orVXITTL4IVISCOPE_VAL_TTL5—PXITRIG5orVXITTL5IVISCOPE_VAL_TTL6—PXITRIG6orVXITTL6IVISCOPE_VAL_TTL7—PXITRIG7orVXITTL7IVISCOPE_VAL_ECL0—VXIECL0IVISCOPE_VAL_ECL1—VXIECL1IVISCOPE_VAL_PXI_STAR—PXIStarIVISCOPE_VAL_RTSI_0—RTSIline0IVISCOPE_VAL_RTSI_1—RTSIline1IVISCOPE_VAL_RTSI_2—RTSIline2IVISCOPE_VAL_RTSI_3—RTSIline3IVISCOPE_VAL_RTSI_4—RTSIline4IVISCOPE_VAL_RTSI_5—RTSIline5IVISCOPE_VAL_RTSI_6—RTSIline6
NoteIVISCOPE_VAL_EXTERNAL—Theoscilloscopewaitsfora
triggerontheexternaltriggerinput.triggerlevel(volts)Passthevoltagethresholdyouwanttheoscilloscopetouseforglitchtriggering.ThedriversetstheIviScopeTriggerLevelpropertytothisvalue.Theoscilloscopetriggerswhenaglitchcrossesthetriggerthresholdyouspecifywiththisparameter.Units:voltsDefaultvalue:0.0
NoteThisparameteronlyaffectsinstrumentbehaviorwhenyouselectachannelortheexternaltriggerinputastheTriggerSource.Youcannotconfigurethetriggerlevelthattheoscilloscopeusesforothertriggersources.glitchwidth(seconds)Passthelengthoftimeyouwanttheoscilloscopetousefortheglitchwidth.ThedriversetstheIviScopeGlitchWidth[GT]propertytothisvalue.Theoscilloscopetriggerswhenitdetectsapulsewithawidthlessthanorgreaterthanthisvalue,dependingontheGlitchConditionparameter.Units:secondsDefaultvalue:0.000010
glitchpolarityPassthepolarityoftheglitchthatyouwanttotriggertheoscilloscope.ThedriversetstheIviScopeGlitchPolarity[GT]propertytothisvalue.DefinedValues:IVISCOPE_VAL_GLITCH_POSITIVE—Theoscilloscopetriggersonapositiveglitch.IVISCOPE_VAL_GLITCH_NEGATIVE—Theoscilloscopetriggersonanegativeglitch.IVISCOPE_VAL_GLITCH_EITHER—Theoscilloscopetriggersoneitherapositiveornegativeglitch.DefaultValue:IVISCOPE_VAL_GLITCH_POSITIVE
glitchconditionPasstheglitchcondition.ThedriverusesthisvaluetosettheIviScopeGlitchCondition[GT]property.
Theoscilloscopetriggerswhenitdetectsapulsewithawidthlessthanorgreaterthanthisvalue,dependingonthisparameter.DefinedValues:IVISCOPE_VAL_GLITCH_LESS_THAN—TheoscilloscopetriggerswhenthepulsewidthislessthantheGlitchWidth.IVISCOPE_VAL_GLITCH_GREATER_THAN—TheoscilloscopetriggerswhenthepulsewidthisgreaterthantheGlitchWidth.DefaultValue:IVISCOPE_VAL_GLITCH_LESS_THAN
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviScopeConfigureInitiateContinuousIviScopeContinuousAcquisitionCapabilityGroup[CA]ThisVIconfigurestheoscilloscopetoperformcontinuousacquisition.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.continuousacquisitionSpecifieswhetheryouwanttoenablecontinuousacquisitionontheoscilloscope.ThedriverusesthisvaluetosettheIviScopeInitiateContinuous[CA]property.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviScopeConfigureInterpolationIviScopeInterpolationCapabilityGroup[I]ThisVIconfigurestheinterpolationmethodtheoscilloscopeuseswhenitcannotsampleavoltageforapointinthewaveformrecord.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptions[I]VI.interpolationPasstheinterpolationmethodyouwanttheoscilloscopetousewhenitcannotsampleavoltageforapointinthewaveformrecord.ThedriversetstheIviScopeInterpolationpropertytothisvalue.DefinedValues:IVISCOPE_VAL_NO_INTERPOLATIONNointerpolationIVISCOPE_VAL_SINE_Xsin(x)/xinterpolationIVISCOPE_VAL_LINEARLinearinterpolationDefaultvalue:IVISCOPE_VAL_SINE_X
NoteIVISCOPE_VAL_NO_INTERPOLATIONTheoscilloscopedoesnotinterpolateanypointsinthewaveform.Instead,thedriversetseveryelementinthewaveformarrayforwhichtheoscilloscopecannotsampleavaluetoanIEEE-definedNaN(NotaNumber)value.
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviScopeConfigureNumberofAveragesIviScopeAverageAcquisitionCapabilityGroup[AA]WhenyousettheacquisitiontypetoIVISCOPE_VAL_AVERAGE,theoscilloscopeacquiresmultiplewaveforms.Aftereachwaveformacquisition,theoscilloscopekeepstheaveragevalueofallacquisitionsforeachelementinthewaveformrecord.ThisVIconfiguresthenumberofwaveformsthattheoscilloscopeacquiresandaverages.Aftertheoscilloscopeacquiresasmanywaveformsasyouspecify,itreturnstotheIdlestate.
NoteSettheacquisitiontypetoIVISCOPE_VAL_AVERAGEbeforeyoucallthisVI.Tosettheacquisitiontype,calltheIviScopeConfigureAcquisitionTypeVI.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.numberofaveragesWhenyousettheacquisitiontypetoIVISCOPE_VAL_AVERAGE,theoscilloscopeacquiresmultiplewaveforms.Aftereachwaveformacquisition,theoscilloscopekeepstheaveragevalueofallacquisitionsforeachelementinthewaveformrecord.Thisparameterspecifiesthenumberofwaveformstheoscilloscopeacquiresandaverages.ThedriversetstheIviScopeNumberofAverages[AA]propertytothisvalue.Defaultvalue:8
NoteThisparameteraffectsinstrumentbehavioronlywhentheacquisitiontypeissettoIVISCOPE_VAL_AVERAGE.errorin(noerror)Theerrorinclustercanaccepterrorinformation
wiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviScopeConfigureNumberofEnvelopesIviScopeMinMaxWaveformCapabilityGroup[MmW]WhenyousettheacquisitiontypetoIVISCOPE_VAL_ENVELOPE,theoscilloscopeacquiresmultiplewaveforms.Aftereachwaveformacquisition,theoscilloscopekeepstheminimumandmaximumvaluesitfindsforeachelementinthewaveformrecord.ThisVIconfiguresthenumberofwaveformstheoscilloscopeacquiresandanalyzestocreatetheminimumandmaximumwaveforms.Aftertheoscilloscopeacquiresasmanywaveformsasyouspecify,itreturnstotheIdlestate.
NoteSettheacquisitiontypetoIVISCOPE_VAL_ENVELOPEbeforeyoucallthisVI.Tosettheacquisitiontype,calltheIviScopeConfigureAcquisitionTypeVI.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.numberofenvelopesWhenyousettheacquisitiontypetoIVISCOPE_VAL_ENVELOPE,theoscilloscopeacquiresmultiplewaveforms.Aftereachwaveformacquisition,theoscilloscopekeepstheminimumandmaximumvaluesitfindsforeachpointinthewaveformrecord.Thisparameterspecifiesthenumberofwaveformstheoscilloscopeacquiresandanalyzestocreatetheminimumandmaximumwaveforms.ThedriversetstheIviScopeNumberofEnvelopes[MmW]propertytothisvalue.Defaultvalue:8
NoteThisparameteraffectsinstrumentbehavioronlywhentheacquisitiontypeissettoIVISCOPE_VAL_ENVELOPE.
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviScopeConfigureReferenceLevelsIviScopeWaveformMeasCapabilityGroup[WM]ThisVIconfiguresthereferencelevelsforwaveformmeasurements.YoumustcallthisVIbeforeyoucalltheIviScopeReadWaveformMeasurementVItotakemeasurements.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.lowref(percentage)Passthelowreferenceyouwanttheoscilloscopetouseforwaveformmeasurements.ThedriversetstheIviScopeMeasurementLowReference[WM]propertytothisvalue.Units:ApercentageofthedifferencebetweentheVoltageHighandVoltageLow.
NoteTheoscilloscopecalculatestheVoltageHighandtheVoltageLowusingeitherthemin/maxorhistogrammethods.Themin/maxmethodusesthemaximumandminimumvaluesfound.Thehistogrammethodusesthemostcommonvaluesfoundaboveandbelowthemiddleofthewaveform.midref(percentage)Passthemidreferenceyouwanttheoscilloscopetouseforwaveformmeasurements.ThedriversetstheIviScopeMeasurementMidReference[WM]propertytothisvalue.Units:ApercentageofthedifferencebetweentheVoltageHighandVoltageLow.
NoteTheoscilloscopecalculatestheVoltageHighandtheVoltageLowusingeitherthemin/maxorhistogrammethods.Themin/maxmethodusesthemaximumandminimumvaluesfound.Thehistogrammethodusesthemostcommonvaluesfoundaboveandbelowthemiddleofthewaveform.highref(percentage)Passthehighreferenceyouwanttheoscilloscopetouseforwaveformmeasurements.ThedriversetstheIviScopeMeasurementHighReference[WM]propertytothisvalue.Units:ApercentageofthedifferencebetweentheVoltageHighandVoltageLow.
NoteTheoscilloscopecalculatestheVoltageHighandtheVoltageLowusingeitherthemin/maxorhistogrammethods.Themin/maxmethodusesthemaximumandminimumvaluesfound.Thehistogrammethodusesthemostcommonvaluesfoundaboveandbelowthemiddleofthewaveform.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviScopeConfigureRuntTriggerSourceIviScopeRuntTriggerCapabilityGroup[RT]ThisVIconfigurestherunttrigger.Arunttriggeroccurswhenthetriggersignalcrossesoneoftheruntthresholdstwicewithoutcrossingtheotherruntthreshold.YouspecifytheruntthresholdswiththeRuntLowThresholdandRuntHighThresholdparameters.YouspecifythepolarityoftheruntwiththeRuntPolarityparameter.
NoteThisVIaffectsinstrumentbehavioronlyifthetriggertypeisIVISCOPE_VAL_RUNT_TRIGGER.CalltheIviScopeConfigureTriggerandIviScopeConfigureTriggerCouplingVIstosetthetriggertypeandtriggercouplingbeforecallingthisVI.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.triggersourcePassthesourceyouwanttheoscilloscopetomonitorforatrigger.ThedriversetstheIviScopeTriggerSourcepropertytothisvalue.AfteryoucalloneoftheIviScopeReadWaveform,IviScopeReadMinMaxWaveform[MmW],IviScopeReadWaveformMeasurement[WM],orIviScopeInitiateAcquisitionVIs,theoscilloscopewaitsforthetriggerfromthesourceyouspecifyinthisparameter.Thiscontrolacceptsoneofthevalidchannelnamesoradditionaltriggersourceslistedbelow.Virtualchannelnamesarealiasesforinstrumentspecificchannelstrings.Theinstrumentspecificchannelstringscandifferfromone
instrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.YouassignavirtualchannelnametoaninstrumentspecificchannelinMAX.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrumentspecificchannelnames.
AdditionalTriggerSources
IVISCOPE_VAL_EXTERNALExternalIVISCOPE_VAL_TTL0—PXITRIG0orVXITTL0IVISCOPE_VAL_TTL1—PXITRIG1orVXITTL1IVISCOPE_VAL_TTL2—PXITRIG2orVXITTL2IVISCOPE_VAL_TTL3—PXITRIG3orVXITTL3IVISCOPE_VAL_TTL4—PXITRIG4orVXITTL4IVISCOPE_VAL_TTL5—PXITRIG5orVXITTL5IVISCOPE_VAL_TTL6—PXITRIG6orVXITTL6IVISCOPE_VAL_TTL7—PXITRIG7orVXITTL7IVISCOPE_VAL_ECL—VXIECL0IVISCOPE_VAL_ECL1—VXIECL1IVISCOPE_VAL_PXI_STAR—PXIStarIVISCOPE_VAL_RTSI_0—RTSIline0IVISCOPE_VAL_RTSI_1—RTSIline1IVISCOPE_VAL_RTSI_2—RTSIline2IVISCOPE_VAL_RTSI_3—RTSIline3IVISCOPE_VAL_RTSI_4—RTSIline4IVISCOPE_VAL_RTSI_5—RTSIline5IVISCOPE_VAL_RTSI_6—RTSIline6
NoteIVISCOPE_VAL_EXTERNALTheoscilloscopewaitsforatriggerontheexternaltriggerinput.runtlowthreshold(volts)Passthelowthresholdyouwanttheoscilloscopetouseforrunttriggering.ThedriversetstheIviScope
RuntLowThreshold[RT]propertytothisvalue.Units:voltsDefaultValue:1.0
runthighthreshold(volts)Passthehighthresholdyouwanttheoscilloscopetouseforrunttriggering.ThedriversetstheIviScopeRuntHighThreshold[RT]propertytothisvalue.Units:voltsDefaultValue:4.0
runtpolarityPassthepolarityoftheruntthatyouwanttotriggertheoscilloscope.ThedriversetstheIviScopeRuntPolarity[RT]propertytothisvalue.DefinedValues:
IVISCOPE_VAL_RUNT_POSITIVETheoscilloscopetriggersonapositiverunt.ApositiveruntoccurswhenarisingedgecrossestheRuntLowThresholdanddoesnotcrosstheRuntHighThresholdbeforere-crossingtheLowRuntThreshold.IVISCOPE_VAL_RUNT_NEGATIVETheoscilloscopetriggersonanegativerunt.AnegativeruntoccurswhenafallingedgecrossestheRuntHighThresholdanddoesnotcrosstheRuntLowThresholdbeforere-crossingtheHighRuntThreshold.IVISCOPE_VAL_RUNT_EITHERTheoscilloscopetriggersoneitherapositiveornegativerunt.
DefaultValue:IVISCOPE_VAL_RUNT_POSITIVE
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.
erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviScopeConfigureTriggerIviScopeBaseCapabilityGroupThisVIconfiguresthecommonpropertiesofthetriggersubsystem.Thesepropertiesarethetriggertypeandholdoff.Details
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.triggertypePassthetypeoftriggeryouwanttheoscilloscopetouse.ThedriversetstheIviScopeTriggerTypetothisvalue.DefinedValues:IVISCOPE_VAL_EDGE_TRIGGER—Configurestheoscilloscopeforedgetriggering.Anedgetriggeroccurswhenthetriggersignalcrossesthetriggerlevelyouspecifywiththeslopeyouspecify.YouconfigurethetriggerlevelandslopewiththeIviScopeConfigureEdgeTriggerSourceVI.IVISCOPE_VAL_TV_TRIGGER—ConfigurestheoscilloscopeforTVtriggering.YouconfiguretheTVsignaltype,theeventonwhichtotrigger,andthesignalpolaritywiththeIviScopeConfigureTVTriggerSource[TV]andIviScopeConfigureTVTriggerLineNumber[TV]VIs.IVISCOPE_VAL_RUNT_TRIGGER—Configurestheoscilloscopeforrunttriggering.Arunttriggeroccurswhenthetriggersignalcrossesoneoftheruntthresholdstwicewithoutcrossingtheotherruntthreshold.YouconfiguretheruntthresholdsandthepolarityoftheruntwiththeIviScopeConfigureRuntTriggerSource[RT]VI.IVISCOPE_VAL_GLITCH_TRIGGER—Configurestheoscilloscopeforglitchtriggering.Aglitchtriggeroccurswhenthetriggersignalhasapulsewithawidththatislessthantheglitchwidth.Thetriggerdoesnotactuallyoccuruntiltheedgeofthepulsethatcorrespondstotheglitchwidthandpolarityyouspecifycrossesthe
triggerlevel.Youconfiguretheglitchwidth,thepolarityofthepulse,andthetriggerlevelwiththeIviScopeConfigureGlitchTriggerSource[GT]VI.IVISCOPE_VAL_WIDTH_TRIGGER—Configurestheoscilloscopeforwidthtriggering.Awidthtriggeroccurswhentheoscilloscopedetectsapositiveornegativepulsewithawidthbetween,oroptionallyoutside,thewidththresholds.Thetriggerdoesnotactuallyoccuruntiltheedgeofapulsethatcorrespondstothewidththresholdsandpolarityyouspecifycrossesthetriggerlevel.Youconfigurethewidththresholds,whethertotriggeronpulsewidthsthatarewithinoroutsidethewidththresholds,thepolarityofthepulse,andthetriggerlevelwiththeIviScopeConfigureWidthTriggerSource[WT]VI.IVISCOPE_VAL_AC_LINE_TRIGGER—ConfigurestheoscilloscopeforACLinetriggering.YouconfiguretheslopeonwhichtotriggerwiththeIviScopeConfigureACLineTriggerSlope[AT]VI.IVISCOPE_VAL_IMMEDIATE_TRIGGER—Configurestheoscilloscopeforimmediatetriggering.Theoscilloscopedoesnotwaitfortriggerofanykinduponinitialization.DefaultValue:IVISCOPE_VAL_EDGE_TRIGGER
NoteThiscontrolconfiguresthetypeoftriggertheoscilloscopeuses.AfteryoucallthisVI,youmustcalltheappropriatetriggerconfigurationVItocompletelyspecifythetrigger.
triggerholdoff(seconds)Passthelengthoftimeyouwanttheoscilloscopetowaitafteritdetectsatriggeruntiltheoscilloscopeenablesthetriggersubsystemtodetectanothertrigger.ThedriversetstheIviScopeTriggerHoldoffpropertytothisvalue.Thisparameteraffectsinstrumentoperationonlywhentheoscilloscoperequiresmultipleacquisitionstobuildacompletewaveform.Theoscilloscoperequiresmultiplewaveformacquisitionswhenitusesequivalent-timesamplingorwhenyousettheacquisitiontypetoenvelopeoraverage.Units:seconds
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviScopeConfigureTriggerDetailsWhenyoucallIviScopeReadWaveform,IviScopeReadWaveformMeasurement[WM],IviScopeReadMinMaxWaveform[MmW],orIviScopeInitiateAcquisition,theoscilloscopewaitsforatrigger.YouspecifythetypeoftriggerforwhichtheoscilloscopewaitswiththeTriggerTypeparameter.Iftheoscilloscoperequiresmultiplewaveformacquisitionstobuildacompletewaveform,itwaitsforthelengthoftimeyouspecifywiththeHoldoffparametertoelapsesincetheprevioustrigger.Theoscilloscopethenwaitsforthenexttrigger.Oncetheoscilloscopeacquiresacompletewaveform,itreturnstotheIdlestate.
NoteAfteryoucallthisVI,youmustcallthetriggerconfigurationVIthatcorrespondstotheTriggerTypeyouselecttocompletelyspecifythetrigger.Forexample,ifyousettheTriggerTypetoIVISCOPE_VAL_EDGE_TRIGGER,youusetheIviScopeConfigureEdgeTriggerSourceVItocompletelyspecifythetrigger.
IviScopeConfigureTriggerCouplingIviScopeBaseCapabilityGroupThisVIconfiguresthetriggercoupling.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.triggercouplingPassthetriggercoupling.ThedriverusesthisvaluetosettheIviScopeTriggerCouplingproperty.DefinedValues:IVISCOPE_VAL_AC—TheoscilloscopeACcouplesthetriggersignal.IVISCOPE_VAL_DC—TheoscilloscopeDCcouplesthetriggersignal.IVISCOPE_VAL_LF_REJECT—Theoscilloscopefiltersoutthelowfrequenciesfromthetriggersignal.IVISCOPE_VAL_HF_REJECT—Theoscilloscopefiltersoutthehighfrequenciesfromthetriggersignal.IVISCOPE_VAL_NOISE_REJECT—Theoscilloscopefiltersoutthenoisefromthetriggersignal.DefaultValue:IVISCOPE_VAL_DC
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviScopeConfigureTriggerModifierIviScopeTriggerModifierCapabilityGroup[TM]ThisVIconfiguresthetriggermodifier.Thetriggermodifierdeterminestheoscilloscope'sbehaviorintheabsenceoftheconfiguredtrigger.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.triggermodifierPassthetriggermodifier.ThedriverusesthisvaluetosettheIviScopeTriggerModifier[TM]property.DefinedValues:IVISCOPE_VAL_NO_TRIGGER_MOD—Theoscilloscopewaitsuntilthetriggeryouspecifyoccurs.IVISCOPE_VAL_AUTO—Theoscilloscopeautomaticallytriggersifthetriggeryouspecifydoesnotoccurwithintheoscilloscope'stimeoutperiod.IVISCOPE_VAL_AUTO_LEVEL—Theoscilloscopeadjuststhetriggerlevelifthetriggeryouspecifydoesnotoccur.DefaultValue:IVISCOPE_VAL_NO_TRIGGER_MOD
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptions
VI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviScopeConfigureTVTriggerLineNumberIviScopeTVTriggerCapabilityGroup[TV]ThisVIconfigurestheTVlineuponwhichtheoscilloscopetriggers.ThelinenumberisabsoluteandnotrelativetothefieldoftheTVsignal.
NoteThisVIaffectsinstrumentbehavioronlyifthetriggertypeissettoIVISCOPE_VAL_TV_TRIGGERandtheTVtriggereventissettoIVISCOPE_VAL_TV_LINE_NUMBER.CalltheIviScopeConfigureTriggerandtheIviScopeConfigureTVTriggerSource[TV]VIstosetthetriggertypeandTVtriggereventbeforecallingthisVI.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.linenumberPassthelineonwhichyouwanttheoscilloscopetotrigger.ThedriversetstheIviScopeTVTriggerLineNumber[TV]propertytothisvalue.Thelinenumberisindependentofthefield.Thismeansthattotriggeronthefirstlineofthesecondfield,youmustspecifyalinenumberof263(ifweassumethatfieldonehas262lines).Defaultvalue:1
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtain
fromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviScopeConfigureTVTriggerSourceIviScopeTVTriggerCapabilityGroup[TV]ThisVIconfigurestheoscilloscopeforTVtriggering.ItconfigurestheTVsignalformat,theevent,andthesignalpolarity.
NoteThisVIaffectsinstrumentbehavioronlyifthetriggertypeisIVISCOPE_VAL_TV_TRIGGER.CalltheIviScopeConfigureTriggerandIviScopeConfigureTriggerCouplingVIstosetthetriggertypeandtriggercouplingbeforecallingthisVI.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.triggersourcePassthesourceyouwanttheoscilloscopetomonitorforatrigger.ThedriversetstheIviScopeTriggerSourcepropertytothisvalue.AfteryoucalloneoftheIviScopeReadWaveform,IviScopeReadMinMaxWaveform[MmW],IviScopeReadWaveformMeasurement[WM],orIviScopeInitiateAcquisitionVIs,theoscilloscopewaitsforthetriggerfromthesourceyouspecifyinthisparameter.Thiscontrolacceptsoneofthevalidchannelnamesoradditionaltriggersourceslistedbelow.Virtualchannelnamesarealiasesforinstrumentspecificchannelstrings.Theinstrumentspecificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.Youassignavirtualchannelnametoan
instrumentspecificchannelinMAX.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrumentspecificchannelnames.
AdditionalTriggerSources
IVISCOPE_VAL_EXTERNALExternalIVISCOPE_VAL_TTL0—PXITRIG0orVXITTL0IVISCOPE_VAL_TTL1—PXITRIG1orVXITTL1IVISCOPE_VAL_TTL2—PXITRIG2orVXITTL2IVISCOPE_VAL_TTL3—PXITRIG3orVXITTL3IVISCOPE_VAL_TTL4—PXITRIG4orVXITTL4IVISCOPE_VAL_TTL5—PXITRIG5orVXITTL5IVISCOPE_VAL_TTL6—PXITRIG6orVXITTL6IVISCOPE_VAL_TTL7—PXITRIG7orVXITTL7IVISCOPE_VAL_ECL0—VXIECL0IVISCOPE_VAL_ECL1—VXIECL1IVISCOPE_VAL_PXI_STAR—PXIStarIVISCOPE_VAL_RTSI_0—RTSIline0IVISCOPE_VAL_RTSI_1—RTSIline1IVISCOPE_VAL_RTSI_2—RTSIline2IVISCOPE_VAL_RTSI_3—RTSIline3IVISCOPE_VAL_RTSI_4—RTSIline4IVISCOPE_VAL_RTSI_5—RTSIline5IVISCOPE_VAL_RTSI_6—RTSIline6
NoteIVISCOPE_VAL_EXTERNAL—Theoscilloscopewaitsforatriggerontheexternaltriggerinput.tvsignalformatPassthetypeofTVsignalonwhichtheoscilloscopetriggers.ThedriversetstheIviScopeTVTriggerSignalFormat[TV]propertytothisvalue.DefinedValues:
IVISCOPE_VAL_NTSCNTSCvideosignalIVISCOPE_VAL_PALPALvideosignalIVISCOPE_VAL_SECAMSECAMvideosignalDefaultValue:IVISCOPE_VAL_NTSC
tveventPasstheTVeventonwhichyouwanttheoscilloscopetotrigger.ThedriversetstheIviScopeTVTriggerEvent[TV]propertytothisvalue.DefinedValues:IVISCOPE_VAL_TV_EVENT_FIELD1—Triggeronfield1IVISCOPE_VAL_TV_EVENT_FIELD2—Triggeronfield2IVISCOPE_VAL_TV_EVENT_ANY_FIELD—TriggeronanyfieldIVISCOPE_VAL_TV_EVENT_ANY_LINE—TriggeronanylineIVISCOPE_VAL_TV_EVENT_LINE_NUMBER—TriggeronalineyouspecifyDefaultValue:IVISCOPE_VAL_TV_EVENT_FIELD1
NoteIfyouspecifyIVISCOPE_VAL_TV_EVENT_LINE_NUMBER,youmustsetthelinenumberonwhichtheoscilloscopetriggersbycallingtheIviScopeConfigureTVTriggerLineNumber[TV]VI.triggerpolarityPassthepolarityoftheTVsignal.ThedriversetstheIviScopeTVTriggerPolaritypropertytothisvalue.DefinedValues:IVISCOPE_VAL_TV_POSITIVE—TriggeronapositivevideosyncIVISCOPE_VAL_TV_NEGATIVE—TriggeronanegativevideosyncDefaultvalue:IVISCOPE_VAL_TV_POSITIVE
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviScopeConfigureWidthTriggerSourceIviScopeWidthTriggerCapabilityGroup[WT]ThisVIconfiguresthewidthtrigger.Awidthtriggeroccurswhentheoscilloscopedetectsapositiveornegativepulsewithawidthbetween,oroptionallyoutside,thewidththresholds.YouspecifythewidththresholdswiththeWidthLowThresholdandWidthHighThresholdparameters.YouspecifywhethertheoscilloscopetriggersonpulsewidthsthatarewithinoroutsidethewidththresholdswiththeWidthConditionparameter.YouspecifythepolarityofthepulsewiththeWidthPolarityparameter.ThetriggerdoesnotactuallyoccuruntiltheedgeofapulsethatcorrespondstotheWidthLowThreshold,WidthHighThreshold,WidthCondition,andWidthPolaritycrossesthethresholdyouspecifyintheTriggerLevelparameter.
NoteThisVIaffectsinstrumentbehavioronlyifthetriggertypeisIVISCOPE_VAL_WIDTH_TRIGGER.CalltheIviScopeConfigureTriggerandIviScopeConfigureTriggerCouplingVIstosetthetriggertypeandtriggercouplingbeforecallingthisVI.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.triggersourcePassthesourceyouwanttheoscilloscopetomonitorforatrigger.ThedriversetstheIviScopeTriggerSourcepropertytothisvalue.AfteryoucalloneoftheIviScopeReadWaveform,IviScopeReadMinMaxWaveform[MmW],IviScopeReadWaveformMeasurement[WM],orIviScopeInitiateAcquisitionVIs,the
oscilloscopewaitsforthetriggerfromthesourceyouspecifyinthisparameter.ThiscontrolacceptsoneofthevalidchannelnamesoradditionaltriggersourceslistedinAdditionalTriggerSources.Virtualchannelnamesarealiasesforinstrumentspecificchannelstrings.Theinstrumentspecificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.YouassignavirtualchannelnametoaninstrumentspecificchannelthroughMAX.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrumentspecificchannelnames.
AdditionalTriggerSources
IVISCOPE_VAL_EXTERNAL—ExternalIVISCOPE_VAL_TTL0—PXITRIG0orVXITTL0IVISCOPE_VAL_TTL1—PXITRIG1orVXITTL1IVISCOPE_VAL_TTL2—PXITRIG2orVXITTL2IVISCOPE_VAL_TTL3—PXITRIG3orVXITTL3IVISCOPE_VAL_TTL4—PXITRIG4orVXITTL4IVISCOPE_VAL_TTL5—PXITRIG5orVXITTL5IVISCOPE_VAL_TTL6—PXITRIG6orVXITTL6IVISCOPE_VAL_TTL7—PXITRIG7orVXITTL7IVISCOPE_VAL_ECL0—VXIECL0IVISCOPE_VAL_ECL1—VXIECL1IVISCOPE_VAL_PXI_STAR—PXIStarIVISCOPE_VAL_RTSI_0—RTSIline0IVISCOPE_VAL_RTSI_1—RTSIline1IVISCOPE_VAL_RTSI_2—RTSIline2IVISCOPE_VAL_RTSI_3—RTSIline3
IVISCOPE_VAL_RTSI_4—RTSIline4IVISCOPE_VAL_RTSI_5—RTSIline5IVISCOPE_VAL_RTSI_6—RTSIline6
NoteIVISCOPE_VAL_EXTERNAL—Theoscilloscopewaitsforatriggerontheexternaltriggerinput.triggerlevel(volts)Passthevoltagethresholdyouwanttheoscilloscopetouseforwidthtriggering.ThedriversetstheIviScopeTriggerLevelpropertytothisvalue.TheoscilloscopetriggerswhentheedgeofapulsethatcorrespondstotheWidthLowThreshold,WidthHighThreshold,WidthCondition,andWidthPolaritycrossesthethresholdyouspecifyinthisparameter.Units:voltsDefaultvalue:0.0
NoteThisparameteronlyaffectsinstrumentbehaviorwhenyouselectachannelortheexternaltriggerinputastheTriggerSource.Youcannotconfigurethetriggerlevelthattheoscilloscopeusesforothertriggersources.widthlowthreshold(seconds)Passthelowwidththresholdtime.ThedriversetstheIviScopeWidthLowThreshold[WT]tothisvalue.Units:seconds
widthhighthreshold(seconds)Passthehighwidththresholdtime.ThedriversetstheIviScopeWidthHighThreshold[WT]tothisvalue.Units:seconds
widthpolarityPassthepolarityofthepulsethatyouwanttotriggertheoscilloscope.ThedriversetstheIviScopeWidthPolarity[WT]propertytothisvalue.DefinedValues:IVISCOPE_VAL_WIDTH_POSITIVE—Theoscilloscopetriggersonapositivepulse.IVISCOPE_VAL_WIDTH_NEGATIVE—Theoscilloscopetriggers
onanegativepulse.Defaultvalue:IVISCOPE_VAL_WIDTH_POSITIVE
widthconditionPasswhetheryouwantapulsethatiswithinoroutsidetheWidthHighThresholdandWidthLowThresholdtotriggertheoscilloscope.DefinedValues:IVISCOPE_VAL_WIDTH_WITHIN—TheoscilloscopetriggersonpulsesthathaveawidththatislessthantheWidthHighThresholdandgreaterthantheWidthLowThreshold.IVISCOPE_VAL_WIDTH_OUTSIDE—TheoscilloscopetriggersonpulsesthathaveawidththatiseithergreaterthantheWidthHighThresholdorlessthanaWidthLowThreshold.DefaultValue:IVISCOPE_VAL_WIDTH_WITHIN
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviScopeFetchMinMaxWaveformIviScopeMinMaxWaveformCapabilityGroup[MmW]ThisVIreturnstheminimumandmaximumwaveformsthattheoscilloscopeacquiresforthechannelyouspecify.Ifthechannelisnotenabledfortheacquisition,thisVIreturnstheIVISCOPE_ERROR_CHANNEL_NOT_ENABLEDerror.Details
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.channelnamePassthevirtualchannelnamethatyouassigntotheinstrumentinMAXfromwhichyouwanttofetchtheminimumandmaximumwaveforms.Virtualchannelnamesarealiasesforinstrumentspecificchannelstrings.Theinstrumentspecificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.YouassignavirtualchannelnametoaninstrumentspecificchannelthroughMAX.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrumentspecificchannelnames.DefaultValue:"CHANNEL1"
waveformsizePassthenumberofelementsintheMinWaveformArrayandMaxWaveformArrayparameters.errorin(noerror)Theerrorinclustercanaccepterrorinformation
wiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.minwaveformarrayReturnstheminimumwaveformthattheoscilloscopeacquires.Units:volts
NoteYouconfiguretheinterpolationmethodtheoscilloscopeuseswiththeIviScopeConfigureInterpolation[I]VI.Ifyoudisableinterpolation,theoscilloscopedoesnotinterpolatepointsinthewaveform.Iftheoscilloscopecannotsampleavalueforapointinthewaveform,thedriversetsthecorrespondingelementintheWaveformArraytoanIEEE-definedNaN(NotaNumber)valueandtheVIreturnsIVISCOPE_WARN_INVALID_WFM_ELEMENT.YoucantestawaveformvalueforaninvalidvalueconditionbycallingtheIviScopeIsInvalidWaveformElementVI.maxwaveformarrayReturnsthemaximumwaveformthattheoscilloscopeacquires.Units:volts
NoteYouconfiguretheinterpolationmethodtheoscilloscopeuseswiththeIviScopeConfigureInterpolation[I]VI.Ifyoudisableinterpolation,theoscilloscopedoesnotinterpolatepointsinthewaveform.Iftheoscilloscopecannotsampleavalueforapointinthewaveform,thedriversetsthecorrespondingelementintheWaveformArraytoanIEEE-definedNaN(NotaNumber)valueandtheVIreturnsIVISCOPE_WARN_INVALID_WFM_ELEMENT.YoucantestawaveformvalueforaninvalidvalueconditionbycallingtheIviScopeIsInvalidWaveformElementVI.actualpointsIndicatesthenumberofpointstheVIplacesintheMinWaveformArrayandMaxWaveformArrayparameters.initialxIndicatesthetimeofthefirstpointintheMinWaveform
ArrayandMaxWaveformArray.Thetimeisrelativetothetriggerevent.Forexample,iftheoscilloscopeacquiresthefirstpointinthewaveforms1secondbeforethetrigger,thisparameterreturnsthevalue–1.0.Iftheacquisitionofthefirstpointoccursatthesametimeasthetrigger,thisparameterreturnsthevalue0.0.Units:seconds
xincrementIndicatesthelengthoftimebetweenpointsintheMinWaveformArrayandMaxWaveformArray.Units:seconds
erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviScopeFetchMinMaxWaveformThewaveformsarefromanacquisitionthatyoupreviouslyinitiated.UsethisVItofetchwaveformswhenyousettheacquisitiontypetoIVISCOPE_VAL_PEAK_DETECTorIVISCOPE_VAL_ENVELOPE.Iftheacquisitiontypeisnotoneofthelistedtypes,theVIreturnstheIVISCOPE_ERROR_INVALID_ACQ_TYPEerror.UsetheIviScopeInitiateAcquisitionVItostartanacquisitiononthechannelsthatyouenablewiththeIviScopeConfigureChannelVI.Theoscilloscopeacquiresthemin/maxwaveformsfortheenabledchannelsconcurrently.YouusetheIviScopeAcquisitionStatusVItodeterminewhentheacquisitioniscomplete.YoumustcallthisVIseparatelyforeachenabledchanneltoobtainthemin/maxwaveforms.YoucancalltheIviScopeReadMinMaxWaveform[MmW]VIinsteadoftheIviScopeInitiateAcquisitionVI.TheIviScopeReadMinMaxWaveform[MmW]VIstartsanacquisitiononallenabledchannels,waitsfortheacquisitiontocomplete,andreturnsthemin/maxwaveformsforthechannelyouspecify.YoucallthisVItoobtainthemin/maxwaveformsforeachoftheremainingchannels.
Notes
1. AfterthisVIexecutes,eachelementintheMinWaveformArrayandMaxWaveformArrayparametersiseitheravoltageoravalueindicatingthattheoscilloscopecouldnotsampleavoltage.
2. YouconfiguretheinterpolationmethodtheoscilloscopeuseswiththeIviScopeIsInvalidWaveformElementVI.Ifyoudisableinterpolation,theoscilloscopedoesnotinterpolatepointsinthewaveform.Iftheoscilloscopecannotsampleavalueforapointinthewaveform,thedriversetsthecorrespondingelementintheWaveformArraytoanIEEEdefinedNaN(NotaNumber)valueandtheVIreturnsIVISCOPE_WARN_INVALID_WFM_ELEMENT.
3. YoucantestawaveformvalueforaninvalidvalueconditionbycallingtheIviScopeIsInvalidWaveformElementVI.
4. ThisVIdoesnotchecktheinstrumentstatus.Typically,youcallthisVIonlyinasequenceofcallstootherlow-leveldriverVIs.Thesequenceperformsoneoperation.Youusethelow-levelVIstooptimizeoneormoreaspectsofinteractionwiththeinstrument.Ifyouwanttochecktheinstrumentstatus,calltheIviScopeError-QueryVIattheconclusionofthesequence.
5. TheclassdriverreturnsasimulatedminimumandmaximumwaveformwhenthisVIiscalledandtheIviScopeSimulatepropertyissettoTRUEandtheIviScopeUseSpecificSimulationpropertyissettoFALSE.Forinformationonhowtoconfigureasimulatedwaveform,refertoIviScopeSimulatorSetupDialogBox.
IviScopeFetchWaveformIviScopeBaseCapabilityGroupThisVIreturnsthewaveformtheoscilloscopeacquiresforthechannelyouspecify.ThewaveformisfromanacquisitionthatyouinitiatepriortocallingthisVI.YouusetheIviScopeInitiateAcquisitionVItostartanacquisitiononthechannelsthatyouenablewiththeIviScopeConfigureChannelVI.Theoscilloscopeacquireswaveformsfortheenabledchannelsconcurrently.YouusetheIviScopeAcquisitionStatusVItodeterminewhentheacquisitioniscomplete.YoumustcallthisVIseparatelyforeachenabledchanneltoobtainthewaveforms.YoucancalltheIviScopeReadWaveformVIinsteadoftheIviScopeInitiateAcquisitionVI.TheIviScopeReadWaveformVIstartsanacquisitiononallenabledchannels,waitsfortheacquisitiontocomplete,andreturnsthewaveformforthechannelyouspecify.YoucallthisVItoobtainthewaveformforeachoftheremainingchannels.
Notes
1. AfterthisVIexecutes,eachelementintheWaveformArrayparameteriseitheravoltageoravalueindicatingthattheoscilloscopecouldnotsampleavoltage.
2. YouconfiguretheinterpolationmethodtheoscilloscopeuseswiththeIviScopeConfigureInterpolation[I]VI.Ifyoudisableinterpolation,theoscilloscopedoesnotinterpolatepointsinthewaveform.Iftheoscilloscopecannotsampleavalueforapointinthewaveform,thedriversetsthecorrespondingelementintheWaveformArraytoanIEEE-definedNaN(NotaNumber)valueandtheVIreturnsIVISCOPE_WARN_INVALID_WFM_ELEMENT.
3. YoucantestawaveformvalueforaninvalidvalueconditionbycallingtheIviScopeIsInvalidWaveformElementVI.
4. ThisVIdoesnotchecktheinstrumentstatus.Typically,youcallthisVIonlyinasequenceofcallstootherlow-leveldriverVIs.Thesequenceperformsoneoperation.Youusethelow-levelVIstooptimizeoneormoreaspectsofinteractionwiththeinstrument.Ifyouwanttochecktheinstrumentstatus,calltheIviScopeError-QueryVIattheconclusionofthesequence.
5. TheclassdriverreturnsasimulatedwaveformwhenthisVIiscalledandtheIviScopeSimulatepropertyissettoTRUEandtheIviScopeUseSpecificSimulationpropertyissettoFALSE.Forinformationonhowtoconfigureasimulatedwaveform,refertoIviScopeSimulatorSetupDialogBox.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.channelnamePassthevirtualchannelnamethatyouassigntotheinstrumentinMAXfromwhichyouwanttofetchawaveform.Virtualchannelnamesarealiasesforinstrumentspecificchannelstrings.Theinstrumentspecificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.YouassignavirtualchannelnametoaninstrumentspecificchannelthroughMAX.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrumentspecificchannelnames.DefaultValue:"CHANNEL1"
waveformsizePassthenumberofelementsintheWaveformArrayparameter.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.waveformarrayReturnsthewaveformthattheoscilloscopeacquires.Units:volts
Notes
1. YouconfiguretheinterpolationmethodtheoscilloscopeuseswiththeIviScopeIsInvalidWaveformElementVI.Ifyoudisableinterpolation,theoscilloscopedoesnotinterpolatepointsinthewaveform.Iftheoscilloscopecannotsampleavalueforapointinthewaveform,thedriversetsthecorrespondingelementintheWaveformArraytoanIEEEdefinedNaN(NotaNumber)valueandtheVIreturnsIVISCOPE_WARN_INVALID_WFM_ELEMENT.
2. YoucantestawaveformvalueforaninvalidvalueconditionbycallingtheIviScopeIsInvalidWaveformElementVI.
actualpointsIndicatesthenumberofpointstheVIplacesintheWaveformArrayparameter.initialxIndicatesthetimeofthefirstpointintheWaveformArray.Thetimeisrelativetothetriggerevent.Forexample,iftheoscilloscopeacquiresthefirstpointintheWaveformArray1secondbeforethetrigger,thisparameterreturnsthevalue–1.0.Iftheacquisitionofthefirstpointoccursatthesametimeasthetrigger,thisparameterreturnsthevalue0.0.Units:seconds
xincrementIndicatesthelengthoftimebetweenpointsintheWaveformArray.Units:seconds
erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviScopeFetchWaveformMeasurementIviScopeWaveformMeasCapabilityGroup[WM]ThisVIfetchesawaveformmeasurementfromthechannelyouspecify.Ifthechannelisnotenabledfortheacquisition,thisVIreturnstheIVISCOPE_ERROR_CHANNEL_NOT_ENABLEDerror.Thewaveformonwhichtheoscilloscopecalculatesthewaveformmeasurementisfromanacquisitionthatyoupreviouslyinitiated.
UsetheIviScopeInitiateAcquisitionVItostartanacquisitiononthechannelsthatyouenablewiththeIviScopeConfigureChannelVI.Theoscilloscopeacquireswaveformsfortheenabledchannelsconcurrently.YouusetheIviScopeAcquisitionStatusVItodeterminewhentheacquisitioniscomplete.YoucallthisVIseparatelyforeachwaveformmeasurementyouwanttoobtainonaspecificchannel.YoucancalltheIviScopeReadWaveformMeasurement[WM]VIinsteadoftheIviScopeInitiateAcquisitionVI.TheIviScopeReadWaveformMeasurement[WM]VIstartsanacquisitiononallenabledchannels.Itthenwaitsfortheacquisitiontocomplete,obtainsawaveformmeasurementonthechannelyouspecify,andreturnsthemeasurementvalue.YoucallthisVIseparatelyforanyotherwaveformmeasurementthatyouwanttoobtainonaspecificchannel.
Notes
1. YoumustconfiguretheappropriatereferencelevelsbeforeyoucallthisVI.Youconfigurethelow,mid,andhighreferenceseitherbycallingtheIviScopeConfigureReferenceLevels[WM]VIorbysettingthefollowingproperties:
IviScopeMeasurementHighReference[WF]IviScopeMeasurementLowReference[WM]IviScopeMeasurementMidReference[WM]
2. ThisVIdoesnotchecktheinstrumentstatus.Typically,youcallthisVIonlyinasequenceofcallstootherlow-leveldriverVIs.Thesequenceperformsoneoperation.Youusethelow-levelVIstooptimizeoneormoreaspectsofinteractionwiththeinstrument.Ifyouwanttochecktheinstrumentstatus,calltheIviScopeError-QueryVIattheconclusionofthesequence.
3. TheclassdriverreturnsasimulatedmeasurementwhenthisVIiscalledandtheIviScopeSimulatepropertyissettoTRUEandtheIviScopeUseSpecificSimulationpropertyissettoFALSE.Forinformationonhowtoconfigureasimulatedmeasurement,refertoIviScopeSimulatorSetupDialogBox.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.channelnamePassthevirtualchannelnamethatyouassigntotheinstrumentinMAXfromwhichyouwanttofetchawaveformmeasurement.Virtualchannelnamesarealiasesforinstrumentspecificchannelstrings.Theinstrumentspecificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.YouassignavirtualchannelnametoaninstrumentspecificchannelthroughMAX.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrumentspecificchannelnames.DefaultValue:"CHANNEL1"
measurementfunctionPassthewaveformmeasurementyouwanttheoscilloscopetoperform.Definedvalues:IVISCOPE_VAL_RISE_TIME—RiseTimeThelengthoftimeforthefirstrisingedgeofthesignaltorisefromthelowreferenceleveltothehighreferencelevel.
IVISCOPE_VAL_FALL_TIME—FallTimeThelengthoftimeforthefirstfallingedgeofthesignaltofallfromthehighreferenceleveltothelowreferencelevel.IVISCOPE_VAL_FREQUENCY—FrequencyThefrequencyofonecompletecycleinthewaveform.IVISCOPE_VAL_PERIOD—PeriodThelengthoftimeofonecompletecycleinthewaveform.IVISCOPE_VAL_VOLTAGE_RMS—VoltageRMSThetrueRootMeanSquarevoltageoftheentirewaveform.IVISCOPE_VAL_VOLTAGE_CYCLE_RMS—VoltageRMS(Cycle)ThetrueRootMeanSquarevoltageoverthefirstcycleinthewaveform.IVISCOPE_VAL_VOLTAGE_MAX—VoltageMaxThemaximumamplitudefoundintheentirewaveform.IVISCOPE_VAL_VOLTAGE_MIN—VoltageMinTheminimumamplitudefoundintheentirewaveform.IVISCOPE_VAL_VOLTAGE_PEAK_TO_PEAK—VoltageVppTheabsolutedifferencebetweentheVoltageMaxandtheVoltageMin.IVISCOPE_VAL_VOLTAGE_HIGH—VoltageHighThevoltagethatcorrespondsto100%whenyouusethereferencelevels.Theoscilloscopecalculatesthisvalueusingeitherthemin/maxorhistogrammethods.Themin/maxmethodusesthemaximumvaluefound.Thehistogrammethodusesthemostcommonvaluefoundabovethemiddleofthewaveform.IVISCOPE_VAL_VOLTAGE_LOW—VoltageLowThevoltagethatcorrespondsto0%whenyouusethereferencelevels.Theoscilloscopecalculatesthisvalueusingeitherthemin/maxorhistogrammethods.Themin/maxmethodusestheminimumvaluefound.Thehistogrammethodusesthemostcommonvaluefoundbelowthemiddleofthewaveform.IVISCOPE_VAL_VOLTAGE_AVERAGE—VoltageAvg.Thearithmeticaverageamplitudeoftheentirewaveform.IVISCOPE_VAL_VOLTAGE_CYCLE_AVERAGE—VoltageAvg.(Cycle)
Thearithmeticaverageamplitudeofthefirstcycleinthewaveform.IVISCOPE_VAL_WIDTH_NEG—WidthNegativeThelengthoftimebetweenthemidreferencelevelpointsofthefirstnegativepulseinthewaveform.IVISCOPE_VAL_WIDTH_POS—WidthPositiveThelengthoftimebetweenthemidreferencelevelpointsofthefirstpositivepulseinthewaveform.IVISCOPE_VAL_DUTY_CYCLE_NEG—DutyCycleNegativeTheratiooftheWidthNegativetothePeriodofthefirstcycleinthewaveformexpressedasapercentage.DutyCycleNegative=100.0x(WidthNegative)/PeriodIVISCOPE_VAL_DUTY_CYCLE_POS—DutyCyclePositiveTheratiooftheWidthPositivetothePeriodofthefirstcycleinthewaveformexpressedasapercentage.DutyCyclePositive=100.0X(WidthPositive)/PeriodIVISCOPE_VAL_AMPLITUDE—AmplitudeTheVoltageHighlesstheVoltageLowinVoltsovertheentirewaveformIVISCOPE_VAL_OVERSHOOT—OvershootTherelativewaveformdistortionwhichfollowsanedgetransition.Itiscalculatedusingoneofthefollowingformulas:Fortherisingedge:
OVERSHOOT=((localmaximum-VoltageHigh)/Amplitude)*100%
wherethelocalmaximumisthemaximumvoltageofthesignalinthefirsthalfofthetimeperiodthatcommenceswhentherisingedgecrossesthehighreferencelevelandconcludeswhenthesubsequentfallingedgecrossesthehighreferencelevel.Forthefallingedge:
OVERSHOOT=((VoltageLow-localminimum)/Amplitude)*100%
wherethelocalminimumistheminimumvalueofthesignalmeasuredinthefirsthalfofthetimeperiodthatcommenceswhenthefallingedgecrossesthelowreferencelevelandconcludes
whenthesubsequentrisingedgecrossesthelowreferencelevel.Theinstrumentmakesthemeasurementontheedgeclosesttothebeginningofthewaveformrecord.IVISCOPE_VAL_PRESHOOT—PreshootTherelativewaveformdistortionwhichprecedesanedgetransition.Itiscalculatedusingoneofthefollowingformulas:Fortherisingedge:
PRESHOOT=((VoltageLow-localminimum)/Amplitude)*100%
wherethelocalminimumistheminimumvalueofthesignalmeasuredinthesecondhalfofthetimeperiodthatcommenceswhentheprecedingfallingedgecrossesthelowreferencelevelandconcludeswhentherisingedgecrossesthelowreferencelevel.Forthefallingedge:
PRESHOOT=((localmaximum-VoltageHigh)/Amplitude)*100%
wherethelocalmaximumisthemaximumvoltageofthesignalinthesecondhalfofthetimeperiodthatcommenceswhentheprecedingrisingedgecrossesthehighreferencelevelandconcludeswhenthefallingedgecrossesthehighreferencelevel.Theinstrumentmakesthemeasurementontheedgeclosesttothebeginningofthewaveformrecord.DefaultValue:IVISCOPE_VAL_RISE_TIME
NoteYoumustconfiguretheappropriatereferencelevelsbeforeyoucallthisVI.Youconfigurethelow,mid,andhighreferenceseitherbycallingtheIviScopeConfigureReferenceLevels[WM]VIorbysettingthefollowingproperties:IviScopeMeasurementHighReference[WM]IviScopeMeasurementLowReference[WM]IviScopeMeasurementMidReference[WM]errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.Usethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfrom
otherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.measurementReturnsthemeasuredvalue.Units:TheunitsdependontheMeasurementFunctionyouselect,asshownbelow.RiseTime—secondsFallTime—secondsFrequency—hertzPeriod—secondsVoltageRMS—voltsVoltageRMS(Cycle)—voltsVoltageMax—voltsVoltageMin—voltsVoltageVpp—voltsVoltageHigh—voltsVoltageLow—voltsVoltageAvg.—voltsVoltageAvg.(Cycle)—voltsWidthNegative—secondsWidthPositive—secondsDutyCycleNegative—percentageDutyCyclePositive—percentageAmplitude—voltsOvershoot—percentagePreshoot—percentage
erroroutTheerroroutclusterpasseserrororwarninginformation
outofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviScopeGetChannelNameIviScopeBaseCapabilityGroupThisVIreturnsthespecificdriverdefinedchannelnamethatcorrespondstotheone-basedindexyouspecify.IfthevalueyoupassfortheIndexparameterislessthanoneorgreaterthanthevalueoftheChannelCountproperty,theVIreturnsanemptystringintheNameparameterandreturnsanerror.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeorIviScopeInitializeWithOptionsVI.Thehandleidentifiesaparticularinstrumentsession.index(1)Aone-basedindexthatdefineswhichnametoreturn.TheindexmustbelessthanorequaltotheClassPrefixChannelCountproperty.instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeorIviScopeInitializeWithOptionsVI.Thehandleidentifiesaparticularinstrumentsession.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
outputchannelnameReturnsthenameoftheChannelspecifiedbytheindexparameter.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviScopeInitiateAcquisitionIviScopeBaseCapabilityGroupThisVIinitiatesawaveformacquisition.AfteryoucallthisVI,theoscilloscopeleavestheIdlestateandwaitsforatrigger.TheoscilloscopeacquiresawaveformforeachchannelyouhaveenabledwiththeIviScopeConfigureChannelVI.
Notes
1. ThisVIdoesnotchecktheinstrumentstatus.Typically,youcallthisVIonlyinasequenceofcallstootherlow-leveldriverVIs.Thesequenceperformsoneoperation.Youusethelow-levelVIstooptimizeoneormoreaspectsofinteractionwiththeinstrument.Ifyouwanttochecktheinstrumentstatus,calltheIviScopeError-QueryVIattheconclusionofthesequence.
2. ThisVIperformsinterchangeabilitycheckingwhentheIviScopeInterchangeCheckpropertyissettoTRUE.UseNISpytoviewinterchangeabilitywarnings.Alternately,youmayusetheIviScopeGetNextInterchangeWarningVItoretrieveinterchangeabilitywarnings.Formoreinformationaboutinterchangeabilitychecking,refertothehelptextfortheIviScopeInterchangeCheckproperty.
3. TheclassdriverperformsasimulatedwaveformacquisitionwhenthisVIiscalledandtheIviScopeSimulatepropertyissettoTRUEandtheIviScopeUseSpecificSimulationpropertyissettoFALSE.Forinformationonhowtoconfigureasimulatedwaveform,refertoIviScopeSimulatorSetupDialogBox.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.Usethisinformationtodecideif
anyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviScopeIsInvalidWaveformElementIviScopeBaseCapabilityGroupAfterthereadandfetchwaveformVIsexecute,eachelementinthewaveformarraycontainseitheravoltageoravalueindicatingthattheoscilloscopecouldnotsampleavoltage.ThedriverusesanIEEE-definedNaN(NotaNumber)valuetomarkasinvalideachelementinthewaveformarrayforwhichtheoscilloscopecouldnotsampleavoltage.ThisVIdetermineswhetheravalueyoupassfromthewaveformarrayisinvalid.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.elementvaluePassoneofthevaluesfromthewaveformarrayreturnedbythereadandfetchwaveformVIs.ThedriverusesanIEEE-definedNaN(NotaNumber)valuetomarkasinvalideachelementinthewaveformarrayforwhichtheoscilloscopecouldnotsampleavoltage.Thedriverdetermineswhetherthevalueyoupassisinvalid.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.isinvalidReturnswhethertheElementValueisavalidvoltageoravalueindicatingthattheoscilloscopecouldnotsampleavoltage.
ValidReturnValues:TRUE(1)—TheElementValueindicatesthattheoscilloscopecouldnotsamplethevoltage.FALSE(0)—TheElementValueisavalidvoltage.
erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviScopeReadMinMaxWaveformIviScopeMinMaxWaveformCapabilityGroup[MmW]ThisVIinitiatesanacquisitiononallchannelsthatyouenablewiththeIviScopeConfigureChannelVI.IfthechannelyouspecifyintheChannelNameparameterisnotenabledfortheacquisition,thisVIreturnstheIVISCOPE_ERROR_CHANNEL_NOT_ENABLEDerror.Itthenwaitsfortheacquisitiontocompleteandreturnsthemin/maxwaveformsforthechannelyouspecify.IftheoscilloscopedidnotcompletetheacquisitionwithinthetimeperiodyouspecifywiththeMaximumTimeparameter,theVIreturnstheIVISCOPE_ERROR_MAX_TIME_EXCEEDEDerror.YoucalltheIviScopeFetchMinMaxWaveform[MmW]VItoobtainthewaveformsforeachoftheremainingenabledchannelswithoutinitiatinganotheracquisition.
Notes
1. UsethisVItoreadwaveformswhenyousettheacquisitiontypetoIVISCOPE_VAL_PEAK_DETECTorIVISCOPE_VAL_ENVELOPE.Iftheacquisitiontypeisnotoneofthelistedtypes,theVIreturnstheIVISCOPE_ERROR_INVALID_ACQ_TYPEerror.
2. AfterthisVIexecutes,eachelementintheMinWaveformArrayandMaxWaveformArrayparametersiseitheravoltageoravalueindicatingthattheoscilloscopecouldnotsampleavoltage.
3. YouconfiguretheinterpolationmethodtheoscilloscopeuseswiththeIviScopeIsInvalidWaveformElementVI.Ifyoudisableinterpolation,theoscilloscopedoesnotinterpolate
pointsinthewaveform.Iftheoscilloscopecannotsampleavalueforapointinthewaveform,thedriversetsthecorrespondingelementintheWaveformArraytoanIEEE-definedNaN(NotaNumber)valueandtheVIreturnsIVISCOPE_WARN_INVALID_WFM_ELEMENT.
4. YoucantestawaveformvalueforaninvalidvalueconditionbycallingtheIviScopeIsInvalidWaveformElementVI.
5. ThisVIperformsinterchangeabilitycheckingwhentheIviScopeInterchangeCheckpropertyissettoTRUE.YouuseNISpytoviewinterchangeabilitywarnings.Alternately,youmayusetheIviScopeGetNextInterchangeWarningVItoretrieveinterchangeabilitywarnings.Formoreinformationaboutinterchangeabilitychecking,refertotheIviScopeInterchangeCheckproperty.
6. TheclassdriverreturnssimulatedminimumandmaximumwaveformswhenthisVIiscalledandtheIviScopeSimulatepropertyissettoTRUEandtheIviScopeUseSpecificSimulationpropertyissettoFALSE.Forinformationonhowtoconfigureasimulatedwaveform,refertoIviScopeSimulatorSetupDialogBox.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.channelnamePassthevirtualchannelnamethatyouassigntotheinstrumentinMAXfromwhichyouwanttoreadtheminimumandmaximumwaveforms.Virtualchannelnamesarealiasesforinstrumentspecificchannelstrings.Theinstrumentspecificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.YouassignavirtualchannelnametoaninstrumentspecificchannelthroughMAX.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrumentspecificchannelnames.DefaultValue:"CHANNEL1"
waveformsizePassthenumberofelementsintheMinWaveform
ArrayandMaxWaveformArrayparameters.maximumtime(ms)Passthemaximumlengthoftimeinwhichtoallowthereadwaveformoperationtocomplete.Iftheoperationdoesnotcompletewithinthistimeinterval,theVIreturnstheIVISCOPE_ERROR_MAX_TIME_EXCEEDEDerrorcode.Whenthisoccurs,youcancallIviScopeAborttocancelthereadwaveformoperationandreturntheoscilloscopetotheIdlestate.Units:millisecondsDefinedValues:IVISCOPE_VAL_MAX_TIME_INFINITEIVISCOPE_VAL_MAX_TIME_IMMEDIATEDefaultValue:5000(ms)
NoteTheMaximumTimeparameterappliesonlytothisVI.Ithasnoeffectonothertimeoutparametersorproperties.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.minwaveformarrayReturnstheminimumwaveformthattheoscilloscopeacquires.Units:volts
Notes
1. YouconfiguretheinterpolationmethodtheoscilloscopeuseswiththeIviScopeIsInvalidWaveformElementVI.Ifyoudisableinterpolation,theoscilloscopedoesnotinterpolatepointsinthewaveform.Iftheoscilloscopecannotsampleavalueforapointinthewaveform,thedriversetsthe
correspondingelementintheWaveformArraytoanIEEE-definedNaN(NotaNumber)valueandtheVIreturnstheIVISCOPE_WARN_INVALID_WFM_ELEMENTerror.
2. YoucantestawaveformvalueforaninvalidvalueconditionbycallingtheIviScopeIsInvalidWaveformElementVI.
maxwaveformarrayReturnsthemaximumwaveformthattheoscilloscopeacquires.Units:volts
Notes
1. YouconfiguretheinterpolationmethodtheoscilloscopeuseswiththeIviScopeIsInvalidWaveformElementVI.Ifyoudisableinterpolation,theoscilloscopedoesnotinterpolatepointsinthewaveform.Iftheoscilloscopecannotsampleavalueforapointinthewaveform,thedriversetsthecorrespondingelementintheWaveformArraytoanIEEE-definedNaN(NotaNumber)valueandtheVIreturnstheIVISCOPE_WARN_INVALID_WFM_ELEMENTerror.
2. YoucantestawaveformvalueforaninvalidvalueconditionbycallingtheIviScopeIsInvalidWaveformElementVI.
actualpointsIndicatesthenumberofpointstheVIplacesintheMinWaveformArrayandMaxWaveformArrayparameters.initialxIndicatesthetimeofthefirstpointintheMinWaveformArrayandMaxWaveformArray.Thetimeisrelativetothetriggerevent.Units:secondsForexample,iftheoscilloscopeacquiresthefirstpointinthewaveforms1secondbeforethetrigger,thisparameterreturnsthevalue–1.0.Iftheacquisitionofthefirstpointoccursatthesametimeasthetrigger,thisparameterreturnsthevalue0.0.
xincrementIndicatesthelengthoftimebetweenpointsintheMinandMaxWaveformArrays.Units:seconds
erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviScopeReadWaveformIviScopeBaseCapabilityGroupThisVIinitiatesanacquisitiononallchannelsthatyouenablewiththeIviScopeConfigureChannelVI.IfthechannelyouspecifyintheChannelNameparameterisnotenabledfortheacquisition,thisVIreturnstheIVISCOPE_ERROR_CHANNEL_NOT_ENABLEDerror.Itthenwaitsfortheacquisitiontocompleteandreturnsthewaveformforthechannelyouspecify.IftheoscilloscopedidnotcompletetheacquisitionwithinthetimeperiodyouspecifywiththeMaximumTimeparameter,theVIreturnstheIVISCOPE_ERROR_MAX_TIME_EXCEEDEDerror.YoucalltheIviScopeFetchWaveformVItoobtainthewaveformsforeachoftheremainingenabledchannelswithoutinitiatinganotheracquisition.
Notes
1. UsethisVItoreadwaveformswhenyousettheacquisitionmodetoIVISCOPE_VAL_NORMAL,IVISCOPE_VAL_HI_RES,orIVISCOPE_VAL_AVERAGE.Iftheacquisitiontypeisnotoneofthelistedtypes,theVIreturnstheIVISCOPE_ERROR_INVALID_ACQ_TYPEerror.
2. AfterthisVIexecutes,eachelementintheWaveformArrayparameteriseitheravoltageoravalueindicatingthattheoscilloscopecouldnotsampleavoltage.
3. YouconfiguretheinterpolationmethodtheoscilloscopeuseswiththeIviScopeIsInvalidWaveformElementVI.Ifyoudisableinterpolation,theoscilloscopedoesnotinterpolatepointsinthewaveform.Iftheoscilloscopecannotsampleavalueforapointinthewaveform,thedriversetsthecorrespondingelementintheWaveformArraytoanIEEE-definedNaN(NotaNumber)valueandtheVIreturnsthe
IVISCOPE_WARN_INVALID_WFM_ELEMENTerror.4. Youcantestawaveformvalueforaninvalidvalueconditionby
callingtheIviScopeIsInvalidWaveformElementVI.5. ThisVIperformsinterchangeabilitycheckingwhenthe
IviScopeInterchangeCheckpropertyissettoTRUE.UseNISpytoviewinterchangeabilitywarnings.Alternately,youmayusetheIviScopeGetNextInterchangeWarningVItoretrieveinterchangeabilitywarnings.Formoreinformationaboutinterchangeabilitychecking,refertotheIviScopeInterchangeCheckproperty.
6. TheclassdriverreturnssimulatedminimumandmaximumwaveformswhenthisVIiscalledandtheIviScopeSimulatepropertyissettoTRUEandtheIviScopeUseSpecificSimulationpropertyissettoFALSE.Forinformationonhowtoconfigureasimulatedwaveform,refertoIviScopeSimulatorSetupDialogBox.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.channelnamePassthevirtualchannelnamethatyouassigntotheinstrumentinMAXfromwhichyouwanttoreadawaveform.Virtualchannelnamesarealiasesforinstrumentspecificchannelstrings.Theinstrumentspecificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.YouassignavirtualchannelnametoaninstrumentspecificchannelthroughMAX.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrumentspecificchannelnames.DefaultValue:""
waveformsizePassthenumberofelementsintheWaveformArrayparameter.maximumtime(ms)Passthemaximumlengthoftimeinwhichtoallowthereadwaveformoperationtocomplete.Iftheoperationdoesnotcompletewithinthistimeinterval,theVIreturnstheIVISCOPE_ERROR_MAX_TIME_EXCEEDEDerror.
Whenthisoccurs,youcancallIviScopeAborttocancelthereadwaveformoperationandreturntheoscilloscopetotheIdlestate.Units:millisecondsDefinedValues:IVISCOPE_VAL_MAX_TIME_INFINITEIVISCOPE_VAL_MAX_TIME_IMMEDIATEDefaultValue:5000(ms)
NoteTheMaximumTimeparameterappliesonlytothisVI.Ithasnoeffectonothertimeoutparametersorproperties.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.waveformarrayReturnsthewaveformthattheoscilloscopeacquires.Units:volts
Notes
1. YouconfiguretheinterpolationmethodtheoscilloscopeuseswiththeIviScopeIsInvalidWaveformElementVI.Ifyoudisableinterpolation,theoscilloscopedoesnotinterpolatepointsinthewaveform.Iftheoscilloscopecannotsampleavalueforapointinthewaveform,thedriversetsthecorrespondingelementintheWaveformArraytoanIEEE-definedNaN(NotaNumber)valueandtheVIreturnstheIVISCOPE_WARN_INVALID_WFM_ELEMENTerror.
2. YoucantestawaveformvalueforaninvalidvalueconditionbycallingtheIviScopeIsInvalidWaveformElementVI.
actualpointsIndicatesthenumberofpointstheVIplacesinthe
WaveformArrayparameter.initialxIndicatesthetimeofthefirstpointintheWaveformArray.Thetimeisrelativetothetriggerevent.Forexample,iftheoscilloscopeacquiresthefirstpointintheWaveformArray1secondbeforethetrigger,thisparameterreturnsthevalue–1.0.Iftheacquisitionofthefirstpointoccursatthesametimeasthetrigger,thisparameterreturnsthevalue0.0.Units:seconds
xincrementIndicatesthelengthoftimebetweenpointsintheWaveformArray.Units:seconds
erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviScopeReadWaveformMeasurementIviScopeWaveformMeasCapabilityGroup[WM]ThisVIinitiatesanacquisitiononallchannelsthatyouenablewiththeIviScopeConfigureChannelVI.IfthechannelyouspecifyintheChannelNameparameterisnotenabledfortheacquisition,thisVIreturnstheIVISCOPE_ERROR_CHANNEL_NOT_ENABLEDerror.Itthenwaitsfortheacquisitiontocompleteandreturnsthewaveformmeasurementforthechannelyouspecify.IftheoscilloscopedidnotcompletetheacquisitionwithinthetimeperiodyouspecifywiththeMaximumTimeparameter,theVIreturnstheIVISCOPE_ERROR_MAX_TIME_EXCEEDEDerror.YoucalltheIviScopeFetchWaveformMeasurement[WM]VItoobtainanyotherwaveformmeasurementonaspecificchannelwithoutinitiatinganotheracquisition.
Notes
1. YoumustconfiguretheappropriatereferencelevelsbeforeyoucallthisVI.Youconfigurethelow,mid,andhighreferenceseitherbycallingtheIviScopeConfigureReferenceLevels[WM]VIorbysettingthefollowingproperties:IviScopeMeasurementHighReference[WM]IviScopeMeasurementLowReference[WM]IviScopeMeasurementMidReference[WM]
2. ThisVIperformsinterchangeabilitycheckingwhentheIviScopeInterchangeCheckpropertyissettoTRUE.UseNISpytoviewinterchangeabilitywarnings.Alternately,youmayusetheIviScopeGetNextInterchangeWarningVItoretrieve
interchangeabilitywarnings.Formoreinformationaboutinterchangeabilitychecking,refertotheIviScopeInterchangeCheckproperty.
3. TheclassdriverreturnssimulatedminimumandmaximumwaveformswhenthisVIiscalledandtheIviScopeSimulatepropertyissettoTRUEandtheIviScopeUseSpecificSimulationpropertyissettoFALSE.Forinformationonhowtoconfigureasimulatedwaveform,refertoIviScopeSimulatorSetupDialogBox.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.channelnamePassthevirtualchannelnamethatyouassigntotheinstrumentinMAXfromwhichyouwanttoreadawaveformmeasurement.Virtualchannelnamesarealiasesforinstrumentspecificchannelstrings.Theinstrumentspecificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.YouassignavirtualchannelnametoaninstrumentspecificchannelinMAX.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrumentspecificchannelnames.DefaultValue:""
measurementfunctionPassthewaveformmeasurementyouwanttheoscilloscopetoperform.Definedvalues:IVISCOPE_VAL_RISE_TIME—RiseTimeThelengthoftimeforthefirstrisingedgeofthesignaltorisefromthelowreferenceleveltothehighreferencelevel.IVISCOPE_VAL_FALL_TIME—FallTimeThelengthoftimeforthefirstfallingedgeofthesignaltofallfromthehighreferenceleveltothelowreferencelevel.IVISCOPE_VAL_FREQUENCY—FrequencyThefrequencyofonecompletecycleinthewaveform.
IVISCOPE_VAL_PERIOD—PeriodThelengthoftimeofonecompletecycleinthewaveform.IVISCOPE_VAL_VOLTAGE_RMS—VoltageRMSThetrueRootMeanSquarevoltageoftheentirewaveform.IVISCOPE_VAL_VOLTAGE_CYCLE_RMS—VoltageRMS(Cycle)ThetrueRootMeanSquarevoltageoverthefirstcycleinthewaveform.IVISCOPE_VAL_VOLTAGE_MAX—VoltageMaxThemaximumamplitudefoundintheentirewaveform.IVISCOPE_VAL_VOLTAGE_MIN—VoltageMinTheminimumamplitudefoundintheentirewaveform.IVISCOPE_VAL_VOLTAGE_PEAK_TO_PEAK—VoltageVppTheabsolutedifferencebetweentheVoltageMaxandtheVoltageMin.IVISCOPE_VAL_VOLTAGE_HIGH—VoltageHighThevoltagethatcorrespondsto100%whenyouusethereferencelevels.Theoscilloscopecalculatesthisvalueusingeitherthemin/maxorhistogrammethods.Themin/maxmethodusesthemaximumvaluefound.Thehistogrammethodusesthemostcommonvaluefoundabovethemiddleofthewaveform.IVISCOPE_VAL_VOLTAGE_LOW—VoltageLowThevoltagethatcorrespondsto0%whenyouusethereferencelevels.Theoscilloscopecalculatesthisvalueusingeitherthemin/maxorhistogrammethods.Themin/maxmethodusestheminimumvaluefound.Thehistogrammethodusesthemostcommonvaluefoundbelowthemiddleofthewaveform.IVISCOPE_VAL_VOLTAGE_AVERAGE—VoltageAvg.Thearithmeticaverageamplitudeoftheentirewaveform.IVISCOPE_VAL_VOLTAGE_CYCLE_AVERAGE—VoltageAvg.(Cycle)Thearithmeticaverageamplitudeofthefirstcycleinthewaveform.IVISCOPE_VAL_WIDTH_NEG—WidthNegativeThelengthoftimebetweenthemidreferencelevelpointsofthefirstnegativepulseinthewaveform.IVISCOPE_VAL_WIDTH_POS—WidthPositive
Thelengthoftimebetweenthemidreferencelevelpointsofthefirstpositivepulseinthewaveform.IVISCOPE_VAL_DUTY_CYCLE_NEG—DutyCycleNegativeTheratiooftheWidthNegativetothePeriodofthefirstcycleinthewaveformexpressedasapercentage.DutyCycleNegative=100.0x(WidthNegative)/PeriodIVISCOPE_VAL_DUTY_CYCLE_POS—DutyCyclePositiveTheratiooftheWidthPositivetothePeriodofthefirstcycleinthewaveformexpressedasapercentage.DutyCyclePositive=100.0X(WidthPositive)/PeriodIVISCOPE_VAL_AMPLITUDE—AmplitudeTheVoltageHighlesstheVoltageLowinVoltsovertheentirewaveform.IVISCOPE_VAL_OVERSHOOT—OvershootTherelativewaveformdistortionwhichfollowsanedgetransition.Itiscalculatedusingoneofthefollowingformulas:Fortherisingedge:
OVERSHOOT=((localmaximum-VoltageHigh)/Amplitude)*100%
wherethelocalmaximumisthemaximumvoltageofthesignalinthefirsthalfofthetimeperiodthatcommenceswhentherisingedgecrossesthehighreferencelevelandconcludeswhenthesubsequentfallingedgecrossesthehighreferencelevel.Forthefallingedge:
OVERSHOOT=((VoltageLow-localminimum)/Amplitude)*100%
wherethelocalminimumistheminimumvalueofthesignalmeasuredinthefirsthalfofthetimeperiodthatcommenceswhenthefallingedgecrossesthelowreferencelevelandconcludeswhenthesubsequentrisingedgecrossesthelowreferencelevel.Theinstrumentmakesthemeasurementontheedgeclosesttothebeginningofthewaveformrecord.IVISCOPE_VAL_PRESHOOT—PreshootTherelativewaveformdistortionwhichprecedesanedge
transition.Itiscalculatedusingoneofthefollowingformulas:Fortherisingedge:PRESHOOT=((VoltageLow-localminimum)/Amplitude)*100%
wherethelocalminimumistheminimumvalueofthesignalmeasuredinthesecondhalfofthetimeperiodthatcommenceswhentheprecedingfallingedgecrossesthelowreferencelevelandconcludeswhentherisingedgecrossesthelowreferencelevel.Forthefallingedge:PRESHOOT=((localmaximum-VoltageHigh)/Amplitude)*100%
wherethelocalmaximumisthemaximumvoltageofthesignalinthesecondhalfofthetimeperiodthatcommenceswhentheprecedingrisingedgecrossesthehighreferencelevelandconcludeswhenthefallingedgecrossesthehighreferencelevel.Theinstrumentmakesthemeasurementontheedgeclosesttothebeginningofthewaveformrecord.DefaultValue:IVISCOPE_VAL_RISE_TIME
NoteYoumustconfiguretheappropriatereferencelevelsbeforeyoucallthisVI.Youconfigurethelow,mid,andhighreferenceseitherbycallingtheIviScopeConfigureReferenceLevels[WM]VIorbysettingthefollowingproperties:IviScopeMeasurementHighReference[WM]IviScopeMeasurementLowReference[WM]IviScopeMeasurementMidReference[WM]maximumtime(ms)Passthemaximumlengthoftimeinwhichtoallowthereadwaveformmeasurementoperationtocomplete.Iftheoperationdoesnotcompletewithinthistimeinterval,theVIreturnstheIVISCOPE_ERROR_MAX_TIME_EXCEEDEDerrorcode.Whenthisoccurs,youcancallIviScopeAborttocancelthereadwaveformoperationandreturntheoscilloscopetotheIdlestate.Units:milliseconds.DefinedValues:
IVISCOPE_VAL_MAX_TIME_INFINITEIVISCOPE_VAL_MAX_TIME_IMMEDIATEDefaultValue:5000(ms)
NoteTheMaximumTimeparameterappliesonlytothisVI.Ithasnoeffectonothertimeoutparametersorproperties.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviScopeInitializeortheIviScopeInitializeWithOptionsVI.measurementReturnsthemeasuredvalue.UnitsTheunitsdependontheMeasurementFunctionyouselect,asshownbelow:RiseTime—secondsFallTime—secondsFrequency—hertzPeriod—secondsVoltageRMS—voltsVoltageRMS(Cycle)—voltsVoltageMax—voltsVoltageMin—voltsVoltageVpp—voltsVoltageHigh—voltsVoltageLow—voltsVoltageAvg.—voltsVoltageAvg.(Cycle)—voltsWidthNegative—seconds
WidthPositive—secondsDutyCycleNegative—percentageDutyCyclePositive—percentageAmplitude—voltsOvershoot—percentagePreshoot—percentage
erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviScopePropertiesExpandthisbooktoviewanalphabetizedlistofIviScopeproperties.
IviScopeACLineTriggerSlope[AT]IviScopeAcLineTrigger[AT]DataType Access Applies
to Coercion HighLevelVIs
R/W N/A None IviScopeConfigureACLineTriggerSlope
DescriptionSpecifiestheslopeofthezerocrossinguponwhichthescopetriggers.ThispropertyaffectsinstrumentoperationonlywhentheIviScopeTriggerTypepropertyissettoIVISCOPE_VAL_AC_LINE_TRIGGER.PropertyNodePathIviScope»Trigger»ACLineTriggering[AT]»ACLineTriggerSlope[AT]DefinedValuesIVISCOPE_VAL_AC_LINE_EITHERIVISCOPE_VAL_AC_LINE_POSITIVEIVISCOPE_VAL_AC_LINE_NEGATIVE
IviScopeAcquisitionStartTimeIviScopeBasePropertyDataType Access Applies
to Coercion HighLevelVIs
R/W N/A None IviScopeConfigureAcquisitionRecord
DescriptionThispropertiesspecifiesthelengthoftimefromthetriggereventtothefirstpointinthewaveformrecord.Theunitsareseconds.Ifthevalueispositive,thefirstpointinthewaveformrecordoccursafterthetriggerevent.Ifthevalueisnegative,thefirstpointinthewaveformrecordoccursbeforethetriggerevent.PropertyNodePathIviScope»Acquisition»AcquisitionStartTime
IviScopeAcquisitionTypeIviScopeBasePropertyDataType Access Applies
to Coercion HighLevelVIs
R/W N/A None IviScopeConfigureAcquisitionType
DescriptionSpecifieshowtheoscilloscopeacquiresdataandfillsthewaveformrecord.WhenyousetthispropertytoIVISCOPE_VAL_ENVELOPEorIVISCOPE_VAL_PEAK_DETECT,theoscilloscopeacquiresminimumandmaximumwaveforms.Toretrievetheminimumandmaximumwaveforms,usetheIviScopeReadMinMaxWaveform[MmW]andIviScopeFetchMinMaxWaveform[MmW]VIs.PropertyNodePathIviScope»Acquisition»AcquisitionTypeDefinedValuesIVISCOPE_VAL_NORMALIVISCOPE_VAL_PEAK_DETECTIVISCOPE_VAL_HI_RESIVISCOPE_VAL_ENVELOPEIVISCOPE_VAL_AVERAGE
IviScopeChannelCountIviScopeBasePropertyDataType Access Appliesto Coercion HighLevelVIs
RO N/A None None
DescriptionReturnsthenumberofchannelsavailableontheinstrument.PropertyNodePathIviScope»InherentIVISettings»SpecificDriverCapabilities»ChannelCount
IviScopeChannelEnabledIviScopeBasePropertyDataType Access Appliesto Coercion HighLevelVIs
R/W Channel None IviScopeConfigureChannel
DescriptionThischannel-basedpropertyspecifieswhethertheoscilloscopeacquiresawaveformforachannelwhenyoucalltheIviScopeInitiateAcquisition,IviScopeReadWaveform,IviScopeReadMinMaxWaveform[MmW],orIviScopeReadWaveformMeasurementVI.PropertyNodePathIviScope»Channel»ChannelEnabled
IviScopeGlitchCondition[GT]IviScopeGlitchTrigger[GT]DataType
Access Appliesto
Coercion HighLevelVIs
R/W N/A None IviScopeConfigureGlitchTriggerSource
DescriptionSpecifiestheglitchconditionthattriggerstheoscilloscope.TheglitchtriggeroccurswhentheoscilloscopedetectsapulsewithawidthlessthanorgreaterthanthewidthvalueyouspecifywiththeIviScopeGlitchWidth[GT]property.ThispropertyaffectsinstrumentoperationonlywhentheIviScopeTriggerTypepropertyissettoIVISCOPE_VAL_GLITCH_TRIGGER.PropertyNodePathIviScope»Trigger»GlitchTriggering[GT]»GlitchCondition[GT]DefinedValuesIVISCOPE_VAL_GLITCH_LESS_THANIVISCOPE_VAL_GLITCH_GREATER_THAN
IviScopeGlitchPolarity[GT]IviScopeGlitchTriggerProperty[GT]DataType Access Applies
to Coercion HighLevelVIs
R/W N/A None IviScopeConfigureGlitchTriggerSource
DescriptionSpecifiesthepolarityoftheglitchthattriggerstheoscilloscope.ThispropertyaffectsinstrumentoperationonlywhentheIviScopeTriggerTypepropertyissettoIVISCOPE_VAL_GLITCH_TRIGGER.PropertyNodePathIviScope»Trigger»GlitchTriggering[GT]»GlitchPolarity[GT]DefinedValuesIVISCOPE_VAL_GLITCH_POSITIVEIVISCOPE_VAL_GLITCH_NEGATIVEIVISCOPE_VAL_GLITCH_EITHER
IviScopeGlitchWidth[GT]IviScopeGlitchTriggerProperty[GT]DataType Access Applies
to Coercion HighLevelVIs
R/W N/A None IviScopeConfigureGlitchTriggerSource
DescriptionSpecifiestheglitchwidth.Theunitsareseconds.Theoscilloscopetriggerswhenitdetectsapulsewithawidththatislessthanthevalueyouspecify.ThispropertyaffectsinstrumentoperationonlywhentheIviScopeTriggerTypepropertyissettoIVISCOPE_VAL_GLITCH_TRIGGER.PropertyNodePathIviScope»Trigger»GlitchTriggering[GT]»GlitchWidth[GT]
IviScopeHorizontalMinimumNumberofPointsIviScopeBasePropertyDataType Access Applies
to Coercion HighLevelVIs
R/W N/A None IviScopeConfigureAcquisitionRecord
DescriptionSpecifiestheminimumnumberofpointsyourequireinthewaveformrecordforeachchannel.Theinstrumentdriverusesthevalueyouspecifytoconfiguretherecordlengththattheoscilloscopeusesforwaveformacquisition.TheIviScopeHorizontalRecordLengthpropertyreturnstheactualrecordlength.PropertyNodePathIviScope»Acquisition»HorizontalMinimumNumberofPoints
IviScopeHorizontalRecordLengthIviScopeBasePropertyDataType Access Applies
to Coercion HighLevelVIs
RO N/A N/A IviScopeActualRecordLength
DescriptionReturnstheactualnumberofpointstheoscilloscopeacquiresforeachchannel.ThevalueisequaltoorgreaterthantheminimumnumberofpointsyouspecifyIviScopeHorizontalMinimumNumberofPointsproperty.
Allocatea arrayofthissizeorgreatertopassastheWaveformArrayparameteroftheIviScopeReadWaveformandIviScopeFetchWaveformVIs.
NoteOscilloscopesmayusedifferentsizerecordsdependingonthevaluespecifiedfortheIviScopeAcquisitionTypeproperty.
PropertyNodePathIviScope»Acquisition»HorizontalRecordLength
IviScopeHorizontalSampleRateIviScopeBasePropertyDataType Access Appliesto Coercion HighLevelVIs
RO N/A N/A IviScopeActualSampleRate
DescriptionReturnstheeffectivedigitizingrateusingthecurrentconfiguration.Theunitsaresamplespersecond.PropertyNodePathIviScope»Acquisition»HorizontalSampleRate
IviScopeHorizontalTimePerRecordIviScopeBasePropertyDataType Access Applies
to Coercion HighLevelVIs
R/W N/A Up IviScopeConfigureAcquisitionRecord
DescriptionSpecifiesthelengthoftimeinsecondsthatcorrespondstotherecordlength.PropertyNodePathIviScope»Acquisition»HorizontalTimePerRecord
IviScopeInitiateContinuous[CA]IviScopeContinuousAcquisitionPropertyDataType Access Applies
to Coercion HighLevelVIs
R/W N/A None IviScopeConfigureInitiateContinuous
DescriptionSpecifieswhethertheoscilloscopecontinuouslyinitiateswaveformacquisition.IfyousetthispropertytoTRUE,theoscilloscopeimmediatelywaitsforanothertriggerafterthepreviouswaveformacquisitioniscomplete.SettingthispropertytoTRUEisusefulwhenyourequirecontinuousupdatesoftheoscilloscopedisplay.PropertyNodePathIviScope»Acquisition»InitiateContinuous[CA]
IviScopeInputImpedanceIviScopeBasePropertyDataType Access Applies
to Coercion HighLevelVIs
R/W Channel None IviScopeConfigureChannelCharacteristics
DescriptionThischannel-basedpropertyspecifiestheinputimpedanceforthechannel.Theunitsareohms.PropertyNodePathIviScope»Channel»InputImpedance
IviScopeInterpolation[I]IviScopeInterpolationProperty[I]DataType Access Applies
to Coercion HighLevelVIs
R/W N/A None IviScopeConfigureInterpolation
DescriptionSpecifiestheinterpolationmethodtheoscilloscopeuseswhenitcannotsampleavoltageforeverypointinthewaveformrecord.PropertyNodePathIviScope»Acquisition»Interpolation[I]DefinedValuesIVISCOPE_VAL_NO_INTERPOLATIONIVISCOPE_VAL_SINE_XIVISCOPE_VAL_LINEAR
IviScopeMaximumInputFrequencyIviScopeBasePropertyDataType
Access Appliesto
Coercion HighLevelVIs
R/W Channel Up IviScopeConfigureChannelCharacteristics
DescriptionThischannel-basedpropertyspecifiesthemaximuminputfrequencyofthechannel.Expressthisvalueasthefrequencyatwhichtheinputcircuitryattenuatestheinputsignalby3dB.Theunitsforthispropertyarehertz(Hz).PropertyNodePathIviScope»Channel»MaximumInputFrequency
IviScopeMeasurementHighReference[WM]IviScopeMeasWaveformProperty[WM]DataType Access Applies
to Coercion HighLevelVIs
R/W N/A None IviScopeConfigureReferenceLevels
DescriptionSpecifiesthehighreferencetheoscilloscopeusesforwaveformmeasurements.ThevalueisapercentageofthedifferencebetweentheVoltageHighandVoltageLow.TheoscilloscopecalculatestheVoltageHighandtheVoltageLowusingeitherthemin/maxorhistogrammethods.Themin/maxmethodusesthemaximumandminimumvaluesfound.Thehistogrammethodusesthemostcommonvaluesfoundaboveandbelowthemiddleofthewaveform.PropertyNodePathIviScope»WaveformMeasurement[WM]»MeasurementHighReference[WM]
IviScopeMeasurementLowReferenceIviScopeMeasWaveformProperty[WM]DataType Access Applies
to Coercion HighLevelVIs
R/W N/A None IviScopeConfigureReferenceLevels
DescriptionSpecifiesthelowreferencetheoscilloscopeusesforwaveformmeasurements.ThevalueisapercentageofthedifferencebetweentheVoltageHighandVoltageLow.TheoscilloscopecalculatestheVoltageHighandtheVoltageLowusingeitherthemin/maxorhistogrammethods.Themin/maxmethodusesthemaximumandminimumvaluesfound.Thehistogrammethodusesthemostcommonvaluesfoundaboveandbelowthemiddleofthewaveform.PropertyNodePathIviScope»WaveformMeasurement[WM]»MeasurementLowReference[WM]
IviScopeMeasurementMidReference[WM]IviScopeMeasWaveformProperty[WM]DataType Access Applies
to Coercion HighLevelVIs
R/W N/A None IviScopeConfigureReferenceLevels
DescriptionSpecifiesthemidreferencetheoscilloscopeusesforwaveformmeasurements.ThevalueisapercentageofthedifferencebetweentheVoltageHighandVoltageLow.TheoscilloscopecalculatestheVoltageHighandtheVoltageLowusingeitherthemin/maxorhistogrammethods.Themin/maxmethodusesthemaximumandminimumvaluesfound.Thehistogrammethodusesthemostcommonvaluesfoundaboveandbelowthemiddleofthewaveform.PropertyNodePathIviScope»WaveformMeasurement[WM]»MeasurementMidReference[WM]
IviScopeNumberofAverages[AA]IviScopeAverageAcquisitionProperty[AA]DataType Access Applies
to Coercion HighLevelVIs
R/W N/A None IviScopeConfigureNumberofAverages
DescriptionSpecifiesthenumberofwaveformtheoscilloscopeacquiresandaverages.Aftertheoscilloscopeacquiresasmanywaveformsasthispropertyspecifies,itreturnstotheIdlestate.ThispropertyaffectsinstrumentbehavioronlywhentheIviScopeAcquisitionTypepropertyissettoIVISCOPE_VAL_AVERAGE.PropertyNodePathIviScope»Acquisition»NumberofAverages[AA]
IviScopeNumberofEnvelopes[MmW]IviScopeMinMaxWaveformProperty[MmW]DataType Access Applies
to Coercion HighLevelVIs
R/W N/A None IviScopeConfigureNumberofEnvelopes
DescriptionWhenyousettheIviScopeAcquisitionTypepropertytoIVISCOPE_VAL_ENVELOPE,theoscilloscopeacquiresmultiplewaveforms.Aftereachwaveformacquisition,theoscilloscopekeepstheminimumandmaximumvaluesitfindsforeachpointinthewaveformrecord.Thispropertyspecifiesthenumberofwaveformstheoscilloscopeacquiresandanalyzestocreatetheminimumandmaximumwaveforms.Aftertheoscilloscopeacquiresasmanywaveformsasthispropertyspecifies,itreturnstotheIdlestate.ThispropertyaffectsinstrumentoperationonlywhentheIviScopeAcquisitionTypepropertyissettoIVISCOPE_VAL_ENVELOPE.PropertyNodePathIviScope»Acquisition»NumberofEnvelopes[MmW]
IviScopeProbeAttenuationIviScopeBasePropertyDataType Access Appliesto Coercion HighLevelVIs
R/W Channel None IviScopeConfigureChannel
DescriptionThischannel-basedpropertyspecifiesthescalingfactorbywhichtheprobeyouattachtothechannelattenuatestheinput.Forexample,whenyouusea10:1probe,setthispropertyto10.0.Thisdriverreservesnegativevaluestocontroltheoscilloscope'sautomaticprobesensecapability.SettingthispropertytoIVISCOPE_VAL_PROBE_SENSE_ONconfigurestheoscilloscopetosensetheattenuationoftheprobeautomatically.Afteryouenabletheautomaticprobesense,subsequentqueriesofthispropertyreturnthevalueIVISCOPE_VAL_PROBE_SENSE_ON.UsetheIviScopeProbeSenseValue[PAS]propertytoobtaintheactualprobeattenuation.Ifyousettheoscilloscopetosensetheprobeattenuationautomatically,theprobeattenuationvaluecanchangeatanytime.Whentheoscilloscopedetectsanewprobeattenuationvalue,othersettingsintheoscilloscopemightalsochange.Thedriverhasnowayofknowingwhenthesechangesoccur.Therefore,whenyouenabletheautomaticprobesensecapability,thisdriverdisablescachingforpropertiesthatdependontheprobeattenuation.ThesepropertiesincludeIviScopeVerticalRange,IviScopeVerticalOffset,andallthepropertiesthatconfiguretriggerlevels.Tomaximizeperformance,setthispropertytoamanualprobeattenuationsetting.Iftheoscilloscopeissettosensetheprobeattenuationautomatically,settingthispropertytoapositivevaluedisablestheautomaticprobesenseandconfigurestheoscilloscopetousethemanualprobeattenuationyouspecify.Ifyouuseamanualprobeattenuation,youmustsetthispropertytoreflectthenewprobeattenuationeachtimeyouattachadifferentprobe.PropertyNodePathIviScope»Channel»AttenuationDefinedValues
IVISCOPE_VAL_PROBE_SENSE_ON
IviScopeProbeSenseValueIviScopeProbeAutoSensePropertyDataType Access Applies
to Coercion HighLevelVIs
RO Channel N/A IviScopeAutoProbeSenseValue
DescriptionThischannel-basedpropertyreturnstheprobeattenuationvaluetheoscilloscopeautomaticallysenses.Ifyoudisabletheautomaticprobesensecapability,thispropertyreturnsthemanualprobeattenuationsetting.PropertyNodePathIviScope»Channel»ProbeSenseValue
IviScopeRuntHighThreshold[RT]IviScopeRuntTriggerProperty[RT]DataType Access Applies
to Coercion HighLevelVIs
R/W N/A None IviScopeConfigureRuntTriggerSource
DescriptionSpecifiesthehighthresholdtheoscilloscopeusesforrunttriggering.Theunitsarevolts.ThispropertyaffectsinstrumentoperationonlywhentheIviScopeTriggerTypepropertyissettoIVISCOPE_VAL_RUNT_TRIGGER.PropertyNodePathIviScope»Trigger»RuntTriggering[RT]»RuntHighThreshold[RT]
IviScopeRuntLowThreshold[RT]IviScopeRuntTriggerProperty[RT]DataType Access Applies
to Coercion HighLevelVIs
R/W N/A None IviScopeConfigureRuntTriggerSource
DescriptionSpecifiesthelowthresholdtheoscilloscopeusesforrunttriggering.Theunitsarevolts.ThispropertyaffectsinstrumentoperationonlywhentheIviScopeTriggerTypepropertyissettoIVISCOPE_VAL_RUNT_TRIGGER.PropertyNodePathIviScope»Trigger»RuntTriggering[RT]»RuntLowThreshold[RT]
IviScopeRuntPolarity[RT]IviScopeRuntTriggerProperty[RT]DataType Access Applies
to Coercion HighLevelVIs
R/W N/A None IviScopeConfigureRuntTriggerSource
DescriptionSpecifiesthepolarityoftheruntthattriggerstheoscilloscope.ThispropertyaffectsinstrumentoperationonlywhentheIviScopeTriggerTypepropertyissettoIVISCOPE_VAL_RUNT_TRIGGER.PropertyNodePathIviScope»Trigger»RuntTriggering[RT]»RuntPolarity[RT]DefinedValuesIVISCOPE_VAL_RUNT_POSITIVEIVISCOPE_VAL_RUNT_NEGATIVEIVISCOPE_VAL_RUNT_EITHER
IviScopeSampleMode[SM]IviScopeSampleModePropertyDataType Access Appliesto Coercion HighLevelVIs
RO N/A N/A IviScopeActualSampleMode
DescriptionReturnsthesamplemodetheoscilloscopeiscurrentlyusing.PropertyNodePathIviScope»Acquisition»SampleMode[SM]DefinedValuesIVISCOPE_VAL_REAL_TIMEIVISCOPE_VAL_EQUIVALENT_TIME
IviScopeTriggerCouplingIviScopeBasePropertyDataType Access Applies
to Coercion HighLevelVIs
R/W N/A None IviScopeConfigureTriggerCoupling
DescriptionSpecifieshowtheoscilloscopecouplesthetriggersource.PropertyNodePathIviScope»Trigger»TriggerCouplingDefinedValuesIVISCOPE_VAL_ACIVISCOPE_VAL_DCIVISCOPE_VAL_HF_REJECTIVISCOPE_VAL_LF_REJECTIVISCOPE_VAL_NOISE_REJECT
IviScopeTriggerHoldoffIviScopeBasePropertyDataType Access Applies
to Coercion HighLevelVIs
R/W N/A SeeNoteBelow
IviScopeConfigureTrigger
NoteManyscopeshaveasmall,non-zerovalueastheminimumvalueforthisproperty.Toconfiguretheinstrumenttousetheshortesttriggerholdoff,youcanspecifyavalueofzeroforthisproperty.
DescriptionSpecifiesthelengthoftimetheoscilloscopewaitsafteritdetectsatriggeruntiltheoscilloscopeenablesthetriggersubsystemtodetectanothertrigger.Theunitsareseconds.TheIviScopeTriggerHoldoffpropertyaffectsinstrumentoperationonlywhentheoscilloscoperequiresmultipleacquisitionstobuildacompletewaveform.Theoscilloscoperequiresmultiplewaveformacquisitionswhenitusesequivalent-timesamplingorwhenyousettheIviScopeAcquisitionTypepropertytoIVISCOPE_VAL_ENVELOPEorIVISCOPE_VAL_AVERAGE.PropertyNodePathIviScope»Trigger»TriggerHoldoff
IviScopeTriggerLevelIviScopeBasePropertyDataType Access Applies
to Coercion HighLevelVIs
R/W N/A None IviScopeConfigureEdgeTriggerSourceIviScopeConfigureGlitchTriggerSourceIviScopeConfigureWidthTriggerSource
DescriptionSpecifiesthevoltagethresholdforthetriggersubsystem.Theunitsarevolts.ThispropertyaffectsinstrumentbehavioronlywhenyousettheIviScopeTriggerTypetoIVISCOPE_VAL_EDGE_TRIGGER,IVISCOPE_VAL_GLITCH_TRIGGER,orIVISCOPE_VAL_WIDTH_TRIGGER.PropertyNodePathIviScope»Trigger»TriggerLevel
IviScopeTriggerModifier[TM]IviScopeTriggerModifierProperty[TM]DataType Access Applies
to Coercion HighLevelVIs
R/W N/A None IviScopeConfigureTriggerModifier
DescriptionSpecifiesthetriggermodifier.Thetriggermodifierdeterminestheoscilloscope'sbehaviorintheabsenceofthetriggeryouconfigure.PropertyNodePathIviScope»Trigger»TriggerModifier[TM]DefinedValuesIVISCOPE_VAL_NO_TRIGGER_MODIVISCOPE_VAL_AUTOIVISCOPE_VAL_AUTO_LEVEL
IviScopeTriggerSlopeIviScopeBasePropertyDataType Access Applies
to Coercion HighLevelVIs
R/W N/A None IviScopeConfigureEdgeTriggerSource
DescriptionSpecifieswhetherarisingorafallingedgetriggerstheoscilloscope.ThispropertyeffectsinstrumentoperationonlywhentheIviScopeTriggerTypepropertyissettoIVISCOPE_VAL_EDGE_TRIGGER.PropertyNodePathIviScope»Trigger»TriggerSlopeDefinedValuesIVISCOPE_VAL_POSITIVEIVISCOPE_VAL_NEGATIVE
IviScopeTriggerSourceIviScopeBasePropertyDataType Access Applies
to Coercion HighLevelVIs
R/W N/A None IviScopeConfigureEdgeTriggerSourceIviScopeConfigureTVTriggerSourceIviScopeConfigureRuntTriggerSourceIviScopeConfigureGlitchTriggerSourceIviScopeConfigureWidthTriggerSource
DescriptionSpecifiesthesourcetheoscilloscopemonitorsforatrigger.Setthispropertytoachannelnameortooneofthedefinedvalues.PropertyNodePathIviScope»Trigger»TriggerSourceDefinedValuesIVISCOPE_VAL_EXTERNALIVISCOPE_VAL_TTL0IVISCOPE_VAL_TTL1IVISCOPE_VAL_TTL2IVISCOPE_VAL_TTL3IVISCOPE_VAL_TTL4IVISCOPE_VAL_TTL5IVISCOPE_VAL_TTL6IVISCOPE_VAL_TTL7IVISCOPE_VAL_ECL0
IVISCOPE_VAL_ECL1IVISCOPE_VAL_PXI_STARIVISCOPE_VAL_RTSI_0IVISCOPE_VAL_RTSI_1IVISCOPE_VAL_RTSI_2IVISCOPE_VAL_RTSI_3IVISCOPE_VAL_RTSI_4IVISCOPE_VAL_RTSI_5IVISCOPE_VAL_RTSI_6
IviScopeTriggerTypeIviScopeBasePropertyDataType Access Appliesto Coercion HighLevelVIs
R/W N/A None IviScopeConfigureTrigger
DescriptionThispropertyspecifiesthetriggertype.PropertyNodePathIviScope»Trigger»TriggerTypeDefinedValuesIVISCOPE_VAL_EDGE_TRIGGERIVISCOPE_VAL_WIDTH_TRIGGERIVISCOPE_VAL_RUNT_TRIGGERIVISCOPE_VAL_GLITCH_TRIGGERIVISCOPE_VAL_TV_TRIGGERIVISCOPE_VAL_IMMEDIATE_TRIGGERIVISCOPE_VAL_AC_LINE_TRIGGER
IviScopeTVTriggerEvent[TV]IviScopeTVTriggerProperty[TV]DataType
Access Appliesto
Coercion HighLevelVIs
R/W N/A None IviScopeConfigureTVTriggerSource
DescriptionSpecifiestheeventonwhichtheoscilloscopetriggers.ThispropertyaffectsinstrumentoperationonlywhentheIviScopeTriggerTypepropertyissettoIVISCOPE_VAL_TV_TRIGGER.PropertyNodePathIviScope»Trigger»TVTriggering[TV]»TVTriggerEvent[TV]DefinedValuesIVISCOPE_VAL_TV_EVENT_FIELD1IVISCOPE_VAL_TV_EVENT_FIELD2IVISCOPE_VAL_TV_EVENT_ANY_FIELDIVISCOPE_VAL_TV_EVENT_ANY_LINEIVISCOPE_VAL_TV_EVENT_LINE_NUMBER
IviScopeTVTriggerLineNumber[TV]IviScopeTVTriggerProperty[TV]DataType
Access Appliesto
Coercion HighLevelVIs
R/W N/A None IviScopeConfigureTVTriggerSource
DescriptionSpecifiesthelineonwhichtheoscilloscopetriggers.ThispropertyaffectsinstrumentoperationonlywhentheIviScopeTriggerTypepropertyissettoIVISCOPE_VAL_TV_TRIGGERandwhentheIviScopeTVTriggerEvent[TV]propertyissettoIVISCOPE_VAL_LINE_NUMBER.Thelinenumbersettingisindependentofthefield.Thismeansthattotriggeronthefirstlineofthesecondfield,youmustsetthispropertytothevalueof263(assumingthatfieldonehad262lines).PropertyNodePathIviScope»Trigger»TVTriggering[TV]»TVTriggerLineNumber[TV]
IviScopeTVTriggerPolarity[TV]IviScopeTVTriggerProperty[TV]DataType Access Applies
to Coercion HighLevelVIs
R/W N/A None IviScopeConfigureTVTriggerSource
DescriptionSpecifiesthepolarityoftheTVsignal.ThispropertyaffectsinstrumentoperationonlywhentheIviScopeTriggerTypepropertyissettoIVISCOPE_VAL_TV_TRIGGER.PropertyNodePathIviScope»Trigger»TVTriggering[TV]»TVTriggerPolarity[TV]DefinedValuesIVISCOPE_VAL_TV_POSITIVEIVISCOPE_VAL_TV_NEGATIVE
IviScopeTVTriggerSignalFormat[TV]IviScopeTVTriggerProperty[TV]DataType
Access Appliesto
Coercion HighLevelVIs
R/W N/A None IviScopeConfigureTVTriggerSource
DescriptionSpecifiestheformatoftheTVsignalonwhichtheoscilloscopetriggers.ThispropertyaffectsinstrumentoperationonlywhentheIviScopeTriggerTypepropertyissettoIVISCOPE_VAL_TV_TRIGGER.PropertyNodePathIviScope»Trigger»TVTriggering[TV]»TVTriggerSignalFormat[TV]DefinedValuesIVISCOPE_VAL_NTSCIVISCOPE_VAL_PALIVISCOPE_VAL_SECAM
IviScopeVerticalCouplingIviScopeBasePropertyDataType Access Appliesto Coercion HighLevelVIs
R/W Channel None IviScopeConfigureChannel
DescriptionThischannel-basedpropertyspecifieshowtheoscilloscopecouplestheinputsignalforthechannel.PropertyNodePathIviScope»Channel»VerticalCouplingDefinedValuesIVISCOPE_VAL_ACIVISCOPE_VAL_DCIVISCOPE_VAL_GND
IviScopeVerticalOffsetIviScopeBasePropertyDataType Access Appliesto Coercion HighLevelVIs
R/W Channel None IviScopeConfigureChannel
DescriptionThischannel-basedpropertyspecifiesthelocationofthecenteroftherangethatyouspecifywiththeIviScopeVerticalRangeproperty.Expressthevalueinvoltsandwithrespecttoground.Forexample,toacquireasinewavethatspansbetween0.0and10.0V,setthispropertyto5.0V.PropertyNodePathIviScope»Channel»VerticalOffset
IviScopeVerticalRangeIviScopeBasePropertyDataType Access Appliesto Coercion HighLevelVIs
R/W Channel Up IviScopeConfigureChannel
DescriptionThischannel-basedpropertyspecifiestheabsolutevalueoftheinputrangetheoscilloscopecanacquireforthechannel.Theunitsarevolts.Forexample,toacquireasinewavewhichspansbetween–5.0and5.0V,yousetthispropertyto10.0V.PropertyNodePathIviScope»Channel»VerticalRange
IviScopeWidthCondition[WT]IviScopeWidthTriggerProperty[WT]DataType Access Applies
to Coercion HighLevelVIs
R/W N/A None IviScopeConfigureWidthTriggerSource
DescriptionSpecifieswhetherapulsethatiswithinoroutsidethehighandlowthresholdstriggerstheoscilloscope.YouspecifythehighandlowthresholdswiththeIviScopeWidthHighThreshold[WT]andIviScopeWidthLowThreshold[WT]properties.ThispropertyaffectsinstrumentoperationonlywhentheIviScopeTriggerTypepropertyissettoIVISCOPE_VAL_WIDTH_TRIGGER.PropertyNodePathIviScope»TriggerSubsystem»WidthTriggering[WT]»WidthCondition[WT]DefinedValuesIVISCOPE_VAL_WIDTH_WITHINIVISCOPE_VAL_WIDTH_OUTSIDE
IviScopeWidthHighThreshold[WT]IviScopeWidthTriggerProperty[WT]DataType Access Applies
to Coercion HighLevelVIs
R/W N/A None IviScopeConfigureWidthTriggerSource
DescriptionSpecifiesthehighwidththresholdtime.Theunitsareseconds.ThispropertyaffectsinstrumentoperationonlywhentheIviScopeTriggerTypepropertyissettoIVISCOPE_VAL_WIDTH_TRIGGER.PropertyNodePathIviScope»Trigger»WidthTriggering[WT]»WidthHighThreshold[WT]
IviScopeWidthLowThreshold[WT]IviScopeWidthTriggerProperty[WT]DataType Access Applies
to Coercion HighLevelVIs
R/W N/A None IviScopeConfigureWidthTriggerSource
DescriptionSpecifiesthelowwidththresholdtime.Theunitsareseconds.ThispropertyaffectsinstrumentoperationonlywhentheIviScopeTriggerTypepropertyissettoIVISCOPE_VAL_WIDTH_TRIGGER.PropertyNodePathIviScope»Trigger»WidthTriggering[WT]»WidthLowThreshold[WT]
IviScopeWidthPolarity[WT]IviScopeWidthTriggerProperty[WT]DataType Access Applies
to Coercion HighLevelVIs
R/W N/A None IviScopeConfigureWidthTriggerSource
DescriptionSpecifiesthepolarityofthepulsethattriggerstheoscilloscope.ThispropertyaffectsinstrumentoperationonlywhentheviScopeTriggerTypepropertyissettoIVISCOPE_VAL_WIDTH_TRIGGER.PropertyNodePathIviScope»Trigger»WidthTriggering[WT]»WidthPolarity[WT]DefinedValuesIVISCOPE_VAL_WIDTH_POSITIVEIVISCOPE_VAL_WIDTH_NEGATIVE
IviScopeValuesExpandthisbooktoviewanalphabetizedlistofIviScopevalues.
IVISCOPE_VAL_AC_LINE_EITHERConfigurestheoscilloscopetotriggeroneitherpositiveornegativeslopezerocrossingsofthenetworksupplyvoltage.DefinedValue:3
IVISCOPE_VAL_AC_LINE_NEGATIVEConfigurestheoscilloscopetotriggeronnegativeslopezerocrossingsofthenetworksupplyvoltage.DefinedValue:2
IVISCOPE_VAL_AC_LINE_POSITIVEConfigurestheoscilloscopetotriggeronpositiveslopezerocrossingsofthenetworksupplyvoltage.DefinedValue:1
IVISCOPE_VAL_AC_LINE_TRIGGERConfigurestheoscilloscopeforAClinetriggering.AnACLinetriggeroccurswhentheoscilloscopedetectsapositivezerocrossing,negativezerocrossing,oroptionallyeitherpositiveornegativezerocrossingofthenetworksupplyvoltage.DefinedValue:7
IVISCOPE_VAL_AC_TRIGGERTheoscilloscopeACcouplesthetriggersignal.DefinedValue:0
IVISCOPE_VAL_AC_Trigger_CouplingTheoscilloscopeACcouplesthetriggersignal.DefinedValue:0
IVISCOPE_VAL_AC_VERTICAL_COUPLINGTheoscilloscopeACcouplestheinputsignal.DefinedValue:0
IVISCOPE_VAL_ACQ_COMPLETEDefinedValue:1
IVISCOPE_VAL_ACQ_IN_PROGRESSDefinedValue:0
IVISCOPE_VAL_ACQ_STATUS_UNKNOWNDefinedValue:-1
IVISCOPE_VAL_AUTOTheoscilloscopeautomaticallytriggersiftheconfiguredtriggerdoesnotoccurwithintheoscilloscope'stimeoutperiod.DefinedValue:2
IVISCOPE_VAL_AUTO_LEVELTheoscilloscopeadjuststhetriggerlevelifthetriggeryouspecifydoesnotoccurwithintheoscilloscope'stimeoutperiod.DefinedValue:3
IVISCOPE_VAL_AVERAGEConfigurestheoscilloscopetoacquiremultiplewaveformsandcalculatetheaveragevalueforeachpointinthewaveformrecord.YouspecifythenumberofwaveformstoacquirewiththeIVISCOPE_ATTR_NUM_AVERAGESproperty.Theoscilloscopeusesreal-timeorequivalenttimesampling.DefinedValue:4
IVISCOPE_VAL_DC_TRIGGERTheoscilloscopeDCcouplesthetriggersignal.DefinedValue:1
IVISCOPE_VAL_DC_Trigger_CouplingTheoscilloscopeDCcouplesthetriggersignal.DefinedValue:1
IVISCOPE_VAL_DC_VERTICAL_COUPLINGTheoscilloscopeDCcouplestheinputsignal.DefinedValue:1
IVISCOPE_VAL_ECL0TheoscilloscopewaitsuntilitreceivesatriggerontheECL0line.DefinedValue:"VAL_ECL0"
IVISCOPE_VAL_ECL1TheoscilloscopewaitsuntilitreceivesatriggerontheECL1line.DefinedValue:"VAL_ECL1"
IVISCOPE_VAL_EDGE_TRIGGERConfigurestheoscilloscopeforedgetriggering.AnedgetriggeroccurswhenthetriggersignalpassesthroughthevoltagethresholdspecifiedbytheIVISCOPE_ATTR_TRIGGER_LEVELpropertyandhastheslopespecifiedbytheIVISCOPE_ATTR_TRIGGER_SLOPEproperty.DefinedValue:1
IVISCOPE_VAL_ENVELOPESetstheoscilloscopetotheenvelopeacquisitionmode.Theoscilloscopeacquiresmultiplewaveformsandkeepstheminimumandmaximumvoltagesitacquiresforeachpointinthewaveformrecord.YouspecifythenumberofwaveformstheoscilloscopeacquireswiththeIVISCOPE_ATTR_NUM_ENVELOPESproperty.Theoscilloscopecanusereal-timeorequivalent-timesampling.DefinedValue:3
IVISCOPE_VAL_EQUIVALENT_TIMEIndicatesthattheoscilloscopeisusingequivalenttimesampling.DefinedValue:1
IVISCOPE_VAL_EXTERNALTheoscilloscopewaitsforatriggerontheexternaltriggerinput.DefinedValue:"VAL_EXTERNAL"
IVISCOPE_VAL_GLITCH_EITHERTheoscilloscopetriggersoneitherapositiveornegativeglitch.DefinedValue:3
IVISCOPE_VAL_GLITCH_GREATER_THANTheoscilloscopetriggerswhenthepulsewidthisgreaterthanthevalueyouspecifywiththeIVISCOPE_ATTR_GLITCH_WIDTHproperty.DefinedValue:2
IVISCOPE_VAL_GLITCH_LESS_THANTheoscilloscopetriggerswhenthepulsewidthislessthanthevalueyouspecifywiththeIVISCOPE_ATTR_GLITCH_WIDTHattribute.DefinedValue:1
IVISCOPE_VAL_GLITCH_NEGATIVETheoscilloscopetriggersonanegativeglitch.DefinedValue:2
IVISCOPE_VAL_GLITCH_POSITIVETheoscilloscopetriggersonapositiveglitch.DefinedValue:1
IVISCOPE_VAL_GLITCH_TRIGGERConfigurestheoscilloscopeforglitchtriggering.Aglitchtriggeroccurswhenthetriggersignalhasapulsewithawidththatislessthantheglitchwidth.YouspecifytheglitchwidthwiththeIVISCOPE_ATTR_GLITCH_WIDTHproperty.YouspecifythepolarityofthepulsewiththeIVISCOPE_ATTR_GLITCH_POLARITYproperty.ThetriggerdoesnotactuallyoccuruntiltheedgeofapulsethatcorrespondstotheglitchwidthandpolarityyouspecifycrossesthetriggerlevelthatyouspecifywiththeIVISCOPE_ATTR_TRIGGER_LEVELproperty.DefinedValue:4
IVISCOPE_VAL_GNDTheoscilloscopegroundcouplestheinputsignal.DefinedValue:2
IVISCOPE_VAL_HF_REJECTTheoscilloscopefiltersoutthelowfrequenciesfromthetriggersignal.DefinedValue:3
IVISCOPE_VAL_HI_RESConfigurestheoscilloscopetooversampletheinputsignalTheoscilloscopecalculatestheaveragevaluethatcorrespondstoeachpositioninthewaveformrecord.Theoscilloscopeusesonlyreal-timesampling.DefinedValue:2
IVISCOPE_VAL_IMMEDIATE_TRIGGERTheoscilloscopedoesnotwaitforatriggerofanykind.DefinedValue:6
IVISCOPE_VAL_LF_REJECTTheoscilloscopefiltersoutthehighfrequenciesfromthetriggersignal.DefinedValue:4
IVISCOPE_VAL_LINEARTheoscilloscopeusesalinearapproximationtointerpolateavaluewhenitcannotresolveavoltageinthewaveformrecord.DefinedValue:3
IVISCOPE_VAL_MAX_TIME_IMMEDIATEThefunctionreturnsimmediately.Ifnovalidmeasurementvalueexists,thefunctionreturnsanerror.DefinedValue:0x0
IVISCOPE_VAL_MAX_TIME_INFINITEThefunctionwaitsindefinitelyforthemeasurementtocomplete.DefinedValue:0xFFFFFFFFUL
IVISCOPE_VAL_NEGATIVEAnegative(falling)edgepassingthroughthetriggerleveltriggerstheoscilloscope.DefinedValue:0
IVISCOPE_VAL_NO_INTERPOLATIONTheoscilloscopedoesnotinterpolatepointsinthewaveform.Instead,thedriversetseveryelementinthewaveformarrayforwhichtheoscilloscopecannotresolveavaluetoanIEEE-definedNaN(NotaNumber)value.DefinedValue:1
IVISCOPE_VAL_NO_TRIGGER_MODTheoscilloscopewaitsuntilthetriggeryouspecifyoccurs.DefinedValue:1
IVISCOPE_VAL_NOISE_REJECTTheoscilloscopefiltersoutthenoisefromthetriggersignal.DefinedValue:5
IVISCOPE_VAL_NORMALConfigurestheoscilloscopetoacquireonesampleforeachpointinthewaveformrecord.Theoscilloscopeusesreal-timeorequivalenttimesampling.DefinedValue:0
IVISCOPE_VAL_NTSCSetstheTVtriggersignalformattoNTSC.DefinedValue:1
IVISCOPE_VAL_PALSetstheTVtriggersignalformattoPAL.DefinedValue:2
IVISCOPE_VAL_PEAK_DETECTSetstheoscilloscopetothepeak-detectacquisitionmode.Theoscilloscopeoversamplestheinputsignalandkeepstheminimumandmaximumvaluesthatcorrespondtoeachpositioninthewaveformrecord.Theoscilloscopeusesonlyreal-timesampling.DefinedValue:1
IVISCOPE_VAL_POSITIVEApositive(rising)edgepassingthroughthetriggerleveltriggerstheoscilloscope.DefinedValue:1
IVISCOPE_VAL_PROBE_SENSE_ONSettingthispropertytoIVISCOPE_VAL_PROBE_SENSE_ONconfigurestheoscilloscopetosensetheattenuationoftheprobeautomatically.Afteryouenabletheautomaticprobesense,subsequentqueriesofthispropertyreturnthevalueIVISCOPE_VAL_PROBE_SENSE_ON.UsetheIVISCOPE_ATTR_PROBE_SENSE_VALUEpropertytoobtaintheactualprobeattenuation.Ifyousettheoscilloscopetosensetheprobeattenuationautomatically,theprobeattenuationvaluecanchangeatanytime.Whentheoscilloscopedetectsanewprobeattenuationvalue,othersettingsintheoscilloscopemightalsochange.Thedriverhasnowayofknowingwhenthesechangesoccur.Therefore,whenyouenabletheautomaticprobesensecapability,thedriverdisablescachingforpropertiesthatdependontheprobeattenuation.ThesepropertiesincludeIVISCOPE_ATTR_VERTICAL_RANGE,IVISCOPE_ATTR_VERTICAL_OFFSET,andallthepropertiesthatconfiguretriggerlevels.Tomaximizeperformance,youshouldsetthispropertytoamanualprobeattenuationsetting.Iftheoscilloscopeissettosensetheprobeattenuationautomatically,settingthispropertytoapositivevaluedisablestheautomaticprobesenseandconfigurestheoscilloscopetousethemanualprobeattenuationyouspecify.DefinedValue:-1
IVISCOPE_VAL_PXI_STARTheoscilloscopewaitsuntilitreceivesatriggeronthePXIStarbus.DefinedValue:"VAL_PXI_STAR"
IVISCOPE_VAL_REAL_TIMEIndicatesthattheoscilloscopeisusingreal-timesampling.DefinedValue:0
IVISCOPE_VAL_RTSI_0TheoscilloscopewaitsuntilitreceivesatriggerontheRTSI0line.DefinedValue:"VAL_RTSI_0"
IVISCOPE_VAL_RTSI_1TheoscilloscopewaitsuntilitreceivesatriggerontheRTSI1line.DefinedValue:"VAL_RTSI_1"
IVISCOPE_VAL_RTSI_2TheoscilloscopewaitsuntilitreceivesatriggerontheRTSI2line.DefinedValue:"VAL_RTSI_2"
IVISCOPE_VAL_RTSI_3TheoscilloscopewaitsuntilitreceivesatriggerontheRTSI3line.DefinedValue:"VAL_RTSI_3"
IVISCOPE_VAL_RTSI_4TheoscilloscopewaitsuntilitreceivesatriggerontheRTSI4line.DefinedValue:"VAL_RTSI_4"
IVISCOPE_VAL_RTSI_5TheoscilloscopewaitsuntilitreceivesatriggerontheRTSI5line.DefinedValue:"VAL_RTSI_5"
IVISCOPE_VAL_RTSI_6TheoscilloscopewaitsuntilitreceivesatriggerontheRTSI6line.DefinedValue:"VAL_RTSI_6"
IVISCOPE_VAL_RUNT_EITHERTheoscilloscopetriggersoneitherapositiveornegativerunt.DefinedValue:3
IVISCOPE_VAL_RUNT_NEGATIVETheoscilloscopetriggersonanegativerunt.Anegativeruntoccurswhenafallingedgecrossesthehighruntthresholdanddoesnotcrossthelowruntthresholdbeforere-crossingthehighruntthreshold.DefinedValue:2
IVISCOPE_VAL_RUNT_POSITIVETheoscilloscopetriggersonapositiverunt.Apositiveruntoccurswhenarisingedgecrossesthelowruntthresholdanddoesnotcrossthehighruntthresholdbeforere-crossingthelowruntthreshold.DefinedValue:1
IVISCOPE_VAL_RUNT_TRIGGERConfigurestheoscilloscopeforrunttriggering.Arunttriggeroccurswhenthetriggersignalcrossesoneoftheruntthresholdstwicewithoutcrossingtheotherruntthreshold.YouspecifytheruntthresholdswiththeIVISCOPE_ATTR_RUNT_HIGH_THRESHOLDandIVISCOPE_ATTR_RUNT_LOW_THRESHOLDproperties.YouspecifythepolarityoftheruntwiththeIVISCOPE_ATTR_RUNT_POLARITYproperties.DefinedValue:3
IVISCOPE_VAL_SECAMSetstheTVtriggersignalformattoSECAM.DefinedValue:3
IVISCOPE_VAL_SINE_XTheoscilloscopeusesasine(x)/xcalculationtointerpolateavaluewhenitcannotresolveavoltageinthewaveformrecord.DefinedValue:2
IVISCOPE_VAL_TTL0TheoscilloscopewaitsuntilitreceivesatriggerontheTLL0line.DefinedValue:"VAL_TTL0"
IVISCOPE_VAL_TTL1TheoscilloscopewaitsuntilitreceivesatriggerontheTLL1line.DefinedValue:"VAL_TTL1"
IVISCOPE_VAL_TTL2TheoscilloscopewaitsuntilitreceivesatriggerontheTLL2line.DefinedValue:"VAL_TTL2"
IVISCOPE_VAL_TTL3TheoscilloscopewaitsuntilitreceivesatriggerontheTLL3line.DefinedValue:"VAL_TTL3"
IVISCOPE_VAL_TTL4TheoscilloscopewaitsuntilitreceivesatriggerontheTLL4line.DefinedValue:"VAL_TTL4"
IVISCOPE_VAL_TTL5TheoscilloscopewaitsuntilitreceivesatriggerontheTLL5line.DefinedValue:"VAL_TTL5"
IVISCOPE_VAL_TTL6TheoscilloscopewaitsuntilitreceivesatriggerontheTLL6line.DefinedValue:"VAL_TTL6"
IVISCOPE_VAL_TTL7TheoscilloscopewaitsuntilitreceivesatriggerontheTLL7line.DefinedValue:"VAL_TTL7"
IVISCOPE_VAL_TV_EVENT_ANY_FIELDSetstheoscilloscopetotriggeronanyfield.DefinedValue:3
IVISCOPE_VAL_TV_EVENT_ANY_LINESetstheoscilloscopetotriggeronanyline.DefinedValue:4
IVISCOPE_VAL_TV_EVENT_FIELD1Setstheoscilloscopetotriggeronfield1ofthevideosignal.DefinedValue:1
IVISCOPE_VAL_TV_EVENT_FIELD2Setstheoscilloscopetotriggeronfield2ofthevideosignal.DefinedValue:2
IVISCOPE_VAL_TV_EVENT_LINE_NUMBERSetstheoscilloscopetotriggeronaspecificlinenumberyouspecifywiththeIVISCOPE_ATTR_TV_TRIGGER_LINE_NUMBERproperty.DefinedValue:5
IVISCOPE_VAL_TV_FIELD1Field1ofthevideosignal.DefinedValue:1
IVISCOPE_VAL_TV_FIELD2Field2ofthevideosignal.DefinedValue:2
IVISCOPE_VAL_TV_NEGATIVENegativevideosyncpulse.DefinedValue:2
IVISCOPE_VAL_TV_POSITIVEPositivevideosyncpulse.DefinedValue:1
IVISCOPE_VAL_TV_TRIGGERConfigurestheoscilloscopetotriggeronTVsignals.YouconfigurethetriggerwiththeIVISCOPE_TV_TRIGGER_SIGNAL_FORMAT,IVISCOPE_TV_TRIGGER_LINE_NUMBER,andIVISCOPE_ATTR_TV_TRIGGER_POLARITYproperties.DefinedValue:5
IVISCOPE_VAL_WIDTH_NEGATIVEConfigurestheoscilloscopetotriggeronnegativepulsesthathaveawidththatmeetstheconditionyouspecifywiththeIVISCOPE_ATTR_WIDTH_CONDITIONproperty.DefinedValue:2
IVISCOPE_VAL_WIDTH_OUTSIDEConfigurestheoscilloscopetotriggeronpulsesthathaveawidththatiseithergreaterthanthehighthresholdorlessthanalowthreshold.YouspecifythehighandlowthresholdswiththeIVISCOPE_ATTR_WIDTH_HIGH_THRESHOLDandIVISCOPE_ATTR_WIDTH_LOW_THRESHOLDproperties.DefinedValue:2
IVISCOPE_VAL_WIDTH_POSITIVEConfigurestheoscilloscopetotriggeronpositivepulsesthathaveawidththatmeetstheconditionyouspecifywiththeIVISCOPE_ATTR_WIDTH_CONDITIONproperty.DefinedValue:1
IVISCOPE_VAL_WIDTH_TRIGGERConfigurestheoscilloscopeforwidthtriggering.Awidthtriggeroccurswhentheoscilloscopedetectsapositiveornegativepulsewithawidthbetween,oroptionallyoutside,thewidththresholds.YouspecifythewidththresholdswiththeIVISCOPE_ATTR_WIDTH_HIGH_THRESHOLDandIVISCOPE_ATTR_WIDTH_LOW_THRESHOLDproperties.YouspecifywhethertheoscilloscopetriggersonpulsewidthsthatarewithinoroutsidethewidththresholdswiththeIVISCOPE_ATTR_WIDTH_CONDITIONproperty.YouspecifythepolarityofthepulsewiththeIVISCOPE_ATTR_WIDTH_POLARITYproperty.Thetriggerdoesnotactuallyoccuruntiltheedgeofapulsethatcorrespondstothewidththresholds,widthcondition,andpolarityyouspecifycrossesthetriggerlevelthatyouspecifywiththeIVISCOPE_ATTR_TRIGGER_LEVELproperty.DefinedValue:2
IVISCOPE_VAL_WIDTH_WITHINConfigurestheoscilloscopetotriggeronpulsesthathaveawidththatislessthanthehighthresholdandgreaterthanthelowthreshold.YouspecifythehighandlowthresholdswiththeIVISCOPE_ATTR_WIDTH_HIGH_THRESHOLDandIVISCOPE_ATTR_WIDTH_LOW_THRESHOLDproperties.DefinedValue:1
PropertiesforControllingIviScopeSimulationNoteYoucansetSimulationAttributesinMAXontheInitialSettingstabofIVIDrivers»Advanced»SimulationDriverSessions»nisIviClassorinthesimulationinteractivepanels.RefertoNationalInstrumentsIVIDriverHelp»ConfiguringYourSystemformoreinformation.
TwosetsofpropertiesexistforusewiththeIviScopeSimulationDriver.Thefollowingtabledescribespropertiesthatcontrolbehaviorofthedriver.Anothertablelistspropertiesthatsimulatethestatusofspecificdriverfunctions.AnIviScopeSimulatorSetupDialogBoxexiststohelpyouconfigurethemeasurementsimulationfortheIviScopeSimulatordriver.
PropertiesforControllingIviScopeSimulationName Data
TypeAccess Applies
toDescription
INTERACTIVE_SIMULATION Boolean W No Specifieswhethertosetthedrivertointeractivemode.Ininteractivemode,thesimulationdriverusespop-upuserinterfacepanelsforgettinginformationfromyou.Non-interactivemodeisusefulwhenyoudonotwanttheinteractivepanelstointerruptyourtestprogram.
SELF_TEST_CODE Integer W No Specifiestheself-testcode.WhentheIviScopeSelf-Testiscalled,theself-testresultparameterreturnsthisvalue.
SELF_TEST_MSG String W No Specifiestheself-testmessage.WhentheIviScopeSelf-TestVIiscalled,thetestmessageparameterreturnsthisstring.
ERROR_QUERY_CODE Integer W No Specifiestheerror-querycode.WhentheIviScopeError-QueryVIiscalled,thequerycodeparameterreturnsthisvalue.
ERROR_QUERY_MSG String W No Specifiestheerror-querymessage.WhentheIviScopeError-QueryVIiscalled,theerrormessagereturnsthisstring.
DRIVER_REV_QUERY String W No Specifiestheinstrumentdriverrevisionmessage.WhentheIviScopeRevisionQuerycalled,theinstrumentdriver
revisionparameterreturnsthisstring.
INSTR_REV_QUERY String W No Specifiesthefirmwarerevisionmessage.WhentheIviScoopeRevisionQueryVIiscalled,thefirmwarerevisionparameterreturnsthisstring.
WAVEFORM Int32 W Yes Specifiesthewaveformtosimulateattheselectedchannel.DefinedValues:1—Sine2—Square3—Triangle4—Ramp-up5—Ramp-down6—DC
FREQUENCY Real64 W Yes Specifiesthefrequencyofthewaveformtosimulateattheselectedchannel.ThispropertydoesnotaffectsimulationbehaviorwhentheNISSCOPE_ATTR_WAVEFORMpropertyissetto6(DC).ValidRange:100.0to15.0E6Hz
AMPLITUDE Real64 W Yes Specifiesthepeak-to-peakamplitudeofthewaveformtosimulateattheselectedchannel.ThispropertydoesnotaffectsimulationbehaviorwhentheNISSCOPE_ATTR_WAVEFORMpropertyissetto6(DC).ValidRange:50.0E-3to10.0V
DC_OFFSET Real64 W Yes SpecifiestheDCoffsetofthewaveformtosimulateattheselectedchannel.ValidRange:-5.0to5.0V
DUTY_CYCLE Real64 W Yes Specifiesthedutycycletosimulateforasquarewaveformattheselectedchannel.ThispropertyaffectssimulationbehavioronlywhentheNISSCOPE_ATTR_WAVEFORMpropertyissetto2(Square).ValidRange:20.0to80.0percent
PHASE_SHIFT Real64 W Yes Specifiesthestartphaseshifttosimulateforawaveformattheselectedchannel.ThispropertydoesnotaffectsimulationbehaviorwhentheNISSCOPE_ATTR_WAVEFORMpropertyissetto6(DC).ValidRange:0.0to360.0degrees
SNR Real64 W Yes Specifiesthesignal-to-noiseratiotosimulateattheselectedchannel.Thesignal-to-noiseratiodeterminestheamountofnoisetosimulateduringwaveformacquisition.ValidRange:0.001to+inf
SIMULATE_STATUS_CODE Boolean W No SpecifieswhethertosimulatereturncodesfromtheIviScopedriverfunctions.RefertotheIviScopePropertiesforStatusSimulationtable.
RelatedTopicsSettingUpSimulatedErrors
SettingUpSimulationforVXIplug&playVIs
IviScopeSimulatorSetupDialogBoxTwosetsofpropertiesexistforusewiththeIviScopesimulationdriver.YouusethedialogboxshownbelowtoconfigurethemeasurementsimulationfortheIviScopesimulationdriver.Scrolldowntoseeadescriptionofeachcontrol.
AlwayspromptforoutputdatasimulationLeavingthiscontrolselectedcausesthepaneltoappearateverysignalacquisitioneventinyourprogram.Allsimulatedacquisitionsintheprogramusethesamewaveformconfigurationinformation.Unselectingthiscontrolcausesthewaveformsimulationpaneltoneverappearagainduringthecourseofyourprogram.ChannelThiscontrolspecifiesthechannelforwhichyouwanttoconfigureasimulationwaveform.WaveformThiscontrolselectsthewaveformtouseforthesimulatedsignal.FrequencyThiscontrolselectsthefrequencyofthewaveformtosimulateattheselectedchannel.ThisvaluedoesnotaffectsimulationbehaviorwhenthewaveformissettoDC.ValidRange:100.0to15.0E6HzAmplitudeThiscontrolselectsthepeak-to-peakamplitudeofthewaveformtosimulateattheselectedchannel.ThisvaluedoesnotaffectsimulationbehaviorwhenthewaveformissettoDC.ValidRange:50.0E-3to10.0VppDCOffsetThiscontrolselectstheDCoffsetofthewaveformtosimulateattheselectedchannel.ValidRange:-5.0to5.0VPhaseShiftThiscontrolselectsthestartingphaseofthewaveformtosimulateattheselectedchannel.ThisvaluedoesnotaffectsimulationbehaviorwhenthewaveformissettoDC.ValidRange:0.0to360.0degrees
SNRThiscontrolselectsthesignal-to-noiseratioofthesimulatedsignal.TheSNRdeterminestheamountofnoisetointroduceintothewaveformgeneration.Thisoptionallowsyoutosimulatelessthanperfectwaveforms.ValidRange:0.001to+inf
PropertiesforStatusSimulationinIviScopeWhenanIviScopedriverfunctioniscalled,thedriverquerieswhetherNISSCOPE_ATTR_SIMULATE_STATUS_CODEisenabled.Ifenabled,thedrivergetstheappropriatefunction'ssimulationstatuscode.Ifthevalueofthesimulationstatuscoderepresentsawarning(hasapositivevalue),thenitisreturnasthefunction'sreturnstatusonlyifnoothererrororwarningoccurredbeforethefunctionends.Ifthevalueofthesimulationstatuscoderepresentsanerror(hasanegativevalue),thenitisreturnedasthefunction'sreturnstatusonlyifnoothererroroccurredbeforethefunctionends.ThefollowingIviScopeVIsdonotsupportstatuscodesimulation:
IviScopeGetErrorIviScopeClearErrorIviScopeGetNextInterchangeWarningIviScopeResetNextInterchangeWarningIviScopeClearNextInterchangeWarningIviScopeGetNextCoercionRecord
EachVIsupportedbytheIviScopeclassdriverhasacorrespondingpropertythatdeterminesthestatuscodetoreturnwhenstatuscodesimulationisenabled.ThefollowinglistindicatesthestatuscodepropertiesandtheVIforwhichtheyreturnavalue.ThesepropertiesarealloftypeViInt32,non-readable,andnon-channelbased:
NoteInthefollowingtable,theliteralstringNISSCOPE_ATTR_precedesallpropertynames.
IviScopePropertiesforStatusSimulationProperty VIINIT_STATUS IviScope
Initialize,IviScopeInitializeWithOptions
CLOSE_STATUS IviScopeCloseRESET_STATUS IviScopeResetSELF_TEST_STATUS IviScopeSelf-TestERROR_QUERY_STATUS IviScopeError-
QueryERROR_MESSAGE_STATUS IviScopeError
MessageREVISION_QUERY_STATUS IviScopeRevision
QueryRESET_DEFAULT_STATUS IviScopeReset
WithDefaultsDISABLE_STATUS IviScopeDisableINVALIDATE_STATUS IviScope
InvalidateAllAttributes
GET_CH_NAME_STATUS IviScopeGetChannelName
CONFIGURE_CHANNEL_STATUS IviScopeConfigureChannel
CONFIGURE_CHAN_CHARACTERISTICS_STATUS IviScopeConfigureChannelCharacteristics
CONFIGURE_ACQUISITION_TYPE_STATUS IviScopeConfigureAcquisitionType
CONFIGURE_ACQUISITION_RECORD__STATUS IviScopeConfigureAcquisitionRecord
ACTUAL_RECORD_LENGTH_STATUS IviScopeActualRecordLength
CONFIGURE_TRIGGER_STATUS IviScopeConfigureTrigger
CONFIGURE_TRIGGER_COUPLING_STATUS IviScopeConfigureTriggerCoupling
CONFIGURE_EDGE_TRIGGER_SOURCE_STATUS IviScopeConfigureEdgeTriggerSource
READ_WAVEFORM_STATUS IviScopeReadWaveform
ABORT_STATUS IviScopeAbortINITIATE_ACQUISITION_STATUS IviScopeInitiate
AcquisitionACQUISITION_STATUS_STATUS IviScope
AcquisitionStatusFETCH_WAVEFORM_STATUS IviScopeFetch
WaveformIS_INVALID_WFM_ELEMENT_STATUS IviScopeIs
InvalidWaveformElement
CONFIGURE_TV_TRIGGER_SOURCE_STATUS IviScopeConfigureTVTriggerSource
CONFIGURE_TV_TRIGGER_LINE_NUMBER_STATUS IviScopeConfigureTVTriggerLineNumber
CONFIGURE_RUNT_TRIGGER_SOURCE_STATUS IviScopeConfigureRunt
TriggerSourceCONFIGURE_GLITCH_TRIGGER_SOURCE_STATUS IviScope
ConfigureGlitchTriggerSource
CONFIGURE_WIDTH_TRIGGER_SOURCE_STATUS IviScopeConfigureWidthTriggerSource
CONFIGURE_AC_LINE_TRIGGER_SLOPE_STATUS IviScopeConfigureACLineTriggerSlope
CONFIGURE_TRIGGER_MODIFIER_STATUS IviScopeConfigureTriggerModifier
CONFIGURE_NUM_ENVELOPES_STATUS IviScopeConfigureNumberofEnvelopes
READ_MIN_MAX_WAVEFORM_STATUS IviScopeReadMinMaxWaveform
FETCH_MIN_MAX_WAVEFORM_STATUS IviScopeFetchMinMaxWaveform
CONFIGURE_REF_LEVELS_STATUS IviScopeConfigureReferenceLevels
READ_WAVEFORM_MEASUREMENT_STATUS IviScopeReadWaveformMeasurement
FETCH_WAVEFORM_MEASUREMENT_STATUS IviScopeFetchWaveformMeasurement
CONFIGURE_NUM_AVERAGES_STATUS IviScopeConfigure
NumberofAverages
CONFIGURE_INITIATE_CONTINUOUS_STATUS IviScopeConfigureInitiateContinuous
CONFIGURE_INTERPOLATION_STATUS IviScopeConfigureInterpolation
SAMPLE_MODE_STATUS IviScopeActualSampleMode
SAMPLE_RATE_STATUS IviScopeActualSampleRate
AUTO_PROBE_SENSE_VALUE_STATUS IviScopeAutoProbeSenseValue
AUTO_SETUP_STATUS IviScopeAutoSetup
IviSpecAnClassDriverReferenceforLabVIEWIviSpecAnVIandPropertyReferenceVITreePropertiesbyGroupErrorandCompletionCodes
IviSpecAnClassDriverOverviewThisinstrumentdriverprovidesprogrammingsupportfortheIviSpecAnClass.TheIviSpecAnclassisdesignedtosupportthetypicalsweptanalyzeraswellascommonextendedfunctionalityfoundininstrumentsthataremorecomplex.TheIviSpecAnclassconceptualizesasweptanalyzerasaninstrumentthatcanmeasuretheamplitudeatdiscretefrequencieswhilesweepingareceiverthrougharangeoffrequencies.Typically,themeasuredquantityisavoltageorpowerlevel.ThedrivercontainsalltheVIsrequiredintheIviSpecAnspecificationdefinedbytheIVIFoundation.ThisdriverrequiresNI-VISAandtheIVICompliancePackagetobeinstalled.Thereisasecondtypeofanalyzerthatisoftenreferredtoasadynamicsignalanalyzer,anaudioanalyzer,oranFFTanalyzer.Whilemanyoftheendresultsarethesame,theprocessoftakingthemeasurementsisquitedifferent.Sincetheyaresodifferent,theyarenotcoveredinthishelptopic.TheIviSpecAnclassisdividedintothebasecapabilitygroupandseveralextensiongroups.Thebasecapabilitygroupisusedtoconfigureananalyzerforatypicalsweep,initiatethatsweep,andreturnanarrayofmeasuredvalues.Inadditiontothebasecapabilities,theIviSpecAnclassdefinesextendedcapabilitiesforspectrumanalyzersthathave:
SimplemathematicaloperationsonmultipletracesMarkeranddelta-markerfunctionalityExternalandVideotriggersourcesBasicdisplayfunctionofspecifyingunitsperdivisionExternalmixercapabilitytoexpandthefrequencyrangePeakpreselectortoreducenoiseandincreasedynamicrange
TheIviSpecAnextendedcapabilitiesarearrangedintoasetofextensioncapabilitygroups.
IviSpecAnExtensionCapabilityGroupsTheIviSpecAnclassdriveridentifiesVIsandpropertiesthatbelongtoanextensiongroupwiththefollowingabbreviations.Instrumentspecificdriversarenotrequiredtoimplementanyoftheextensioncapabilitygroups.IfyouuseVIsandpropertiesthatbelongtoextensioncapabilitygroups,everyinstrumentspecificdriverthatyouusemustimplementthoseextensions.
GroupName DescriptionIviSpecAnMultitrace Definesextensionsforanalyzerscapableof
performingsimplemathematicalVIsononeormoretraces.
IviSpecAnMarker Supportsspectrumanalyzersthathavemarkers.Markersareappliedtotracesandusedforawiderangeofoperations.Someoperationsaresimple,suchasreadinganamplitudevalueatanX-axisposition,whileothersoperationsarecomplex,suchassignaltracking
IviSpecAnTrigger SpecifiesthesourceofthetriggersignalthatcausestheanalyzertoleavetheWait-For-Triggerstate.
IviSpecAnExternalTrigger SpecifiestheexternaltriggerlevelandexternaltriggerslopewhentheTriggerSourcepropertyissettoexternal,whichcausestheanalyzertoleavetheWait-For-Triggerstate.
IviSpecAnSoftwareTrigger Supportsspectrumanalyzersthatcanacquiretracesbasedonasoftwaretriggersignal.Youcansendasoftwaretriggertocausesignaloutputtooccur.AffectsinstrumentbehaviorwhentheTriggerSourcepropertyissettoSoftware.
IviSpecAnVideoTrigger SpecifiesthevideotriggerlevelandvideotriggerslopewhentheTriggerSource
propertyissettoVideo,whichcausestheanalyzertoleavetheWait-For-Triggerstate.
IviSpecAnDisplay Controlsthedisplayrelatedproperties.IviSpecAnMarkerType Supportsanalyzersthathavemultiple
markertypes.IviSpecAnDeltaMarker Supportsanalyzersthathavedelta-marker
capabilities.Adeltamarkerhasthesamepropertiesasanormalmarkerexceptthatitspositionandamplitudearerelativetoafixedreferencepoint.Thisreferencepointisdefinedwhenthemarkerisconvertedfromanormalmarkertoadeltamarker.
IviSpecAnExternalMixer Allowstheuseofananalyzertomeasurevaluesthatareoutsideofthenormalfrequencyrangeoftheequipment.Whenusinganexternalmixer,manyofthesettingsoftheanalyzerhavetobecarefullyconvertedtoallowyoutoknowwhatismeantbythevaluesread.
IviSpecAnPreselector Controlspreselectors.Preselectorsareanetworkoffiltersandpreamplifiersthatarebuiltintooneunitforreducingnoiseandincreasingdynamicrangeofananalyzer.Preselectorsareoftenseparateinstruments,buttheyareinstrumentsthatonlyworkwithspectrumanalyzers.Someanalyzershaveinternalpreselectors.
RelatedTopicIVIInherentClassCapabilities
IviSpecAnExtensionCapabilityGroupsTheIviSpecAnclassdriveridentifiesVIsandpropertiesthatbelongtoanextensiongroupwiththefollowingabbreviations.Instrumentspecificdriversarenotrequiredtoimplementanyoftheextensioncapabilitygroups.IfyouuseVIsandpropertiesthatbelongtoextensioncapabilitygroups,everyinstrumentspecificdriverthatyouusemustimplementthoseextensions.
GroupName DescriptionIviSpecAnMultitrace Definesextensionsforanalyzerscapableof
performingsimplemathematicalVIsononeormoretraces.
IviSpecAnMarker Supportsspectrumanalyzersthathavemarkers.Markersareappliedtotracesandusedforawiderangeofoperations.Someoperationsaresimple,suchasreadinganamplitudevalueatanX-axisposition,whileothersoperationsarecomplex,suchassignaltracking
IviSpecAnTrigger SpecifiesthesourceofthetriggersignalthatcausestheanalyzertoleavetheWait-For-Triggerstate.
IviSpecAnExternalTrigger SpecifiestheexternaltriggerlevelandexternaltriggerslopewhentheTriggerSourcepropertyissettoexternal,whichcausestheanalyzertoleavetheWait-For-Triggerstate.
IviSpecAnSoftwareTrigger Supportsspectrumanalyzersthatcanacquiretracesbasedonasoftwaretriggersignal.Youcansendasoftwaretriggertocausesignaloutputtooccur.AffectsinstrumentbehaviorwhentheTriggerSourcepropertyissettoSoftware.
IviSpecAnVideoTrigger SpecifiesthevideotriggerlevelandvideotriggerslopewhentheTriggerSource
propertyissettoVideo,whichcausestheanalyzertoleavetheWait-For-Triggerstate.
IviSpecAnDisplay Controlsthedisplayrelatedproperties.IviSpecAnMarkerType Supportsanalyzersthathavemultiple
markertypes.IviSpecAnDeltaMarker Supportsanalyzersthathavedelta-marker
capabilities.Adeltamarkerhasthesamepropertiesasanormalmarkerexceptthatitspositionandamplitudearerelativetoafixedreferencepoint.Thisfixedreferencepointisdefinedwhenthemarkerisconvertedfromanormalmarkertoadeltamarker.
IviSpecAnExternalMixer Allowstheuseofananalyzertomeasurevaluesthatareoutsideofthenormalfrequencyrangeoftheequipment.Whenusinganexternalmixer,manyofthesettingsoftheanalyzerhavetobecarefullyconvertedtoallowtheusertoknowwhatismeantbythevaluesread.
IviSpecAnPreselector Controlspreselectors.Preselectorsareanetworkoffiltersandpreamplifiersthatarebuiltintooneunitforreducingnoiseandincreasingdynamicrangeofananalyzer.Preselectorsareoftenseparateinstruments,buttheyareinstrumentsthatonlyworkwithspectrumanalyzers.Someanalyzershaveinternalpreselectors.
IviSpecAnBaseCapabilityGroupOverviewTheIviSpecAnBasecapabilitygroupsupportsspectrumanalyzersthatconfigureandtakeafrequencysweep.Afrequencysweepisthoughtofasadjustingthefrequencyofatunerfromthestartfrequencytothestopfrequencyinadefinedamountoftime.Formoreinformationabouttimedomainmeasurements,refertoTimeDomainMeasurements.Whilethetunerisbeingadjusted,powerlevels(orvoltagelevels)arebeingmeasuredforthefrequencies.Theresultisanarrayofamplitudeversusfrequencydata.Inadditiontoconfiguringthestartandstopfrequency,ausercanalsosetafrequencyoffset.Thisaffectsthesettingofthespectrumanalyzer'sabsolutefrequencies,suchasstart,stop,center,andmarker.Itdoesnotaffectvalues,whicharethedifferenceoffrequencies,suchasspananddeltamarker.TheIviSpecAnBasecapabilitygroupalsoincludesVIsforconfiguringtheanalyzeraswellasinitiatingandretrievingmeasurements.Thisincludesconfiguringthesweep,range,andresolution.Atypicalspectrumanalyzerdoesnothaveseveralinputchannels.Itcan,however,haveseveraltraces.MultipletracesarecoveredintheIviSpecAnMultitraceextensiongroup.ThetriggerVIsarecoveredinTrigger,ExternalTrigger,andVideoTriggerextensiongroups.Inaddition,mostspectrumanalyzershaveacoupledfunctionmode,whichlinkstheresolutionbandwidth(RBW),videobandwidth(VBW),andsweeptimetogether.Formoreinformationaboutthisbehavior,refertoSweepCouplingOverview.Thefollowingfigureshowsthetuning,filtering,anddetectionprocessinatypicalspectrumanalyzer.
Thefollowingfigureshowshowthedetectordetectsthesignalandoutputsthesignalonmultipletraces.
SweepCouplingOverviewManyspectrumanalyzersarecapableofcouplingtheresolutionbandwidth,videobandwidth,andsweeptimetogether.Theinstrumentmakesdecisionsbasedonthevarioussettingstoensuretheaccuracyofthemeasurement.Ifyouelecttochoosethesettings,itispossibletoplaceconstraintsonthesystemthatmakeaccuratemeasurementsimpossible.Mostanalyzersrespondtothisconditionwithamessageindicatingthatthemeasurementisuncalibrated.Whenallthesettingsarecoupled,theinstrumentmakesdecisionsalongthefollowinghierarchy.TheRBWandVBWaretypicallylockedtogetherandsetfor1%ofthespan.Forexample,ifthespanweresetfor100MHz,theinstrumentchooses1MHzfortheRBWandVBW.Tomeasureverylowsignallevels,theRBWmayneedtobemorenarrowed,whichslowsthesweepspeed.Lastly,thesweeptimeisdependentontheRBWandtheVBW.Asaruleofthumb:SweepTime*Span/RBW2
Ascanbeseenfromtheaboveequation,theRBWhasadrasticeffectonsweepspeed.Theseareissuestokeepinmindwhendevelopingautomatedtests.Whenconsideringinterchangeabilityandmeasurementaccuracy,itisimportanttoconsiderthewaydifferentinstrumentscouplesettingstogether.ThevalidcombinationofRBW,VBW,andsweeptimeononespectrumanalyzermaynotbeavalidcombinationonanotherspectrumanalyzer.Awarenessofthesedifferencesensuresthattheresultsobtainedinonesystemcorrelatewiththeresultsfromanothersystem.
IviSpecAnBaseFunctionsIviSpecAn_AbortIviSpecAn_AcquisitionStatusIviSpecAn_ConfigureAcquisitionIviSpecAn_ConfigureFrequencyCenterSpanIviSpecAn_ConfigureFrequencyOffsetIviSpecAn_ConfigureFrequencyStartStopIviSpecAn_ConfigureLevelIviSpecAn_ConfigureSweepCouplingIviSpecAn_ConfigureTraceTypeIviSpecAn_FetchYTraceIviSpecAn_GetTraceNameIviSpecAn_InitiateIviSpecAn_QueryTraceSizeIviSpecAn_ReadYTrace
IviSpecAnBaseAttributesIVISPECAN_ATTR_AMPLITUDE_UNITSIVISPECAN_ATTR_ATTENUATIONIVISPECAN_ATTR_ATTENUATION_AUTOIVISPECAN_ATTR_DETECTOR_TYPEIVISPECAN_ATTR_DETECTOR_TYPE_AUTOIVISPECAN_ATTR_FREQUENCY_STARTIVISPECAN_ATTR_FREQUENCY_STOPIVISPECAN_ATTR_FREQUENCY_OFFSETIVISPECAN_ATTR_INPUT_IMPEDANCEIVISPECAN_ATTR_NUMBER_OF_SWEEPSIVISPECAN_ATTR_REFERENCE_LEVELIVISPECAN_ATTR_REFERENCE_LEVEL_OFFSETIVISPECAN_ATTR_RESOLUTION_BANDWIDTHIVISPECAN_ATTR_RESOLUTION_BANDWIDTH_AUTOIVISPECAN_ATTR_SWEEP_MODE_CONTINUOUSIVISPECAN_ATTR_SWEEP_TIMEIVISPECAN_ATTR_SWEEP_TIME_AUTOIVISPECAN_ATTR_TRACE_COUNTForaninstrumentwithonlyoneTrace,i.e.,theTraceCountattributeisone,thedrivermayreturnanemptystring.IVISPECAN_ATTR_TRACE_SIZEIVISPECAN_ATTR_TRACE_TYPEIVISPECAN_ATTR_VERTICAL_SCALEIVISPECAN_ATTR_VIDEO_BANDWIDTHRelatedTopicsIVIInherentVIsIVIInherentPropertiesIviSpecAnBasebehaviormodel
IviSpecAnDeltaMarkerExtensionGroupTheIviSpecAnDeltaMarkerextensiongroupsupportsanalyzersthathavedelta-markercapabilities.Adeltamarkerhasthesamepropertiesasanormalmarkerexceptthatitspositionandamplitudearerelativetoafixedreferencepoint.Thisfixedreferencepointisdefinedwhenthemarkerisconvertedfromanormalmarkertoadeltamarker.
IviSpecAnDeltaMarkerVIsIviSpecAn_MakeMarkerDeltaIviSpecAn_QueryReferenceMarker
IviSpecAnDeltaMarkerPropertiesIVISPECAN_ATTR_REFERENCE_MARKER_AMPLITUDEIVISPECAN_ATTR_REFERENCE_MARKER_POSITION
IviSpecAnDisplayExtensionGroupTheIviSpecAnDisplayextensiongroupcontrolsthedisplayrelatedproperties.
IviSpecAnDisplayPropertiesIVISPECAN_ATTR_NUMBER_OF_DIVISIONSIVISPECAN_ATTR_UNITS_PER_DIVISION
IviSpecAnExternalMixerExtensionGroupManyspectrumanalyzershaveoutputsandinputsthatallowexternalequipmenttousetheIFormixersignalthatthespectrumanalyzeruses.Inthiscase,externalequipmentcanbeusedtomixsignalstoconvertthemtomeasurablefrequencies.Thisallowstheuseofananalyzertomeasurevaluesthatareoutsideofthenormalfrequencyrangeoftheequipment.Whenusinganexternalmixer,manyofthesettingsoftheanalyzerhavetobecarefullyconvertedtoallowyoutoknowwhatismeantbythevaluesread.Specifically,thefrequency,theharmonicnumber,mixerconfiguration,andconversionlossmustbeconfiguredcarefullytobeabletousetheexternalmixingsuccessfully.Thefrequencyoftheinputsignalcanbeexpressedasafunctionofthelocaloscillator(LO)frequencyandtheselectedharmonicofthe1stLOisasfollows:
fin=n*fLO+/-fIF Where: fin frequencyofinputsignal n orderofharmonicusedforconversion fLOfrequencyof1stLO fIF intermediatefrequency
TheHarmonicnumberdefinestheordernoftheharmonicusedforconversion.Bothevenandoddharmonicscanbeused.Theselectedharmonic,togetherwiththesettingrangeofthe1stLO,determinesthelimitsofthesettablefrequencyrange.Thefollowingapplies:
Lowerfrequencylimit: fmin=n*fLO,min-fIF Upperfrequencylimit: fmax=n*fLO,max+fIF Where: fLO,min lowerfrequencylimitofLO fLO,maxupperfrequencylimitofLO
Thefollowingsectionsdescribethemixerconfigurationandtheconversionlosstableconfiguration.
MixerConfigurationTheexternalmixersaretypicallyconfiguredeitherastwo-portorthreeportmixers.Single-diodemixersgenerallyrequireaDCvoltagewhichisappliedviatheLOline.ThisDCvoltageistobetunedtotheminimumconversionlossversusfrequency.SomeinstrumentscandefinealimitfortheBIAScurrent.Thetwo-portmixerconnectstheLOOUT/IFINoutputoftheanalyzertotheLO/IFportoftheexternalmixer.ThediplexeriscontainedintheanalyzerandtheIFsignalcanbetappedfromthelinewhichisusedtofeedtheLOsignaltothemixer.ThesignaltobemeasuredisfedtotheRFinputoftheexternalmixer.Ontheotherhand,thethree-portmixerconnectstheLOOUT/IFINoutputoftheanalyzertotheLOportoftheexternalmixer.TheIFINinputoftheanalyzerisconnectedtotheIFportoftheexternalmixer.ThesignaltobemeasuredisfedtotheRFinputoftheexternalmixer.
ConversionLossThemaximumsettablereferenceleveldependsontheexternalmixersconversionlosswhichisdefinedbyaverageconversionlossorbyusingtheconversionlosstable.Forexample,ifanIFsignalwithalevelof-20dBmisappliedtotheLOOUT/IFINorIFINinputofthespectrumanalyzer,fullscreenlevelisattained.Consequently,themaximumsettablereferencelevelis-20dBmatasetconversionlossof0dB.Ifaconversionloss>0dBisentered,themaximumsettablereferencelevelincreasesinthesameproportion.Ifthemaximumpossiblereferencelevelissetontheanalyzer,thislevelisreducedifasmallerconversionlossisentered.Inadditiontothedynamicrangeofthespectrumanalyzerthe1dBcompressionpointofthemixerhastobetakenintoaccount.Thelevelsoftheinputsignalsliewellbelowthisvaluetoavoidgenerationofharmonicsofthesesignalsinthemixer.TheseareconvertedbytheLOsignalsharmonicsofhigherorderandappearinthedisplayedspectrum.Someinstrumentsallowthedefinitionofconversionlosstables.TheConversionlosstableallowstheconversionlossofthemixerintheselectedbandtobetakenintoaccountasafunctionoffrequency.Correctionvaluesforfrequenciesbetweentheindividualreferencevaluesareobtainedbyinterpolation(Linearinterpolation).Outsidethefrequencyrangecoveredbythetabletheconversionlossisassumedtobethesameasthatforthereferencevaluemarkingthetablelimit.
IviSpecAnExternalMixerVIsIviSpecAn_ConfigureConversionLossTableIviSpecAn_ConfigureConversionLossTableEnabledIviSpecAn_ConfigureExternalMixerIviSpecAn_ConfigureExternalMixerBiasIviSpecAn_ConfigureExternalMixerBiasEnabledIviSpecAn_ConfigureExternalMixerEnabledIviSpecAn_ConfigureExternalMixerNumberOfPorts
IviSpecAnExternalMixerPropertiesIVISPECAN_ATTR_EXTERNAL_MIXER_AVERAGE_CONVERSION_LOSSIVISPECAN_ATTR_EXTERNAL_MIXER_BIASIVISPECAN_ATTR_EXTERNAL_MIXER_BIAS_ENABLEDIVISPECAN_ATTR_EXTERNAL_MIXER_BIAS_LIMITIVISPECAN_ATTR_EXTERNAL_MIXER_CONVERSION_LOSS_TABLE_ENABLEDIVISPECAN_ATTR_EXTERNAL_MIXER_ENABLEDIVISPECAN_ATTR_EXTERNAL_MIXER_HARMONICIVISPECAN_ATTR_EXTERNAL_MIXER_NUMBER_OF_PORTS
IviSpecAnExternalTriggerExtensionGroupTheIviSpecAnExternalTriggerextensiongroupextensiongroupspecifiestheexternaltriggerlevelandexternaltriggerslopewhentheTriggerSourcepropertyissettoexternal,whichcausestheanalyzertoleavetheWait-For-Triggerstate.
IviSpecAnTriggerVIIviSpecAn_ConfigureExternalTrigger
IviSpecAnTriggerPropertiesIVISPECAN_ATTR_EXTERNAL_TRIGGER_LEVELIVISPECAN_ATTR_EXTERNAL_TRIGGER_SLOPE
IviSpecAnMarkerExtensionGroupTheIviSpecAnMarkerextensiongroupsupportsspectrumanalyzersthathavemarkers.Markersareappliedtotracesandusedforawiderangeofoperations.Someoperationsaresimple,suchasreadinganamplitudevalueatanX-axisposition,whileothersoperationsarecomplex,suchassignaltracking.
IviSpecAnMarkerVIsIviSpecAn_ConfigureMarkerEnabledIviSpecAn_ConfigureMarkerFrequencyCounterIviSpecAn_ConfigureMarkerSearchIviSpecAn_ConfigureSignalTrackEnabledIviSpecAn_DisableAllMarkersIviSpecAn_GetMarkerNameIviSpecAn_MarkerSearchIviSpecAn_MoveMarkerIviSpecAn_QueryMarkerIviSpecAn_SetActiveMarkerIviSpecAn_SetInstrumentFromMarker
IviSpecAnMarkerPropertiesIVISPECAN_ATTR_ACTIVE_MARKERIVISPECAN_ATTR_MARKER_AMPLITUDEIVISPECAN_ATTR_MARKER_COUNTIVISPECAN_ATTR_MARKER_ENABLEDIVISPECAN_ATTR_MARKER_FREQUENCY_COUNTER_ENABLEDIVISPECAN_ATTR_MARKER_FREQUENCY_COUNTER_RESOLUTIONIVISPECAN_ATTR_MARKER_POSITIONIVISPECAN_ATTR_MARKER_THRESHOLDIVISPECAN_ATTR_MARKER_TRACEIVISPECAN_ATTR_PEAK_EXCURSIONIVISPECAN_ATTR_SIGNAL_TRACK_ENABLED
IviSpecAnMarkerTypeExtensionGroupTheIviSpecAnMarkerTypeextensiongroupsupportsanalyzersthathavemultiplemarkertypes.
IviSpecAnMarkerTypeVIIviSpecAn_QueryMarkerType
IviSpecAnMarkerTypePropertyIVISPECAN_ATTR_MARKER_TYPE
IviSpecAnMultitraceExtensionGroupTheIviSpecAnMultitraceextensiongroupdefinesextensionsforanalyzerscapableofperformingsimplemathematicalVIsononeormoretraces.
IviSpecAnMultitraceVIsIviSpecAn_AddTracesIviSpecAn_CopyTraceIviSpecAn_ExchangeTracesIviSpecAn_SubtractTraces
IviSpecAnPreselectorExtensionGroupTheIviSpecAnPreselectorextensiongroupsupportsanalyzersthathavemultiplemarkertypes.
IviSpecAnPreselectorVIIviSpecAn_PeakPreselector
IviSpecAnSoftwareTriggerExtensionGroupTheIviSpecAnSoftwareTriggerextensiongroupsupportsspectrumanalyzersthatcanacquiretracesbasedonasoftwaretriggersignal.Youcansendasoftwaretriggertocausesignaloutputtooccur.TheIviSpecAnSoftwareTriggerextensiongroupaffectsinstrumentbehaviorwhentheTriggerSourcepropertyissettoSoftware.
IviSpecAnSoftwareTriggerVIIviSpecAn_SendSoftwareTrigger
IviSpecAnTriggerExtensionGroupTheIviSpecAnTriggerextensiongroupspecifiesthesourceofthetriggersignalthatcausestheanalyzertoleavetheWait-For-Triggerstate.
IviSpecAnTriggerVIIviSpecAn_ConfigureTriggerSource
IviSpecAnTriggerPropertyIVISPECAN_ATTR_TRIGGER_SOURCE
IviSpecAnVideoTriggerExtensionGroupTheIviSpecAnVideoTriggerextensiongroupspecifiesthevideotriggerlevelandvideotriggerslopewhentheTriggerSourcepropertyissettoVideo,whichcausestheanalyzertoleavetheWait-For-Triggerstate.
IviSpecAnVideoTriggerVIIviSpecAn_ConfigureVideoTrigger
IviSpecAnVideoTriggerPropertiesIVISPECAN_ATTR_VIDEO_TRIGGER_LEVELIVISPECAN_ATTR_VIDEO_TRIGGER_SLOPE
IviSpecAnBehaviorModelsIviSpecAnBaseIviSpecAnDeltaMarkerIviSpecAnDisplayIviSpecAnExternalMixerIviSpecAnExternalTriggerIviSpecAnMarkerIviSpecAnMultitraceIviSpecAnPreselectorIviSpecAnSoftwareTriggerIviSpecAnTriggerIviSpecAnVideoTrigger
IviSpecAnBehaviorModelThefollowingstatediagramshowsrelationshipsbetweenIviSpecAnFundamentalCapabilitiesandanalyzerbehavior.
ThemainstateintheIviSpecAnClassistheIdlestate.TheanalyzerenterstheIdlestateastheresultofbeing"powered-on",successfullycompletingameasurement,orbyyouabortingapreviousmeasurementbyyouwiththeAbortVI.Typically,youconfiguretheanalyzerwhileitisintheIdlestate.IviSpecAnpropertiescanbeconfiguredindividuallywiththeSetAttributeVI(IVI-C)orusingoneofthehigher-levelVIs.TheReadYTraceandInitiateVIscausetheanalyzertoleavetheIdlestate.TheReadYTraceVIdoesnotreturnuntilthemeasurementprocessiscompleteandtheanalyzerhasreturnedtotheIdlestate.TheInitiateVIreturnsassoonastheanalyzerleavestheIdlestate.Afterthesweepistaken,theanalyzerreturnstotheIdlestate.YoucanusetheAcquisitionStatusVItodetermineiftheacquisitioniscompleteorisstillinprogress.TheFetchYTraceIviSpecAn_Fetch_Y_Trace.htmlisusedtoreturnawaveformfromapreviouslyinitiatedmeasurement.
IviSpecAnDeltaMarkerBehaviorModelTheIviSpecAnDeltaMarkerextensiongroupfollowsthesamebehaviormodelastheIviSpecAnMarkercapabilitygroup
IviSpecAnDisplayBehaviorModelTheIviSpecAnDisplayextensiongroupfollowsthesamebehaviormodelastheIviSpecAnBasecapabilitygroup.
IviSpecAnExternalMixerBehaviorModelTheIviSpecAnExternalMixerextensiongroupfollowsthesamebehaviormodelastheIviSpecAnBasecapabilitygroup.
IviSpecAnExternalTriggerBehaviorModelTheIviSpecAnExternalTriggerextensiongroupfollowsthesamebehaviormodelastheIviSpecAnTriggerextensiongroup
IviSpecAnMarkerBehaviorModelThemarkerpropertiesmaybeusedatanytimeduringthecourseoftheoperationofthespectrumanalyzer.Whensignaltrackingisenabled,theeffectsarethesameascallingtheSetInstrumentFromMarkerVIwiththeInstrumentSettingparametersettoFrequencyCenter:itkeepsthesignalpeakatthecenterofthetrace.Theadjustmentofpropertiesnecessarytocenterthepeakisdoneinthecalculationblock.
IviSpecAnMarkerTypeBehaviorModelTheIviSpecAnMarkerTypeextensiongroupfollowsthesamebehaviormodelastheIviSpecAnMarkercapabilitygroup.
IviSpecAnMultitraceBehaviorModelTheIviSpecAnMultitraceextensiongroupfollowsthesamebehaviormodelastheIviSpecAnBasecapabilitygroup.
IviSpecAnPreselectorBehaviorModelTheIviSpecAnPreselectorextensiongroupfollowsthesamebehaviormodelastheIviSpecAnBasecapabilitygroup.
IviSpecAnSoftwareTriggerBehaviorModelTheIviSpecAnSoftwareTriggerextensiongroupfollowsthesamebehaviormodelastheIviSpecAnTriggerextensiongroup.
IviSpecAnTriggerBehaviorModelTheIviSpecAnTriggerextensiongroupfollowsthesamebehaviormodelastheIviSpecAnBasecapabilitygroup,withtheadditionofaWaitForTriggerstate,asshownbelow.
IviSpecAnVideoTriggerBehaviorModelTheIviSpecAnVideoTriggerextensiongroupfollowsthesamebehaviormodelastheIviSpecAnTriggerextensiongroup.
IviSpecAnVITreeClass/PanelName VIName
ConfigurationFunctionsConfigureFrequencyStartStop IviSpecAn_Configure
FrequencyStartStop.viConfigureFrequencyCenterSpan IviSpecAn_Configure
FrequencyCenterSpan.vi
ConfigureFrequencyOffset IviSpecAn_ConfigureFrequencyOffset.vi
ConfigureSweepCoupling IviSpecAn_ConfigureSweepCoupling.vi
ConfigureAcquisition IviSpecAn_ConfigureAcquisition.vi
ConfigureLevel IviSpecAn_ConfigureLevel.vi
ConfigureTraceType IviSpecAn_ConfigureTraceType.vi
GetTraceName IviSpecAn_GetTraceName.vi
QueryTraceSize IviSpecAn_QueryTraceSize.vi
PeakPreselector[PS] IviSpecAn_PeakPreselector[PS].vi
MultitraceAddTraces[MT] IviSpecAn_AddTraces
[MT].viExchangeTraces[MT] IviSpecAn_Exchange
Traces[MT].viCopyTrace[MT] IviSpecAn_CopyTrace
[MT].viSubtractTraces[MT] IviSpecAn_Subtract
Traces[MT].viMarkerConfigureMarkerEnabled[MKR] IviSpecAn_Configure
MarkerEnabled[MKR].vi
ConfigureMarkerFrequencyCounter[MKR] IviSpecAn_ConfigureMarkerFrequencyCounter[MKR].vi
ConfigureMarkerSearch[MKR] IviSpecAn_ConfigureMarkerSearch[MKR].vi
ConfigureSignalTrackEnabled[MKR] IviSpecAn_ConfigureSignalTrackEnabled[MKR].vi
DisableAllMarkers[MKR] IviSpecAn_DisableAllMarkers[MKR].vi
MarkerSearch[MKR] IviSpecAn_MarkerSearch[MKR].vi
MoveMarker[MKR] IviSpecAn_MoveMarker[MKR].vi
QueryMarker[MKR] IviSpecAn_QueryMarker[MKR].vi
SetActiveMarker[MKR] IviSpecAn_SetActiveMarker[MKR].vi
SetInstrumentFromMarker[MKR] IviSpecAn_SetInstrumentFromMarker[MKR].vi
QueryMarkerType[MKT] IviSpecAn_QueryMarkerType[MKT].vi
MakeMarkerDelta[DMK] IviSpecAn_MakeMarkerDelta[DMK].vi
QueryReferenceMarker[DMK] IviSpecAn_QueryReferenceMarker[DMK].vi
GetMarkerName[MKR] IviSpecAn_GetMarkerName[MKR].vi
TriggerExtensionGroupConfigureTriggerSource[TRG] IviSpecAn_Configure
TriggerSource[TRG].viConfigureExternalTrigger[EXT] IviSpecAn_Configure
ExternalTrigger[EXT].vi
ConfigureVideoTrigger[VT] IviSpecAn_ConfigureVideoTrigger[VT].vi
ExternalMixerExtensionGroupConfigureExternalMixerEnabled[EM] IviSpecAn_Configure
ExternalMixerEnabled[EM].vi
ConfigureExternalMixerNumberofPorts[EM] IviSpecAn_ConfigureExternalMixerNumberofPorts[EM].vi
ConfigureExternalMixer[EM] IviSpecAn_ConfigureExternalMixer[EM].vi
ConfigureExternalMixerBiasEnabled[EM] IviSpecAn_ConfigureExternalMixerBiasEnabled[EM].vi
ConfigureExternalMixerBias[EM] IviSpecAn_ConfigureExternalMixerBias[EM].vi
ConfigureConversionLossTableEnabled[EM] IviSpecAn_ConfigureConversionLossTableEnabled[EM].vi
ConfigureConversionLossTable[EM] IviSpecAn_ConfigureConversionLossTable[EM].vi
MeasurementReadYTrace IviSpecAn_ReadY
Trace.viFetchYTrace IviSpecAn_FetchY
Trace.viLowLevelMeasurementInitiate IviSpecAn_Initiate.viAbort IviSpecAn_Abort.viAcquisitionStatus IviSpecAn_Acquisition
Status.viSendSoftwareTrigger[SWT] IviSpecAn_Send
SoftwareTrigger[SWT].vi
IviSpecAnPropertiesGroup/AttributeName PropertyLabel
BasicOperationAmplitudeUnits IviSpecAn»Basic
Operation»AmplitudeUnitsAttenuation IviSpecAn»Basic
Operation»AttenuationAttenuationAuto IviSpecAn»Basic
Operation»AttenuationAutoDetectorType IviSpecAn»Basic
Operation»DetectorTypeDetectorTypeAuto IviSpecAn»Basic
Operation»DetectorTypeAuto
FrequencyStart IviSpecAn»BasicOperation»FrequencyStart
FrequencyStop IviSpecAn»BasicOperation»FrequencyStop
FrequencyOffset IviSpecAn»BasicOperation»FrequencyOffset
InputImpedance IviSpecAn»BasicOperation»InputImpedance
NumberofSweeps IviSpecAn»BasicOperation»NumberofSweeps
ReferenceLevel IviSpecAn»BasicOperation»ReferenceLevel
ReferenceLevelOffset IviSpecAn»BasicOperation»ReferenceLevelOffset
ResolutionBandwidth IviSpecAn»BasicOperation»ResolutionBandwidth
ResolutionBandwidthAuto IviSpecAn»BasicOperation»ResolutionBandwidthAuto
SweepModeContinuous IviSpecAn»BasicOperation»SweepModeContinuous
SweepTime IviSpecAn»BasicOperation»SweepTime
SweepTimeAuto IviSpecAn»BasicOperation»SweepTimeAuto
TraceCount IviSpecAn»BasicOperation»TraceCount
TraceSize IviSpecAn»BasicOperation»TraceSize
TraceType IviSpecAn»BasicOperation»TraceType
VerticalScale IviSpecAn»BasicOperation»VerticalScale
VideoBandwidth IviSpecAn»BasicOperation»VideoBandwidth
VideoBandwidthAuto IviSpecAn»BasicOperation»VideoBandwidthAuto
MarkersActiveMarker[MKR] IviSpecAn»Markers»Active
Marker[MKR]MarkerAmplitude[MKR] IviSpecAn»Markers»Marker
Amplitude[MKR]MarkerEnabled[MKR] IviSpecAn»Markers»Marker
Enabled[MKR]MarkerFrequencyCounterEnabled[MKR] IviSpecAn»Markers»Marker
FrequencyCounterEnabled[MKR]
MarkerFrequencyCounterResolution[MKR] IviSpecAn»Markers»MarkerFrequencyCounterResolution[MKR]
MarkerPosition[MKR] IviSpecAn»Markers»MarkerPosition[MKR]
MarkerThreshold[MKR] IviSpecAn»Markers»MarkerThreshold[MKR]
MarkerTrace[MKR] IviSpecAn»Markers»MarkerTrace[MKR]
NumberofMarkers[MKR] IviSpecAn»Markers»NumberofMarkers[MKR]
PeakExcursion[MKR] IviSpecAn»Markers»PeakExcursion[MKR]
SignalTrackEnabled[MKR] IviSpecAn»Markers»SignalTrackEnabled[MKR]
MarkerTypeMarkerType[MKT] IviSpecAn»Markers»Marker
Type»MarkerType[MKT]DeltaMarkerReferenceMarkerAmplitude[DMK] IviSpecAn»Markers»Delta
Marker»ReferenceMarkerAmplitude[DMK]
ReferenceMarkerPosition[DMK] IviSpecAn»Markers»DeltaMarker»ReferenceMarkerPosition[DMK]
TriggerTriggerSource[TRG] IviSpecAn»Trigger»Trigger
Source[TRG]ExternalTriggerExternalTriggerLevel[EXT] IviSpecAn»Trigger»External
Trigger»ExternalTriggerLevel[EXT]
ExternalTriggerSlope[EXT] IviSpecAn»Trigger»External
Trigger»ExternalTriggerSlope[EXT]
VideoTriggerVideoTriggerLevel[VT] IviSpecAn»Trigger»Video
Trigger»VideoTriggerLevel[VT]
VideoTriggerSlope[VT] IviSpecAn»Trigger»VideoTrigger»VideoTriggerSlope[VT]
DisplayControlUnitsPerDivision[DSP] IviSpecAn»Display
Control»UnitsPerDivision[DSP]
NumberofDivisions[DSP] IviSpecAn»DisplayControl»NumberofDivisions[DSP]
ExternalMixingExternalMixerEnabled[EM] IviSpecAn»External
Mixing»ExternalMixerEnabled[EM]
ExternalMixerNumberofPorts[EM] IviSpecAn»ExternalMixing»ExternalMixerNumberofPorts[EM]
ExternalMixerHarmonic[EM] IviSpecAn»ExternalMixing»ExternalMixerHarmonic[EM]
ExternalMixerAverageConversionLoss[EM] IviSpecAn»ExternalMixing»ExternalMixerAverageConversionLoss[EM]
ExternalMixerConversionLossTableEnabled[EM] IviSpecAn»ExternalMixing»ExternalMixerConversionLossTableEnabled[EM]
BiasEnabled[EM] IviSpecAn»ExternalMixing»BiasEnabled[EM]
Bias[EM] IviSpecAn»ExternalMixing»Bias[EM]
BiasLimit[EM] IviSpecAn»ExternalMixing»BiasLimit[EM]
IviSpecAnErrorandWarningCodesStatusCodeRangesStatusCodeType NumericRange(inHex)IviSpecAnErrors 0xBFFA2001to0xBFFA3FFFIviSpecAnWarnings 0x3FFA2001to0x3FFA3FFFIVISpecificDriverErrors 0xBFFA4000to0xBFFA5FFFIVISpecificDriverWarnings 0x3FFA4000to0x3FFA5FFFIVIErrors 0xBFFA0000to0xBFFA1FFFIVIWarnings 0x3FFA0000to0x3FFA1FFFCommonInstrumentDriverErrors 0xBFFC0000to0xBFFCFFFFCommonInstrumentDriverWarnings 0x3FFC0000to0x3FFCFFFFVISAErrors 0xBFFF0000to0xBFFFFFFFVISAWarnings 0x3FFF0000to0xFFFFFFF
TheIviSpecAnclassdriverdefinestheerrorcodesshowninthefollowingtableinadditiontotheIVIdefinederrorcodes.
IviSpecAnErrorCodesError Value MessageIVISPECAN_ERROR_MARKER_NOT_ENABLED 0xBFFA2001 TheActive
Markerisnotenabled.
IVISPECAN_ERROR_NOT_DELTA_MARKER 0xBFFA2002 TheActiveMarkerisnotadeltamarker.
IVISPECAN_ERROR_MAX_TIME_EXCEEDED 0xBFFA2003 Maximumtimeexceededbeforetheoperationcompleted.
IviSpecAnWarningCodeWarning Value MessageIVISPECAN_WARN_OVER_RANGE 0x3FFA2002 OverRange
warningIVISPECAN_WARN_MEASURE_UNCALIBERATED 0x3FFA2001 The
instrumentwasinauncalibratedstatewhenthemeasurementwastaken.
RelatedTopicIVIStatusCodes
IviSpecAnVIsExpandthisbooktoviewanalphabetizedlistofIviSpecAnVIs.
IviSpecAnAbortIviSpecAnBaseCapabilityGroupThisVIabortsapreviouslyinitiatedmeasurementandreturnsthespectrumanalyzertotheidlestate.
Note:
ThisVIdoesnotchecktheinstrumentstatus.Typically,youcallthisVIonlyinasequenceofcallstootherlow-leveldriverVIs.Thesequenceperformsoneoperation.Usethelow-levelVIstooptimizeoneormoreaspectsofinteractionwiththeinstrument.Ifyouwanttochecktheinstrumentstatus,calltheattheconclusionofthesequence.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSpecAnAcquisitionStatusIviSpecAnBaseCapabilityGroupThisVIdeterminesifanacquisitionisinprogressorcomplete.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.acquisitionstatusReturnstheacquisitionstatus.
ValidValues:
IVISPECAN_VAL_ACQUISITION_STATUS_COMPLETE(1)-Thespectrumanalyzerhascompletedtheacquisition.
IVISPECAN_VAL_ACQUISITION_STATUS_IN_PROGRESS(0)-Thespectrumanalyzerisstillacquiringdata.
IVISPECAN_VAL_ACQUISITION_STATUS_UNKNOWN(-1)-Thespectrumanalyzercannotdeterminethestatusoftheacquisition.erroroutTheerroroutclusterpasseserrororwarninginformation
outofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSpecAnAddTraces[MT]IviSpecAnMultitraceCapabilityGroupThisVIaddstrace1andtrace2,pointbypoint,andstorestheresultsinthedestinationtrace.Anydatainthedestinationtraceisdeleted.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.destinationtracePassthetracenameintowhichtheaddedtracesarestored.Anydatainthedestinationtraceisoverwritten.
Thiscontrolacceptseitheravirtualrepeatedcapabilitynameoraninstrument-specifictracename.
Virtualrepeatedcapabilitynamesarealiasesforinstrument-specifictracestrings.Theinstrument-specifictracestringscandifferfromoneinstrumenttoanother.Virtualrepeatedcapabilitynamesallowyoutouseandswapinstrumentswithouthavingtochangethetracenamesinyoursourcecode.YouspecifyvirtualrepeatedcapabilitynamesinMAX.
DefaultValue:""trace1Passthetracenameofoneofthetwotracestobeadded.
Thiscontrolacceptseitheravirtualrepeatedcapabilitynameoraninstrument-specifictracename.
Virtualrepeatedcapabilitynamesarealiasesforinstrument-specifictracestrings.Theinstrument-specifictracestringscandifferfromoneinstrumenttoanother.Virtualrepeatedcapabilitynamesallowyoutouseandswapinstrumentswithouthavingto
changethetracenamesinyoursourcecode.YouspecifyvirtualrepeatedcapabilitynamesinMAX.
DefaultValue:""trace2Passthetracenameofthesecondtracetobeadded.
Thiscontrolacceptseitheravirtualrepeatedcapabilitynameoraninstrument-specifictracename.
Virtualrepeatedcapabilitynamesarealiasesforinstrument-specifictracestrings.Theinstrument-specifictracestringscandifferfromoneinstrumenttoanother.Virtualrepeatedcapabilitynamesallowyoutouseandswapinstrumentswithouthavingtochangethetracenamesinyoursourcecode.YouspecifyvirtualrepeatedcapabilitynamesinMAX.
DefaultValue:""errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSpecAnConfigureAcquisitionIviSpecAnBaseCapabilityGroupThisVIconfigurestheacquisitionpropertiesofthespectrumanalyzer.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.sweepmodecontinuousTurnson/offcontinuoussweeping.Thedriverusesthisvaluetosettheproperty.
ValidValues:
TRUE-Sweepmodeiscontinuous.FALSE-Sweepmodeisnotcontinuous.
DefaultValue:FALSEnumberofsweepsThenumberofsweepstotake.Thedriversetsthepropertytothisvalue.
DefaultValue:1detectortypeautoEnablestheautodetector.Thedriverusesthisvaluetosetthe_AUTOproperty.
Note:Whenthe_AUTOpropertyissettoTrue,therelationshipbetweenthepropertyandtheIVISPECAN__ATTR_DETECTOR_TYPattributeisisnotdefined.
ValidValues:
TRUE-Detectortypeisautomaticallyselected.FALSE-Detectortypeismanuallyselected.
DefaultValue:FALSEdetectortypeSpecifiesthemethodofcapturingandprocessingsignaldata.Thedriverusesthisvaluetosettheproperty.
ValidValues:-IVISPECAN_VAL_DETECTOR_TYPE_AUTO_PEAK-Allowsthedetectortocapturebetterreadingsbyusingbothpositiveandnegativepeakvalueswhennoiseispresent.
-IVISPECAN_VAL_DETECTOR_TYPE_AVERAGE-Averagevalueofsamplestakenwithinthebinforadedicatedpointonthedisplay.
-IVISPECAN_VAL_DETECTOR_TYPE_MAX_PEAK-Obtainsthemaximumvideosignalbetweenthelastdisplaypointandthepresentdisplaypoint.
-IVISPECAN_VAL_DETECTOR_TYPE_MIN_PEAK-Obtainstheminimumvideosignalbetweenthelastdisplaypointandthepresentdisplaypoint.
-IVISPECAN_VAL_DETECTOR_TYPE_SAMPLE-Pickonepointwithinabin.
-IVISPECAN_VAL_DETECTOR_TYPE_RMS-RMSvalueofsamplestakenwithinthebinforadedicatedpointonthedisplay.
DefaultValues:IVISPECAN_VAL_DETECTOR_TYPE_AVERAGEverticalscalePasstheverticalscaleofthemeasurementhardwarethatyouwantthespectrumanalyzertouse(useoflogamplifiersorlinearamplifiers).Thedriversetsthepropertytothisvalue.
DefinedValues:
IVISPECAN_VAL_VERTICAL_SCALE_LINEAR-LinearIVISPECAN_VAL_VERTICAL_SCALE_LOGARITHMIC-Logarithmic
DefaultValue:IVISPECAN_VAL_VERTICAL_SCALE_LOGARITHMICerrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSpecAnConfigureConversionLossTableEnabled[EM]IviSpecAnExternalMixerCapabilityGroupThisVIenablestheconversionlosstable.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.conversionlosstableenabledSpecifywhethertheconversionlosstableisenabled.ThedriverusesthisvaluetosettheIviSpecAn>>ExternalMixing>>ExternalMixerConversionLossTableEnabledproperty.
ValidValues:TRUE;FALSE
DefaultValue:FALSEerrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSpecAnConfigureConversionLossTable[EM]IviSpecAnExternalMixerCapabilityGroupThisVIconfigurestheconversionlosstablebyspecifyingaseriesoffrequencyandapowerlosspairs.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.countSpecifythenumberoffrequencyandconversionlosspairs.
DefaultValue:NonefrequencyAnarrayoffrequencyvaluesforthefrequencyandpowerlosspairs.ThearraymusthaveatleastasmanyelementsasthevalueyouspecifyintheCountparameter.
DefaultValue:NoneconversionlossAnarrayofconversionlossvaluesforthefrequencyandpowerlosspairs.ThearraymusthaveatleastasmanyelementsasthevalueyouspecifyintheCountparameter.
DefaultValue:Noneerrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptions
VIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSpecAnConfigureExternalMixerBiasEnabled[EM]IviSpecAnExternalMixerCapabilityGroupThisVIenablestheexternalmixingbias.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.biasenabledSpecifieswhetherexternalmixerbiasisenabled.ThedriverusesthisvaluetosettheIviSpecAn>>ExternalMixing>>BiasEnabledproperty.
ValidValues:TRUE;FALSE
DefaultValue:FALSEerrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSpecAnConfigureExternalMixerBias[EM]IviSpecAnExternalMixerCapabilityGroupThisVIconfigurestheexternalmixerbiasandtheexternalmixerbiaslimit.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.biasSpecifiesthebiascurrent.ThedriverusesthisvaluetosettheIviSpecAn>>ExternalMixing>>Biasproperty.
Units:Amps
DefaultValue:0.0biaslimitSpecifiesthebiascurrentlimit.ThedriverusesthisvaluetosettheIviSpecAn>>ExternalMixing>>Bias_LIMITproperty.
Units:Amps
DefaultValue:0.0errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptions
VIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSpecAnConfigureExternalMixerEnabled[EM]IviSpecAnExternalMixerCapabilityGroupThisVIenablesexternalmixing.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.externalmixingenabledSpecifieswhetherexternalmixingisenabled.ThedriverusesthisvaluetosettheIviSpecAn>>ExternalMixing>>ExternalMixerEnabledproperty.
ValidValues:TRUE;FALSE
DefaultValue:FALSEerrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSpecAnConfigureExternalMixerNumberofPorts[EM]IviSpecAnExternalMixerCapabilityGroupThisVIspecifiesthenumberofexternalmixerports.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.numberofportsSpecifythenumberofmixerports.ThedriversetstheIviSpecAn>>ExternalMixing>>ExternalMixerNumberofPortspropertytothisvalue.
DefaultValue:2errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSpecAnConfigureExternalMixer[EM]IviSpecAnExternalMixerCapabilityGroupThisVIspecifiesthemixerharmonicandaverageconversionloss.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.harmonicSpecifiestheordernoftheharmonicusedforconversion.ThedriversetstheIviSpecAn>>ExternalMixing>>ExternalMixerHarmonicpropertytothisvalue.
DefaultValue:0averageconversionlossSpecifiestheaverageconversionloss.ThedriversetstheIviSpecAn>>ExternalMixing>>ExternalMixerAverageConversionLosstothisvalue.
DefaultValue:0.0errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.
Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSpecAnConfigureExternalTrigger[EXT]IviSpecAnExternalTriggerCapabilityGroupThisVIspecifiestheexternallevelandpolarityfortriggering.Thisisapplicablewhenthetriggersourceissettoexternal.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.externaltriggerlevelSpecifiestheleveloftheexternaltriggersignaltotriggeranacquisition.ThedriverusesthisvaluetosettheIviSpecAn>>Trigger>>ExternalTrigger>>ExternalTriggerLevelproperty.
Units:Volts
DefaultValue:1.0VexternaltriggerpolaritySpecifiestheslopeoftheexternaltriggersignaltotriggeranacquisition.ThedriverusesthisvaluetosettheIviSpecAn>>Trigger>>ExternalTrigger>>ExternalTriggerSlopeproperty.
ValidValues:-IVISPECAN_VAL_EXTERNAL_TRIGGER_SLOPE_POSITIVE-Setspositiveslope.
-IVISPECAN_VAL_EXTERNAL_TRIGGER_SLOPE_NEGATIVE-Setspositiveslope.
Defaultvalue:IVISPECAN_VAL_EXTERNAL_TRIGGER_SLOPE_POSITIVE
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSpecAnConfigureFrequencyCenterSpanIviSpecAnBaseCapabilityGroupThisVIconfiguresthefrequencyrangeofthespectrumanalyzerusingthecenterfrequencyandthefrequencyspan.IfspancorrespondstozeroHertz,thenthespectrumanalyzeroperatesintime-domainmode.Otherwise,spectrumanalyzeroperatesinfrequency-domainmode.
ThisVImodifiestheandpropertiesasfollows:
FrequencyStart=CenterFrequency-Span/2FrequencyStop=CenterFrequency+Span/2
Note:
Inauto-coupledmode,resolutionbandwidth(RBW),videobandwidth(VBW),andsweeptimemaybeaffectedbythisVI.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.centerfrequencyThecenterfrequencyofthefrequencysweep.
Units:Hertz
DefaultValue:5.0MHzspanThefrequencyspanofthefrequencysweep.
Units:Hertz
DefaultValue:1.0MHz
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSpecAnConfigureFrequencyOffsetIviSpecAnBaseCapabilityGroupThisVIconfiguresthefrequencyoffsetofthespectrumanalyzer.Thisaffectsthesettingofthespectrumanalyzer'sabsolutefrequencies,suchasstart,stop,center,andmarker.ThisVIdoesnotmodifythesettingsfordifferencesoffrequencies,suchasspananddeltamarker.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.frequencyoffsetSpecifiesanoffsetvaluethatisaddedtothefrequencyreadout.Theoffsetisusedtocompensateforexternalfrequencyconversion.Thedriverusesthisvaluetosettheproperty.
Units:Hertz
DefaultValue:1.0e12Hzerrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.
Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSpecAnConfigureFrequencyStartStopIviSpecAnBaseCapabilityGroupThisVIconfiguresthefrequencyrangedefiningitsstartfrequencyanditsstopfrequency.Ifthestartfrequencyisequaltothestopfrequency,thenthespectrumanalyzeroperatesinthetime-domainmode.Otherwise,thespectrumanalyzeroperatesinfrequency-domainmode.
Notes
(1)Inauto-coupledmode,resolutionbandwidth(RBW),videobandwidth(VBW),andsweeptimemaybeaffectedbythisVI.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.startfrequencyThestartfrequencyofthefrequencysweep.Thedriverusesthisvaluetosettheproperty.
Units:Hertz
DefaultValue:1.0MHzstopfrequencyThestopfrequencyofthefrequencysweep.Thedriverusesthisvaluetosettheproperty.
Units:Hertz
DefaultValue:10.0MHzerrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.Usethisinformationtodecideif
anyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSpecAnConfigureLevelIviSpecAnBaseCapabilityGroupThisVIconfigurestheverticalsettingsofthespectrumanalyzer.Thiscorrespondstosettingslikeamplitudeunits,inputattenuation,inputimpedance,referencelevel,andreferenceleveloffset.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.amplitudeunitsPasstheunitsyouwantthespectrumanalyzertouseforinput,output,anddisplay.Thedriversetsthetothisvalue.
ValidValues:-IVISPECAN_VAL_AMPLITUDE_UNITS_DBM-Setsthespectrumanalyzertomeasureindecibelsrelativeto1milliwatt.
-IVISPECAN_VAL_AMPLITUDE_UNITS_DBMV-Setsthespectrumanalyzertomeasureindecibelsrelativeto1millivolt.
-IVISPECAN_VAL_AMPLITUDE_UNITS_DBUV-Setsthespectrumanalyzertomeasureindecibelsrelativeto1microvolt.
-IVISPECAN_VAL_AMPLITUDE_UNITS_VOLT-Setsthespectrumanalyzertomeasureinvolts.
-IVISPECAN_VAL_AMPLITUDE_UNITS_WATT-Setsthespectrumanalyzertomeasureinwatts.
Defaultvalue:IVISPECAN_VAL_AMPLITUDE_UNITS_VOLTinputimpedanceSpecifiesthevalueofinputimpedance,inohms,expectedattheactiveinputport.Thisistypically50ohmsor75ohms.Thedriverusesthisvaluetosettheproperty.
Units:Ohms
DefaultValue:50ohmsreferencelevelThecalibratedverticalpositionofthecaptureddatausedasareferenceforamplitudemeasurements.Thisistypicallysettoavalueslightlyhigherthanthehighestexpectedsignallevel.Thedriverusesthisvaluetosettheproperty.
Units:TheunitsaredeterminedbysettingtheAmplitudeUnitsparameterofthisVIorbysettingproperty.
DefaultValue:0.0referenceleveloffsetSpecifiestheoffsetvaluetothereferencelevel.Thisadjuststhereferencelevelforexternalsignalgainorloss.Apositivevaluecorrespondstoagainwhileanegativenumbercorrespondstoaloss.Thedriverusesthisvaluetosetthe_OFFSETproperty.
Units:dB
DefaultValue:0.0attenuationautoSpecifieswhetherthespectrumanalyzerisenabledforautoattenuation.WhenyousetthisvaluetoTRUE,theattenuationisautomaticallyselected.WhenyousetthisvaluetoFALSE,theattenuationissettomanualselection.Thedriverusesthisvaluetosetthe_AUTOproperty.
ValidValues:
TRUE-AttenuationisautomaticallyselectedFALSE-Attenuationismanuallyselected
DefaultValue:FALSE
attenuationSpecifiestheinputattenuation(inpositivedB).Thismeansthatif10dBisselected,theresultisareductioninthesignallevelof10dB.Thedriverusesthisvaluetosettheproperty.
Units:dB
DefaultValue:0.0
Note:
Ifautoattenuationisturnedon,thisvalueisignored.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSpecAnConfigureMarkerEnabled[MKR]IviSpecAnMarkerCapabilityGroupThisVIenablestheactivemarkeronthespecifiedtrace.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.markerenabledSpecifieswhetherthespecifiedmarkerisenabled.ThedriverusesthisvaluetosettheIviSpecAn>>Markers>>MarkerEnabledproperty.
ValidValues:TRUE;FALSE
DefaultValue:FALSEmarkertracenamePassthenameofthetraceyouforwhichyouareenablingtheactivemarker.
Thiscontrolacceptseitheravirtualrepeatedcapabilitynameoraninstrument-specifictracename.
Virtualrepeatedcapabilitynamesarealiasesforinstrument-specifictracestrings.Theinstrument-specifictracestringscandifferfromoneinstrumenttoanother.Virtualrepeatedcapabilitynamesallowyoutouseandswapinstrumentswithouthavingtochangethetracenamesinyoursourcecode.YouspecifyvirtualrepeatedcapabilitynamesinMAX.
DefaultValue:""errorin(noerror)Theerrorinclustercanaccepterrorinformation
wiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSpecAnConfigureMarkerFrequencyCounter[MKR]IviSpecAnMarkerCapabilityGroupThisVIsetsthemarkerfrequencycounterresolutionandturnsthemarkerfrequencycounteron/off.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.markerfrequencycounterSpecifieswhetherthefrequencycounterisenabled.ThedriverusesthisvaluetosettheIviSpecAn>>Markers>>MarkerFrequencyCounterEnabledproperty.
ValidValues:TRUE;FALSE
DefaultValue:FALSEfrequencycounterresolutionSpecifiesthefrequencycounterresolution.Themeasurementgatetimeisthereciprocalofthespecifiedresolution.ThedriverusesthisvaluetosettheIviSpecAn>>Markers>>MarkerFrequencyCounterResolutionproperty.
Units:Hertz
DefaultValue:1.0KHz
Note:
ThisvalueisignoredwhentheIviSpecAn>>Markers>>Marker
FrequencyCounterEnabledisFalse.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSpecAnConfigureMarkerSearch[MKR]IviSpecAnMarkerCapabilityGroupThisVIconfiguresthemarkerpeakexcursionandmarkerthresholdvalues.Themarkerpeakexcursionspecifiestheminimumamplitudevariationthatcanberecognizedasapeakorminimumbythemarker.ThemarkerthresholdspecifiesalowerboundforALLmarkersearchVIs.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.peakexcursionSpecifiestheminimumamplitudevariationofthesignalindBthattheidentifiesasapeak.ThedriverusesthisvaluetosettheIviSpecAn>>Markers>>PeakExcursionproperty.
Units:dB
DefaultValue:10.0dBmarkerthresholdSpecifiesthelowerlimitofthesearchdomainverticalrangeforthe.ThedriverusesthisvaluetosettheIviSpecAn>>Markers>>MarkerThresholdproperty.
Units:AmplitudeUnits
DefaultValue:0.0errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmore
informationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSpecAnConfigureSignalTrackEnabled[MKR]IviSpecAnMarkerCapabilityGroupThisVIenablessignal-tracking.Whensignaltrackingisturnedon,thespectrumanalyzercentersthesignalonwhichtheactivemarkerresidesaftereachsweep.Therearetwoprevalentmethodsofsignaltrackingintheindustry.
1.Asearchforthelargestsignalonscreenismade,andthespectrumanalyzercenterfrequencyistunedtothissignal.
2.Themarkerisplacedonasignal(anywhereonscreen)andwhenmarkertrackisenabled,thefrequencyofthepeakoftheselectedsignalisusedfortuningthespectrumanalyzer.Thisdoesnotneedtobethelargestsignalonscreen,andthismethodtracksthespecifiedsignalinthepresenceofalargersignal.
ThisVIimplementsthefirstmethodofsignaltracking.ThisINVALIDATEStheandpropertyvalues.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.signaltrackenabledSpecifieswhethersignaltrackingisenabled.ThedriverusesthisvaluetosettheIviSpecAn>>Markers>>SignalTrackEnabledproperty.
Note:Signaltrackcanonlybeenabledononemarkeratatime.ThedrivershallcheckallothermarkerstoseeifthisVIisalreadyenabledonanymarkerotherthantheactiveandturnthisoffontheothermarkerbeforeenablingthisontheactivemarker.
ValidValues:TRUE;FALSE
DefaultValue:FALSEerrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSpecAnConfigureSweepCouplingIviSpecAnBaseCapabilityGroupThisVIconfiguresthecouplingandsweepingpropertiesofthespectrumanalyzer.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.resolutionbandwidthautoEnablesresolutionbandwidthautocoupling.Thedriverusesthisvaluetosetthe_AUTOproperty.
ValidValues:
TRUE-Resolutionbandwidthisautomaticallyselected.FALSE-Resolutionbandwidthismanuallyselected.
DefaultValue:FALSEresolutionbandwidthSpecifiesthemeasurementresolutionbandwidth.Thedriverusesthisvaluetosettheproperty.
Units:Hertz
DefaultValue:1.0HHz
Note:
ThisvalueisignoredwhentheResolutionBandwidthAutoparameterortheAutoissettoTRUE.
videobandwidthautoEnablesvideobandwidthautocoupling.Thedriverusesthisvaluetosetthe_AUTOproperty.
ValidValues:
TRUE-VideobandwidthisautomaticallyselectedFALSE-Videobandwidthismanuallyselected
DefaultValue:FALSEvideobandwidthSpecifiesthevideobandwidthofthepost-detectionfilter.Thedriverusesthisvaluetosettheproperty.
Units:Hertz
DefaultValue:1.0MHz
Note:
ThisvalueisignoredwhentheVideoBandwidthAutoparameterorthe_AUTOissettoTRUE.sweeptimeautoEnablessweeptimeauto.Thedriverusesthisvaluetosetthe_AUTOproperty.
ValidValues:TRUE-SweeptimeisautomaticallyselectedFALSE-Sweeptimeismanuallyselected
DefaultValue:FALSEsweeptimeThelengthoftimetocompleteonesweep.Thedriverusesthisvaluetosettheproperty.
Units:seconds
DefaultValue:1.0
Note:
ThisvalueisignoredwhentheSweepTimeAutoparameterorthe
_AUTOissettoTRUE.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSpecAnConfigureTraceTypeIviSpecAnBaseCapabilityGroupThisVIconfiguresthetypeoftracetoacquire.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.tracenamePassthenameofthetraceyouareconfiguring.
Thiscontrolacceptseitheravirtualrepeatedcapabilitynameoraninstrument-specifictracename.
Virtualrepeatedcapabilitynamesarealiasesforinstrument-specifictracestrings.Theinstrument-specifictracestringscandifferfromoneinstrumenttoanother.Virtualrepeatedcapabilitynamesallowyoutouseandswapinstrumentswithouthavingtochangethetracenamesinyoursourcecode.YouspecifyvirtualrepeatedcapabilitynamesinMAX.
DefaultValue:""tracetypeThetypeoftracetoacquire.Thedriversetsthepropertytothisvalue.
ValidValues:IVISPECAN_VAL_TRACE_TYPE_CLEAR_WRITE-Setsthespectrumanalyzertoclearprevioussweepdataoffthedisplaybeforeperformingasweep.Subsequentsweepsmayormaynotclearthedisplayfirst,butthedataarrayattheendofthesweepisentirelynew.
IVISPECAN_VAL_TRACE_TYPE_MAX_HOLD
-Setsthespectrumanalyzertokeepthedatafromeitherthepreviousdataorthenewsweepdata,whicheverishigher.
IVISPECAN_VAL_TRACE_TYPE_MIN_HOLD-Setsthespectrumanalyzertokeepthedatafromeitherthepreviousdataorthenewsweepdata,whicheverislower.
IVISPECAN_VAL_TRACE_TYPE_VIDEO_AVERAGE-Setsthespectrumanalyzertomaintainarunningaverageofthesweptdata.
IVISPECAN_VAL_TRACE_TYPE_VIEW-Disablesacquisitionintothistracebutdisplaystheexistingtracedata.
IVISPECAN_VAL_TRACE_TYPE_STORE-Disablesacquisitionanddisablesthedisplayoftheexistingtracedata.
DefaultValue:IVISPECAN_VAL_TRACE_TYPE_CLEAR_WRITEerrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSpecAnConfigureTriggerSource[TRG]IviSpecAnTriggerCapabilityGroupThisVIspecifiesthetriggersourcethatcausesthespectrumanalyzertoleavetheWait-for-Triggerstate.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.triggersourceSpecifiesthesourceofthetriggersignalthatcausestheanalyzertoleavetheWait-For-Triggerstate.ThedriverusesthisvaluetosettheIviSpecAn>>Trigger>>TriggerSourceproperty.
ValidValues:-IVISPECAN_VAL_TRIGGER_SOURCE_EXTERNAL-Thespectrumanalyzerwaitsuntilitreceivesatriggerontheexternaltriggerconnector.
-IVISPECAN_VAL_TRIGGER_SOURCE_IMMEDIATE-Thespectrumanalyzerdoesnotwaitforatriggerofanykind.
-IVISPECAN_VAL_TRIGGER_SOURCE_AC_LINE-ThespectrumanalyzerwaitsuntilitreceivesatriggerontheACline.
-IVISPECAN_VAL_TRIGGER_SOURCE_VIDEO-Thespectrumanalyzerwaitsuntilitreceivesavideolevel.
Defaultvalue:IVISPECAN_VAL_TRIGGER_SOURCE_EXTERNAL
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSpecAnConfigureVideoTrigger[VT]IviSpecAnVideoTriggerCapabilityGroupThisVIspecifiesthevideolevelandpolarityforvideotriggering.Thisisapplicablewhenthetriggersourceissettovideo.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.videotriggerlevelSpecifiesthelevelofthevideosignaltotriggeranacquisition.ThedriverusesthisvaluetosettheIviSpecAn>>Trigger>>VideoTrigger>>VideoTriggerLevelproperty.
Units:Theunitsarespecifiedbytheproperty.
DefaultValue:0.0videotriggerslopeSpecifiestheslopeofthevideosignaltotriggeranacquisition.ThedriverusesthisvaluetosettheIviSpecAn>>Trigger>>VideoTrigger>>VideoTriggerSlopeproperty.
ValidValues:-IVISPECAN_VAL_VIDEO_TRIGGER_SLOPE_POSITIVE-Setspositiveslope.
-IVISPECAN_VAL_VIDEO_TRIGGER_SLOPE_NEGATIVE-Setspositiveslope.
Defaultvalue:IVISPECAN_VAL_VIDEO_TRIGGER_SLOPE_POSITIVE
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSpecAnCopyTrace[MT]IviSpecAnMultitraceCapabilityGroupThisVIcopiesonetracearraytoanothertracearray.Anydatainthedestinationtraceisoverwritten.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.destinationtracePassthetracenameintowhichthearrayisstored.
Thiscontrolacceptseitheravirtualrepeatedcapabilitynameoraninstrument-specifictracename.
Virtualrepeatedcapabilitynamesarealiasesforinstrument-specifictracestrings.Theinstrument-specifictracestringscandifferfromoneinstrumenttoanother.Virtualrepeatedcapabilitynamesallowyoutouseandswapinstrumentswithouthavingtochangethetracenamesinyoursourcecode.YouspecifyvirtualrepeatedcapabilitynamesinMAX.
DefaultValue:""sourcetracePassthetracenameofthesourcetracearray.
Thiscontrolacceptseitheravirtualrepeatedcapabilitynameoraninstrument-specifictracename.
Virtualrepeatedcapabilitynamesarealiasesforinstrument-specifictracestrings.Theinstrument-specifictracestringscandifferfromoneinstrumenttoanother.Virtualrepeatedcapabilitynamesallowyoutouseandswapinstrumentswithouthavingto
changethetracenamesinyoursourcecode.YouspecifyvirtualrepeatedcapabilitynamesinMAX.
DefaultValue:""errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSpecAnDisableAllMarkers[MKR]IviSpecAnMarkerCapabilityGroupThisVIdisablesallofmarkers.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSpecAnExchangeTraces[MT]IviSpecAnMultitraceCapabilityGroupThisVIexchangesthedataarraysoftwotraces.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.trace1Passthetracenameofoneofthetwotracestobeexchanged.
Thiscontrolacceptseitheravirtualrepeatedcapabilitynameoraninstrument-specifictracename.
Virtualrepeatedcapabilitynamesarealiasesforinstrument-specifictracestrings.Theinstrument-specifictracestringscandifferfromoneinstrumenttoanother.Virtualrepeatedcapabilitynamesallowyoutouseandswapinstrumentswithouthavingtochangethetracenamesinyoursourcecode.YouspecifyvirtualrepeatedcapabilitynamesinMAX.
DefaultValue:""trace2Passthetracenameofthesecondofthetwotracestobeexchanged.
Thiscontrolacceptseitheravirtualrepeatedcapabilitynameoraninstrument-specifictracename.
Virtualrepeatedcapabilitynamesarealiasesforinstrument-specifictracestrings.Theinstrument-specifictracestringscandifferfromoneinstrumenttoanother.Virtualrepeatedcapabilitynamesallowyoutouseandswapinstrumentswithouthavingto
changethetracenamesinyoursourcecode.YouspecifyvirtualrepeatedcapabilitynamesinMAX.
DefaultValue:""errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSpecAnFetchYTraceIviSpecAnBaseCapabilityGroupThisVIreturnsthetracethespectrumanalyzeracquires.Thetraceisfromapreviouslyinitiatedacquisition.Callthetostartanacquisition.Callthetodeterminewhentheacquisitioniscomplete.Oncetheacquisitioniscomplete,calltheFetchYTraceVItoreturnthetrace.
Youmaycalltheinsteadofthe.Thestartsanacquisition,waitsfortheacquisitiontocomplete,andreturnsthetraceinoneVIcall.
Usethewhenacquiringmultipletraces.Useadifferenttracenameforeachcall.Youmayalsocallaftercallingtoacquiresubsequenttraces.
Note:
ThisVIdoesnotchecktheinstrumentstatus.Typically,youcallthisVIonlyinasequenceofcallstootherlow-leveldriverVIs.Thesequenceperformsoneoperation.Youusethelow-levelVIstooptimizeoneormoreaspectsofinteractionwiththeinstrument.Ifyouwanttochecktheinstrumentstatus,calltheattheconclusionofthesequence.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.tracenamePassthenameofthetraceforthedesiredamplitudearray.
Thiscontrolacceptseitheravirtualrepeatedcapabilitynameoraninstrument-specifictracename.
Virtualrepeatedcapabilitynamesarealiasesforinstrument-specifictracestrings.Theinstrument-specifictracestringscan
differfromoneinstrumenttoanother.Virtualrepeatedcapabilitynamesallowyoutouseandswapinstrumentswithouthavingtochangethetracenamesinyoursourcecode.YouspecifyvirtualrepeatedcapabilitynamesinMAX.
DefaultValue:""arraylengthPassthenumberofAmplitudearraypointsrequested.
DefaultValue:Noneerrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.actualpointsIndicatesthenumberofpointstheVIplacesintheAmplitudearray.
Usethetodeterminethenumberofpointsthespectrumanalyzeracquires.amplitudeReturnstheamplitudewaveformthatthespectrumanalyzeracquires.
Thisdatarepresentstheamplitudeofthesignalsofthesweepfromthestartfrequencytothestopfrequency(infrequencydomain,intimedomaintheamplitudearrayisorderedfrombeginningofsweeptoend).
TheunitsaredeterminedbytheAmplitudeUnitsparameteroftheorbytheproperty.
Note:
Thereturnsthenumberofpointsthespectrumanalyzeracquires.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSpecAnGetMarkerName[MKR]IviSpecAnMarkerCapabilityGroupThisVIreturnsthespecificdriverdefinedtracenamethatcorrespondstotheone-basedindexspecifiedbytheIndexparameter.IfyoupassinavaluefortheIndexparameterthatislessthanoneorgreaterthanthevalueoftheIviSpecAn>>Markers>>NumberofMarkersproperty,theVIreturnsanemptystringintheNameparameterandreturnstheInvalidValueerror.
Note:ForaninstrumentwithonlyoneMarker,i.e.theIviSpecAn>>Markers>>NumberofMarkerspropertyisone,thedrivermayreturnanemptystring.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.indexSpecifiestheindexoftheMarkerNametoreturn.
DefaultValue:0namebuffersizeSpecifythebuffersizefortheNameparameter.
DefaultValue:0errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtain
fromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.nameThemarkernamethatcorrespondstotheIndex.
TheNamebuffermustcontainatleastasmanyelementsasthevalueyouspecifywiththeNameBufferSizeparameter.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSpecAnGetTraceNameIviSpecAnBaseCapabilityGroupThisVIreturnsthespecificdriverdefinedtracenamethatcorrespondstotheone-basedindexspecifiedbytheIndexparameter.IfyoupassinavaluefortheIndexparameterthatislessthanoneorgreaterthanthevalueoftheproperty,theVIreturnsanemptystringintheNameparameterandreturnstheInvalidValueerror(0xBFFA1010).
Note:ForaninstrumentwithonlyoneTrace,i.e.thepropertyisone,thedrivermayreturnanemptystring.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.indexSpecifiestheindexoftheTraceNametoreturn.
DefaultValue:0namebuffersizeSpecifythebuffersizefortheNameparameter.
DefaultValue:0errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.nameThetracenamethatcorrespondstotheIndex.
TheNamebuffermustcontainatleastasmanyelementsasthevalueyouspecifywiththeNameBufferSizeparameter.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSpecAnInitiateIviSpecAnBaseCapabilityGroupThisVIinitiatesanacquisition.AftercallingthisVI,thespectrumanalyzerleavestheidlestateandwaitsforatrigger.
Notes
(1)ThisVIdoesnotchecktheinstrumentstatus.Typically,youcallthisVIonlyinasequenceofcallstootherlow-leveldriverVIs.Thesequenceperformsoneoperation.Youusethelow-levelVIstooptimizeoneormoreaspectsofinteractionwiththeinstrument.Ifyouwanttochecktheinstrumentstatus,calltheattheconclusionofthesequence.
(2)Calltodeterminewhentheacquisitioniscomplete.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmore
informationabouttheerrordisplayed.
IviSpecAnMakeMarkerDelta[DMK]IviSpecAnDeltaMarkerCapabilityGroupThisVIspecifieswhethertheactivemarkerisadeltamarker.
WhenthisVIiscalledwithDeltaMarkertrue,thecurrentactivemarkerischangedtoadeltamarkerandtheassociatedreferencemarkerismovedtothecurrentpositionoftheactivemarker.Thecurrentpositionbecomesthereferencepointformarkervalues.Themarkerreadoutindicatestherelativefrequency(ortime)separationandamplitudedifferencebetweenthereferenceandactivemarker.
WhenthisDeltaMarkerissettofalse,thecurrentmarkerischangedtoanormalmarker.Thereferencemarkerisdeterminedbycallingthe.
Notes
(1)IfthecurrentactivemarkerisnotenabledthenthisVIenablestheactivemarker.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.deltamarkerSpecifieswhethermarkerDeltaisTrueorFalse.Dependingonthisvalue,thedriverwillsetthemarkertoIVISPECAN_VAL_MARKER_TYPE_NORMALorIVISPECAN_VAL_MARKER_TYPE_DELTA(seetheVIhelpformoredetails).
ValidValues:TRUE;FALSE
DefaultValue:FALSEerrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSpecAnMarkerSearch[MKR]IviSpecAnMarkerCapabilityGroupThisVIspecifiesthetypeofmarkersearchandperformsthesearch.
ThisVIreturnstheMarkerNotEnablederror(0x0xBFFA2001)iftheIviSpecAn>>Markers>>MarkerEnabledpropertyissettoFALSE.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.markersearchSpecifiesthetypeofmarkersearchtoperform.
ValidValues:IVISPECAN_VAL_MARKER_SEARCH_HIGHEST-Setsmarkersearchforthehighestamplitude.
IVISPECAN_VAL_MARKER_SEARCH_NEXT_PEAK-Setsmarkersearchforthenexthighestpeak.
IVISPECAN_VAL_MARKER_SEARCH_NEXT_PEAK_LEFT-Setsmarkersearchforthenextpeakleftofthepeakamplitude.
IVISPECAN_VAL_MARKER_SEARCH_NEXT_PEAK_RIGHT-Setsmarkersearchforthenextpeakrightofthepeakamplitude.
IVISPECAN_VAL_MARKER_SEARCH_MINIMUM-Setsmarkersearchfortheminimumamplitude.
DefaultValue:IVISPECAN_VAL_MARKER_SEARCH_MINIMUMerrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.Usethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfrom
otherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSpecAnMoveMarker[MKR]IviSpecAnMarkerCapabilityGroupThisVImovestheactivemarkertothespecifiedhorizontalposition.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.markerpositionSpecifiesthefrequencyortimepositionoftheactivemarker.ThedriverusesthisvaluetosettheIviSpecAn>>Markers>>MarkerPositionproperty.
Units:HertzorSeconds
DefaultValue:0.0errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSpecAnPeakPreselector[PS]IviSpecAnPreselectorCapabilityGroupThisVIadjuststhepreselectortoobtainthemaximumreadingsforthecurrentstartandstopfrequency.ThisVImayaffectthemarkerconfiguration.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSpecAnQueryMarkerType[MKT]IviSpecAnMarkerTypeCapabilityGroupThisVIqueriestheread-onlyIviSpecAn>>Markers>>MarkerType>>MarkerTypeproperty.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.markertypeReturnsthemarkertype.ThisvaluecorrespondstotheIviSpecAn>>Markers>>MarkerType>>MarkerTypeproperty.
ValidValues:
IVISPECAN_VAL_MARKER_TYPE_NORMAL(1)-Regularmarkerusedtomakeabsolutemeasurements.
IVISPECAN_VAL_MARKER_TYPE_DELTA(2)-Markerusedinconjunctionwiththereferencemarkertomakerelativemeasurements.erroroutTheerroroutclusterpasseserrororwarninginformation
outofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSpecAnQueryMarker[MKR]IviSpecAnMarkerCapabilityGroupThisVIreturnsthehorizontalpositionandthemarkeramplitudeleveloftheactivemarker.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.markerpositionReturnsthehorizontalpositionoftheactivemarkerfromtheIviSpecAn>>Markers>>MarkerPositionproperty.markeramplitudeReturnstheamplitudevalueoftheactivemarkerfromtheIviSpecAn>>Markers>>MarkerAmplitudeproperty.
Units:Theunitsarespecifiedbytheproperty,exceptwhentheIviSpecAn>>Markers>>MarkerType>>MarkerTypepropertyissettoDelta.WhenIviSpecAn>>Markers>>MarkerType>>MarkerTypeissettoDeltatheunitsaredB.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSpecAnQueryReferenceMarker[DMK]IviSpecAnDeltaMarkerCapabilityGroupThisVIreturnstheamplitudeandpositionofthereferencemarker.
IftheIviSpecAn>>Markers>>MarkerType>>MarkerTypepropertyisnotDelta,thisVIreturnstheNotDeltaMarkererror(0xBFFA2002).
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.referencemarkeramplitudeReturnsthereferencemarkerwhentheactivemarkerisadeltamarker.ThisreturnsthevalueoftheIviSpecAn>>Markers>>DeltaMarker>>ReferenceMarkerAmplitudeproperty.
DefaultValue:NonereferencemarkerpositionReturnsthereferencemarkerpositionwhentheactivemarkerisadeltamarker.ThisreturnsthevalueoftheIviSpecAn>>Markers>>DeltaMarker>>ReferenceMarkerPositionproperty.
DefaultValue:NoneerroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSpecAnQueryTraceSizeIviSpecAnBaseCapabilityGroupThisVIqueriestheread-onlyproperty.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.tracenamePassthenameofthetracewhichyourequestthetracesize.
Thiscontrolacceptseitheravirtualrepeatedcapabilitynameoraninstrument-specifictracename.
Virtualrepeatedcapabilitynamesarealiasesforinstrument-specifictracestrings.Theinstrument-specifictracestringscandifferfromoneinstrumenttoanother.Virtualrepeatedcapabilitynamesallowyoutouseandswapinstrumentswithouthavingtochangethetracenamesinyoursourcecode.YouspecifyvirtualrepeatedcapabilitynamesinMAX.
DefaultValue:""errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.
tracesizeReturnsthenumberofpointsinthetracearray.Thisvaluecorrespondstotheproperty.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSpecAnReadYTraceIviSpecAnBaseCapabilityGroupThisVIinitiatesasignalacquisitionbasedonthepresentinstrumentconfiguration.Itthenwaitsfortheacquisitiontocomplete,andreturnsthetraceasanarrayofamplitudevalues.Theamplitudearrayreturnsdatathatrepresenttheamplitudeofthesignalsofthesweepfromthestartfrequencytothestopfrequency(infrequencydomain,intimedomaintheamplitudearrayisorderedfrombeginningofsweeptoend).ThisVIresetsthesweepcount.
Notes
(1)IfthespectrumanalyzerdidnotcompletetheacquisitionwithinthetimespecifiedintheMaximumTimeparameter,thisVIreturnstheMaxTimeExceeded(0xBFFA2003)error.
(2)Ifthedatawascapturedinanuncalibratedspectrumanalyzermode,thisVIreturnsaMeasureUncalibrated(0x3FFA2001)warning.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.tracenamePassthenameofthetraceforthedesiredamplitudearray.
Thiscontrolacceptseitheravirtualrepeatedcapabilitynameoraninstrument-specifictracename.
Virtualrepeatedcapabilitynamesarealiasesforinstrument-specifictracestrings.Theinstrument-specifictracestringscan
differfromoneinstrumenttoanother.Virtualrepeatedcapabilitynamesallowyoutouseandswapinstrumentswithouthavingtochangethetracenamesinyoursourcecode.YouspecifyvirtualrepeatedcapabilitynamesinMAX.
DefaultValue:""maximumtime(ms)Passthemaximumlengthoftimeinwhichtoallowthereadtraceoperationtocomplete.
Iftheoperationdoesnotcompletewithinthistimeinterval,theVIreturnstheIVISPECAN_ERROR_MAX_TIME_EXCEEDED(0xBFFA2003)errorcode.Whenthisoccurs,calltocancelthereadtraceoperationandreturnthespectrumanalyzertotheIdlestate.
Units:milliseconds.
DefinedValues:IVISPECAN_VAL_MAX_TIME_INFINITE(-1)IVISPECAN_VAL_MAX_TIME_IMMEDIATE(0)
DefaultValue:5000(ms)
Notes
(1)TheMaximumTimeparameterappliesonlytothisVI.Ithasnoeffectonothertimeoutparametersorproperties.arraylengthPassthenumberofAmplitudearraypointsrequested.
DefaultValue:Noneerrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.actualpointsIndicatesthenumberofpointstheVIplacesintheAmplitudearray.amplitudeReturnstheamplitudewaveformthatthespectrumanalyzeracquires.
Units:TheunitsaredeterminedbysettingtheAmplitudeUnitsparameteroftheorbysettingproperty.
Notes
(1)Thereturnsthenumberofpointsthespectrumanalyzeracquires.PassaViReal64arraywithatleastthismanyelements.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSpecAnSendSoftwareTrigger[SWT]ThisVIsendsacommandtotriggerthespectrumanalyzer.CallthisVIifyoupassIVISPECAN_VAL_TRIGGER_SOURCE_SOFTWAREfortheIviSpecAn>>Trigger>>TriggerSourcepropertyortheTriggerSourceparameterofthe.
Notes
(1)IftheIviSpecAn>>Trigger>>TriggerSourceisnotsettotheIVISPECAN_VAL_TRIGGER_SOURCE_SOFTWAREvalue,thisVIreturnstheTriggerNotSoftwareerror(0xBFFA1001).
(2)ThisVIdoesnotchecktheinstrumentstatus.Typically,youcallthisVIonlyinasequenceofcallstootherlow-leveldriverVIs.Thesequenceperformsoneoperation.Youusethelow-levelVIstooptimizeoneormoreaspectsofinteractionwiththeinstrument.Ifyouwanttochecktheinstrumentstatus,calltheattheconclusionofthesequence.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.
erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSpecAnSetActiveMarker[MKR]IviSpecAnMarkerCapabilityGroupThisVIselectsoneoftheavailablemarkers,andmakesittheactivemarker.Theactivemarkermustbeenabledusingthebeforeitcanbeusedformostmarkeroperations.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.activemarkerPassthenameofthemarkertobeselected.ThedriverusesthisvaluetosettheIviSpecAn>>Markers>>ActiveMarkerproperty.
Thiscontrolacceptseitheravirtualrepeatedcapabilitynameoraninstrument-specificmarkername.
Virtualrepeatedcapabilitynamesarealiasesforinstrument-specificmarkerstrings.Theinstrument-specificmarkerstringscandifferfromoneinstrumenttoanother.Virtualrepeatedcapabilitynamesallowyoutouseandswapinstrumentswithouthavingtochangethetracenamesinyoursourcecode.YouspecifyvirtualrepeatedcapabilitynamesinMAX.
DefaultValue:""errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmore
informationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSpecAnSetInstrumentFromMarker[MKR]IviSpecAnMarkerCapabilityGroupThisVIusestheIviSpecAn>>Markers>>MarkerPositionorIviSpecAn>>Markers>>MarkerAmplitudepropertytoconfigurethespectrumanalyzeraccordingtovalueoftheInstrumentSettingparameter.Forexample,settingtheInstrumentSettingparametertoFrequencyCentersetsthecenterfrequencytothevalueoftheIviSpecAn>>Markers>>MarkerPositionproperty.
ThisVImaysetthe,,orproperties.
IftheIviSpecAn>>Markers>>MarkerEnabledpropertyissettoFALSE,thisVIreturnstheMarkerNotEnablederror(0xBFFA2001).IftheIviSpecAn>>Markers>>MarkerType>>MarkerTypepropertyisnotDeltaandtheInstrumentSettingparameterisFrequencySpan,theVIreturnstheNotDeltaMarkererror(0xBFFA2002).
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.instrumentsettingSpecifiestheinstrumentsettingtobesetfromthemarkerposition.
DefinedValues:FrequencyCenter-IVISPECAN_VAL_INSTRUMENT_SETTING_FREQUENCY_CENTER
FrequencySpan-IVISPECAN_VAL_INSTRUMENT_SETTING_FREQUENCY_SPAN
FrequencyStart-
IVISPECAN_VAL_INSTRUMENT_SETTING_FREQUENCY_START
FrequencyStop-IVISPECAN_VAL_INSTRUMENT_SETTING_FREQUENCY_STOP
ReferenceLevel-IVISPECAN_VAL_INSTRUMENT_SETTING_REFERENCE_LEVEL
DefaultValue:FrequencyCenter-IVISPECAN_VAL_INSTRUMENT_SETTING_FREQUENCY_CENTERerrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSpecAnSubtractTraces[MT]IviSpecAnMultitraceCapabilityGroupThisVIsubtractsthearrayelementsofTrace2fromTrace1andstorestheresultintheDestinationTrace.
DestinationTrace=Trace1-Trace2
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.destinationtracePassthetracenameintowhichthesubtractedtracesarestored.
DestinationTrace=Trace1-Trace2.
Anydatainthedestinationtraceisoverwritten.
Thiscontrolacceptseitheravirtualrepeatedcapabilitynameoraninstrument-specifictracename.
Virtualrepeatedcapabilitynamesarealiasesforinstrument-specifictracestrings.Theinstrument-specifictracestringscandifferfromoneinstrumenttoanother.Virtualrepeatedcapabilitynamesallowyoutouseandswapinstrumentswithouthavingtochangethetracenamesinyoursourcecode.YouspecifyvirtualrepeatedcapabilitynamesinMAX.
DefaultValue:""trace1Passthetracenameofoneofthetwotracestobesubtracted.
Thiscontrolacceptseitheravirtualrepeatedcapabilitynameoraninstrument-specifictracename.
Virtualrepeatedcapabilitynamesarealiasesforinstrument-specifictracestrings.Theinstrument-specifictracestringscandifferfromoneinstrumenttoanother.Virtualrepeatedcapabilitynamesallowyoutouseandswapinstrumentswithouthavingtochangethetracenamesinyoursourcecode.YouspecifyvirtualrepeatedcapabilitynamesinMAX.
DefaultValue:""trace2Passthetracenameofthesecondtracetobesubtracted.
Thiscontrolacceptseitheravirtualrepeatedcapabilitynameoraninstrument-specifictracename.
Virtualrepeatedcapabilitynamesarealiasesforinstrument-specifictracestrings.Theinstrument-specifictracestringscandifferfromoneinstrumenttoanother.Virtualrepeatedcapabilitynamesallowyoutouseandswapinstrumentswithouthavingtochangethetracenamesinyoursourcecode.YouspecifyvirtualrepeatedcapabilitynamesinMAX.
DefaultValue:""errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSpecAnInitializeorIviSpecAnInitializeWithOptionsVIs.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.
Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSpecAnPropertiesExpandthisbooktoviewanalphabetizedlistofIviSpecAnproperties.
ActiveTraceActiveTracePropertyDatatype Access Appliesto Coercion HighLevelVIs
WO n/a none none
DescriptionSpecifiesthetracenameusedtoaccessallsubsequentpropertiesinthisinstanceofthepropertynode.Ifthepropertyyouareattemptingtouseistrace-based,youmustfirstselecttheActiveTracepropertyandpassthenameofaspecifictrace.Youcanpassoneofthetracestringsthatthespecificinstrumentdriverdefines,oravirtualnametheend-userdefinesintheIVIconfigurationfileinMAX.
PropertyNodePathIviSpecAn»ActiveTrace
IviSpecAnActiveMarker[MKR]IviSpecAnMarkerPropertyDatatype Access Appliesto Coercion HighLevelVIs
R/W N/A None IviSpecAnSetActiveMarker[MKR]
DescriptionSpecifiesthemarkerwhichiscurrentlyactive.ThevaluesforthispropertycorrespondtotheMarkerrepeatedcapability.
PropertyNodePathIviSpecAn»Markers>>ActiveMarker[MKR]
IviSpecAnAmplitudeUnitsIviSpecAnBasePropertyDatatype Access Appliesto Coercion HighLevelVIs
R/W N/A None IviSpecAnConfigureLevel
DescriptionSpecifiestheamplitudeunitsforinput,output,anddisplayamplitude.
PropertyNodePathIviSpecAn»BasicOperation>>AmplitudeUnits
DefinedValuesIVISPECAN_VAL_AMPLITUDE_UNITS_DBMIVISPECAN_VAL_AMPLITUDE_UNITS_DBMVIVISPECAN_VAL_AMPLITUDE_UNITS_DBUVIVISPECAN_VAL_AMPLITUDE_UNITS_VOLTIVISPECAN_VAL_AMPLITUDE_UNITS_WATT
IviSpecAnAttenuationIviSpecAnBasePropertyDatatype Access Appliesto Coercion HighLevelVIs
R/W N/A Up IviSpecAnConfigureLevel
DescriptionSpecifiestheinputattenuation(inpositivedB).Thismeansthatif10dBisselected,theresultisareductioninthesignallevelof10dB.
PropertyNodePathIviSpecAn»BasicOperation>>Attenuation
IviSpecAnAttenuationAutoIviSpecAnBasePropertyDatatype Access Appliesto Coercion HighLevelVIs
R/W N/A None IviSpecAnConfigureLevel
DescriptionEnablesordisablesautoattenuation.
PropertyNodePathIviSpecAn»BasicOperation>>AttenuationAuto
DefinedValuesVI_TRUEVI_FALSE
IviSpecAnBias[EM]IviSpecAnExternalMixerPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviSpecAnConfigureExternalMixerBias[EM]
DescriptionSpecifiestheexternalmixerbiascurrentinAmps.
PropertyNodePathIviSpecAn»ExternalMixing>>Bias[EM]
IviSpecAnBiasEnabled[EM]IviSpecAnExternalMixerPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviSpecAnConfigureExternalMixerBiasEnabled[EM]
DescriptionEnablestheexternalmixer'sbias.
PropertyNodePathIviSpecAn»ExternalMixing>>BiasEnabled[EM]
DefinedValuesVI_TRUEVI_FALSE
IviSpecAnBiasLimit[EM]IviSpecAnExternalMixerPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviSpecAnConfigureExternalMixerBias[EM]
DescriptionSpecifiestheexternalmixerbiascurrentlimitinAmps.
PropertyNodePathIviSpecAn»ExternalMixing>>BiasLimit[EM]
IviSpecAnDetectorTypeIviSpecAnBasePropertyDatatype Access Appliesto Coercion HighLevelVIs
R/W N/A None IviSpecAnConfigureAcquisition
DescriptionSpecifiesthedetectionmethodusedtocaptureandprocessthesignal.Thisgovernsthedataacquisitionforaparticularsweep,butdoesnothaveanycontroloverhowmultiplesweepsareprocessed.
PropertyNodePathIviSpecAn»BasicOperation>>DetectorType
DefinedValuesIVISPECAN_VAL_DETECTOR_TYPE_AUTO_PEAKIVISPECAN_VAL_DETECTOR_TYPE_AVERAGEIVISPECAN_VAL_DETECTOR_TYPE_MAX_PEAKIVISPECAN_VAL_DETECTOR_TYPE_MIN_PEAKIVISPECAN_VAL_DETECTOR_TYPE_SAMPLEIVISPECAN_VAL_DETECTOR_TYPE_RMS
IviSpecAnDetectorTypeAutoIviSpecAnBasePropertyDatatype Access Appliesto Coercion HighLevelVIs
R/W N/A None IviSpecAnConfigureAcquisition
DescriptionEnablestheautodetector.Note:WhentheIviSpecAn>>BasicOperation>>DetectorTypeAutopropertyissettoTrue,therelationshipbetweentheIviSpecAn>>BasicOperation>>TraceTypepropertyandtheIviSpecAn>>BasicOperation>>DetectorTypepropertyisnotdefined.
PropertyNodePathIviSpecAn»BasicOperation>>DetectorTypeAuto
DefinedValuesVI_TRUEVI_FALSE
IviSpecAnExternalMixerAverageConversionLoss[EM]IviSpecAnExternalMixerPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviSpecAnConfigureExternalMixer[EM]
DescriptionSpecifiestheaverageconversionloss.
PropertyNodePathIviSpecAn»ExternalMixing>>ExternalMixerAverageConversionLoss[EM]
IviSpecAnExternalMixerConversionLossTableEnabled[EM]IviSpecAnExternalMixerPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviSpecAnConfigureConversionLossTableEnabled[EM]
DescriptionEnablesordisablestheconversionlosstable.
PropertyNodePathIviSpecAn»ExternalMixing>>ExternalMixerConversionLossTableEnabled[EM]
DefinedValuesVI_TRUEVI_FALSE
IviSpecAnExternalMixerEnabled[EM]IviSpecAnExternalMixerPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviSpecAnConfigureExternalMixerEnabled[EM]
DescriptionEnablestheexternalmixer.
PropertyNodePathIviSpecAn»ExternalMixing>>ExternalMixerEnabled[EM]
DefinedValuesVI_TRUEVI_FALSE
IviSpecAnExternalMixerHarmonic[EM]IviSpecAnExternalMixerPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviSpecAnConfigureExternalMixer[EM]
DescriptionSpecifiestheordernoftheharmonicusedforconversion.
PropertyNodePathIviSpecAn»ExternalMixing>>ExternalMixerHarmonic[EM]
IviSpecAnExternalMixerNumberofPorts[EM]IviSpecAnExternalMixerPropertyDatatype Access Appliesto Coercion HighLevelVIs
R/W N/A None None
DescriptionSelectsthenumberofportsusedinexternalmixing.
PropertyNodePathIviSpecAn»ExternalMixing>>ExternalMixerNumberofPorts[EM]
IviSpecAnExternalTriggerLevel[EXT]IviSpecAnExternalTriggerPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviSpecAnConfigureExternalTrigger[EXT]
DescriptionSpecifiesthelevel,inVolts,oftheexternaltriggersignaltotriggeranacquisition.
PropertyNodePathIviSpecAn»Trigger>>ExternalTrigger>>ExternalTriggerLevel[EXT]
IviSpecAnExternalTriggerSlope[EXT]IviSpecAnExternalTriggerPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviSpecAnConfigureExternalTrigger[EXT]
DescriptionSpecifiestheslopeoftheexternaltriggersignaltotriggeranacquisition.
PropertyNodePathIviSpecAn»Trigger>>ExternalTrigger>>ExternalTriggerSlope[EXT]
DefinedValuesIVISPECAN_VAL_EXTERNAL_TRIGGER_SLOPE_POSITIVEIVISPECAN_VAL_EXTERNAL_TRIGGER_SLOPE_NEGATIVE
IviSpecAnFrequencyOffsetIviSpecAnBasePropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviSpecAnConfigureFrequencyOffset
DescriptionSpecifiesanoffsetvalue,inHertz,thatisaddedtothefrequencyreadout.Theoffsetisusedtocompensateforexternalfrequencyconversion.SettingthispropertychangestheIviSpecAn>>BasicOperation>>FrequencyStartandIviSpecAn>>BasicOperation>>FrequencyStopproperties.Thefollowingequationsdefinetherelationshipofthesesettings:FrequencyStart=ActualStartFrequency+FrequencyOffsetFrequencyStop=ActualStopFrequency+FrequencyOffsetMarkerPosition=ActualMarkerFrequency+FrequencyOffset
PropertyNodePathIviSpecAn»BasicOperation>>FrequencyOffset
IviSpecAnFrequencyStartIviSpecAnBasePropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviSpecAnConfigureFrequencyStartStopIviSpecAnConfigureFrequencyCenterSpan
DescriptionSpecifiestheleftedgeofthefrequencydomaininHertz.ThisisusedinconjunctionwiththeIviSpecAn>>BasicOperation>>FrequencyStoppropertytodefinethefrequencydomain.IftheIviSpecAn>>BasicOperation>>FrequencyStartpropertyvalueisequaltotheIviSpecAn>>BasicOperation>>FrequencyStoppropertyvaluethenthespectrumanalyzer'shorizontalpropertiesareintime-domain.
PropertyNodePathIviSpecAn»BasicOperation>>FrequencyStart
IviSpecAnFrequencyStopIviSpecAnBasePropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviSpecAnConfigureFrequencyStartStopIviSpecAnConfigureFrequencyCenterSpan
DescriptionSpecifiestherightedgeofthefrequencydomaininHertz.ThisisusedinconjunctionwiththeIviSpecAn>>BasicOperation>>FrequencyStoppropertytodefinethefrequencydomain.IftheIviSpecAn>>BasicOperation>>FrequencyStartpropertyvalueisequaltotheIviSpecAn>>BasicOperation>>FrequencyStoppropertyvaluethenthespectrumanalyzer'shorizontalpropertiesareintime-domain.
PropertyNodePathIviSpecAn»BasicOperation>>FrequencyStop
IviSpecAnInputImpedanceIviSpecAnBasePropertyDatatype Access Appliesto Coercion HighLevelVIs
R/W N/A None IviSpecAnConfigureLevel
DescriptionSpecifiesthevalueofinputimpedance,inohms,expectedattheactiveinputport.Thisistypically50ohmsor75ohms.
PropertyNodePathIviSpecAn»BasicOperation>>InputImpedance
IviSpecAnMarkerAmplitude[MKR]IviSpecAnMarkerPropertyDatatype Access Appliesto Coercion HighLevelVIs
RO N/A None IviSpecAnQueryMarker[MKR]
DescriptionReturnstheamplitudeoftheactivemarker.TheunitsarespecifiedbytheIviSpecAn>>BasicOperation>>AmplitudeUnitsproperty,exceptwhentheIviSpecAn>>Markers>>MarkerType>>MarkerType[MKR]propertyissettoDelta.WhentheIviSpecAn>>Markers>>MarkerType>>MarkerType[MKR]propertyissettoDeltatheunitsaredB.IftheIviSpecAn>>Markers>>MarkerEnabled[MKR]propertyissettoFalse,anyattempttoreadthispropertyreturnstheMarkerNotEnablederror(0xBFFA2001).
PropertyNodePathIviSpecAn»Markers>>MarkerAmplitude[MKR]
IviSpecAnMarkerEnabled[MKR]IviSpecAnMarkerPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviSpecAnConfigureMarkerEnabled[MKR]
DescriptionEnablestheactivemarker.
PropertyNodePathIviSpecAn»Markers>>MarkerEnabled[MKR]
DefinedValuesVI_TRUEVI_FALSE
IviSpecAnMarkerFrequencyCounterEnabled[MKR]IviSpecAnMarkerPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviSpecAnConfigureMarkerFrequencyCounter[MKR]
DescriptionEnablesthemarkerfrequencycounterforbettermarkermeasurementaccuracy.ThispropertyreturnstheMarkerNotEnablederror(0xBFFA2001)iftheIviSpecAn>>Markers>>MarkerEnabled[MKR]propertyissettoFalse.
PropertyNodePathIviSpecAn»Markers>>MarkerFrequencyCounterEnabled[MKR]
DefinedValuesVI_TRUEVI_FALSE
IviSpecAnMarkerFrequencyCounterResolution[MKR]IviSpecAnMarkerPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A Down IviSpecAnConfigureMarkerFrequencyCounter[MKR]
DescriptionSpecifiestheresolutionofthefrequencycounterinHertz.Themeasurementgatetimeisthereciprocalofthespecifiedresolution.
PropertyNodePathIviSpecAn»Markers>>MarkerFrequencyCounterResolution[MKR]
IviSpecAnMarkerPosition[MKR]IviSpecAnMarkerPropertyDatatype Access Appliesto Coercion HighLevelVIs
R/W N/A None IviSpecAnMoveMarker[MKR]IviSpecAnQueryMarker[MKR]
DescriptionSpecifiesthefrequencyortimepositionoftheactivemarker(dependingonthemodeinwhichtheanalyzerisoperating,frequencyortime-domain).ThispropertyreturnstheMarkerNotEnablederror(0xBFFA2001)iftheactivemarkerisnotenabled.
PropertyNodePathIviSpecAn»Markers>>MarkerPosition[MKR]
IviSpecAnMarkerThreshold[MKR]IviSpecAnMarkerPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviSpecAnConfigureMarkerSearch[MKR]
DescriptionSpecifiesthelowerlimitofthesearchdomainverticalrangefortheIviSpecAnMarkerSearch[MKR].vi.
PropertyNodePathIviSpecAn»Markers>>MarkerThreshold[MKR]
IviSpecAnMarkerTrace[MKR]IviSpecAnMarkerPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviSpecAnConfigureMarkerEnabled[MKR]
DescriptionSpecifiesthetracefortheactivemarker.
PropertyNodePathIviSpecAn»Markers>>MarkerTrace[MKR]
IviSpecAnMarkerType[MKT]IviSpecAnMarkerTypePropertyDatatype Access Applies
to Coercion HighLevelVIs
RO N/A None IviSpecAnQueryMarkerType[MKT]
DescriptionReturnsthemarkertypeoftheactivemarker.
PropertyNodePathIviSpecAn»Markers>>MarkerType>>MarkerType[MKT]
DefinedValuesIVISPECAN_VAL_MARKER_TYPE_NORMALIVISPECAN_VAL_MARKER_TYPE_DELTA
IviSpecAnNumberofDivisions[DSP]IviSpecAnDisplayPropertyDatatype Access Appliesto Coercion HighLevelVIs
RO N/A None None
DescriptionSpecifiesthenumberofdivisions.
PropertyNodePathIviSpecAn»DisplayControl>>NumberofDivisions[DSP]
IviSpecAnNumberofMarkers[MKR]IviSpecAnMarkerPropertyDatatype Access Appliesto Coercion HighLevelVIs
RO N/A None None
DescriptionReturnsthenumberofmarkersavailablefortheinstrument.
PropertyNodePathIviSpecAn»Markers>>NumberofMarkers[MKR]
IviSpecAnNumberofSweepsIviSpecAnBasePropertyDatatype Access Appliesto Coercion HighLevelVIs
R/W N/A None IviSpecAnConfigureAcquisition
DescriptionThispropertydefinesthenumberofsweeps.ThispropertyvaluehasnoeffectiftheIviSpecAn>>BasicOperation>>TraceTypepropertyissettothevalueClearWrite.
PropertyNodePathIviSpecAn»BasicOperation>>NumberofSweeps
IviSpecAnPeakExcursion[MKR]IviSpecAnMarkerPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviSpecAnConfigureMarkerSearch[MKR]
DescriptionSpecifiestheminimumamplitudevariationofthesignalindBthattheIviSpecAnMarkerSearch[MKR].viidentifiesasapeak.
PropertyNodePathIviSpecAn»Markers>>PeakExcursion[MKR]
IviSpecAnReferenceLevelIviSpecAnBasePropertyDatatype Access Appliesto Coercion HighLevelVIs
R/W N/A None IviSpecAnConfigureLevel
DescriptionThecalibratedverticalpositionofthecaptureddatausedasareferenceforamplitudemeasurements.Thisistypicallysettoavalueslightlyhigherthanthehighestexpectedsignallevel.TheunitsaredeterminedbytheIviSpecAn>>BasicOperation>>AmplitudeUnitsproperty.
PropertyNodePathIviSpecAn»BasicOperation>>ReferenceLevel
IviSpecAnReferenceLevelOffsetIviSpecAnBasePropertyDatatype Access Appliesto Coercion HighLevelVIs
R/W N/A None IviSpecAnConfigureLevel
DescriptionSpecifiesanoffsetfortheIviSpecAn>>BasicOperation>>ReferenceLevelpropertyindB.Thispropertyadjuststhereferencelevelforexternalsignalgainorloss.Apositivevaluecorrespondstoagainwhileanegativenumbercorrespondstoaloss.
PropertyNodePathIviSpecAn»BasicOperation>>ReferenceLevelOffset
IviSpecAnReferenceMarkerAmplitude[DMK]IviSpecAnDeltaMarkerPropertyDatatype Access Applies
to Coercion HighLevelVIs
RO N/A None IviSpecAnQueryReferenceMarker[DMK]
DescriptionReturnsthereferencemarkeramplitudewhentheactivemarkerisadeltamarker.TheunitsarespecifiedbytheIviSpecAn>>BasicOperation>>AmplitudeUnitsproperty.IftheMarkerTypepropertyisnotDelta,thispropertyreturnstheNotDeltaMarkererror(0xBFFA2002).
PropertyNodePathIviSpecAn»Markers>>DeltaMarker>>ReferenceMarkerAmplitude[DMK]
IviSpecAnReferenceMarkerPosition[DMK]IviSpecAnDeltaMarkerPropertyDatatype Access Applies
to Coercion HighLevelVIs
RO N/A None IviSpecAnQueryReferenceMarker[DMK]
DescriptionReturnsthepositionofthereferencemarker,whentheactivemarkerisadeltamarker.TheunitsareHertzforfrequencydomainmeasurements,andsecondsfortimedomainmeasurements.IftheMarkerTypepropertyisnotDelta,thispropertyreturnstheNotDeltaMarkererror(0xBFFA2002).
PropertyNodePathIviSpecAn»Markers>>DeltaMarker>>ReferenceMarkerPosition[DMK]
IviSpecAnResolutionBandwidthIviSpecAnBasePropertyDatatype Access Appliesto Coercion HighLevelVIs
R/W N/A Up IviSpecAnConfigureSweepCoupling
DescriptionThisspecifiesthewidthoftheIFfilterinHertz.
PropertyNodePathIviSpecAn»BasicOperation>>ResolutionBandwidth
IviSpecAnResolutionBandwidthAutoIviSpecAnBasePropertyDatatype Access Appliesto Coercion HighLevelVIs
R/W N/A None IviSpecAnConfigureSweepCoupling
DescriptionEnablesresolutionbandwidthautocoupling.
PropertyNodePathIviSpecAn»BasicOperation>>ResolutionBandwidthAuto
DefinedValuesVI_TRUEVI_FALSE
IviSpecAnSignalTrackEnabled[MKR]IviSpecAnMarkerPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviSpecAnConfigureSignalTrackEnabled[MKR]
DescriptionEnablesordisablessignaltracking.Whensignaltrackingisturnedon,thespectrumanalyzercentersthesignalaftereachsweep.ThisprocessinvalidatesthetheIviSpecAn>>BasicOperation>>FrequencyStartandIviSpecAn>>BasicOperation>>FrequencyStopproperties.Iftheactivemarkerisnotenabled,operationsonthispropertyreturntheMarkerNotEnabled(0xBFFA2001)error.
Note:Signaltrackingcanonlybeenabledononemarkeratanygiventime.
PropertyNodePathIviSpecAn»Markers>>SignalTrackEnabled[MKR]
DefinedValuesVI_TRUEVI_FALSE
IviSpecAnSweepModeContinuousIviSpecAnBasePropertyDatatype Access Appliesto Coercion HighLevelVIs
R/W N/A None IviSpecAnConfigureAcquisition
DescriptionEnablescontinuoussweepmode.
PropertyNodePathIviSpecAn»BasicOperation>>SweepModeContinuous
DefinedValuesVI_TRUEVI_FALSE
IviSpecAnSweepTimeIviSpecAnBasePropertyDatatype Access Appliesto Coercion HighLevelVIs
R/W N/A Up IviSpecAnConfigureSweepCoupling
DescriptionSpecifiesthelengthoftime(inseconds)tosweepfromtheleftedgetotherightedgeofthecurrentdomain.
PropertyNodePathIviSpecAn»BasicOperation>>SweepTime
IviSpecAnSweepTimeAutoIviSpecAnBasePropertyDatatype Access Appliesto Coercion HighLevelVIs
R/W N/A None IviSpecAnConfigureSweepCoupling
DescriptionEnablessweeptimeauto.
PropertyNodePathIviSpecAn»BasicOperation>>SweepTimeAuto
DefinedValuesVI_TRUEVI_FALSE
IviSpecAnTraceCountIviSpecAnBasePropertyDatatype Access Appliesto Coercion HighLevelVIs
RO N/A None None
DescriptionReturnsthenumberoftraces.Note:ForaninstrumentwithonlyoneTracethedrivermayreturnanemptystring.
PropertyNodePathIviSpecAn»BasicOperation>>TraceCount
IviSpecAnTraceSizeIviSpecAnBasePropertyDatatype Access Appliesto Coercion HighLevelVIs
RO Trace None IviSpecAnQueryTraceSize
DescriptionThistrace-basedpropertyreturnsthenumberofpointsinthetracearray.
PropertyNodePathIviSpecAn»BasicOperation>>TraceSize
IviSpecAnTraceTypeIviSpecAnBasePropertyDatatype Access Appliesto Coercion HighLevelVIs
R/W Trace None IviSpecAnConfigureTraceType
DescriptionThistrace-basedpropertyspecifiestherepresentationoftheacquireddata.
PropertyNodePathIviSpecAn»BasicOperation>>TraceType
DefinedValuesIVISPECAN_VAL_TRACE_TYPE_CLEAR_WRITEIVISPECAN_VAL_TRACE_TYPE_MAX_HOLDIVISPECAN_VAL_TRACE_TYPE_MIN_HOLDIVISPECAN_VAL_TRACE_TYPE_VIDEO_AVERAGEIVISPECAN_VAL_TRACE_TYPE_VIEWIVISPECAN_VAL_TRACE_TYPE_STORE
IviSpecAnTriggerSource[TRG]IviSpecAnTriggerPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviSpecAnConfigureTriggerSource[TRG]
DescriptionSpecifiesthesourceofthetriggersignalthatcausestheanalyzertoleavetheWait-For-Triggerstate.
PropertyNodePathIviSpecAn»Trigger>>TriggerSource[TRG]
DefinedValuesIVISPECAN_VAL_TRIGGER_SOURCE_EXTERNALIVISPECAN_VAL_TRIGGER_SOURCE_IMMEDIATEIVISPECAN_VAL_TRIGGER_SOURCE_SOFTWAREIVISPECAN_VAL_TRIGGER_SOURCE_AC_LINEIVISPECAN_VAL_TRIGGER_SOURCE_VIDEO
IviSpecAnUnitsPerDivision[DSP]IviSpecAnDisplayPropertyDatatype Access Appliesto Coercion HighLevelVIs
R/W N/A None None
DescriptionSpecifiesthenumberofverticalunitsinonescreendivision.ThisistypicallyusedinconjunctionwiththeIviSpecAn>>BasicOperation>>ReferenceLevelpropertytosettheverticalrangeofthespectrumanalyzer.
PropertyNodePathIviSpecAn»DisplayControl>>UnitsPerDivision[DSP]
IviSpecAnVerticalScaleIviSpecAnBasePropertyDatatype Access Appliesto Coercion HighLevelVIs
R/W N/A None IviSpecAnConfigureAcquisition
DescriptionSpecifiestheverticalscaleofthemeasurementhardware(useoflogamplifiersversuslinearamplifiers).
PropertyNodePathIviSpecAn»BasicOperation>>VerticalScale
DefinedValuesIVISPECAN_VAL_VERTICAL_SCALE_LINEARIVISPECAN_VAL_VERTICAL_SCALE_LOGARITHMIC
IviSpecAnVideoBandwidthIviSpecAnBasePropertyDatatype Access Appliesto Coercion HighLevelVIs
R/W N/A Up IviSpecAnConfigureSweepCoupling
DescriptionSpecifiesthevideobandwidthofthepost-detectionfilterinHertz.
PropertyNodePathIviSpecAn»BasicOperation>>VideoBandwidth
IviSpecAnVideoBandwidthAutoIviSpecAnBasePropertyDatatype Access Appliesto Coercion HighLevelVIs
R/W N/A None IviSpecAnConfigureSweepCoupling
DescriptionEnablesvideobandwidthautocoupling.
PropertyNodePathIviSpecAn»BasicOperation>>VideoBandwidthAuto
DefinedValuesVI_TRUEVI_FALSE
IviSpecAnVideoTriggerLevel[VT]IviSpecAnVideoTriggerPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviSpecAnConfigureVideoTrigger[VT]
DescriptionSpecifiesthelevelofthevideosignaltotriggeranacquisition.TheunitsarespecifiedbytheIviSpecAn>>BasicOperation>>AmplitudeUnitsproperty.
PropertyNodePathIviSpecAn»Trigger>>VideoTrigger>>VideoTriggerLevel[VT]
IviSpecAnVideoTriggerSlope[VT]IviSpecAnVideoTriggerPropertyDatatype Access Applies
to Coercion HighLevelVIs
R/W N/A None IviSpecAnConfigureVideoTrigger[VT]
DescriptionSpecifiestheslopeofthevideosignaltotriggeranacquisition.
PropertyNodePathIviSpecAn»Trigger>>VideoTrigger>>VideoTriggerSlope[VT]
DefinedValuesIVISPECAN_VAL_VIDEO_TRIGGER_SLOPE_POSITIVEIVISPECAN_VAL_VIDEO_TRIGGER_SLOPE_NEGATIVE
IviSpecAnDefinedValuesExpandthisbooktoviewanalphabetizedlistofIviSpecAndefinedvalues.
IVISPECAN_VAL_AMPLITUDE_UNITS_DBMDescriptionSetsthespectrumAnalyzertomeasureindecibelsrelativeto1milliwatt.
DefinedValue1
IVISPECAN_VAL_AMPLITUDE_UNITS_DBMVDescriptionSetsthespectrumanalyzertomeasureindecibelsrelativeto1millivolt.
DefinedValue2
IVISPECAN_VAL_AMPLITUDE_UNITS_DBUVDescriptionSetsthespectrumanalyzertomeasureindecibelsrelativeto1microvolt.
DefinedValue3
IVISPECAN_VAL_AMPLITUDE_UNITS_VOLTDescriptionSetsthespectrumanalyzertomeasureinvolts.
DefinedValue4
IVISPECAN_VAL_AMPLITUDE_UNITS_WATTDescriptionSetsthespectrumanalyzertomeasureinwatts.
DefinedValue5
IVISPECAN_VAL_DETECTOR_TYPE_AUTO_PEAKDescriptionAllowsthedetectortocapturebetterreadingsbyusingbothpositiveandnegativepeakvalueswhennoiseispresent.
DefinedValue1
IVISPECAN_VAL_DETECTOR_TYPE_AVERAGEDescriptionAveragevalueofsamplestakenwithinthebinforadedicatedpointonthedisplay.
DefinedValue2
IVISPECAN_VAL_DETECTOR_TYPE_MAX_PEAKDescriptionObtainsthemaximumvideosignalbetweenthelastdisplaypointandthepresentdisplaypoint.
DefinedValue3
IVISPECAN_VAL_DETECTOR_TYPE_MIN_PEAKDescriptionObtainstheminimumvideosignalbetweenthelastdisplaypointandthepresentdisplaypoint.
DefinedValue4
IVISPECAN_VAL_DETECTOR_TYPE_RMSDescriptionRMSvalueofsamplestakenwithinthebinforadedicatedpointonthedisplay.
DefinedValue6
IVISPECAN_VAL_DETECTOR_TYPE_SAMPLEDescriptionPickonepointwithinabin.
DefinedValue5
IVISPECAN_VAL_EXTERNAL_TRIGGER_SLOPE_NEGATIVEDescriptionSetsnegativeslope.
DefinedValue2
IVISPECAN_VAL_EXTERNAL_TRIGGER_SLOPE_POSITIVEDescriptionSetspositiveslope.
DefinedValue1
IVISPECAN_VAL_INSTRUMENT_SETTING_FREQUENCY_CENTERDescriptionSetsthecenterfrequencywiththeMarkerPositionattribute.
DefinedValue1
IVISPECAN_VAL_INSTRUMENT_SETTING_FREQUENCY_SPANDescriptionSetsthefrequencyspanwiththeMarkerPositionattribute.ThisoperationisonlyvalidiftheMarkerTypeattributeissettoDelta.
DefinedValue2
IVISPECAN_VAL_INSTRUMENT_SETTING_FREQUENCY_STARTDescriptionSetstheFrequencyStartattributewiththeMarkerPositionattribute.
DefinedValue3
IVISPECAN_VAL_INSTRUMENT_SETTING_FREQUENCY_STOPDescriptionSetstheFrequencyStopattributewiththeMarkerPositionattribute.
DefinedValue4
IVISPECAN_VAL_INSTRUMENT_SETTING_REFERENCE_LEVELDescriptionSetstheReferenceLevelattributewiththeMarkerAmplitudeattribute.
DefinedValue5
IVISPECAN_VAL_MARKER_SEARCH_HIGHESTDescriptionSetsmarkersearchforthehighestamplitude.
DefinedValue1
IVISPECAN_VAL_MARKER_SEARCH_MINIMUMDescriptionSetsmarkersearchfortheminimumamplitude.
DefinedValue2
IVISPECAN_VAL_MARKER_SEARCH_NEXT_PEAKDescriptionSetsmarkersearchforthenexthighestpeak.
DefinedValue3
IVISPECAN_VAL_MARKER_SEARCH_NEXT_PEAK_LEFTDescriptionSetsmarkersearchforthenextpeakleftofthepeakamplitude.
DefinedValue4
IVISPECAN_VAL_MARKER_SEARCH_NEXT_PEAK_RIGHTDescriptionSetsmarkersearchforthenextpeakrightofthepeakamplitude.
DefinedValue5
IVISPECAN_VAL_MARKER_TYPE_DELTADescriptionMarkerusedinconjunctionwiththereferencemarkertomakerelativemeasurements.
DefinedValue2
IVISPECAN_VAL_MARKER_TYPE_NORMALDescriptionRegularmarkerusedtomakeabsolutemeasurements.
DefinedValue1
IVISPECAN_VAL_TRACE_TYPE_CLEAR_WRITEDescriptionSetsthespectrumanalyzertoclearprevioussweepdataoffthedisplaybeforeperformingasweep.Subsequentsweepsmayormaynotclearthedisplayfirst,butthedataarrayattheendofthesweepisentirelynew.
DefinedValue1
IVISPECAN_VAL_TRACE_TYPE_MAX_HOLDDescriptionSetsthespectrumanalyzertokeepthedatafromeitherthepreviousdataorthenewsweepdata,whicheverishigher.
DefinedValue2
IVISPECAN_VAL_TRACE_TYPE_MIN_HOLDDescriptionSetsthespectrumanalyzertokeepthedatafromeitherthepreviousdataorthenewsweepdata,whicheverislower.
DefinedValue3
IVISPECAN_VAL_TRACE_TYPE_STOREDescriptionDisablesacquisitionanddisablesthedisplayoftheexistingtracedata.
DefinedValue6
IVISPECAN_VAL_TRACE_TYPE_VIDEO_AVERAGEDescriptionSetsthespectrumanalyzertomaintainarunningaverageofthesweptdata.
DefinedValue4
IVISPECAN_VAL_TRACE_TYPE_VIEWDescriptionDisablesacquisitionintothistracebutdisplaystheexistingtracedata.
DefinedValue5
IVISPECAN_VAL_TRIGGER_SOURCE_AC_LINEDescriptionThespectrumanalyzerwaitsuntilitreceivesatriggerontheACline.
DefinedValue4
IVISPECAN_VAL_TRIGGER_SOURCE_EXTERNALDescriptionThespectrumanalyzerwaitsuntilitreceivesatriggerontheexternaltriggerconnector.
DefinedValue1
IVISPECAN_VAL_TRIGGER_SOURCE_IMMEDIATEDescriptionThespectrumanalyzerdoesnotwaitforatriggerofanykind.
DefinedValue2
IVISPECAN_VAL_TRIGGER_SOURCE_SOFTWAREDescriptionThespectrumanalyzerwaitsuntiltheSendSoftwareTriggerfunctionexecutes.
DefinedValue3
IVISPECAN_VAL_TRIGGER_SOURCE_VIDEODescriptionThespectrumanalyzerwaitsuntilitreceivesavideolevel.
DefinedValue5
IVISPECAN_VAL_VERTICAL_SCALE_LINEARDescriptionSetstheverticalscaleinlinearunits.
DefinedValue1
IVISPECAN_VAL_VERTICAL_SCALE_LOGARITHMICDescriptionSetstheverticalscaleinlogarithmicunits.
DefinedValue2
IVISPECAN_VAL_VIDEO_TRIGGER_SLOPE_NEGATIVEDescriptionSetsnegativeslope.
DefinedValue2
IVISPECAN_VAL_VIDEO_TRIGGER_SLOPE_POSITIVEDescriptionSetspositiveslope.
DefinedValue1
IviSwtchClassDriverReferenceforLabVIEWConceptsIviSwtchTerminologyIviSwtchClassDriverOverviewIviSwtchExtensionCapabilityGroupsIviSwtchBehaviorModels
IviSwtchVIandPropertyReferenceIviSwtchVITreeIviSwtchPropertiesbyGroupIviSwtchPropertyValueDefinitionsIviSwtchErrorandCompletionCodes
OtherReferenceInterchangeabilityCheckingSimulation
IviSwtchTerminologyChannel Aninput/output(I/O)connectionontheswitchmodule
thatyoucanaccess.Whatconstitutesachannelisdefinedbythevendor,butthechannelmustbeapointthatyoucanconnecttooneormoreotherchannelsoftheswitchmodulethroughapath.Inaddition,itistheconnectionpointtotheswitchmodule.Noticethatachanneldoesnotindicatethenumberofwires.Achannelmayconsistof1,2,3or4wires,forexample.
ChannelPair Twochannelnamesseparatedbythe"->"symbol.Common Thenameoftheoutputchannelinamultiplexerswitch
module.ConfigurationChannel
AchannelthatisnotdirectlyaccessibletoyouthroughtheIviSwtchclassdriver,orthatyoumarkasaconfigurationchanneltoreserveforthepathcreation.Thedriverusesaconfigurationchanneltocreatepathsbetweenthechannels,connectordisconnecttoananalogbus,andsoon.Thisgivesthedrivermoreflexibilityincreatingpathsattheexpenseoflosingchannels.Markacolumninamatrixasaconfigurationchannelwhenyouwanttoallowthematrixtoconnectarowtoarow.
MatrixSwitchModule
Aswitchmodulethatisconfiguredtohavemultipleinputsandoutputsthatformastandardmatrixorganizationsuchthatanyrowcanbeconnectedtoanycolumn.Noticethatsome,butnotallmatricessupportrow-to-rowandcolumn-to-columnconnections.SeeConfigurationChannel.
MultiplexerSwitchModule
Aswitchmodulethatisconfiguredtohavemultipleinputchannelsbutonlyasingleoutputchannels.Othernamesforthemultiplexerswitchmoduleareatree,anda1xnmatrix.
Path Theconnection(electrical,optical,etc.)betweenthetwochannels.YoucreateapathwithoperationsdefinedintheIviSwtchclass.Theend-pointchannelsdefinesuchaconnection.Noticethatitisuptotheswitchmoduleto
knowwhatpathsarevalid,invalidorinuse.ScannerSwitchModule
AnIviSwtchswitchmodulewiththecapabilitytoscanchannels.
SourceChannel
AchanneldirectlyaccessibletoyouthroughtheIviSwtchclassdriver.Typically,thedrivermarksachannelasasourcechanneltoallowforexternalconnection.
SwitchModule
Thevendordefineddevicethattheinstrumentdriversessioncancommunicatewithandcontrol.Thechannelsofsuchadevicedefineaswitchmodule.Noticethatonaphysicalswitchdevicetheremaybemultipleswitchmodules.Inaddition,aswitchmodulemaybeonmultipleswitchdevices.Theconceptistohaveasingleblackboxwithexternalconnectionsandhavethesoftwarefindthenecessarypaths.Noticethatthisdoesnotremovetheneedoftheapplicationprogrammertounderstandtheunderlyingswitchstructureforissuessuchassendingthecorrectsignalsthroughthecorrectswitches(forexample,RFsignalsthroughRFpathsonly).
IviSwtchClassDriverOverviewThisinstrumentdriverprovidesprogrammingsupportfortheIviSwtchClass.TheIviSwtchclassdriverconceptualizesaswitchasaninstrumentthatcanestablishaconnectionbetweentwoI/Ochannels.TheIviSwtchclassdrivercansupportinstrumentsthatcanperformtriggeredscanning(trigger-synchronizedestablishingorbreakingofthepaths).ThedrivercontainsalltheVIsthattheIVIFoundationrequiresfortheIviSwtchspecification.ThisdriverrequiresNI-VISAandtheIVICompliancePackagetobeinstalled.AnIviSwtchisavendor-definedswitchmodulewithaseriesofI/Ocapablechannels.Thesechannelscanthenbeconnectedthroughtheinternalsoftheswitchmodule,wherenotallconnectionsarenecessarilyvalid.Refertothefigurebelow.TheIviSwtchclassdriverisdesignedtosupportthetypicalswitchaswellascommonextendedfunctionalityfoundinmorecomplexswitchinstruments.TheIviSwtchclassdriverconceptualizestheswitchasaninstrumentthatcanestablishpathsbetweenitsI/Ochannels.Usethisdrivertodevelopprogramsthatareindependentofaparticularswitch.YoucanusethisclassdriverwithanyswitchthathasanIVIinstrumentspecificdriverthatiscompliantwiththeIviSwtchclass.TheIviSwtchclassdriveraccessesthespecificdriverforyourinstrumentusingtheconfigurationinformationyousupplywithMAX.TheIviSwtchclassdriverdividesinstrumentcapabilitiesintoabasecapabilitygroupandmultipleextensioncapabilitygroups.TheIviSwtchBasecapabilitygroupsupportsswitchesabletoconnectanddisconnectpathsontheinstrument,determinetheconnectivityoftwoswitches,andquerythestateoftheswitchmodule.TheVIsandpropertiesofthisgroupareimplementedbyallswitchinstrumentdriversthatarecompliantwiththeIviSwtchclass.
IviSwtchExtensionCapabilityGroupsTheIviSwtchclassdriveridentifiesVIsandpropertiesthatbelongtoanextensiongroupwiththefollowingabbreviations.Instrumentspecificdriversarenotrequiredtoimplementanyoftheextensioncapabilitygroups.IfyouuseVIsandpropertiesthatbelongtoextensioncapabilitygroups,everyinstrumentspecificdriverthatyouusemustimplementthoseextensions.
GroupName DescriptionIviSwtchScanner[SCN] Definesextensionsforinstrumentscapableof
scanningchannels.IviSwtchSoftwareTrigger[SWT]
DefinesinstrumentscapableofreceivingsoftwaretriggersandimplementstheIviSwtchScannerextensiongroup.
IviSwtchScannerdefinesextendedcapabilitiesforswitchesthatcanwaitforthetriggertoestablishorbreakpathsontheswitchmodule,andassertatriggeruponcompletedtask.TheswitchesthatcanperformsuchtasksarethepartoftheIviSwtchScannerextensiongroup.IviSwtchSoftwareTriggerdefinesextendedcapabilitiesforswitchesthatcansupportIviSwtchScannerextensiongroupandreceivesoftwaretriggers.
SwitchModule
IviSwtchBaseCapabilityGroupTheIviSwtchBasecapabilitygroupsupportsswitchinstrumentscapableofconnectinganddisconnectingpathswithintheinstrument,determiningtheconnectivityoftwoswitches,andqueryingvariousinternalstatesoftheswitchmodule.TheIviSwtchBasecapabilitygroupdefinespropertiessthatreflectthephysicalcharacteristicsoftheswitchmodule,aswellaspropertiesthatallowyoutospecifytheconnectivityofswitchingchannels.TheIviSwtchBasecapabilitygroupalsodefinesasetofVIsthatallowsyoutoconnectanddisconnectpaths,aswellasquerytheconnectivityofpaths.
IviSwtchBaseVIsIviSwtchConnectChannelsIviSwtchDisconnectChannelsIviSwtchGetPathIviSwtchSetPathIviSwtchCanConnectChannelsIviSwtchDisconnectAllChannelsIviSwtchSwitchIsDebouncedIviSwtchWaitForDebounce
IviSwtchBasePropertiesIviSwtchBandwidthIviSwtchCharacteristicImpedanceIviSwtchIsConfigurationChannelIviSwtchIsDebouncedIviSwtchIsSourceChannelIviSwtchMaximumACVoltageIviSwtchMaximumCarryACCurrentIviSwtchMaximumCarryACPowerIviSwtchMaximumCarryDCCurrentIviSwtchMaximumCarryDCPowerIviSwtchMaximumDCVoltageIviSwtchMaximumSwitchingACCurrentIviSwtchMaximumSwitchingACPowerIviSwtchMaximumSwitchingDCCurrentIviSwtchMaximumSwitchingDCPowerIviSwtchSettlingTimeIviSwtchWireModeRelatedTopicsVITreeIviSwtchPropertiesIVIInherentVIsIVIInherentPropertiesIviSwtchBasebehaviormodel
IviSwtchScannerExtensionGroupTheIviSwtchScannerExtensionGroupdefinesasetofpropertiesandVIstoperformscanningoperations.RefertotheIviSwtchScannerbehaviormodel.
IviSwtchScannerVIsIviSwtchInitiateScanIviSwtchAbortScanIviSwtchSwitchIsScanningIviSwtchWaitForScanToCompleteIviSwtchConfigureScanListIviSwtchConfigureScanTriggerIviSwtchSetContinuousScan
IviSwtchScannerPropertiesIviSwtchContinuousScanIviSwtchIsScanningIviSwtchNumberofRowsIviSwtchNumberofColumnsIviSwtchScanAdvancedOutputIviSwtchScanListIviSwtchScanModeIviSwtchScanDelayIviSwtchTriggerInputRelatedTopicsVITreeIviSwtchProperties
IviSwtchSoftwareTriggerExtensionGroupTheIviSwtchSoftwareTriggerExtensionGroupdefinesasetofVIsthatperformsoftwaretriggeroperations.
IviSwtchSoftwareTriggerVIIviSwtchSendSoftwareTriggerRelatedTopicsVITreeIviSwtchProperties
IviSwtchBehaviorModelsIviSwtchBaseIviSwtchScannerIviSwtchSoftwareTrigger
IviSwtchBaseBehaviorModelYoucanaccessanyoftheVIsinthiscapabilitygroupatanytime.IfyouexecutetheIviSwtchWaitForDebounceVI,thedriverblocksanyfurtheroperationuntiltheVIcompletes(thatis,allthesignalsflowingthroughtheswitchhavesettled).
IviSwtchScannerBehaviorModel
IviSwtchScannerBehaviorModelItistheIVIdriver'sresponsibilitytoensurethatwhenthescanningbeginsatriggerissentfromtheswitchmoduleiftheswitchmoduleisconfiguredtoassertatriggeronpathcreation(theIviSwtchScanAdvancedOutput[SCN]property).Thisensuresthatiftheswitchmoduleisusinghandshakelineswithameasurementorsourcedeviceandalsousingscanning,thesequenceisbegunwithatriggerfromtheswitchmodule.WhennotintheIdleorResetstate,allpropertiesoftheIviSwtchclassarereadonly.Similarly,whennotintheIdleorResetstate,propertiesarereadonly,andonlytheIviSwtchResetandIviSwtchAbortScanpropertiescanbeexecuted.
IviSwtchSoftwareTriggerBehaviorModelTheIviSwtchSoftwareTriggerextensiongroupfollowsthebehaviormodeloftheIviSwtchScannerextensiongroup.IftheIviSwtchTriggerInput[SCN]propertyissettoIVISWTCH_VAL_SOFTWARETRIG,theswitchexitsthewait-for-triggerstateonlyaftertheIviSwtchSendSoftwareTriggerVIexecutes.
IviSwtchVITreeTheVItreefortheIviSwtchclassdriver,includingIVIandVXIplug&playrequiredVIs,isshownbelow.
NoteYouusetheLabVIEWPropertyNodetogetandsetproperties.
IviSwtchVITreeNameorClass VIName RequiredBy
Initialize IviSwtchInitialize VPP
InitializeWithOptions
IviSwtchInitializeWithOptions
IVI
ConfigurationVIs
ConfigureScanList[SCN]
IviSwtchConfigureScanList
IviSwtchScanner
ConfigureScanTrigger[SCN]
IviSwtchConfigureScanTrigger
IviSwtchScanner
SetContinuousScan[SCN]
IviSwtchSetContinuousScan
IviSwtchScanner
Route
ConnectChannels IviSwtchConnectChannels
IviSwtchBase
DisconnectChannels
IviSwtchDisconnectChannels
IviSwtchBase
DisconnectAllChannels
IviSwtchDisconnectAllChannels
IviSwtchBase
SwitchIsDebounced?
IviSwtchSwitchIsDebounced
IviSwtchBase
WaitForDebounce IviSwtchWaitForDebounce
IviSwtchBase
CanConnectChannels?
IviSwtchCanConnectChannels
IviSwtchBase
Paths
SetPath IviSwtchSetPath IviSwtchBase
GetPath IviSwtchGetPath IviSwtchBase
Scan
InitiateScan[SCN] IviSwtchInitiateScan IviSwtchScanner
AbortScan[SCN] IviSwtchAbortScan IviSwtchScanner
SwitchIsScanning[SCN]
IviSwtchSwitchIsScanning
IviSwtchScanner
WaitForScanToComplete[SCN]
IviSwtchWaitForScanToComplete
IviSwtchScanner
SendSoftwareTrigger[SWT]
IviSwtchSendSoftwareTrigger
IviSwtchSoftwareTrigger
Utility
Reset IviSwtchReset VPP
ResetWithDefaults ResetWithDefaults VPP
Self-Test IviSwtchSelf-Test VPP
Disable Disable VPP
InvalidateAllAttributes
InvalidateAllAttributes VPP
RevisionQuery IviSwtchRevisionQuery
VPP
Error-Query IviSwtchError-Query VPP
ErrorMessage IviSwtchErrorMessage
VPP
GetChannelName GetChannelName VPP
InterchangeabilityInfo
GetNext IviSwtchGetNext IVI
InterchangeWarning
InterchangeWarning
ResetInterchangeCheck
IviSwtchResetInterchangeCheck
IVI
ClearInterchangeWarnings
IviSwtchClearInterchangeWarnings
IVI
CoercionInfo
GetNextCoercionRecord
IviSwtchGetNextCoercionRecord
IVI
Close IviSwtchClose VPP
RelatedTopicsIviSwtchPropertiesIVIInherentVIs
IviSwtchPropertiesNoteYouusetheLabVIEWPropertyNodetogetandsetproperties.
IviSwtchBasePropertiesIviSwtchBandwidthIviSwtchCharacteristicImpedanceIviSwtchIsConfigurationChannelIviSwtchIsDebouncedIviSwtchIsSourceChannelIviSwtchMaximumACVoltageIviSwtchMaximumCarryACCurrentIviSwtchMaximumCarryACPowerIviSwtchMaximumCarryDCCurrentIviSwtchMaximumCarryDCPowerIviSwtchMaximumDCVoltageIviSwtchMaximumSwitchingACCurrentIviSwtchMaximumSwitchingACPowerIviSwtchMaximumSwitchingDCCurrentIviSwtchMaximumSwitchingDCPowerIviSwtchSettlingTimeIviSwtchWireMode
IviSwtchScannerExtensionPropertiesIviSwtchContinuousScanIviSwtchIsScanningIviSwtchNumberofRowsIviSwtchNumberofColumnsIviSwtchScanAdvancedOutputIviSwtchScanListIviSwtchScanModeIviSwtchScanDelayIviSwtchTriggerInput
IviSwtchPropertyValueDefinitionsThefollowingtabledefinesvalueforallIviSwtchclasspropertiesconstants.
NoteInthefollowingtable,theliteralstringIVISWTCHprecedesthepropertynameandtheliteralstringIVISWTCH_precedesthevalueextensionname.
IviSwtchPropertyDefinedValues
Property ValueName
DefinedValue Description
SCANMODE
NoAction 0 Indicatesthatnoactionshouldbetakenonthepreviouspaths.
BeforeBreakMake
1 Tellsthedevicetobreakthepreviouspathsbeforemakingthenewpaths.
BreakAfterMake
2 Tellsthedrivertomakethenewpathsbeforebreakingthepreviouspaths.
TRIGGERINPUT
Immediate 1 Indicatesthattheswitchmoduledoesnotwaitforatriggerbeforestartingthenextentryinthescan.
External 2 Meansthetriggerisgoingouttoanexternaldevicethroughatriggeroutputconnection.
SoftwareTriggerFunction
3 ThetriggerwillbeasoftwarecommandsentbytheprogramthoughtheIviSwtchSendSoftwareTriggeroperation.
TTL0 111 AbackplaneTTLtrigger,suchasisfoundintheVXIbusorPXITRIG0.
TTL1 112 AbackplaneTTLtrigger,suchasisfoundintheVXIbusorPXITRIG1.
TTL2 113 AbackplaneTTLtrigger,suchasisfoundintheVXIbusorPXITRIG2.
TTL3 114 AbackplaneTTLtrigger,suchasisfoundintheVXIbusorPXITRIG3.
TTL4 115 AbackplaneTTLtrigger,suchasisfoundintheVXIbusorPXITRIG4.
TTL5 116 AbackplaneTTLtrigger,suchasisfoundintheVXIbusorPXITRIG5.
TTL6 117 AbackplaneTTLtrigger,suchasis
foundintheVXIbusorPXITRIG6.TTL7 118 AbackplaneTTLtrigger,suchasis
foundintheVXIbusorPXITRIG7.ECL0 119 AbackplaneECLtrigger,suchasis
foundintheVXIbus.ECL1 120 AbackplaneECLtrigger,suchasis
foundintheVXIbus.PXIStar 125 APXIStartriggerbus.RTSI0 140 TheRTSI0triggerlineusuallyfoundin
DAQinstruments.RTSI1 141 TheRTSI1triggerlineusuallyfoundin
DAQinstruments.RTSI2 142 TheRTSI2triggerlineusuallyfoundin
DAQinstruments.RTSI3 143 TheRTSI3triggerlineusuallyfoundin
DAQinstruments.RTSI4 144 TheRTSI4triggerlineusuallyfoundin
DAQinstruments.RTSI5 145 TheRTSI5triggerlineusuallyfoundin
DAQinstruments.RTSI6 146 TheRTSI6triggerlineusuallyfoundin
DAQinstruments.SCANADVANCEDOUTPUT
None 0 Noscanadvancedoutputtriggerissentoutoftheswitchmodule.
External 2 Meansthetriggerisgoingouttoanexternaldevicethroughatriggeroutputconnection.
GPIBServiceRequest
5 ThescanadvancedoutputtriggerisrepresentedasaGPIBSRQevent.
TTL0 111 AbackplaneTTLtrigger,suchasisfoundintheVXIbusorPXITRIG0.
TTL1 112 AbackplaneTTLtrigger,suchasis
foundintheVXIbusorPXITRIG1.
TTL2 113 AbackplaneTTLtrigger,suchasisfoundintheVXIbusorPXITRIG2.
TTL3 114 AbackplaneTTLtrigger,suchasisfoundintheVXIbusorPXITRIG3.
TTL4 115 AbackplaneTTLtrigger,suchasisfoundintheVXIbusorPXITRIG4.
TTL5 116 AbackplaneTTLtrigger,suchasisfoundintheVXIbusorPXITRIG5.
TTL6 117 AbackplaneTTLtrigger,suchasisfoundintheVXIbusorPXITRIG6.
TTL7 118 AbackplaneTTLtrigger,suchasisfoundintheVXIbusorPXITRIG7.
ECL0 119 AbackplaneECLtrigger,suchasisfoundintheVXIbus.
ECL1 120 AbackplaneECLtrigger,suchasisfoundintheVXIbus.
PXIStar 125 APXIStartriggerbus.RTSI0 140 TheRTSI0triggerlineusuallyfoundin
DAQinstruments.RTSI1 141 TheRTSI1triggerlineusuallyfoundin
DAQinstruments.RTSI2 142 TheRTSI2triggerlineusuallyfoundin
DAQinstruments.RTSI3 143 TheRTSI3triggerlineusuallyfoundin
DAQinstruments.RTSI4 144 TheRTSI4triggerlineusuallyfoundin
DAQinstruments.RTSI5 145 TheRTSI5triggerlineusuallyfoundin
DAQinstruments.RTSI6 146 TheRTSI6triggerlineusuallyfoundin
DAQinstruments.
RelatedTopics
IviSwtchVITreeIviSwtchProperties
IviSwtchErrorandWarningCodesTheVIsinthisclassdrivergeneratereturnvaluesthatreportthestatusoftheoperation.
StatusCodeRanges
StatusCodeType NumericRange(inHex)
IviSwtchErrors 0xBFFA2001to0xBFFA3FFF
IviSwtchWarnings(Scrolldowntoseethesevalues.)
0x3FFA2001to0x3FFA3FFF
IVISpecificDriverErrors 0xBFFA4000to0xBFFA5FFF
IVISpecificDriverWarnings 0x3FFA4000to0x3FFA5FFF
IVIErrors BFFA0000toBFFA1FFFIVIWarnings 3FFA0000to3FFA1FFFCommonInstrumentDriverErrors BFFC0000toBFFCFFFFCommonInstrumentDriverWarnings 3FFC0000to3FFCFFFFVISAErrors BFFF0000toBFFFFFFFVISAWarnings 3FFF0000to3FFFFFFF
IviSwtchErrorCodesError ValueIVISWTCH_ERROR_INVALID_SWITCH_PATH 0xBFFA2001
IVISWTCH_ERROR_INVALID_SCAN_LIST 0xBFFA2002
IVISWTCH_ERROR_RSRC_IN_USE 0xBFFA2003
IVISWTCH_ERROR_EMPTY_SCAN_LIST 0xBFFA2004
IVISWTCH_ERROR_EMPTY_SWITCH_PATH 0xBFFA2005
IVISWTCH_ERROR_SCAN_IN_PROGRESS 0xBFFA2006
IVISWTCH_ERROR_NO_SCAN_IN_PROGRESS 0xBFFA2007
IVISWTCH_ERROR_NO_SUCH_PATH 0xBFFA2008
IVISWTCH_ERROR_IS_CONFIGURATION_CHANNEL 0xBFFA2009
IVISWTCH_ERROR_NOT_A_CONFIGURATION_CHANNEL 0xBFFA200A
IVISWTCH_ERROR_ATTEMPT_TO_CONNECT_SOURCES 0xBFFA200B
IVISWTCH_ERROR_EXPLICIT_CONNECTION_EXISTS 0xBFFA200C
IVISWTCH_ERROR_LEG_MISSING_FIRST_CHANNEL 0xBFFA200D
IVISWTCH_ERROR_LEG_MISSING_SECOND_CHANNEL 0xBFFA200E
IVISWTCH_ERROR_CHANNEL_DUPLICATED_IN_LEG 0xBFFA200F
IVISWTCH_ERROR_CHANNEL_DUPLICATED_IN_PATH 0xBFFA2010
IVISWTCH_ERROR_PATH_NOT_FOUND 0xBFFA2011
IVISWTCH_ERROR_DISCONTINUOUS_PATH 0xBFFA2012
IVISWTCH_ERROR_CANNOT_CONNECT_DIRECTLY 0xBFFA2013
IVISWTCH_ERROR_CHANNELS_ALREADY_CONNECTED 0xBFFA2014
IVISWTCH_ERROR_CANNOT_CONNECT_TO_ITSELF 0xBFFA2015
IVISWTCH_ERROR_TRIGGER_NOT_SOFTWARE 0xBFFA1001
IviSwtchWarningCodesWarning Value MessageIVISWTCH_WARN_PATH_REMAINS 0x3FFA2001 Some
connectionsremainafterdisconnecting.
IVISWTCH_WARN_IMPLICIT_CONNECTION_EXISTS 0x3FFA2002 Thechannelsareimplicitlyconnected.
RelatedTopicIVIStatusCodes
IviSwtchVIsExpandthisbooktoviewanalphabetizedlistofIviSwtchVIs.
IviSwtchAbortScanIviSwtchScannerCapabilityGroup[SCN]ThisVIabortsapreviouslyinitiatedscan.YouinitiateascanwiththeIviSwtchInitiateScan[SCN]VI.Iftheinstrumentisnotcurrentlyscanning,thisVIreturnstheIVISWTCH_ERROR_NO_SCAN_IN_PROGRESS(0xBFFA2007)error.YoucandeterminethecurrentstatusofthescanbycallingtheIviSwtchIsScanningVI.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSwtchInitializeorIviSwtchInitializeWithOptionsVI.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSwtchInitializeorIviSwtchInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSwtchCanConnectChannelsIviSwtchBaseCapabilityGroupThisVIverifiesthattheswitchmoduleiscapableofcreatingapathbetweenthetwochannelsyouspecifywiththechannel1andchannel2parameters.Iftheswitchmoduleiscapableofcreatingapath,thisVIindicateswhetherthepathiscurrentlyavailablegiventheexistingconnections.Ifthepathisnotavailableduetocurrentlyexistingconnections,buttheimplicitconnectionbetweenthetwochannelsalreadyexists,theVIreturnsthewarningIVISWTCH_WARN_IMPLICIT_CONNECTION_EXISTS(0x3FFA2002).
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSwtchInitializeorIviSwtchInitializeWithOptionsVI.channel1("")Youidentifyapathwithtwochannels.Passoneofthevirtualchannelnamesforwhichyouwanttoverifyapath.Passtheotherchannelnameasthechannel2parameter.Virtualchannelnamesarealiasesforinstrumentspecificchannelstrings.Theinstrumentspecificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.YouassignavirtualchannelnametoaninstrumentspecificchannelthroughMAX.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrumentspecificchannelnames.DefaultValue:""
channel2("")Youidentifyapathwithtwochannels.Passoneofthevirtualchannelnamesforwhichyouwanttoverifyapath.Passtheotherchannelnameasthechannel1parameter.
Virtualchannelnamesarealiasesforinstrumentspecificchannelstrings.Theinstrumentspecificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.YouassignavirtualchannelnametoaninstrumentspecificchannelthroughMAX.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrumentspecificchannelnames.DefaultValue:""
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSwtchInitializeorIviSwtchInitializeWithOptionsVI.
erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
pathcapabilityIndicateswhetherapathisvalid.Possiblevaluesinclude:IVISWTCH_VAL_PATH_AVAILABLE1IVISWTCH_VAL_PATH_EXISTS2IVISWTCH_VAL_PATH_UNSUPPORTED3IVISWTCH_VAL_RSRC_IN_USE4IVISWTCH_VAL_SOURCE_CONFLICT5IVISWTCH_VAL_CHANNEL_NOT_AVAILABLE6
Note
1. IVISWTCH_VAL_PATH_AVAILABLEindicatesthatthedriver
cancreatethepathatthistime.2. IVISWTCH_VAL_PATH_EXISTSindicatesthattheexplicit
pathbetweenthechannelsalreadyexists.3. IVISWTCH_VAL_PATH_UNSUPPORTEDindicatesthatthe
instrumentisnotcapableofcreatingapathbetweenthetwochannels.
4. IVISWTCH_VAL_RSRC_IN_USEindicatesthatalthoughthepathisvalid,thedrivercannotcreatethepathatthismomentbecausetheswitchmoduleiscurrentlyusingoneormoreoftherequiredchannelstocreateanotherpath.Youmustdestroytheotherpathbeforecreatingthisone.
5. IVISWTCH_VAL_SOURCE_CONFLICTindicatesthattheinstrumentcannotcreateapathbecausebothchannelsareconnectedtoadifferentsourcechannel.
6. IVISWTCH_VAL_CHANNEL_NOT_AVAILABLEindicatesthatthedrivercannotcreateapathbetweenthetwochannelsbecauseoneofthechannelsisaconfigurationchannelandthusunavailableforexternalconnections.
IviSwtchConfigureScanListIviSwtchScannerCapabilityGroup[SCN]ThisVIconfigurestheswitchmoduleforscanning.UsetheIviSwtchConfigureScanTriggerVItoconfigurethescantrigger.UsetheIviSwtchInitiateScanVItostartthescan.Iftheswitchmoduleiscurrentlyscanningthroughthescanlist,thisVIreturnstheIVISWTCH_ERROR_SCAN_IN_PROGRESS(0xBFFA2006)errorwithoutconfiguringthescanlist.Ifthegivenscanliststringcontainsincorrectsyntax,thisVIreturnstheIVISWTCH_ERROR_INVALID_SCAN_LIST(0xBFFA2002)error.Ifthegivenscanliststringisempty,thisVIreturnstheIVISWTCH_ERROR_EMPTY_SCAN_LIST(0xBFFA2004)error.
pathcapabilityIndicateswhetherapathisvalid.Possiblevaluesinclude:IVISWTCH_VAL_PATH_AVAILABLE1IVISWTCH_VAL_PATH_EXISTS2IVISWTCH_VAL_PATH_UNSUPPORTED3IVISWTCH_VAL_RSRC_IN_USE4IVISWTCH_VAL_SOURCE_CONFLICT5IVISWTCH_VAL_CHANNEL_NOT_AVAILABLE6
Notes
1. IVISWTCH_VAL_PATH_AVAILABLEindicatesthatthedrivercancreatethepathatthistime.
2. IVISWTCH_VAL_PATH_EXISTSindicatesthattheexplicitpathbetweenthechannelsalreadyexists.
3. IVISWTCH_VAL_PATH_UNSUPPORTEDindicatesthatthe
instrumentisnotcapableofcreatingapathbetweenthetwochannels.
4. IVISWTCH_VAL_RSRC_IN_USEindicatesthatalthoughthepathisvalid,thedrivercannotcreatethepathatthismomentbecausetheswitchmoduleiscurrentlyusingoneormoreoftherequiredchannelstocreateanotherpath.Youmustdestroytheotherpathbeforecreatingthisone.
5. IVISWTCH_VAL_SOURCE_CONFLICTindicatesthattheinstrumentcannotcreateapathbecausebothchannelsareconnectedtoadifferentsourcechannel.
6. IVISWTCH_VAL_CHANNEL_NOT_AVAILABLEindicatesthatthedrivercannotcreateapathbetweenthetwochannelsbecauseoneofthechannelsisaconfigurationchannelandthusunavailableforexternalconnections.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSwtchInitializeorIviSwtchInitializeWithOptionsVI.scanlist("")Passthescanlistyouwanttheinstrumenttouse.ThedriverusesthisvaluetosettheIviSwtchScanList[SCN]property.Thescanlistisastringthatspecifieschannelconnectionsandtriggerconditionsforscanning.AfteryoucalltheIviSwtchInitiateScanVI,theinstrumentmakesorbreaksconnectionsandwaitsfortriggersaccordingtotheinstructionsinthescanlist.Thescanlistiscomprisedofchannelnamesthatyouseparatewithspecialcharacters.Thesespecialcharactersdeterminetheoperationthescannerperformsonthechannelswhenitexecutesthisscanlist.SeetheIviSwtchScanListpropertyfordetaileddescriptiononthescanlistsyntax.
scanmode(NoAction)Passthescanmodeyouwanttheinstrumenttouse.ThedriversetstheIviSwtchScanMode[SCN]propertytothisvalue.Thescanmodespecifieshowtheinstrumentbreaksexistingconnectionswhenscanning.Definedvalues:IVISWTCH_VAL_NONE(0)—Theinstrumenttakesnoactionon
existingconnections.IVISWTCH_VAL_BREAK_BEFORE_MAKE(1)—Theinstrumentbreaksanexistingconnectionbeforecreatinganewone.Thisisusefulifyouwanttopreventtwochannelsfromconnectingtogetherinthetransitionalperiod.IVISWTCH_VAL_BREAK_AFTER_MAKE(2)—Theinstrumentbreaksanexistingconnectionaftercreatinganewone.Thisisusefulifyouwanttopreventdamagefromoccurringoninductiveelementsofacircuitthatcannotstandrapidchangesinthecurrentflow.
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSwtchInitializeorIviSwtchInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSwtchConfigureScanTriggerIviSwtchScannerCapabilityGroup[SCN]ThisVIconfiguresthescantriggersforthescanlistyouestablishwithIviSwtchConfigureScanListVI.Iftheswitchmoduleiscurrentlyscanningthroughthescanlist,thisVIreturnstheIVISWTCH_ERROR_SCAN_IN_PROGRESS(0xBFFA2006)errorwithoutconfiguringthescantrigger.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSwtchInitializeorIviSwtchInitializeWithOptionsVI.scandelay(0.0s)PasstheminimumlengthoftimeyouwanttheinstrumenttowaitfromthetimetheinstrumentcreatesapathuntilitassertsatriggerontheScanAdvancedoutputline.Expressthisvalueinseconds.ThedriverusesthisvaluetosettheIviSwtchScanDelay[SCN]property.triggerinput(Immediate)Passthetriggersourceyouwanttheinstrumenttouseforscanning.ThedriverusesthisvaluetosettheIviSwtchTriggerInput[SCN]property.Theswitchmodulewaitsforthetriggeryouspecifywhenitencountersasemicoloninthescanlist.Whenthetriggeroccurs,theswitchmoduleadvancestothenextentryinthescanlist.DefinedValues
scanadvancedoutput(None)Passtheoutputonwhichyouwanttheinstrumenttoassertthescanadvancedsignal.ThedriverusesthisvaluetosettheIviSwtchScanAdvancedOutput[SCN]property.Aftertheinstrumentprocesseseachentryinthescanlist,itwaitsthelengthoftimeyouspecifyintheScanDelayparameterandthenassertsatriggeronthelineyouspecifywiththisparameter.
DefinedValues
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSwtchInitializeorIviSwtchInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSwtchConnectChannelsIviSwtchBaseCapabilityGroupThisVIcreatesapathbetweenchannel1andchannel2.Thedrivercalculatestheshortestpathbetweenthetwochannels.DetailsThisVIappliesdefaultvaluestopropertiesthathavenotbeensetbyyouunderthefollowingconditions:IfyouhavenotsetthevalueofanypropertyintheIviSwtchScannerextension,thefollowingdefaultvaluesareused:IviSwtchScanList[SCN]""(Emptystring)IviSwtchTriggerInput[SCN]IVISWTCH_VAL_EXTERNALIviSwtchScanAdvancedOutput[SCN]IVISWTCH_VAL_EXTERNALIviSwtchScanDelay[SCN]0
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSwtchInitializeorIviSwtchInitializeWithOptionsVI.channel1("")Youidentifyapathwithtwochannels.Passoneofthevirtualchannelnamesforwhichyouwanttocreateapath.Passtheotherchannelnameasthechannel2parameter.Virtualchannelnamesarealiasesforinstrumentspecificchannelstrings.Theinstrumentspecificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.YouassignavirtualchannelnametoaninstrumentspecificchannelinMAX.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrumentspecificchannelnames.DefaultValue:""
channel2("")Youidentifyapathwithtwochannels.Passoneof
thevirtualchannelnamesforwhichyouwanttocreateapath.Passtheotherchannelnameasthechannel1parameter.Virtualchannelnamesarealiasesforinstrumentspecificchannelstrings.Theinstrumentspecificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.YouassignavirtualchannelnametoaninstrumentspecificchannelinMAX.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrumentspecificchannelnames.DefaultValue:""
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSwtchInitializeorIviSwtchInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
Ifapathisnotavailable,theVIreturnsoneofthefollowingerrors:IVISWTCH_ERROR_EXPLICIT_CONNECTION_EXISTS(0xBFFA200C)ifthetwochannelsarealreadyexplicitlyconnectedbycallingeithertheIviSwtchConnectChannelsorIviSwtchSetPathVI.IVISWTCH_ERROR_IS_CONFIGURATION_CHANNEL(0xBFFA2009)ifachannelisaconfigurationchannel.CallIviSwtch_GetErrorforinformationaboutwhichofthetwochannelsisaconfigurationchannel.IVISWTCH_ERROR_ATTEMPT_TO_CONNECT_SOURCES(0xBFFA200B)ifbothchannelsareconnectedtoadifferentsource.CallIviSwtch_GetErrorforsourcestowhichchannel1and2connect.IVISWTCH_ERROR_CANNOT_CONNECT_TO_ITSELF(0xBFFA2015)ifchannels1and2areoneandthesamechannel.
IVISWTCH_ERROR_PATH_NOT_FOUND(0xBFFA2011)ifthedrivercannotfindapathbetweenthetwochannels.
IviSwtchConnectChannelsDetails
Notes
1. Thepathsarebidirectional.Forexample,ifapathexistsfromchannelCH1toCH2,thenapathfromchannelCH2toCH1alsoexists.
2. ThisVIperformsinterchangeabilitycheckingwhentheIviSwtchInterchangeCheckpropertyissettoTRUE.UseNISpytoviewinterchangeabilitywarnings.Alternately,youmayusetheIviSwtchGetNextInterchangeWarningVItoretrieveinterchangeabilitywarnings.Formoreinformationaboutinterchangeabilitychecking,refertothehelptextfortheIviSwtchInterchangeCheckproperty.
IviSwtchDisconnectAllChannelsIviSwtchBaseCapabilityGroupThisVIdisconnectsallpathscreatedsincetheIviSwtchInitializeVIorIviSwtchResetVIhasbeencalled.
NoteIftheswitchmoduleisnotcapableofdisconnectingallpaths,thisVIreturnsthewarningIVISWTCH_WARN_PATH_REMAINS(0x3FFA2001).
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSwtchInitializeorIviSwtchInitializeWithOptionsVI.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSwtchInitializeorIviSwtchInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSwtchDisconnectChannelsIviSwtchBaseCapabilityGroupThisVIdestroysthepathbetweentwochannelsthatyoucreatewiththeIviSwtchConnectChannelsorIviSwtchSetPathVI.ThisVIreturnsassoonasthecommandisgiventotheswitchmoduleandtheswitchmoduleisreadyforanothercommand.Thismaybebeforeoraftertheswitchesinvolvedsettle.UsetheIviSwtchSwitchIsDebouncedVItoseeiftheswitchhassettled.UsetheIviSwtchWaitForDebounceVIifyouwanttowaituntiltheswitchhasdebounced.Ifsomeconnectionsremainafterdisconnectingthetwospecifiedchannels,thisVIreturnsthewarningIVISWTCH_WARN_PATH_REMAINS(0x3FFA2001)error.Ifnoexplicitpathexistsbetweenthetwospecifiedchannels,thisVIreturnstheIVISWTCH_ERROR_NO_SUCH_PATH(0xBFFA2008)errorwithoutperforminganydisconnectionoperation.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSwtchInitializeorIviSwtchInitializeWithOptionsVI.channel1("")Youidentifyapathwithtwochannels.Passoneofthevirtualchannelnamesforwhichyouwanttodestroyapath.Passtheotherchannelnameasthechannel2parameter.Virtualchannelnamesarealiasesforinstrumentspecificchannelstrings.Theinstrumentspecificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.YouassignavirtualchannelnametoaninstrumentspecificchannelthroughMAX.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrumentspecificchannelnames.
DefaultValue:""
channel2("")Youidentifyapathwithtwochannels.Passoneofthevirtualchannelnamesforwhichyouwanttodestroyapath.Passtheotherchannelnameasthechannel1parameter.Virtualchannelnamesarealiasesforinstrumentspecificchannelstrings.Theinstrumentspecificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.YouassignavirtualchannelnametoaninstrumentspecificchannelthroughMAX.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrumentspecificchannelnames.DefaultValue:""
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSwtchInitializeorIviSwtchInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSwtchGetChannelNameIviSwtchBaseCapabilityGroupThisVIreturnsthespecificdriverdefinedchannelnamethatcorrespondstotheone-basedindexyouspecify.IfthevalueyoupassfortheIndexparameterislessthanoneorgreaterthanthevalueoftheChannelCountproperty,theVIreturnsanemptystringintheNameparameterandreturnsanerror.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSwtchInitializeorIviSwtchInitializeWithOptionsVI.Thehandleidentifiesaparticularinstrumentsession.
index(1)Aone-basedindexthatdefineswhichnametoreturn.TheindexmustbelessthanorequaltotheClassPrefixChannelCountproperty.instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSwtchInitializeorIviSwtchInitializeWithOptionsVI.Thehandleidentifiesaparticularinstrumentsession.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
outputchannelnameReturnsthenameoftheChannelspecifiedbytheindexparameter.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSwtchGetPathIviSwtchBaseCapabilityGroupInsomecasesthereismorethanonepossiblepathbetweentwochannels.ThedriverortheinstrumentselectsthepathwhenyouconnecttwochannelswiththeIviSwtchConnectChannelsVI.Thus,youcannotguaranteethateverycalltotheIviSwtchConnectChannelsVIestablishesexactlythesamepathwhenyoupassthesamechannels.ThisVIreturnsastringthatuniquelyidentifiesthepathyoucreatewiththeIviSwtchConnectChannelsVI.YoucanpassthisstringtotheIviSwtchSetPathVItoestablishtheexactsamepathinthefuture.Ifnoexplicitpathexistsbetweenthetwospecifiedchannels,thisVIreturnstheIVISWTCH_ERROR_NO_SUCH_PATH(0xBFFA2008)error.
NoteThisVIreturnsonlythosepathsthatyouexplicitlycreatebycallingIviSwtchConnectChannelsandIviSwtchSetPathVIs.Forexample,ifyouconnectchannelsCH1andCH3,andthenchannelsCH2andCH3,theexplicitpathbetweenchannelsCH1andCh2doesnotexistandthisVIreturnstheIVISWTCH_ERROR_NO_SUCH_PATH(0xBFFA2008)error.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSwtchInitializeorIviSwtchInitializeWithOptionsVI.channel1("")Youidentifyapathwithtwochannels.Passoneofthevirtualchannelnamesforwhichyouwanttogetapath.Passtheotherchannelnameasthechannel2parameter.
Virtualchannelnamesarealiasesforinstrumentspecificchannelstrings.Theinstrumentspecificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.Youassignavirtualchannelnametoan
instrumentspecificchannelthroughMAX.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrumentspecificchannelnames.DefaultValue:""
channel2("")Youidentifyapathwithtwochannels.Passoneofthevirtualchannelnamesforwhichyouwanttogetapath.Passtheotherchannelnameasthechannel1parameter.
Virtualchannelnamesarealiasesforinstrumentspecificchannelstrings.Theinstrumentspecificchannelstringscandifferfromoneinstrumenttoanother.Virtualchannelnamesallowyoutouseandswapinstrumentswithouthavingtochangethechannelnamesinyoursourcecode.YouassignavirtualchannelnametoaninstrumentspecificchannelthroughMAX.Thiscontrolacceptsvirtualchannelnamesyouhaveassignedtothespecificinstrumentyouareusing.Italsoacceptstheinstrumentspecificchannelnames.DefaultValue:""
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.
Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSwtchInitializeorIviSwtchInitializeWithOptionsVI.pathThecomma-separatedpathbetweenchannelsyouspecifyintheChannel1andChannel2parameters.
erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.
Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSwtchInitiateScanIviSwtchScannerCapabilityGroup[SCN]ThisVIinitiatesascanusingthescanlistandtriggersyouconfigurewiththeIviSwtchConfigureScanListandIviSwtchConfigureScanTrigger[SCN]VIs.Ifthereisnoscanlist,thisVIreturnstheerrorIVISWTCH_ERROR_EMPTY_SCAN_LIST(0xBFFA2004).ThisVIreturnsimmediately.
Onceyoustartthescanningoperation,youcannotperformanyotheroperationotherthanGetProperty,AbortScan,orSendSoftwareTrigger.AllotherVIsreturntheIVISWTCH_ERROR_SCAN_IN_PROGRESS(0xBFFA2006)error.Tostopthescanningoperation,calltheIviSwtchAbortScanVI.ThisVIappliesdefaultvaluestopropertiesthathavenotbeensetbyyouunderthefollowingconditions:IfyouhavenotsetthevalueofanypropertyintheIviSwtchScannerextension,thefollowingdefaultvaluesareused:IviSwtchScanList[SCN]—""(Emptystring)IviSwtchTriggerInput[SCN]—IVISWTCH_VAL_EXTERNALIviSwtchScanAdvancedOutput[SCN]—IVISWTCH_VAL_EXTERNALIviSwtchScanDelay[SCN]—0
Notes
1. Thepathsarebidirectional.Forexample,ifapathexistsfromchannelCH1toCH2,thenapathfromchannelCH2toCH1alsoexists.
2. ThisVIperformsinterchangeabilitycheckingwhentheIviSwtchInterchangeCheckpropertyissettoTRUE.UseNISpytoviewinterchangeabilitywarnings.Alternately,youmayusetheIviSwtchGetNextInterchangeWarningVItoretrieveinterchangeabilitywarnings.Formoreinformationabout
interchangeabilitychecking,refertotheIviSwtchInterchangeCheckproperty.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSwtchInitializeorIviSwtchInitializeWithOptionsVI.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSwtchInitializeorIviSwtchInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSwtchSendSoftwareTriggerIviSwtchSoftwareTriggerCapabilityGroup[SWT]ThisVIsendsacommandtotriggertheinstrument.YoumustsatisfycertainconditionsbeforeyoucansuccessfullycallthisVI.TheIviSwtchTriggerInputpropertyissettoIVISWTCH_VAL_SOFTWARE_TRIG.Ifthisconditionisnottrue,thisVIdoesnotsendthesoftwaretriggerandreturnstheerrorIVISWTCH_ERROR_TRIGGER_NOT_SOFTWARE.ThisVIdoesnotchecktheinstrumentstatus.Typically,theend-usercallsthisVIonlyinasequenceofcallstootherlow-leveldriverVIs.Thesequenceperformsoneoperation.Theend-userusesthelow-levelVIstooptimizeoneormoreaspectsofinteractionwiththeinstrument.Tochecktheinstrumentstatus,calltheIviSwtchError-QueryVIattheconclusionofthesequence.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSwtchInitializeorIviSwtchInitializeWithOptionsVI.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSwtchInitializeorIviSwtchInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSwtchSetContinuousScanIviSwtchScannerCapabilityGroup[SCN]ThisVIsetsthecontinuousscanmodeontheinstrument.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSwtchInitializeorIviSwtchInitializeWithOptionsVI.continuousscanstate(false)Specifieswhetherthecontinuousscanmodeisenabledordisabled.FALSE—disabledTRUE—enabled
errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSwtchInitializeorIviSwtchInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSwtchSetPathIviSwtchBaseCapabilityGroupThisVIconnectstwochannelsbyestablishingtheexactpathyouspecifywiththePathListparameter.ThisVIallowsyoutobypasstheautomaticroutingfeatureprovidedbytheIviSwtchdriver,andgivesyoudeterministiccontroloverthepaththatiscreatedbetweentwochannels.Youcanspecifytheexactpath,intermsofconfigurationchannels,usedtoconnecttwochannels.ThefirstandlastentriesinthepathListrepresentthetwochannelsyouwanttoconnect.
Thedrivermakesaconnectionbetweenthechannelsusingtheconfigurationchannels.Theseintermediarystepsarecalledlegsofthepath.Theformatofthelegofthepathisch1->conf1,wherech1andconf1arethetwochannelsthedriverusedtoestablishtheconnectionbetweenthefirstandthelastchannel.Thepathlistsyntaxisacomma-separatedlistofpathlegsthatobeythefollowingrules:
Thesecondchannelofaleginthepathlistmustbethesameasthefirstchannelinthesubsequentleg.Everychannelinthepathlistotherthanthefirstandthelastmustbeaconfigurationchannel.
Anexampleofapathlistis:ch1»conf1,conf1»ch2Thisstringisnotinterchangeablebecausethenamesofswitcheswithintheswitchmodulearenotrequiredtobeinterchangeableanddependontheinternalarchitectureoftheswitchmodule.However,youcanusetheIviSwtchConnectChannelsandthenIviSwtchGetPathVIstoretrieveanalreadyexistingpath.Thisallowsyoutoguaranteethattheroutingcanberecreatedexactly.Iftheinstrumentcannotparsetheinputpathliststring,thisVIreturnstheerrorIVISWTCH_ERROR_INVALID_SWITCH_PATH(0xBFFA2001).Ifthespecifiedpathliststringisempty,thisVIreturnstheerror
IVISWTCH_ERROR_EMPTY_SWITCH_PATH(0xBFFA2005).Ifoneofthechannelsinthepathlistisaconfigurationchannelthatiscurrentlyinuse,thisVIreturnstheerrorIVISWTCH_ERROR_RSRC_IN_USE(0xBFFA2003).Ifanexplicitconnectionismadetoaconfigurationchannel,thisVIreturnstheerrorIVISWTCH_ERROR_IS_CONFIGURATION_CHANNEL(0xBFFA2009).Ifoneofthenon-terminalchannelsinthepathlistisnotaconfigurationchannel,thisVIreturnstheerrorIVISWTCH_ERROR_NOT_A_CONFIGURATION_CHANNEL(0xBFFA200A).Ifthepathlistattemptstoconnectbetweentwodifferentsourcechannels,thisVIreturnstheerrorIVISWTCH_ERROR_ATTEMPT_TO_CONNECT_SOURCES(0xBFFA200B).Ifthepathlistattemptstoconnectbetweenchannelsthatalreadyhaveanexplicitconnection,thisVIreturnstheerrorIVISWTCH_ERROR_EXPLICIT_CONNECTION_EXISTS(0xBFFA200C).Ifaleginthepathlistdoesnotbeginwithachannelname,thisVIreturnstheerrorIVISWTCH_ERROR_LEG_MISSING_FIRST_CHANNEL(0xBFFA200D).Ifaleginthepathlistismissingthesecondchannel,thisVIreturnstheerrorIVISWTCH_ERROR_LEG_MISSING_SECOND_CHANNEL(0xBFFA200E).Ifthefirstandthesecondchannelsinthelegarethesame,thisVIreturnstheerrorIVISWTCH_ERROR_CHANNEL_DUPLICATED_IN_LEG(0xBFFA200F).Ifachannelnameisduplicatedinthepathstring,thisVIreturnstheerrorIVISWTCH_ERROR_CHANNEL_DUPLICATED_IN_PATH(0xBFFA2010).Ifthefirstchannelofaleginthepathisnotthesameasthesecondchannelinthepreviousleg,thisVIreturnstheerrorIVISWTCH_ERROR_DISCONTINUOUS_PATH(0xBFFA2012).Ifthepathlistcontainsalegwithtwochannelsthatcannotbedirectly
connected,thisVIreturnstheerrorIVISWTCH_ERROR_CANNOT_CONNECT_DIRECTLY(0xBFFA2013).Ifaleginthepathcontainstwochannelsthatarealreadydirectlyconnected,thisVIreturnstheerrorIVISWTCH_ERROR_CHANNELS_ALREADY_CONNECTED(0xBFFA2014).ThisVIappliesdefaultvaluestopropertiesthatarenotsetbyyouunderthefollowingcondition:(1)IfthevalueofanypropertyisnotsetintheIviSwtchScannerextension,thefollowingdefaultvaluesareused:IviSwtchScanList[SCN]—""(Emptystring)IviSwtchTriggerInput[SCN]—IVISWTCH_VAL_EXTERNALIviSwtchScanAdvancedOutput[SCN]—IVISWTCH_VAL_EXTERNALIviSwtchScanDelay[SCN]—0
Notes
1. Thepathsarebidirectional.Forexample,ifapathexistsfromCH1toCH2,thenapathfromCH2toCH1alsoexists.
2. ThisVIperformsinterchangeabilitycheckingwhentheIviSwtchInterchangeCheckpropertyissettoTRUE.UseNISpytoviewinterchangeabilitywarnings.Alternately,youmayusetheIviSwtchGetNextInterchangeWarningVItoretrieveinterchangeabilitywarnings.Formoreinformationaboutinterchangeabilitychecking,refertotheIviSwtchInterchangeCheckproperty.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSwtchInitializeorIviSwtchInitializeWithOptionsVI.pathlist("")Passthepathlistforthepathyoupreviouslycreatedthatyouwanttheswitchmoduletoestablish.YouobtainthepathlistforapathyoupreviouslycreatedwiththeIviSwtchGetPathVI.Example:ThepathfromCh1toCh3overConf1is:"Ch1»Conf1,Conf1»Ch3"
errorin(noerror)Theerrorinclustercanaccepterrorinformation
wiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSwtchInitializeorIviSwtchInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSwtchSwitchIsDebouncedIviSwtchBaseCapabilityGroupThisVIreturnsavaluethatindicateswhetherallthepathsthatyoupreviouslycreatedhavesettled.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSwtchInitializeorIviSwtchInitializeWithOptionsVI.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSwtchInitializeorIviSwtchInitializeWithOptionsVI.isdebouncedIndicatesthestateoftheswitchmodule.ThedriverreturnsthevalueoftheIviSwtchIsDebouncedproperty.TRUEindicatesthatallthepathsthatyoucreatedhavesettled.FALSEindicatesthatallthepathsthatyoucreatedhavenotsettled.
erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSwtchSwitchIsScanningIviSwtchScannerCapabilityGroup[SCN]ThisVIreturnsthestateoftheswitchmodule.Itindicatesiftheinstrumentiscurrentlyscanningorisidle.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSwtchInitializeorIviSwtchInitializeWithOptionsVI.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSwtchInitializeorIviSwtchInitializeWithOptionsVI.isscanningIndicatesthestateoftheswitchmodule.ThedriverreturnsthevalueofIviSwtchIsScanning[SCN]property.TRUEindicatesthattheswitchmoduleisscanning.FALSEindicatesthattheswitchmoduleisidle.
erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSwtchWaitForDebounceIviSwtchBaseCapabilityGroupCallingthisVIcausesthedrivertoreturnprocesscontrolbacktoyouonlyafterallthepathsthatyoupreviouslycreatedhavesettled.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSwtchInitializeorIviSwtchInitializeWithOptionsVI.maximumtime(1000ms)SpecifiesthemaximumlengthoftimeforthisVItowaituntilallswitchesintheswitchmoduledebounce.Ifthetimeyouspecifyelapsesbeforeallswitchesdebounce,thisVIreturnsatimeouterror.Theunitsaremilliseconds.DefaultValue:1000(ms)
NoteTheMaximumTimeparameteraffectsonlythisVI.Ithasnoeffectonothertimeoutparametersorproperties.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSwtchInitializeorIviSwtchInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSwtchWaitForScanToCompleteIviSwtchScannerCapabilityGroup[SCN]ThisVIwaitsuntiltheinstrumentstopsscanningorthetimeyouspecifiedhaselapsed.Iftheswitchmoduleisnotcurrentlyscanningthroughthescanlist,thisVIreturnstheIVISWTCH_ERROR_NO_SCAN_IN_PROGRESS(0xBFFA2007)error.Ifthetimeyouspecifiedelapsesbeforetheinstrumentstopsscanning,thisVIreturnsanerror.
instrumenthandleTheinstrumenthandlethatyouobtainfromtheIviSwtchInitializeorIviSwtchInitializeWithOptionsVI.maximumtime(1000ms)SpecifiesthemaximumlengthoftimeforthisVItowaituntiltheinstrumentstopsscanning.Ifthetimeyouspecifyelapsesbeforeitstopsscanning,thisVIreturnsatimeouterror.Theunitsaremilliseconds.Defaultvalue:1000ms.
NoteTheMaximumTimeparameteraffectsonlythisVI.Ithasnoeffectonothertimeoutparametersorproperties.errorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
instrumenthandleoutTheinstrumenthandlethatyouobtainfromtheIviSwtchInitializeorIviSwtchInitializeWithOptionsVI.erroroutTheerroroutclusterpasseserrororwarninginformation
outofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
IviSwtchPropertiesExpandthisbooktoviewanalphabetizedlistofIviSwtchproperties.
IviSwtchMaximumACVoltageIviSwtchBasePropertyDataType Access Appliesto Coercion HighLevelVIs
RO Channel N/A None
DescriptionThischannel-basedpropertyreturnsthemaximumACvoltagethechannelcanswitch.TheunitsarevoltsRMS.Thevaluesforthispropertyareonper-channelbasisandmaynottakeintoaccounttheotherswitchesthatmakeupapathtoorfromthischannel.PropertyNodePathIviSwtch»ModuleCharacteristics»MaximumACVoltage
IviSwtchBandwidthIviSwtchBasePropertyDataType Access Appliesto Coercion HighLevelVIs
RO Channel N/A None
DescriptionThischannel-basedpropertyreturnsthebandwidthforthechannel.Theunitsarehertz.Thevaluesforthispropertyareonper-channelbasisandmaynottakeintoaccounttheotherswitchesthatmakeupapathtoorfromthischannel.PropertyNodePathIviSwtch»ModuleCharacteristics»Bandwidth
IviSwtchMaximumCarryACCurrentIviSwtchBasePropertyDataType Access Appliesto Coercion HighLevelVIs
RO Channel N/A None
DescriptionThischannel-basedpropertyreturnsthemaximumACcurrentthechannelcancarry.TheunitsareamperesRMS.Thevaluesforthispropertyareonper-channelbasisandmaynottakeintoaccounttheotherswitchesthatmakeupapathtoorfromthischannel.PropertyNodePathIviSwtch»ModuleCharacteristics»MaximumCarryACCurrent
IviSwtchMaximumCarryACPowerIviSwtchBasePropertyDataType Access Appliesto Coercion HighLevelVIs
RO Channel N/A None
DescriptionThischannel-basedpropertyreturnsthemaximumACpowerthechannelcancarry.Theunitsarevolt-amperes.Thevaluesforthispropertyareonper-channelbasisandmaynottakeintoaccounttheotherswitchesthatmakeupapathtoorfromthischannel.PropertyNodePathIviSwtch»ModuleCharacteristics»MaximumCarryACPower
IviSwtchMaximumCarryDCCurrentIviSwtchBasePropertyDataType Access Appliesto Coercion HighLevelVIs
RO Channel N/A None
DescriptionThischannel-basedpropertyreturnsthemaximumDCcurrentthechannelcancarry.Theunitsareamperes.Thevaluesforthispropertyareonper-channelbasisandmaynottakeintoaccounttheotherswitchesthatmakeupapathtoorfromthischannel.PropertyNodePathIviSwtch»ModuleCharacteristics»MaximumCarryDCCurrent
IviSwtchMaximumCarryDCPowerIviSwtchBasePropertyDataType Access Appliesto Coercion HighLevelVIs
RO Channel N/A None
DescriptionThischannel-basedpropertyreturnsthemaximumDCpowerthechannelcanswitch.Theunitsarewatts.Thevaluesforthispropertyareonper-channelbasisandmaynottakeintoaccounttheotherswitchesthatmakeupapathtoorfromthischannel.PropertyNodePathIviSwtch»ModuleCharacteristics»MaximumCarryDCPower
IviSwtchChannelCountIviSwtchBasePropertyDataType Access Appliesto Coercion HighLevelVIs
RO N/A None None
DescriptionReturnsthenumberofchannelavailableontheinstrument.PropertyNodePathIviSwtch&»InherentIVISettings»SpecificDriverCapabilities»ChannelCount
IviSwtchCharacteristicImpedanceIviSwtchBasePropertyDataType Access Appliesto Coercion HighLevelVIs
RO Channel N/A None
DescriptionThischannel-basedpropertyreturnsthecharacteristicimpedanceforthechannel.Theunitsareohms.Thevaluesforthispropertyareonper-channelbasisandmaynottakeintoaccounttheotherswitchesthatmakeupapathtoorfromthischannelPropertyNodePathIviSwtch»ModuleCharacteristics»CharacteristicImpedance
IviSwtchIsConfigurationChannelIviSwtchBasePropertyDataType Access Appliesto Coercion HighLevelVIs
R/W Channel None None
DescriptionThischannel-basedpropertyspecifieswhethertoreservethechannelforinternalpathcreation.Achannelthatisavailableforinternalpathcreationiscalledaconfigurationchannel.ThedrivermayuseconfigurationchannelstocreatepathsbetweentwochannelsyouspecifyintheIviSwtchConnectChannelsVI.Configurationchannelsarenotavailableforexternalconnections.SetthispropertytoTRUEtomarkthechannelasaconfigurationchannel.SetthispropertytoFALSEtomarkthechannelasavailableforexternalconnections.Afteryouidentifyachannelasaconfigurationchannel,youcannotusethatchannelforexternalconnections.TheIviSwtchConnectChannelsVIreturnstheIVISWTCH_ERROR_IS_CONFIGURATION_CHANNELerrorwhenyouattempttoestablishaconnectionbetweenaconfigurationchannelandanyotherchannel.PropertyNodePathIviSwtch»ChannelConfiguration»IsConfigurationChannel
IviSwtchContinuousScan[SCN]IviSwtchScannerProperty[SCN]DataType
Access Appliesto
Coercion HighLevelVIs
R/W N/A N/A IviSwtchSetContinuousScan
DescriptionThispropertyspecifieswhethertheswitchmodulecontinuesscanningfromthetopofthescanlistafterreachingtheendofthelist.AvalueofTRUEindicatesthattheswitchmodulecontinuouslyscans.AvalueofFALSEindicatesthattheswitchmoduledoesnotcontinuouslyscan.IfyousetthispropertytoTRUE,theVIIviSwtchWaitForScanToCompletealwaystimesout,andyoumustcallIviSwtchAbortScantostopthescan.PropertyNodePathIviSwtch»ScanningConfiguration»ContinuousScan
IviSwtchMaximumDCVoltageIviSwtchBasePropertyDataType Access Appliesto Coercion HighLevelVIs
RO Channel N/A None
DescriptionThischannel-basedpropertyreturnsthemaximumDCvoltagethechannelcanswitch.Theunitsarevolts.Thevaluesforthispropertyareonper-channelbasisandmaynottakeintoaccounttheotherswitchesthatmakeupapathtoorfromthischannel.PropertyNodePathIviSwtch»ModuleCharacteristics»MaximumDCVoltage
IviSwtchIsDebouncedIviSwtchBasePropertyDataType
Access Appliesto
Coercion HighLevelVIs
RO N/A N/A IviSwtchSwitchIsDebounced
DescriptionThispropertyindicateswhethertheentireswitchmodulehassettledsincethelastswitchingcommand.AvalueofTRUEindicatesthatallsignalsgoingthroughtheswitchmodulearevalid.PropertyNodePathIviSwtch»ModuleCharacteristics»IsDebounced
IviSwtchNumberofColumns[SCN]IviSwtchScannerProperty[SCN]DataType Access Appliesto Coercion HighLevelVIs
RO N/A N/A None
DescriptionThispropertyreturnsthenumberofcolumnsofamatrixorscanner.Iftheswitchmoduleisascanner,thisvalueisthenumberofinputchannels.TheIviSwtchWireModepropertyaffectsthenumberofavailablecolumns.Forexample,ifyourmodulehas8inputlinesandyouusethe4-wiremode,thenthenumberofcolumnsyouhaveavailableis2.PropertyNodePathIviSwtch»MatrixConfiguration»NumberofColumns[SCN]
IviSwtchNumberofRows[SCN]IviSwtchScannerProperty[SCN]DataType Access Appliesto Coercion HighLevelVIs
RO N/A N/A None
DescriptionThispropertyreturnsthenumberofrowsofamatrixorscanner.Iftheswitchmoduleisascanner,thisvalueisthenumberofoutputchannels.TheIviSwtchWireModepropertyaffectsthenumberofavailablerows.Forexample,ifyourmodulehas2outputlinesandyouusethe2-wiremode,thenthenumberofrowsyouhaveavailableis1.PropertyNodePathIviSwtch»MatrixConfiguration»NumberofRows[SCN]
IviSwtchScanAdvancedOutput[SCN]IviSwtchScannerProperty[SCN]DataType
Access Appliesto
Coercion HighLevelVIs
R/W N/A None IviSwtchConfigureScanTrigger
DescriptionThispropertyspecifiesthemethodyouwanttousetonotifyanotherinstrumentthatallsignalsgoingthroughtheswitchmodulehavesettledfollowingtheprocessingofoneentryinthescanlist.Thistriggerisassertedeachtimeapathiscreated.Thistriggershouldnotbeasserteduntilaftersufficientsettlingtimehasbeengivenforthepath.TheIVISWTCH_VAL_EXTERNALvaluemeansthetriggerisgoingouttoanexternaldevicethroughatriggeroutputconnection.PropertyNodePathIviSwtch»ScanningConfiguration»ScanAdvancedOutput[SCN]DefinedValuesIVISWTCH_VAL_NONEIVISWTCH_VAL_EXTERNALIVISWTCH_VAL_GPIB_SRQIVISWTCH_VAL_TTL0IVISWTCH_VAL_TTL1IVISWTCH_VAL_TTL2IVISWTCH_VAL_TTL3IVISWTCH_VAL_TTL4IVISWTCH_VAL_TTL5IVISWTCH_VAL_TTL6IVISWTCH_VAL_TTL7IVISWTCH_VAL_ECL0IVISWTCH_VAL_ECL1
IVISWTCH_VAL_PXI_STARIVISWTCH_VAL_RTSI_0IVISWTCH_VAL_RTSI_1IVISWTCH_VAL_RTSI_2IVISWTCH_VAL_RTSI_3IVISWTCH_VAL_RTSI_4IVISWTCH_VAL_RTSI_5IVISWTCH_VAL_RTSI_6
IviSwtchScanDelay[SCN]IviSwtchScannerProperty[SCN]DataType
Access Appliesto
Coercion HighLevelVIs
R/W N/A None IviSwtchConfigureScanTrigger
DescriptionThispropertyspecifiestheminimumamountoftimetheswitchmodulewaitsbeforeitassertsthescanadvancedoutputtriggerafteropeningorclosingtheswitch.Theswitchmodulealwayswaitsfordebouncebeforeassertingthetrigger.Thus,theactualdelayisalwaysthegreatervalueofthesettlingtimeandthevalueyouspecifyastheswitchdelay.Theunitsareseconds.Duetodifferentdesignsoftheswitchmodules,theactualtimemightbelonger.PropertyNodePathIviSwtch»ScanningConfiguration»ScanDelay[SCN]
IviSwtchScanList[SCN]IviSwtchScannerProperty[SCN]DataType Access Appliesto Coercion HighLevelVIs
R/W N/A None IviSwtchConfigureScanList
DescriptionThispropertycontainsascanlist,whichisastringthatspecifieschannelconnectionsandtriggerconditions.TheIviSwtchInitiateScan[SCN]VImakesorbreaksconnectionsandwaitsfortriggersaccordingtotheinstructionsinthescanlist.Thescanlistiscomprisedofchannelnamesthatyouseparatewithspecialcharacters.Thesespecialcharactersdeterminetheoperationsthescannerperformsonthechannelswhenitexecutesthisscanlist.Thelistscanlistcontainsthechannels,intheordertobescanned.Youcanrefertothefollowingtableforscanlistsyntax.
Symbol SymbolName
Description SyntaxExamples
; Semi-colon Thischaracterinstructsthedrivertowaitforaninputtriggereventbeforeproceedingtothenextinstructioninthescanliststring.Intheexample,thedrivernotifiestheswitchmoduletocreateapathfromchannelCH1tochannelCH2,waitforatrigger,andthencreateapathfromchannelCH3tochannelCH4.
CH1->CH2;CH3->CH4
& Ampersand Thischaracterinstructsthedrivertoconnectallthepathsseparatedbythesymbolatthesametime,beforethenexttriggerevent.However,thedriverdoesnotguaranteetheorderofconnection,exceptthatallconnectionsaresettledbeforethenexttriggerevent.Intheexample,thedrivernotifiestheswitchmoduletocreatea
CH1->CH2&CH3->CH4;A->B
pathbetweenchannelsCH1andCH2andbetweenchannelsCH3andCH4,notnecessarilyinthatorder.TheswitchmodulethenwaitsforatriggerbeforeconnectingchannelAtochannelB.
~ Tilde Thischaracterinstructsthedrivertodisconnectapath.Intheexample,thedrivernotifiestheswitchmoduletodisconnectchannelCH1fromchannelCH2.Noticethatonlyapathconnectioneventgenerateascan-advancedtrigger.Disconnectingapathwillnotgenerateascan-advancedtrigger.
~CH1->CH2
-> ChannelPair
Thissymbolsignifiesachannelpair,whichinstructsthedrivertocreateapathbetweenthetwochannelsseparatedbythesymbol.Intheexample,thedrivernotifiestheswitchmoduletocreateapathfromchannelCH1tochannelCH2.
CH1->CH2
PropertyNodePathIviSwtch»ScanningConfiguration»ScanList[SCN]
IviSwtchScanMode[SCN]IviSwtchScannerProperty[SCN]DataType Access Appliesto Coercion HighLevelVIs
R/W N/A None IviSwtchConfigureScanList
DescriptionThispropertyspecifieswhathappenstoexistingconnectionsthatconflictwiththeconnectionsyoumakeinascanlist.Forexample,ifCH1isalreadyconnectedtoCH2andthescanlistinstructstheswitchmoduletoconnectCH1toCH3,thispropertyspecifieswhathappenstotheconnectionbetweenCH1andCH2.IfthevalueofthispropertyisIVISWTCH_VAL_NONE,theswitchmoduletakesnoactiononexistingpaths.IfthevalueisIVISWTCH_VAL_BREAK_BEFORE_MAKE,theswitchmodulebreaksconflictingpathsbeforemakingnewones.IfthevalueisIVISWTCH_VAL_BREAK_AFTER_MAKE,theswitchmodulebreaksconflictingpathsaftermakingnewones.Mostswitchmodulessupportonlyoneofthepossiblevalues.Insuchcases,thispropertyservesasanindicatorofthemodule'sbehavior.IVISWTCH_VAL_BREAK_BEFORE_MAKE—tellsthedrivertobreakthepreviouspathsbeforemakingthenewpaths.IVISWTCH_VAL_BREAK_AFTER_MAKE—tellsthedrivertomakenewpathsbeforebreakingthepreviouspaths.IVISWTCH_VAL_NONE_for_SCAN_MODE—indicatesthatnoactionshouldbetakenonthepreviouspaths.Youmustsupportatleastonevaluetosupportthisproperty.PropertyNodePathIviSwtch»ScanningConfiguration»ScanMode[SCN]DefinedValuesIVISWTCH_VAL_NONEIVISWTCH_VAL_BREAK_BEFORE_MAKEIVISWTCH_VAL_BREAK_AFTER_MAKE
IviSwtchIsScanning[SCN]IviSwtchScannerProperty[SCN]DataType Access Appliesto Coercion HighLevelVIs
RO N/A N/A IviSwtchSwitchIsScanning
DescriptionThispropertyindicateswhethertheswitchmodulehascompletedthescanoperation.ThevalueTRUEindicatesthatthescaniscomplete.PropertyNodePathIviSwtch»ScanningConfiguration»IsScanning[SCN]
IviSwtchSettlingTimeIviSwtchBasePropertyDataType Access Appliesto Coercion HighLevelVIs
RO Channel N/A None
DescriptionThischannel-basedpropertyreturnsthemaximumlengthoftimefromafteryoumakeaconnectionuntilthesignalflowingthroughthechannelsettles.Theunitsareseconds.Thevaluesforthispropertyareonper-channelbasisandmaynottakeintoaccounttheotherswitchesthatmakeupapathtoorfromthischannel.PropertyNodePathIviSwtch»ModuleCharacteristics»SettlingTime
IviSwtchIsSourceChannelIviSwtchBasePropertyDataType Access Appliesto Coercion HighLevelVIs
R/W Channel None None
DescriptionThischannel-basedpropertyspecifieswhetheryouwanttoidentifythechannelasasourcechannel.Typically,yousetthispropertytoTRUEwhenyouattachthechanneltoapowersupply,afunctiongenerator,oranactivemeasurementpointontheunitundertest,andyoudonotwanttoconnectthechanneltoanothersource.Thedriverpreventssourcechannelsfromconnectingtoeachother.TheConnectChannelsVIreturnstheIVISWTCH_ERROR_ATTEMPT_TO_CONNECT_SOURCESerrorwhenyouattempttoconnecttwochannelsthatyouidentifyassourcechannels.PropertyNodePathIviSwtch»ChannelConfiguration»IsSourceChannel
IviSwtchMaximumSwitchingACCurrentIviSwtchBasePropertyDataType Access Appliesto Coercion HighLevelVIs
RO Channel N/A None
DescriptionThischannel-basedpropertyreturnsthemaximumACcurrentthechannelcanswitch.TheunitsareamperesRMS.Thevaluesforthispropertyareonper-channelbasisandmaynottakeintoaccounttheotherswitchesthatmakeupapathtoorfromthischannel.PropertyNodePathIviSwtch»ModuleCharacteristics»MaximumSwitchingACCurrent
IviSwtchMaximumSwitchingACPowerIviSwtchBasePropertyDataType Access Appliesto Coercion HighLevelVIs
RO Channel N/A None
DescriptionThischannel-basedpropertyreturnsthemaximumACpowerthechannelcanswitch.Theunitsarevolt-amperes.Thevaluesforthispropertyareonper-channelbasisandmaynottakeintoaccounttheotherswitchesthatmakeupapathtoorfromthischannel.PropertyNodePathIviSwtch»ModuleCharacteristics»MaximumSwitchingACPower
IviSwtchMaximumSwitchingDCCurrentIviSwtchBasePropertyDataType Access Appliesto Coercion HighLevelVIs
RO Channel N/A None
DescriptionThischannel-basedpropertyreturnsthemaximumDCcurrentthechannelcancarry.Theunitsareamperes.Thevaluesforthispropertyareonper-channelbasisandmaynottakeintoaccounttheotherswitchesthatmakeupapathtoorfromthischannel.PropertyNodePathIviSwtch»ModuleCharacteristics»MaximumSwitchingDCCurrent
IviSwtchMaximumSwitchingDCPowerIviSwtchBasePropertyDataType Access Appliesto Coercion HighLevelVIs
RO Channel N/A None
DescriptionThischannel-basedpropertyreturnsthemaximumDCpowerthechannelcanswitch.Theunitsarewatts.Thevaluesforthispropertyareonper-channelbasisandmaynottakeintoaccounttheotherswitchesthatmakeupapathtoorfromthischannel.PropertyNodePathIviSwtch»ModuleCharacteristics»MaximumSwitchingDCPower
IviSwtchTriggerInput[SCN]IviSwtchScannerProperty[SCN]DataType
Access Appliesto
Coercion HighLevelVIs
R/W N/A None IviSwtchConfigureScanTrigger
DescriptionThispropertyspecifiesthesourceofthetriggerforwhichtheswitchmodulecanwaitwhenprocessingascanlist.Theswitchmodulewaitsforatriggerwhenitencountersasemicoloninascanlist.Whenthetriggeroccurs,theswitchmoduleadvancestothenextentryinthescanlist.Thistriggertellstheswitchmoduletoadvancetothenextentryinthescanlistandclosethespecifiedchannel.TheIVISWTCH_VAL_IMMEDIATEvalueindicatesthattheswitchmoduledoesnotwaitforatriggerbeforestartingthenextentryinthescan.ThisistypicallydoneforswitchmodulesthatsupporttheIviSwtchScanDelaypropertyandcanthereforehavetheswitchmodulepaceitself.TheIVISWTCH_VAL_EXTERNALvaluemeansthetriggeriscomingfromanexternalsourcethroughatriggerinputconnection.PropertyNodePathIviSwtch»ScanningConfiguration»TriggerInput[SCN]DefinedValuesIVISWTCH_VAL_IMMEDIATEIVISWTCH_VAL_EXTERNALIVISWTCH_VAL_SOFTWARE_TRIGIVISWTCH_VAL_TTL0IVISWTCH_VAL_TTL1IVISWTCH_VAL_TTL2IVISWTCH_VAL_TTL3IVISWTCH_VAL_TTL4IVISWTCH_VAL_TTL5
IVISWTCH_VAL_TTL6IVISWTCH_VAL_TTL7IVISWTCH_VAL_ECL0IVISWTCH_VAL_ECL1IVISWTCH_VAL_PXI_STARIVISWTCH_VAL_RTSI_0IVISWTCH_VAL_RTSI_1IVISWTCH_VAL_RTSI_2IVISWTCH_VAL_RTSI_3IVISWTCH_VAL_RTSI_4IVISWTCH_VAL_RTSI_5IVISWTCH_VAL_RTSI_6
IviSwtchWireModeIviSwtchBasePropertyDataType Access Appliesto Coercion HighLevelVIs
RO Channel None None
DescriptionThispropertyspecifiesthewiremodeoftheswitchmodule.ThispropertyaffectsthevaluesoftheIviSwtchNumberofRowsandIviSwtchNumberofColumnsproperties.Theactualnumberofinputandoutputlinesontheswitchmoduleisfixed,butthenumberofchannelsdependsonhowmanylinesconstituteeachchannel.PropertyNodePathIviSwtch»MatrixConfiguration»WireMode
IviSwtchDefinedValuesExpandthisbooktoviewanalphabetizedlistofIviSwtchdefinedvalues.
IVISWTCH_VAL_BREAK_AFTER_MAKEforIVISWTCH_ATTR_SCAN_MODETellsthedrivertomakethenewpathsbeforebreakingthepreviouspaths.DefinedValue:2
IVISWTCH_VAL_BREAK_BEFORE_MAKEforIVISWTCH_ATTR_SCAN_MODETellsthedevicestobreakthepreviouspathsbeforemakingthenewpaths.DefinedValue:1
IVISWTCH_VAL_ECL0AbackplaneECL0trigger,suchasisfoundintheVXIbus.DefinedValue:119
IVISWTCH_VAL_ECL1AbackplaneECL1trigger,suchasisfoundintheVXIbus.DefinedValue:120
IVISWTCH_VAL_EXTERNALMeansthetriggerisgoingouttoanexternaldevicethroughatriggeroutputconnection.DefinedValue:2
IVISWTCH_VAL_EXTERNAL(forIVISWTCH_ATTR_SCAN_ADVANCED_OUTPUT)ThescanadvancedoutputtriggerisrepresentedasanexternaltriggereventDefinedValue:2
IVISWTCH_VAL_EXTERNAL(forIVISWTCH_ATTR_TRIGGER_INPUT)Indicatesthatthetriggeriscomingfromanexternalsourcethroughatriggerinputconnection.DefinedValue:2
IVISWTCH_VAL_GPIB_SRQThescanadvancedoutputtriggerisrepresentedasaGPIBSRQevent.DefinedValue:5
IVISWTCH_VAL_IMMEDIATEIndicatesthattheswitchmoduledoesnotwaitforatriggerbeforestartingthenextentryinthescan.DefinedValue:1
IVISWTCH_VAL_NONE(for_SCAN_ADVANCED_OUTPUT)Noscanadvancedoutputtriggerissentoutoftheswitchmodule.DefinedValue:0
IVISWTCH_VAL_NONE(for_SCAN_MODE)Indicatesthatnoactionshouldbetakenonthepreviouspaths.DefinedValue:0
IVISWTCH_VAL_NONE_for_SCAN_ADVANCED_OUTPUTNoscanadvancedoutputtriggerissentoutoftheswitchmodule.DefinedValue:0
IVISWTCH_VAL_NONEforIviSwtchScanModeIndicatesthatnoactionshouldbetakenonthepreviouspaths.DefinedValue:0
IVISWTCH_VAL_PXI_STARAPXIstartriggerbus.DefinedValue:125
IVISWTCH_VAL_RTSI_0TheRTSI0triggerlineusuallyfoundinDAQinstruments.DefinedValue:140
IVISWTCH_VAL_RTSI_1TheRTSI1triggerlineusuallyfoundinDAQinstruments.DefinedValue:141
IVISWTCH_VAL_RTSI_2TheRTSI2triggerlineusuallyfoundinDAQinstruments.DefinedValue:142
IVISWTCH_VAL_RTSI_3TheRTSI3triggerlineusuallyfoundinDAQinstruments.DefinedValue:143
IVISWTCH_VAL_RTSI_4TheRTSI4triggerlineusuallyfoundinDAQinstruments.DefinedValue:144
IVISWTCH_VAL_RTSI_5TheRTSI5triggerlineusuallyfoundinDAQinstruments.DefinedValue:145
IVISWTCH_VAL_RTSI_6TheRTSI6triggerlineusuallyfoundinDAQinstruments.DefinedValue:146
IVISWTCH_VAL_SOFTWARE_TRIGThetriggerisasoftwarecommandsentbytheprogramthoughtheIviSwtch_SendSoftwareTriggeroperation.IfyousettheIVISWTCH_ATTR_TRIGGER_INPUTpropertytothisvalue,theinstrumentcanonlybetriggeredbycallingtheIviSwtch_SendSoftwareTriggerfunction.DefinedValue:3
IVISWTCH_VAL_TTL0AbackplaneTTLtrigger,suchastheVXIbusTTL0orPXITRIG0.DefinedValue:111
IVISWTCH_VAL_TTL1AbackplaneTTLtrigger,suchastheVXIbusTTL1orPXITRIG1.DefinedValue:112
IVISWTCH_VAL_TTL2AbackplaneTTLtrigger,suchastheVXIbusTTL2orPXITRIG2.DefinedValue:113
IVISWTCH_VAL_TTL3AbackplaneTTLtrigger,suchastheVXIbusTTL3orPXITRIG3.DefinedValue:114
IVISWTCH_VAL_TTL4AbackplaneTTLtrigger,suchastheVXIbusTTL4orPXITRIG4.DefinedValue:115
IVISWTCH_VAL_TTL5AbackplaneTTLtrigger,suchastheVXIbusTTL5orPXITRIG5.DefinedValue:116
IVISWTCH_VAL_TTL6AbackplaneTTLtrigger,suchastheVXIbusTTL6orPXITRIG6.DefinedValue:117
IVISWTCH_VAL_TTL7AbackplaneTTLtrigger,suchastheVXIbusTTL7orPXITRIG7.DefinedValue:118
PropertiesforControllingIviSwtchSimulationNoteYoucansetSimulationAttributesinMAXontheInitialSettingstabofIVIDrivers»Advanced»SimulationDriverSessions»nisIviClassorinthesimulationinteractivepanels.RefertoNationalInstrumentsIVIDriverHelp»ConfiguringYourSystemformoreinformation.
TwosetsofpropertiesexistforusewiththeIviSwtchSimulationDriver.Thefollowingtabledescribespropertiesthatcontrolbehaviorofthedriver.Anothertablelistspropertiesthatsimulatethestatusofspecificdriverfunctions.
PropertiesforControllingIviSwtchSimulation
Name DataType Access Applies
to Description
INTERACTIVE_SIMULATION Boolean W N/A Specifieswhethertosetthedrivertointeractivemode.Ininteractivemode,thesimulationdriverusespop-upuserinterfacepanelsforgettinginformationfromyou.Non-interactivemodeisusefulwhenyoudonotwanttheinteractivepanelstointerruptyourtestprogram.
SELF_TEST_CODE Integer W N/A Specifiestheself-testcode.WhentheIviSwtchSelf-TestVIiscalled,theself-testresultparameterreturnsthis
value.SELF_TEST_MSG String W N/A Specifiesthe
self-testmessage.WhentheIviSwtchSelf-TestVIiscalled,theself-testmessageparameterreturnsthisstring.
ERROR_QUERY_CODE Integer W N/A Specifiestheerror-querycode.WhentheIviSwtchError-QueryVIiscalled,theerrorcodeparameterreturnsthisvalue.
ERROR_QUERY_MSG String W N/A Specifiestheerror-querymessage.WhentheIviSwtchError-QueryVIiscalled,theerrormessageparameterreturnsthisstring.
DRIVER_REV_QUERY String W N/A Specifiestheinstrument
driverrevisionmessage.WhentheIviSwtchRevisionQueryVIiscalled,theinstrumentdriverrevisionparameterreturnsthisstring.
INSTR_REV_QUERY String W N/A Specifiesthefirmwarerevisionmessage.WhentheIviSwtchRevisionQueryVIiscalled,thefirmwarerevisionparameterreturnsthisstring.
SIMULATE_STATUS_CODE Boolean W N/A SpecifieswhethertosimulatereturncodesfromtheIviSwtchdriverVIs.RefertotheIviSwtchPropertiesforStatusSimulation
table.
RelatedTopicsSettingUpSimulatedErrorsSettingUpSimulationforVXIplug&playVIs
PropertiesforStatusSimulationinIviSwtchWhenanIviSwtchdriverfunctioniscalled,thedriverquerieswhetherNISSWTCH_ATTR_SIMULATE_STATUS_CODEisenabled.Ifenabled,thedrivergetstheappropriatefunction'ssimulationstatuscode.Ifthevalueofthesimulationstatuscoderepresentsawarning(hasapositivevalue),thenitisreturnedasthefunction'sreturnstatusonlyifnoothererrororwarningoccurredbeforethefunctionends.Ifthevalueofthesimulationstatuscoderepresentsanerror(hasanegativevalue),thenitisreturnedasthefunction'sreturnstatusonlyifnoothererroroccurredbeforethefunctionends.ThefollowingIviSwtchVIsdonotsupportstatuscodesimulation:
IviSwtchGetErrorIviSwtchClearErrorIviSwtchGetNextInterchangeWarningIviSwtchResetNextInterchangeWarningIviSwtchClearNextInterchangeWarningIviSwtchGetNextCoercionRecord
EachVIsupportedbytheIviSwtchclassdriverhasacorrespondingpropertythatdeterminesthestatuscodetoreturnwhenstatuscodesimulationisenabled.ThefollowingtableliststhestatuscodepropertiesandtheVIforwhichtheyreturnavalue.ThesepropertiesarealloftypeViInt32,non-readable,andnon-channelbased.
NoteInthefollowingtable,theliteralstringNISSWTCH_ATTR_precedesallpropertynames.
IviSwtchPropertiesforStatusSimulationProperty VIINIT_STATUS IviSwtchInitialize,IviSwtch
InitializeWithOptionsCLOSE_STATUS IviSwtchCloseRESET_STATUS IviSwtchResetSELF_TEST_STATUS IviSwtchSelf-TestERROR_QUERY_STATUS IviSwtchError-QueryERROR_MESSAGE_STATUS IviSwtchErrorMessageREVISION_QUERY_STATUS IviSwtchRevisionQueryRESET_DEFAULT_STATUS IviSwtchResetWithDefaultsDISABLE_STATUS IviSwtchDisableINVALIDATE_STATUS IviSwtchInvalidateAll
AttributesGET_CH_NAME_STATUS IviSwtchGetChannelNameCAN_CONNECT_STATUS IviSwtchCanConnect
ChannelsCONNECT_STATUS IviSwtchConnectChannelsDISCONNECT_STATUS IviSwtchDisconnectChannelsDISCONNECT_ALL_STATUS IviSwtchDisconnectAll
ChannelsGET_PATH_STATUS IviSwtchGetPathIS_DEBOUNCED_STATUS IviSwtchSwitchIsDebouncedSET_PATH_STATUS IviSwtchSetPathWAIT_FOR_DEBOUNCE_STATUS IviSwtchWaitForDebounceABORT_SCAN_STATUS IviSwtchAbortScanCONFIGURE_SCAN_LIST_STATUS IviSwtchConfigureScanListCONFIGURE_SCAN_TRIGGER_STATUS IviSwtchConfigureScan
TriggerINITIATE_SCAN_STATUS IviSwtchInitiateScan
IS_SCANNING_STATUS IviSwtchSwitchIsScanningSET_CONTINUOUS_SCAN_STATUS IviSwtchSetContinuousScanWAIT_FOR_SCAN_COMPLETE_STATUS IviSwtchWaitForScanTo
CompleteSEND_SOFTWARE_TRIGGER_STATUS IviSwtchSendSoftware
Trigger
ImportantInformationWarrantyCopyrightTrademarksPatentsWarningRegardingUseofNIProducts
WarrantyThemediaonwhichyoureceiveNationalInstrumentssoftwarearewarrantednottofailtoexecuteprogramminginstructions,duetodefectsinmaterialsandworkmanship,foraperiodof90daysfromdateofshipment,asevidencedbyreceiptsorotherdocumentation.NationalInstrumentswill,atitsoption,repairorreplacesoftwaremediathatdonotexecuteprogramminginstructionsifNationalInstrumentsreceivesnoticeofsuchdefectsduringthewarrantyperiod.NationalInstrumentsdoesnotwarrantthattheoperationofthesoftwareshallbeuninterruptedorerrorfree.AReturnMaterialAuthorization(RMA)numbermustbeobtainedfromthefactoryandclearlymarkedontheoutsideofthepackagebeforeanyequipmentwillbeacceptedforwarrantywork.NationalInstrumentswillpaytheshippingcostsofreturningtotheownerpartswhicharecoveredbywarranty.NationalInstrumentsbelievesthattheinformationinthisdocumentisaccurate.Thedocumenthasbeencarefullyreviewedfortechnicalaccuracy.Intheeventthattechnicalortypographicalerrorsexist,NationalInstrumentsreservestherighttomakechangestosubsequenteditionsofthisdocumentwithoutpriornoticetoholdersofthisedition.ThereadershouldconsultNationalInstrumentsiferrorsaresuspected.InnoeventshallNationalInstrumentsbeliableforanydamagesarisingoutoforrelatedtothisdocumentortheinformationcontainedinit.EXCEPTASSPECIFIEDHEREIN,NATIONALINSTRUMENTSMAKESNOWARRANTIES,EXPRESSORIMPLIED,ANDSPECIFICALLYDISCLAIMSANYWARRANTYOFMERCHANTABILITYORFITNESSFORAPARTICULARPURPOSE.CUSTOMER'SRIGHTTORECOVERDAMAGESCAUSEDBYFAULTORNEGLIGENCEONTHEPARTOFNATIONALINSTRUMENTSSHALLBELIMITEDTOTHEAMOUNTTHERETOFOREPAIDBYTHECUSTOMER.NATIONALINSTRUMENTSWILLNOTBELIABLEFORDAMAGESRESULTINGFROMLOSSOFDATA,PROFITS,USEOFPRODUCTS,ORINCIDENTALORCONSEQUENTIALDAMAGES,EVENIFADVISEDOFTHEPOSSIBILITYTHEREOF.ThislimitationoftheliabilityofNationalInstrumentswillapplyregardlessoftheformofaction,whetherincontractortort,includingnegligence.AnyactionagainstNationalInstrumentsmustbebroughtwithinoneyearafterthecauseofaction
accrues.NationalInstrumentsshallnotbeliableforanydelayinperformanceduetocausesbeyonditsreasonablecontrol.Thewarrantyprovidedhereindoesnotcoverdamages,defects,malfunctions,orservicefailurescausedbyowner'sfailuretofollowtheNationalInstrumentsinstallation,operation,ormaintenanceinstructions;owner'smodificationoftheproduct;owner'sabuse,misuse,ornegligentacts;andpowerfailureorsurges,fire,flood,accident,actionsofthirdparties,orothereventsoutsidereasonablecontrol.
CopyrightUnderthecopyrightlaws,thispublicationmaynotbereproducedortransmittedinanyform,electronicormechanical,includingphotocopying,recording,storinginaninformationretrievalsystem,ortranslating,inwholeorinpart,withoutthepriorwrittenconsentofNationalInstrumentsCorporation.NationalInstrumentsrespectstheintellectualpropertyofothers,andweaskouruserstodothesame.NIsoftwareisprotectedbycopyrightandotherintellectualpropertylaws.WhereNIsoftwaremaybeusedtoreproducesoftwareorothermaterialsbelongingtoothers,youmayuseNIsoftwareonlytoreproducematerialsthatyoumayreproduceinaccordancewiththetermsofanyapplicablelicenseorotherlegalrestriction.
PatentsForpatentscoveringNationalInstrumentsproducts,refertotheappropriatelocation:Help»Patentsinyoursoftware,thepatents.txtfileonyourCD,orni.com/patents.
TrademarksNationalInstruments,NI,ni.com,andLabVIEWaretrademarksofNationalInstrumentsCorporation.RefertotheTermsofUsesectiononni.com/legalformoreinformationaboutNationalInstrumentstrademarks.FireWire®istheregisteredtrademarkofAppleComputer,Inc.HandleGraphics®,MATLAB®,Real-TimeWorkshop®,Simulink®,Stateflow®,andxPCTargetBox®areregisteredtrademarks,andTargetBox™andTargetLanguageCompiler™aretrademarksofTheMathWorks,Inc.Tektronix®andTekareregisteredtrademarksofTektronix,Inc.Otherproductandcompanynamesmentionedhereinaretrademarksortradenamesoftheirrespectivecompanies.MembersoftheNationalInstrumentsAlliancePartnerProgramarebusinessentitiesindependentfromNationalInstrumentsandhavenoagency,partnership,orjoint-venturerelationshipwithNationalInstruments.
WARNINGREGARDINGUSEOFNATIONALINSTRUMENTSPRODUCTS(1)NATIONALINSTRUMENTSPRODUCTSARENOTDESIGNEDWITHCOMPONENTSANDTESTINGFORALEVELOFRELIABILITYSUITABLEFORUSEINORINCONNECTIONWITHSURGICALIMPLANTSORASCRITICALCOMPONENTSINANYLIFESUPPORTSYSTEMSWHOSEFAILURETOPERFORMCANREASONABLYBEEXPECTEDTOCAUSESIGNIFICANTINJURYTOAHUMAN.(2)INANYAPPLICATION,INCLUDINGTHEABOVE,RELIABILITYOFOPERATIONOFTHESOFTWAREPRODUCTSCANBEIMPAIREDBYADVERSEFACTORS,INCLUDINGBUTNOTLIMITEDTOFLUCTUATIONSINELECTRICALPOWERSUPPLY,COMPUTERHARDWAREMALFUNCTIONS,COMPUTEROPERATINGSYSTEMSOFTWAREFITNESS,FITNESSOFCOMPILERSANDDEVELOPMENTSOFTWAREUSEDTODEVELOPANAPPLICATION,INSTALLATIONERRORS,SOFTWAREANDHARDWARECOMPATIBILITYPROBLEMS,MALFUNCTIONSORFAILURESOFELECTRONICMONITORINGORCONTROLDEVICES,TRANSIENTFAILURESOFELECTRONICSYSTEMS(HARDWAREAND/ORSOFTWARE),UNANTICIPATEDUSESORMISUSES,ORERRORSONTHEPARTOFTHEUSERORAPPLICATIONSDESIGNER(ADVERSEFACTORSSUCHASTHESEAREHEREAFTERCOLLECTIVELYTERMED"SYSTEMFAILURES").ANYAPPLICATIONWHEREASYSTEMFAILUREWOULDCREATEARISKOFHARMTOPROPERTYORPERSONS(INCLUDINGTHERISKOFBODILYINJURYANDDEATH)SHOULDNOTBERELIANTSOLELYUPONONEFORMOFELECTRONICSYSTEMDUETOTHERISKOFSYSTEMFAILURE.TOAVOIDDAMAGE,INJURY,ORDEATH,THEUSERORAPPLICATIONDESIGNERMUSTTAKEREASONABLYPRUDENTSTEPSTOPROTECTAGAINSTSYSTEMFAILURES,INCLUDINGBUTNOTLIMITEDTOBACK-UPORSHUTDOWNMECHANISMS.BECAUSEEACHEND-USERSYSTEMISCUSTOMIZEDANDDIFFERSFROMNATIONALINSTRUMENTS'TESTINGPLATFORMSANDBECAUSEAUSERORAPPLICATIONDESIGNERMAYUSENATIONALINSTRUMENTSPRODUCTSINCOMBINATIONWITHOTHERPRODUCTSINAMANNERNOTEVALUATEDORCONTEMPLATEDBYNATIONALINSTRUMENTS,THEUSEROR
APPLICATIONDESIGNERISULTIMATELYRESPONSIBLEFORVERIFYINGANDVALIDATINGTHESUITABILITYOFNATIONALINSTRUMENTSPRODUCTSWHENEVERNATIONALINSTRUMENTSPRODUCTSAREINCORPORATEDINASYSTEMORAPPLICATION,INCLUDING,WITHOUTLIMITATION,THEAPPROPRIATEDESIGN,PROCESSANDSAFETYLEVELOFSUCHSYSTEMORAPPLICATION.
TechnicalSupportandProfessionalServicesVisitthefollowingsectionsoftheNationalInstrumentsWebsiteatni.comfortechnicalsupportandprofessionalservices:
Support—Onlinetechnicalsupportresourcesatni.com/supportincludethefollowing:
Self-HelpResources—Foranswersandsolutions,visittheaward-winningNationalInstrumentsWebsiteforsoftwaredriversandupdates,asearchableKnowledgeBase,productmanuals,step-by-steptroubleshootingwizards,thousandsofexampleprograms,tutorials,applicationnotes,instrumentdrivers,andsoon.FreeTechnicalSupport—AllregisteredusersreceivefreeBasicService,whichincludesaccesstohundredsofApplicationsEngineersworldwideintheNIDiscussionForumsatforums.ni.com.NationalInstrumentsApplicationsEngineersmakesureeveryquestionreceivesananswer.Forinformationaboutothertechnicalsupportoptionsinyourarea,visitni.com/servicesorcontactyourlocalofficeatni.com/contact.
TrainingandCertification—Visitni.com/trainingforself-pacedtraining,eLearningvirtualclassrooms,interactiveCDs,andCertificationprograminformation.Youalsocanregisterforinstructor-led,hands-oncoursesatlocationsaroundtheworld.SystemIntegration—Ifyouhavetimeconstraints,limitedin-housetechnicalresources,orotherprojectchallenges,NationalInstrumentsAlliancePartnermemberscanhelp.Tolearnmore,callyourlocalNIofficeorvisitni.com/alliance.
Ifyousearchedni.comandcouldnotfindtheanswersyouneed,contactyourlocalofficeorNIcorporateheadquarters.YoualsocanvisittheWorldwideOfficessectionofni.com/niglobaltoaccessthebranchofficeWebsites,whichprovideup-to-datecontactinformation,supportphonenumbers,emailaddresses,andcurrentevents.
errorinerrorin(noerror)TheerrorinclustercanaccepterrorinformationwiredfromVIspreviouslycalled.UsethisinformationtodecideifanyfunctionalityshouldbebypassedintheeventoferrorsfromotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
statusThestatusBooleaniseitherTRUE(X)foranerror,orFALSE(checkmark)fornoerrororawarning.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
codeThecodeinputidentifiestheerrororwarning.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.sourceThesourcestringdescribestheoriginoftheerrororwarning.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.ErrorCodes
errorouterroroutTheerroroutclusterpasseserrororwarninginformationoutofaVItobeusedbyotherVIs.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.
statusThestatusBooleaniseitherTRUE(X)foranerror,orFALSE(checkmark)fornoerrororawarning.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.codeThecodeinputidentifiestheerrororwarning.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.sourceThesourcestringdescribestheoriginoftheerrororwarning.Thepop-upoptionExplainError(orExplainWarning)givesmoreinformationabouttheerrordisplayed.ErrorCodes
ClassPrefixChannelCountInherentPropertyDataType Access Appliesto Coercion HighLevelFunctions
RO N/A None None
DescriptionReturnsthenumberofavailablechannels.PropertyNodePathClassPrefix»InherentIVISettings»UserOptions»ChannelCount
InteractiveSimulationInallclassdrivers,theVXIplug&play-compliantVIsandfunctionshaveoutputparametersthatreturnvaluesorstringsfromtheinstrument.
VXIplug&play-compliantVIsCLASSPREFIX_self-test
CLASSPREFIX_revision_query CLASSPREFIX_error_query
Duringsimulation,thesimulationdrivercancreatesimulateddatafortheoutputparametersofthesefunctions.Thispanelallowsyoutoconfigurethesimulationdatatoreturnfromthesefunctions.YoucanaccessthisviewintheIviDmm,theIviDCPwr,ortheIviScopeSimulatorSetupdialogboxes.Inthiscase,youseetheSimulatorSetupdialogboxforIviScope.Scrolldowntoseeadescriptionofeachcontrol.
IviScopeSimulatorSetupDialogBoxTheSimulatorSetupdialogboxesforthedifferentclassdrivershavecommonfeatures.EachSimulatorSetupdialogboxhasaViewringcontrolintheupperleft-handcorner.UsetheViewringcontroltoselectafeatureofthesimulationdrivertoconfigure.AllthedialogboxeshaveviewstoconfigurethesimulationoftheVXIplug&playfunctionsandthesimulationoffunctionstatuscodes.Forclassesthattakemeasurements,suchasIviDmm,IviScope,andIviDCPwr,theSimulatorSetupdialogboxalsocontainsaMeasurementDataSimulationview.BecauseyoucanfullyconfigurethesimulationdriverintheSimulatorSetupdialogboxatruntime,youdonothavetouseMAXtospecifyattributevaluesintheInitialSettingstaboftheSimulationDriverSessionsdialogbox.Ifyoudospecifytheinitialsettings,however,thevaluesthatyouspecifyappearastheinitialvaluesintheSimulatorSetupdialogboxeachtimeyoucallClassPrefix_init.
Self-TestUsetheResultCodeandMessagecontrolstospecifythevaluesyouwantthedriver'sClassPrefixSelf-TestVIorClassPrefix_self_testfunctiontoreturninitsoutputparameters.
Error-QueryUsetheErrorCodeandMessagecontrolstospecifythevaluesyouwantthedriver'sClassPrefixError-QueryVIorClassPrefix_error_queryfunctiontoreturninitsoutputparameters.
RevisionQueryUsetheInstrumentDriverRevisionandFirmwareRevisioncontrolstospecifythevaluesyouwantthedriver'sClassPrefixRevisionQueryVIorClassPrefix_revision_queryfunctiontoreturninitsoutputparameters.
StatusCodeSimulationYouusethedialogboxshownbelowtoconfigurethestatuscodeforasimulation.YoucanaccessthisviewintheIviDmm,theIviDCPwr,ortheIviScopeSimulatorSetupdialogboxes.Inthiscase,youseetheSimulatorSetupdialogboxforIviScope.Toconfigurethestatuscodesimulation,selectStatusCodeSimulationfromtheViewringcontrol.
Scrolldowntoseeadescriptionofeachcontrol.
StatusCodeSimulationViewTheStatusCodeSimulationviewisthesameforallsimulationdrivers.TheStatusCodeSimulationviewhasthefollowingcontrols:
SimulateStatusCodesThiscontrollistsalloftheclassdriverfunctionsthattheselectedinstrumentspecificdriverdriversupports.Thelistalsoindicateseachfunction'sassociatedsimulationstatuscodeinbothmacronameformandinhexadecimalvalueform.YouusetheStatusCodeMacroandCustomStatusCodecontrolstomodifysimulationstatuscodes.SettingthiscontrolhasthesameeffectasconfiguringthePREFIX_ATTR_SIMULATE_STATUS_CODESattributeontheInitialSettingstabofIVIDrivers»Advanced»SimulationDriverSessions»nisIviClassinMAX.
StatusCodeMacroThiscontrolallowsyoutochangethesimulationstatuscodeofthecurrentlyselectedfunction.SettingthiscontroltothecustomstatuscodeoptionsetsthevalueyouplacedintheCustomStatusCodecontrolasthefunction'ssimulatedstatuscode.
IfyouselectCustomStatusCode,youcanconfigureacustomstatuscodeintheCustomStatusCodecontrol.
CustomStatusCodeLetsyouspecifyacustomstatuscodetosimulateforaparticularfunction.
ResetalltoVI_SUCCESSThiscontrolresetsalloftheclassdriverfunctions'simulationstatuscodestoVI_SUCCESS(0).
ConfiguringsimulatedstatuscodeswiththisdialogboxhasthesameeffectasconfiguringthecorrespondingsimulatedstatuscodeattributesontheInitialSettingstabofIVIDrivers»Advanced»SimulationDriverSessions»nisIviClassinMAX.RelatedTopicsPropertiesforControllingIviDCPwrSimulationPropertiesforControllingIviDmmSimulationPropertiesforControllingIviFgenSimulationPropertiesforControllingIviScopeSimulationPropertiesforControllingIviSwtchSimulation
DiagramofStandardWaveforms
DiagramofStandardWaveforms
VI_TRUEDescriptionTrue
DefinedValue1
VI_FALSEDescriptionFalse
DefinedValue0
IVISCOPE_VAL_AC_LINE_EITHERConfigurestheoscilloscopetotriggeroneitherpositiveornegativeslopezerocrossingsofthenetworksupplyvoltage.DefinedValue:3
IVISCOPE_VAL_AC_LINE_POSITIVEConfigurestheoscilloscopetotriggeronpositiveslopezerocrossingsofthenetworksupplyvoltage.DefinedValue:1
IVISCOPE_VAL_AC_LINE_NEGATIVEConfigurestheoscilloscopetotriggeronnegativeslopezerocrossingsofthenetworksupplyvoltage.DefinedValue:2
TimeDomainMeasurementsIncertainsituationsthespectrumanalyzermaybeusedtotaketimedomainratherthanfrequencydomainmeasurements.Typicaltimedomainmeasurementsareoscilloscopetraces,butwhenaspectrumanalyzeristakingatimedomainmeasurement,theamplitudeofonlyonefrequencyismeasured.Tosetthespectrumanalyzertoatimedomainmode,thestartandstopfrequencyhavetobesettothesamefrequency;thefrequencyofinterest.Sweepingwiththestartandstopsettothesamefrequencycausestheanalyzertotakemanyindependentmeasurementsofthatfrequencyovertime(inthetimedomain).Thisisveryusefulindeterminingsuchthingsasthechangeinoutputpowerofatransmitterasitwarmsup.Anotheruseistocaptureapeakofapulsedsignalataparticularfrequency.
IviSwtchTriggerInputValuesIVISWTCH_VAL_IMMEDIATEImmediate(Default)IVISWTCH_VAL_EXTERNALExternalIVISWTCH_VAL_SOFTWARE_TRIGSoftwareTriggerFunctionIVISWTCH_VAL_TTL0PXITRIG0orVXITTL0IVISWTCH_VAL_TTL1PXITRIG1orVXITTL1IVISWTCH_VAL_TTL2PXITRIG2orVXITTL2IVISWTCH_VAL_TTL3PXITRIG3orVXITTL3IVISWTCH_VAL_TTL4PXITRIG4orVXITTL4IVISWTCH_VAL_TTL5PXITRIG5orVXITTL5IVISWTCH_VAL_TTL6PXITRIG6orVXITTL6IVISWTCH_VAL_TTL7PXITRIG7orVXITTL7IVISWTCH_VAL_ECL0VXIECL0IVISWTCH_VAL_ECL1VXIECL1IVISWTCH_VAL_PXI_STARPXIStarIVISWTCH_VAL_RTSI_0RTSIline0IVISWTCH_VAL_RTSI_1RTSIline1IVISWTCH_VAL_RTSI_2RTSIline2IVISWTCH_VAL_RTSI_3RTSIline3IVISWTCH_VAL_RTSI_4RTSIline4IVISWTCH_VAL_RTSI_5RTSIline5IVISWTCH_VAL_RTSI_6RTSIline6
NoteForallofthefollowingtriggers,theswitchmodulewaitsuntilitreceivesatriggeronthespecifiedtriggerlinebeforeprocessingthenextentryinthescanlist...(1)IVISWTCH_VAL_IMMEDIATEImmediateTrigger.(2)IVISWTCH_VAL_EXTERNALExternalTrigger.(3)IVISWTCH_VAL_SOFTWARE_TRIG.(111)IVISWTCH_VAL_TTL.
(112)IVISWTCH_VAL_TTL.(113)IVISWTCH_VAL_TTL.(114)IVISWTCH_VAL_TTL.(115)IVISWTCH_VAL_TTL.(116)IVISWTCH_VAL_TTL.(117)IVISWTCH_VAL_TTL.(118)IVISWTCH_VAL_TTL.(119)IVISWTCH_VAL_ECL.(120)IVISWTCH_VAL_ECL.(125)IVISWTCH_VAL_PXI_STA.(140)IVISWTCH_VAL_RTSI_0.(141)IVISWTCH_VAL_RTSI_1.(142)IVISWTCH_VAL_RTSI_2.(143)IVISWTCH_VAL_RTSI_.(144)IVISWTCH_VAL_RTSI_4.(145)IVISWTCH_VAL_RTSI_.(146)IVISWTCH_VAL_RTSI_6
IviSwtchScanAdvOutputValuesIVISWTCH_VAL_NONENTrigger(Default)IVISWTCH_VAL_EXTERNALExternalIVISWTCH_VAL_GPIB_SRQGPIBServiceRequestIVISWTCH_VAL_TTL0PXITRIG0orVXITTL0IVISWTCH_VAL_TTL1PXITRIG1orVXITTL1IVISWTCH_VAL_TTL2PXITRIG2orVXITTL2IVISWTCH_VAL_TTL3PXITRIG3orVXITTL3IVISWTCH_VAL_TTL4PXITRIG4orVXITTL4IVISWTCH_VAL_TTL5PXITRIG5orVXITTL5IVISWTCH_VAL_TTL6PXITRIG6orVXITTL6IVISWTCH_VAL_TTL7PXITRIG7orVXITTL7IVISWTCH_VAL_ECL0VXIECL0IVISWTCH_VAL_ECL1VXIECL1IVISWTCH_VAL_PXI_STARPXIStarIVISWTCH_VAL_RTSI_0RTSIline0IVISWTCH_VAL_RTSI_1RTSIline1IVISWTCH_VAL_RTSI_2RTSIline2IVISWTCH_VAL_RTSI_3RTSIline3IVISWTCH_VAL_RTSI_4RTSIline4IVISWTCH_VAL_RTSI_5RTSIline5IVISWTCH_VAL_RTSI_6RTSIline6
Note(0)IVISWTCH_VAL_NONETheswitchmoduledoesnotproduceaScanAdvancedOutputtrigger.
NoteForallofthefollowingtriggers,theswitchmodulewaitsuntilitreceivesatriggeronthespecifiedtriggerlinebeforeprocessingthenextentryinthescanlist...(1)IVISWTCH_VAL_IMMEDIATEImmediateTrigger.(2)IVISWTCH_VAL_EXTERNALExternalTrigger.
(3)IVISWTCH_VAL_SOFTWARE_TRIG.(111)IVISWTCH_VAL_TTL.(112)IVISWTCH_VAL_TTL.(113)IVISWTCH_VAL_TTL.(114)IVISWTCH_VAL_TTL.(115)IVISWTCH_VAL_TTL.(116)IVISWTCH_VAL_TTL.(117)IVISWTCH_VAL_TTL.(118)IVISWTCH_VAL_TTL.(119)IVISWTCH_VAL_ECL.(120)IVISWTCH_VAL_ECL.(125)IVISWTCH_VAL_PXI_STA.(140)IVISWTCH_VAL_RTSI_0.(141)IVISWTCH_VAL_RTSI_1.(142)IVISWTCH_VAL_RTSI_2.(143)IVISWTCH_VAL_RTSI_3.(144)IVISWTCH_VAL_RTSI_4.(145)IVISWTCH_VAL_RTSI_.(146)IVISWTCH_VAL_RTSI_6
BranchOfficesOffice TelephoneNumberAustralia 0261296728846Austria 4306624579900Belgium 32027570020Brazil 551132623599Canada(Calgary) 4032749391Canada(Montreal) 5142885722Canada(Ottawa) 6132335949Canada(Québec) 5146948521Canada(Toronto) 9057850085Canada(Vancouver) 5146857530China 862165557838CzechRepublic 420224235774Denmark 4545762600Finland 3850972572511France 330148142424Germany 490897413130Greece 302104296427India 918051190000Israel 972036393737Italy 3902413091Japan 81354722970Korea 820234513400Malaysia 60391310918Mexico 0018000100793Netherlands 310348433466NewZealand 64099140488Norway 47032277300
Poland 480223390150Portugal 351210311210Russia 70952387139Singapore 6562265886Slovenia 38634254200SouthAfrica 270118058197Spain 34916400085Sweden 460858789500Switzerland 41562005151Taiwan 886225287227Thailand 6629927519UnitedKingdom 4401635523545UnitedStates(Corporate) 5126830100