How it Works
AMETEK
Loading...
Ls
User Manual
275 pgs1.08 Mb0

AMETEK Ls User Manual

Lx \ Ls Series
AC Power Source
IVI Instrument Driver
Manual
LabView, LabWindows/CVI
Telephone: 800 733 5427 (toll free in North America) 858 450 0085 (direct) Fax: 858 458 0267 Email: Domestic Sales: domorders.sd@ametek.com International Sales: intlorders.sd@ametek.com Customer Service: service.ppd@ametek.com
Web: www.programmablepower.com
March 2011 Document No. 7004-967 Rev. B
About AMETEK
AMETEK Programmable Power, Inc., a Division of AMETEK, Inc., is a global leader in the design and manufacture of precision, programmable power supplies for R&D, test and measurement, process control, power bus simulation and power conditioning applications across diverse industrial segments. From bench top supplies to rack-mounted industrial power subsystems, AMETEK Programmable Power is the proud manufacturer of Elgar, Sorensen, California Instruments and Power Ten brand power supplies.
AMETEK, Inc. is a leading global manufacturer of electronic instruments and electromechanical devices with annualized sales of $2.5 billion. The Company has over 11,000 colleagues working at more than 80 manufacturing facilities and more than 80 sales and service centers in the United States and around the world.
Trademarks
AMETEK is a registered trademark of AMETEK, Inc. Other trademarks, registered trademarks, and product names are the property of their respective owners and are used herein for identification purposes only.
Notice of Copyright
AC Power Source, IVI Instrument Driver Manual LabView, LabWindows/CVI
Programmable Power, Inc. All rights reserved.
© 2010 AMETEK
Exclusion for Documentation
UNLESS SPECIFICALLY AGREED TO IN WRITING, AMETEK PROGRAMMABLE POWER, INC. (“AMETEK”):
(a) MAKES NO WARRANTY AS TO THE ACCURACY, SUFFICIENCY OR SUITABILITY OF ANY
TECHNICAL OR OTHER INFORMATION PROVIDED IN ITS MANUALS OR OTHER DOCUMENTATION.
(b) ASSUMES NO RESPONSIBILITY OR LIABILITY FOR LOSSES, DAMAGES, COSTS OR
EXPENSES, WHETHER SPECIAL, DIRECT, INDIRECT, CONSEQUENTIAL OR INCIDENTAL, WHICH MIGHT ARISE OUT OF THE USE OF SUCH INFORMATION. THE USE OF ANY SUCH INFORMATION WILL BE ENTIRELY AT THE USER’S RISK, AND
(c) REMINDS YOU THAT IF THIS MANUAL IS IN ANY LANGUAGE OTHER THAN ENGLISH,
ALTHOUGH STEPS HAVE BEEN TAKEN TO MAINTAIN THE ACCURACY OF THE TRANSLATION, THE ACCURACY CANNOT BE GUARANTEED. APPROVED AMETEK CONTENT IS CONTAINED WITH THE ENGLISH LANGUAGE VERSION, WHICH IS POSTED AT WWW.PROGRAMMABLEPOWER.COM.
Date and Revision
March 2011 Revision B
Part Number
7004-967
Contact Information
Telephone: 800 733 5427 (toll free in North America) 858 450 0085 (direct) Fax: 858 458 0267 Email: sales@programmablepower.com service@programmablepower.com Web: www.programmablepower.com
i
This page intentionally left blank.
ii
WARNING
Hazardous voltages may be present when covers are removed. Qualified personnel must use extreme caution when servicing this equipment. Circuit boards, test points, and output voltages also may be floating above (below) chassis ground.
WARNING
The equipment used contains ESD sensitive ports. When installing equipment, follow ESD Safety Procedures. Electrostatic discharges might cause damage to the equipment.
Important Safety Instructions
Before applying power to the system, verify that your product is configured properly for your particular application.
Only qualified personnel who deal with attendant hazards in power supplies, are allowed to perform installation and servicing.
Ensure that the AC power line ground is connected properly to the Power Rack input connector or chassis. Similarly, other power ground lines including those to application and maintenance equipment must be grounded properly for both personnel and equipment safety.
Always ensure that facility AC input power is de-energized prior to connecting or disconnecting any cable.
In normal operation, the operator does not have access to hazardous voltages within the chassis. However, depending on the user’s application configuration, HIGH VOLTAGES HAZARDOUS TO HUMAN SAFETY may be normally generated on the output terminals. The customer/user must ensure that the output power lines are labeled properly as to the safety hazards and that any inadvertent contact with hazardous voltages is eliminated.
Guard against risks of electrical shock during open cover checks by not touching any portion of the electrical circuits. Even when power is off, capacitors may retain an electrical charge. Use safety glasses during open cover checks to avoid personal injury by any sudden component failure.
Neither AMETEK Programmable Power Inc., San Diego, California, USA, nor any of the subsidiary sales organizations can accept any responsibility for personnel, material or inconsequential injury, loss or damage that results from improper use of the equipment and accessories.
SAFETY SYMBOLS
iii
Product Family: Lx\Ls Series
Warranty Period: One Year
WARRANTY TERMS
AMETEK Programmable Power, Inc. (“AMETEK”), provides this written warranty covering the Product stated above, and if the Buyer discovers and notifies AMETEK in writing of any defect in material or workmanship within the applicable warranty period stated above, then AMETEK may, at its option: repair or replace the Product; or issue a credit note for the defective Product; or provide the Buyer with replacement parts for the Product.
The Buyer will, at its expense, return the defective Product or parts thereof to AMETEK in accordance with the return procedure specified below. AMETEK will, at its expense, deliver the repaired or replaced Product or parts to the Buyer. Any warranty of AMETEK will not apply if the Buyer is in default under the Purchase Order Agreement or where the Product or any part thereof:
is damaged by misuse, accident, negligence or failure to maintain the same as
specified or required by AMETEK;
is damaged by modifications, alterations or attachments thereto which are not
authorized by AMETEK;
is installed or operated contrary to the instructions of AMETEK; is opened, modified or disassembled in any way without AMETEK’s consent; or is used in combination with items, articles or materials not authorized by AMETEK.
The Buyer may not assert any claim that the Products are not in conformity with any warranty until the Buyer has made all payments to AMETEK provided for in the Purchase Order Agreement.
PRODUCT RETURN PROCEDURE
1. Request a Return Material Authorization (RMA) number from the repair facility (must be
done in the country in which it was purchased):
In the USA, contact the AMETEK Repair Department prior to the return of the
product to AMETEK for repair: Telephone: 800-733-5427, ext. 2295 or ext. 2463 (toll free North America)
858-450-0085, ext. 2295 or ext. 2463 (direct)
Outside the United States, contact the nearest Authorized Service Center
(ASC). A full listing can be found either through your local distributor or our website, www.programmablepower.com, by clicking Support and going to the Service Centers tab.
2. When requesting an RMA, have the following information ready:
Model number Serial number Description of the problem
NOTE: Unauthorized returns will not be accepted and will be returned at the shipper’s expense.
NOTE: A returned product found upon inspection by AMETEK, to be in specification is subject to
an evaluation fee and applicable freight charges.
iv
IVI Driver Manual Lx / Ls Series
5
Table of Contents
Introduction: .................................................................................................................................................... 7
Assumptions: .............................................................................................................................................. 7
Error and Status Information: .................................................................................................................... 7
How To Use This Document: ..................................................................................................................... 8
Function Tree Layout: ..................................................................................................................................... 8
ciLxs_Abort .................................................................................................................................................... 12
ciLxs_CheckAttributeViBoolean .................................................................................................................. 14
ciLxs_CheckAttributeViInt32 ....................................................................................................................... 17
ciLxs_CheckAttributeViReal64 .................................................................................................................... 20
ciLxs_CheckAttributeViSession .................................................................................................................. 23
ciLxs_CheckAttributeViString ..................................................................................................................... 26
ciLxs_ClearAllArbWaveforms ...................................................................................................................... 29
ciLxs_ClearArbWaveforms........................................................................................................................... 31
ciLxs_ClearError ........................................................................................................................................... 33
ciLxs_ClearInterchangeWarnings ............................................................................................................... 35
ciLxs_close .................................................................................................................................................... 37
ciLxs_ConfigureAcqTriggerSource ............................................................................................................. 39
ciLxs_ConfigureAcquisitionStartTime ........................................................................................................ 41
ciLxs_ConfigureClippingLevel .................................................................................................................... 43
ciLxs_ConfigureCurrentLimit ...................................................................................................................... 45
ciLxs_ConfigureFrequencyValue ................................................................................................................ 48
ciLxs_ConfigureOutput ................................................................................................................................ 50
ciLxs_ConfigureOutputALCState ................................................................................................................ 52
ciLxs_ConfigureOutputEnabled .................................................................................................................. 54
ciLxs_ConfigureOutputPhaseMode ............................................................................................................ 56
ciLxs_ConfigureOutputRange ..................................................................................................................... 58
ciLxs_ConfigureOVP ..................................................................................................................................... 60
ciLxs_ConfigurePhaseAngle ....................................................................................................................... 63
ciLxs_ConfigurePulse ................................................................................................................................... 66
ciLxs_ConfigureSlewFrequency .................................................................................................................. 68
ciLxs_ConfigureSlewVoltageLevel .............................................................................................................. 70
ciLxs_ConfigureSynchronizationPhase ..................................................................................................... 72
ciLxs_ConfigureSynchronizationSource .................................................................................................... 74
ciLxs_ConfigureTriggerAngleList ............................................................................................................... 76
ciLxs_ConfigureTriggerDelay ...................................................................................................................... 78
ciLxs_ConfigureTriggeredAngle ................................................................................................................. 80
ciLxs_ConfigureTriggeredAngleMode ........................................................................................................ 82
ciLxs_ConfigureTriggeredFrequency ......................................................................................................... 84
ciLxs_ConfigureTriggeredFrequencyMode ................................................................................................ 86
ciLxs_ConfigureTriggeredFunction ............................................................................................................ 88
ciLxs_ConfigureTriggeredFunctionMode ................................................................................................... 90
ciLxs_ConfigureTriggeredSlewFrequency ................................................................................................. 92
ciLxs_ConfigureTriggeredSlewVoltage ...................................................................................................... 94
ciLxs_ConfigureTriggeredVoltageLevel ..................................................................................................... 96
ciLxs_ConfigureTriggeredVoltageMode ..................................................................................................... 99
ciLxs_ConfigureTriggerFrequencyList ..................................................................................................... 102
ciLxs_ConfigureTriggerFunctionList ........................................................................................................ 104
ciLxs_ConfigureTriggerList ....................................................................................................................... 106
ciLxs_ConfigureTriggerSource ................................................................................................................. 109
ciLxs_ConfigureTriggerTTLOutputList ..................................................................................................... 111
ciLxs_ConfigureTriggerVoltageList .......................................................................................................... 113
ciLxs_ConfigureTrigSlewFrequencyList .................................................................................................. 116
ciLxs_ConfigureTrigSlewFrequencyMode ............................................................................................... 118
IVI Driver Manual Lx / Ls Series
6
ciLxs_ConfigureTrigSlewVoltageList ........................................................................................................ 120
ciLxs_ConfigureTrigSlewVoltageMode ..................................................................................................... 123
ciLxs_ConfigureTTLTriggerOutput ........................................................................................................... 126
ciLxs_ConfigureVoltageLevel .................................................................................................................... 128
ciLxs_ConfigureWaveform ......................................................................................................................... 131
ciLxs_Disable .............................................................................................................................................. 133
ciLxs_error_message ................................................................................................................................. 135
ciLxs_error_query ....................................................................................................................................... 141
ciLxs_Fetch .................................................................................................................................................. 143
ciLxs_FetchArray ........................................................................................................................................ 146
ciLxs_FetchHarmonic ................................................................................................................................. 149
ciLxs_GetAttributeViBoolean .................................................................................................................... 152
ciLxs_GetAttributeViInt32 .......................................................................................................................... 155
ciLxs_GetAttributeViReal64 ....................................................................................................................... 158
ciLxs_GetAttributeViSession ..................................................................................................................... 161
ciLxs_GetAttributeViString ........................................................................................................................ 164
ciLxs_GetError ............................................................................................................................................ 168
ciLxs_GetNextCoercionRecord ................................................................................................................. 171
ciLxs_GetNextInterchangeWarning .......................................................................................................... 174
ciLxs_GetPhaseName ................................................................................................................................. 177
ciLxs_init ...................................................................................................................................................... 180
ciLxs_InitiateAcquisition ............................................................................................................................ 184
ciLxs_InitiateTransient ............................................................................................................................... 186
ciLxs_InitWithOptions ................................................................................................................................ 188
ciLxs_InvalidateAllAttributes ..................................................................................................................... 193
ciLxs_LockSession ..................................................................................................................................... 195
ciLxs_Measure ............................................................................................................................................. 198
ciLxs_MeasureArray ................................................................................................................................... 201
ciLxs_MeasureHarmonic ............................................................................................................................ 204
ciLxs_QueryArbWaveformCapabilities ..................................................................................................... 207
ciLxs_QueryDefinedWaveforms ................................................................................................................ 210
ciLxs_QueryMaxCurrentLimit .................................................................................................................... 212
ciLxs_QueryMaxVoltageLevel ................................................................................................................... 214
ciLxs_QueryOutputState ............................................................................................................................ 216
ciLxs_QueryTrnsListStatus ....................................................................................................................... 219
ciLxs_ReadInstrData ................................................................................................................................... 221
ciLxs_reset ................................................................................................................................................... 223
ciLxs_ResetInterchangeCheck .................................................................................................................. 225
ciLxs_ResetOutputProtection .................................................................................................................... 227
ciLxs_ResetWithDefaults ........................................................................................................................... 229
ciLxs_revision_query .................................................................................................................................. 231
ciLxs_self_test ............................................................................................................................................. 233
ciLxs_SendSoftwareTrigger ....................................................................................................................... 235
ciLxs_SetAttributeViBoolean ..................................................................................................................... 237
ciLxs_SetAttributeViInt32 ........................................................................................................................... 241
ciLxs_SetAttributeViReal64 ....................................................................................................................... 245
ciLxs_SetAttributeViSession ..................................................................................................................... 249
ciLxs_SetAttributeViString ......................................................................................................................... 253
ciLxs_StoreRecallRegister ......................................................................................................................... 257
ciLxs_UnlockSession ................................................................................................................................. 259
ciLxs_WriteArbWaveform........................................................................................................................... 262
ciLxs_WriteInstrData ................................................................................................................................... 264
IVI Driver Manual Lx / Ls Series
7
California Instruments Lx/Ls Series AC Source
________________________________________________________________________________
Introduction:
This instrument driver provides programming support for California Instr Lx/Ls
Series AC Source. It contains functions for opening, configuring, taking measurements from, and closing the instrument.
________________________________________________________________________________
Assumptions:
To successfully use this module, the following conditions must be met:
For GPIB instrument drivers:
- the instrument is connected to the GPIB.
- the GPIB address supplied to the initialize function must match the GPIB address of the instrument.
For VXI instrument drivers:
- the instrument is installed in the VXI mainframe and you are using one of the following controller options: Embedded controller MXI MXI2 GPIB-VXI
- the logical address supplied to the initialize function must match the logical address of the instrument.
For RS-232 instrument drivers:
- the instrument is connected to the RS-232 interface.
- the COM port, baud rate, parity, and timeout supplied to the initialize function must match the settings of the instrument.
________________________________________________________________________________
Error and Status Information:
Each function in this instrument driver returns a status code that either indicates success or describes an error or warning condition. Your program should examine the status code from each call to an instrument driver function to determine if an error occurred. The general meaning of the status code is as follows:
Value Meaning
------------------------------­ 0 Success Positive Values Warnings Negative Values Errors
The description of each instrument driver function lists possible error codes and their meanings
IVI Driver Manual Lx / Ls Series
8
________________________________________________________________________________
How To Use This Document:
Use this document as a programming reference manual. It describes each function in the
California Instr Lx/Ls Series AC Source
instrument. The functions appear in alphabetical order, with a description of the function and its C syntax, a description of each parameter, and a list of possible error codes.
________________________________________________________________________________
Function Tree Layout:
Class/Panel Name: Function Name:
Initialize ciLxs_init Initialize With Options ciLxs_InitWithOptions Configuration Output Configure Output ciLxs_ConfigureOutput Configure Output Enabled ciLxs_ConfigureOutputEnabled Configure Output ALC State ciLxs_ConfigureOutputALCState Configure Output Range ciLxs_ConfigureOutputRange Configure Current Limit ciLxs_ConfigureCurrentLimit Configure OVP ciLxs_ConfigureOVP Configure Voltage Level ciLxs_ConfigureVoltageLevel Configure Frequency Value ciLxs_ConfigureFrequencyValue Configure Output Phase Mode ciLxs_ConfigureOutputPhaseMode Configure Phase Angle ciLxs_ConfigurePhaseAngle Configure Waveform ciLxs_ConfigureWaveform Configure Clipping Level ciLxs_ConfigureClippingLevel Configure Slew Voltage Level ciLxs_ConfigureSlewVoltageLevel Configure Slew Frequency ciLxs_ConfigureSlewFrequency Get Phase Name ciLxs_GetPhaseName Arbitrary Waveform Write Arb Waveform ciLxs_WriteArbWaveform Query Arb Waveform Capabilities ciLxs_QueryArbWaveformCapabilities Clear All Arb Waveforms ciLxs_ClearAllArbWaveforms Clear Arb Waveforms ciLxs_ClearArbWaveforms Query Defined Waveforms ciLxs_QueryDefinedWaveforms Acquisition Configure Acq Trigger Source ciLxs_ConfigureAcqTriggerSource Configure Acq Start Time ciLxs_ConfigureAcquisitionStartTime Triggering Configure Trigger Source ciLxs_ConfigureTriggerSource Configure Trigger Delay ciLxs_ConfigureTriggerDelay
IVI Driver Manual Lx / Ls Series
9
Configure TTL Trigger Output ciLxs_ConfigureTTLTriggerOutput Configure Triggered Volt ciLxs_ConfigureTriggeredVoltageLevel Configure Triggered Freq ciLxs_ConfigureTriggeredFrequency Configure Triggered Func ciLxs_ConfigureTriggeredFunction Configure Triggered Angle ciLxs_ConfigureTriggeredAngle Configure Triggered Slew Volt ciLxs_ConfigureTriggeredSlewVoltage Configure Triggered Slew Freq ciLxs_ConfigureTriggeredSlewFrequency Mode Configure Triggered Volt Mode ciLxs_ConfigureTriggeredVoltageMode Configure Triggered Freq Mode ciLxs_ConfigureTriggeredFrequencyMode Configure Triggered Func Mode ciLxs_ConfigureTriggeredFunctionMode Configure Triggered Angle Mode ciLxs_ConfigureTriggeredAngleMode Configure Trig Slew Volt Mode ciLxs_ConfigureTrigSlewVoltageMode Configure Trig Slew Freq Mode ciLxs_ConfigureTrigSlewFrequencyMode Pulse Trigger Configure Pulse ciLxs_ConfigurePulse List Trigger Configure Trigger List ciLxs_ConfigureTriggerList Configure Trigger Volt List ciLxs_ConfigureTriggerVoltageList Configure Trigger Freq List ciLxs_ConfigureTriggerFrequencyList Configure Trigger Func List ciLxs_ConfigureTriggerFunctionList Configure Trigger Angle List ciLxs_ConfigureTriggerAngleList Configure Trig Slew Volt List ciLxs_ConfigureTrigSlewVoltageList Configure Trig Slew Freq List ciLxs_ConfigureTrigSlewFrequencyList Configure Trig TTL Output List ciLxs_ConfigureTriggerTTLOutputList Synchronization Configure Synch Source ciLxs_ConfigureSynchronizationSource Configure Synch Phase ciLxs_ConfigureSynchronizationPhase Set/Get/Check Attribute Set Attribute Set Attribute ViInt32 ciLxs_SetAttributeViInt32 Set Attribute ViReal64 ciLxs_SetAttributeViReal64 Set Attribute ViString ciLxs_SetAttributeViString Set Attribute ViBoolean ciLxs_SetAttributeViBoolean Set Attribute ViSession ciLxs_SetAttributeViSession Get Attribute
IVI Driver Manual Lx / Ls Series
10
Get Attribute ViInt32 ciLxs_GetAttributeViInt32 Get Attribute ViReal64 ciLxs_GetAttributeViReal64 Get Attribute ViString ciLxs_GetAttributeViString Get Attribute ViBoolean ciLxs_GetAttributeViBoolean Get Attribute ViSession ciLxs_GetAttributeViSession Check Attribute Check Attribute ViInt32 ciLxs_CheckAttributeViInt32 Check Attribute ViReal64 ciLxs_CheckAttributeViReal64 Check Attribute ViString ciLxs_CheckAttributeViString Check Attribute ViBoolean ciLxs_CheckAttributeViBoolean Check Attribute ViSession ciLxs_CheckAttributeViSession Action/Status Send Software Trigger ciLxs_SendSoftwareTrigger Query Max Current Limit ciLxs_QueryMaxCurrentLimit Query Max Voltage Level ciLxs_QueryMaxVoltageLevel Query Transient List Status ciLxs_QueryTrnsListStatus Query Output State ciLxs_QueryOutputState Reset Output Protection ciLxs_ResetOutputProtection Store Recall Register ciLxs_StoreRecallRegister Measure Measure ciLxs_Measure Fetch ciLxs_Fetch Harmonic Meaurement Measure Harmonic ciLxs_MeasureHarmonic
Fetch Harmonic ciLxs_FetchHarmonic Array Measurement Measure Array ciLxs_MeasureArray Fetch Array ciLxs_FetchArray Low-Level Initiate Transient ciLxs_InitiateTransient Initiate Acquisition ciLxs_InitiateAcquisition Abort ciLxs_Abort Utility Self-Test ciLxs_self_test Reset ciLxs_reset Reset With Defaults ciLxs_ResetWithDefaults Disable ciLxs_Disable Revision Query ciLxs_revision_query Error-Query ciLxs_error_query Error Message ciLxs_error_message Invalidate All Attributes ciLxs_InvalidateAllAttributes Error Get Error ciLxs_GetError Clear Error ciLxs_ClearError Coercion Info Get Next Coercion Record ciLxs_GetNextCoercionRecord Interchangeability Info Get Next Interchange Warning ciLxs_GetNextInterchangeWarning Clear Interchange Warnings ciLxs_ClearInterchangeWarnings Reset Interchange Check ciLxs_ResetInterchangeCheck Locking Lock Session ciLxs_LockSession Unlock Session ciLxs_UnlockSession Instrument I/O Write Instrument Data ciLxs_WriteInstrData
IVI Driver Manual Lx / Ls Series
11
Read Instrument Data ciLxs_ReadInstrData Close ciLxs_close ________________________________________________________________________________
California Instr Lx/Ls Series AC Source
This instrument driver provides programming support for the Californai Instrument iL series of AC Power Supplies. The driver contains all the functions that IVI and VXIplug&play require. In addition, the driver contains high-level functions that configure the power supply and generate output in a single operation. The driver also contains lower level functions that configure the power supply and initiate the output changes in separate operations.
Note: This driver requires the VISA and IVI libraries. ________________________________________________________________________________
The following functions are in alphabetical order.
________________________________________________________________________________
IVI Driver Manual Lx / Ls Series
12
ciLxs_Abort
ViStatus ciLxs_Abort (ViSession instrumentHandle);
Purpose
This function aborts all pending output changes.
Parameter List
instrumentHandle
Variable Type ViSession
The ViSession handle that you obtain from the ciLxs_init or ciLxs_InitWithOptions function. The handle identifies a particular instrument session.
Default Value: None
Return Value
Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. You examine the status code from each call to an instrument driver function to determine if an error occurred.
To obtain a text description of the status code, call the ciLxs_error_message function. To obtain additional information about the error condition, call the ciLxs_GetError function. To clear the error information from the driver, call the ciLxs_ClearError function.
The general meaning of the status code is as follows:
Value Meaning
------------------------------­ 0 Success Positive Values Warnings Negative Values Errors
This driver defines the following status codes:
Status Description
------------------------------------------------­ ERRORS: BFFA1001 The trigger source is not software trigger.
This instrument driver also returns errors and warnings defined by other sources. The following table defines the ranges of additional status codes that this driver can return. The table lists the different include files that contain the defined constants for the particular status codes:
IVI Driver Manual Lx / Ls Series
13
Numeric Range (in Hex) Status Code Types
------------------------------------------------­ 3FFA0000 to 3FFA1FFF IVI Warnings 3FFF0000 to 3FFFFFFF VISA Warnings 3FFC0000 to 3FFCFFFF VXIPnP Driver Warnings
BFFA0000 to BFFA1FFF IVI Errors BFFF0000 to BFFFFFFF VISA Errors BFFC0000 to BFFCFFFF VXIPnP Driver Errors
________________________________________________________________________________
IVI Driver Manual Lx / Ls Series
14
ciLxs_CheckAttributeViBoolean
ViStatus ciLxs_CheckAttributeViBoolean (ViSession instrumentHandle, ViChar _VI_FAR channelName[], ViAttr attributeID, ViBoolean attributeValue);
Purpose
This function checks the validity of a value you specify for a ViBoolean attribute.
Parameter List
instrumentHandle
Variable Type ViSession
The ViSession handle that you obtain from the ciLxs_init or ciLxs_InitWithOptions function. The handle identifies a particular instrument session.
Default Value: None
channelName
Variable Type ViChar[]
If the attribute is channel-based, this parameter specifies the name of the channel on which to check the attribute value. If the attribute is not channel-based, then you set this control to empty string or VI_NULL.
Pass the virtual channel name that you assign to the instrument in the Configuration Utility.
Virtual channel names are aliases for instrument-specific channel strings. The instrument-specific channel strings can differ from one instrument to another. Virtual channel names allow you to use and swap instruments without having to change the channel names in your source code. You assign a virtual channel name to an instrument-specific channel through the Configuration Utility. This control accepts virtual channel names you have assigned to the specific instrument you are using. It also accepts the instrument-specific channel names.
Default Value: ""
Notes:
(1) You can specify the channel name as a string variable or as a literal enclosed in double quotes.
attributeID
IVI Driver Manual Lx / Ls Series
15
Variable Type ViAttr
Pass the ID of an attribute.
From the function panel window, you can use this control as follows.
- Click on the control or press <ENTER>, <spacebar>, or <ctrl-down arrow>, to display a dialog box containing a hierarchical list of the available attributes. Attributes whose value cannot be set are dim. Help text is shown for each attribute. Select an attribute by double-clicking on it or by selecting it and then pressing <ENTER>.
Read-only attributes appear dim in the list box. If you select a read-only attribute, an error message appears.
A ring control at the top of the dialog box allows you to see all IVI attributes or only the attributes of the ViBoolean type. If you choose to see all IVI attributes, the data types appear to the right of the attribute names in the list box. Attributes with data types other than ViBoolean are dim. If you select an attribute data type that is dim, LabWindows/CVI transfers you to the function panel for the corresponding function that is consistent with the data type.
- If you want to enter a variable name, press <CTRL-T> to change this ring control to a manual input box.
- If the attribute in this ring control has named constants as valid values, you can view the constants by moving to the Attribute Value control and pressing <ENTER>.
attributeValue
Variable Type ViBoolean
Pass the value which you want to verify as a valid value for the attribute.
From the function panel window, you can use this control as follows.
- If the attribute currently showing in the Attribute ID ring control has constants as valid values, you can view a list of the constants by pressing <ENTER> on this control. Select a value by double-clicking on it or by selecting it and then pressing <ENTER>.
Note: Some of the values might not be valid depending on the current settings of the instrument session.
Default Value: none
Return Value
Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. You
IVI Driver Manual Lx / Ls Series
16
examine the status code from each call to an instrument driver function to determine if an error occurred.
To obtain a text description of the status code, call the ciLxs_error_message function. To obtain additional information about the error condition, call the ciLxs_GetError function. To clear the error information from the driver, call the ciLxs_ClearError function.
The general meaning of the status code is as follows:
Value Meaning
------------------------------­ 0 Success Positive Values Warnings Negative Values Errors
This driver defines the following status codes:
Status Description
------------------------------------------------­ ERRORS: BFFA1001 The trigger source is not software trigger.
This instrument driver also returns errors and warnings defined by other sources. The following table defines the ranges of additional status codes that this driver can return. The table lists the different include files that contain the defined constants for the particular status codes:
Numeric Range (in Hex) Status Code Types
------------------------------------------------­ 3FFA0000 to 3FFA1FFF IVI Warnings 3FFF0000 to 3FFFFFFF VISA Warnings 3FFC0000 to 3FFCFFFF VXIPnP Driver Warnings
BFFA0000 to BFFA1FFF IVI Errors BFFF0000 to BFFFFFFF VISA Errors BFFC0000 to BFFCFFFF VXIPnP Driver Errors
________________________________________________________________________________
IVI Driver Manual Lx / Ls Series
17
ciLxs_CheckAttributeViInt32
ViStatus ciLxs_CheckAttributeViInt32 (ViSession instrumentHandle, ViChar _VI_FAR channelName[], ViAttr attributeID, ViInt32 attributeValue);
Purpose
This function checks the validity of a value you specify for a ViInt32 attribute.
Parameter List
instrumentHandle
Variable Type ViSession
The ViSession handle that you obtain from the ciLxs_init or ciLxs_InitWithOptions function. The handle identifies a particular instrument session.
Default Value: None
channelName
Variable Type ViChar[]
If the attribute is channel-based, this parameter specifies the name of the channel on which to check the attribute value. If the attribute is not channel-based, then you set this control to empty string or VI_NULL.
Pass the virtual channel name that you assign to the instrument in the Configuration Utility.
Virtual channel names are aliases for instrument-specific channel strings. The instrument-specific channel strings can differ from one instrument to another. Virtual channel names allow you to use and swap instruments without having to change the channel names in your source code. You assign a virtual channel name to an instrument-specific channel through the Configuration Utility. This control accepts virtual channel names you have assigned to the specific instrument you are using. It also accepts the instrument-specific channel names.
Default Value: ""
Notes:
(1) You can specify the channel name as a string variable or as a literal enclosed in double quotes.
attributeID
IVI Driver Manual Lx / Ls Series
18
Variable Type ViAttr
Pass the ID of an attribute.
From the function panel window, you can use this control as follows.
- Click on the control or press <ENTER>, <spacebar>, or <ctrl-down arrow>, to display a dialog box containing a hierarchical list of the available attributes. Attributes whose value cannot be set are dim. Help text is shown for each attribute. Select an attribute by double-clicking on it or by selecting it and then pressing <ENTER>.
Read-only attributes appear dim in the list box. If you select a read-only attribute, an error message appears.
A ring control at the top of the dialog box allows you to see all IVI attributes or only the attributes of the ViInt32 type. If you choose to see all IVI attributes, the data types appear to the right of the attribute names in the list box. Attributes with data types other than ViInt32 are dim. If you select an attribute data type that is dim, LabWindows/CVI transfers you to the function panel for the corresponding function that is consistent with the data type.
- If you want to enter a variable name, press <CTRL-T> to change this ring control to a manual input box.
- If the attribute in this ring control has named constants as valid values, you can view the constants by moving to the Attribute Value control and pressing <ENTER>.
attributeValue
Variable Type ViInt32
Pass the value which you want to verify as a valid value for the attribute.
From the function panel window, you can use this control as follows.
- If the attribute currently showing in the Attribute ID ring control has constants as valid values, you can view a list of the constants by pressing <ENTER> on this control. Select a value by double-clicking on it or by selecting it and then pressing <ENTER>.
Note: Some of the values might not be valid depending on the current settings of the instrument session.
Default Value: none
Return Value
Returns the status code of this operation. The status code either
IVI Driver Manual Lx / Ls Series
19
indicates success or describes an error or warning condition. You examine the status code from each call to an instrument driver function to determine if an error occurred.
To obtain a text description of the status code, call the ciLxs_error_message function. To obtain additional information about the error condition, call the ciLxs_GetError function. To clear the error information from the driver, call the ciLxs_ClearError function.
The general meaning of the status code is as follows:
Value Meaning
------------------------------­ 0 Success Positive Values Warnings Negative Values Errors
This driver defines the following status codes:
Status Description
------------------------------------------------­ ERRORS: BFFA1001 The trigger source is not software trigger.
This instrument driver also returns errors and warnings defined by other sources. The following table defines the ranges of additional status codes that this driver can return. The table lists the different include files that contain the defined constants for the particular status codes:
Numeric Range (in Hex) Status Code Types
------------------------------------------------­ 3FFA0000 to 3FFA1FFF IVI Warnings 3FFF0000 to 3FFFFFFF VISA Warnings 3FFC0000 to 3FFCFFFF VXIPnP Driver Warnings
BFFA0000 to BFFA1FFF IVI Errors BFFF0000 to BFFFFFFF VISA Errors BFFC0000 to BFFCFFFF VXIPnP Driver Errors
________________________________________________________________________________
IVI Driver Manual Lx / Ls Series
20
ciLxs_CheckAttributeViReal64
ViStatus ciLxs_CheckAttributeViReal64 (ViSession instrumentHandle, ViChar _VI_FAR channelName[], ViAttr attributeID, ViReal64 attributeValue);
Purpose
This function checks the validity of a value you specify for a ViReal64 attribute.
Parameter List
instrumentHandle
Variable Type ViSession
The ViSession handle that you obtain from the ciLxs_init or ciLxs_InitWithOptions function. The handle identifies a particular instrument session.
Default Value: None
channelName
Variable Type ViChar[]
If the attribute is channel-based, this parameter specifies the name of the channel on which to check the attribute value. If the attribute is not channel-based, then you set this control to empty string or VI_NULL.
Pass the virtual channel name that you assign to the instrument in the Configuration Utility.
Virtual channel names are aliases for instrument-specific channel strings. The instrument-specific channel strings can differ from one instrument to another. Virtual channel names allow you to use and swap instruments without having to change the channel names in your source code. You assign a virtual channel name to an instrument-specific channel through the Configuration Utility. This control accepts virtual channel names you have assigned to the specific instrument you are using. It also accepts the instrument-specific channel names.
Default Value: ""
Notes:
(1) You can specify the channel name as a string variable or as a literal enclosed in double quotes.
attributeID
IVI Driver Manual Lx / Ls Series
21
Variable Type ViAttr
Pass the ID of an attribute.
From the function panel window, you can use this control as follows.
- Click on the control or press <ENTER>, <spacebar>, or <ctrl-down arrow>, to display a dialog box containing a hierarchical list of the available attributes. Attributes whose value cannot be set are dim. Help text is shown for each attribute. Select an attribute by double-clicking on it or by selecting it and then pressing <ENTER>.
Read-only attributes appear dim in the list box. If you select a read-only attribute, an error message appears.
A ring control at the top of the dialog box allows you to see all IVI attributes or only the attributes of the ViReal64 type. If you choose to see all IVI attributes, the data types appear to the right of the attribute names in the list box. Attributes with data types other than ViReal64 are dim. If you select an attribute data type that is dim, LabWindows/CVI transfers you to the function panel for the corresponding function that is consistent with the data type.
- If you want to enter a variable name, press <CTRL-T> to change this ring control to a manual input box.
- If the attribute in this ring control has named constants as valid values, you can view the constants by moving to the Attribute Value control and pressing <ENTER>.
attributeValue
Variable Type ViReal64
Pass the value which you want to verify as a valid value for the attribute.
From the function panel window, you can use this control as follows.
- If the attribute currently showing in the Attribute ID ring control has constants as valid values, you can view a list of the constants by pressing <ENTER> on this control. Select a value by double-clicking on it or by selecting it and then pressing <ENTER>.
Note: Some of the values might not be valid depending on the current settings of the instrument session.
Default Value: none
Return Value
Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. You
IVI Driver Manual Lx / Ls Series
22
examine the status code from each call to an instrument driver function to determine if an error occurred.
To obtain a text description of the status code, call the ciLxs_error_message function. To obtain additional information about the error condition, call the ciLxs_GetError function. To clear the error information from the driver, call the ciLxs_ClearError function.
The general meaning of the status code is as follows:
Value Meaning
------------------------------­ 0 Success Positive Values Warnings Negative Values Errors
This driver defines the following status codes:
Status Description
------------------------------------------------­ ERRORS: BFFA1001 The trigger source is not software trigger.
This instrument driver also returns errors and warnings defined by other sources. The following table defines the ranges of additional status codes that this driver can return. The table lists the different include files that contain the defined constants for the particular status codes:
Numeric Range (in Hex) Status Code Types
------------------------------------------------­ 3FFA0000 to 3FFA1FFF IVI Warnings 3FFF0000 to 3FFFFFFF VISA Warnings 3FFC0000 to 3FFCFFFF VXIPnP Driver Warnings
BFFA0000 to BFFA1FFF IVI Errors BFFF0000 to BFFFFFFF VISA Errors BFFC0000 to BFFCFFFF VXIPnP Driver Errors
________________________________________________________________________________
IVI Driver Manual Lx / Ls Series
23
ciLxs_CheckAttributeViSession
ViStatus ciLxs_CheckAttributeViSession (ViSession instrumentHandle, ViChar _VI_FAR channelName[], ViAttr attributeID, ViSession attributeValue);
Purpose
This function checks the validity of a value you specify for a ViSession attribute.
Parameter List
instrumentHandle
Variable Type ViSession
The ViSession handle that you obtain from the ciLxs_init or ciLxs_InitWithOptions function. The handle identifies a particular instrument session.
Default Value: None
channelName
Variable Type ViChar[]
If the attribute is channel-based, this parameter specifies the name of the channel on which to check the attribute value. If the attribute is not channel-based, then you set this control to empty string or VI_NULL.
Pass the virtual channel name that you assign to the instrument in the Configuration Utility.
Virtual channel names are aliases for instrument-specific channel strings. The instrument-specific channel strings can differ from one instrument to another. Virtual channel names allow you to use and swap instruments without having to change the channel names in your source code. You assign a virtual channel name to an instrument-specific channel through the Configuration Utility. This control accepts virtual channel names you have assigned to the specific instrument you are using. It also accepts the instrument-specific channel names.
Default Value: ""
Notes:
(1) You can specify the channel name as a string variable or as a literal enclosed in double quotes.
attributeID
IVI Driver Manual Lx / Ls Series
24
Variable Type ViAttr
Pass the ID of an attribute.
From the function panel window, you can use this control as follows.
- Click on the control or press <ENTER>, <spacebar>, or <ctrl-down arrow>, to display a dialog box containing a hierarchical list of the available attributes. Attributes whose value cannot be set are dim. Help text is shown for each attribute. Select an attribute by double-clicking on it or by selecting it and then pressing <ENTER>.
Read-only attributes appear dim in the list box. If you select a read-only attribute, an error message appears.
A ring control at the top of the dialog box allows you to see all IVI attributes or only the attributes of the ViSession type. If you choose to see all IVI attributes, the data types appear to the right of the attribute names in the list box. Attributes with data types other than ViSession are dim. If you select an attribute data type that is dim, LabWindows/CVI transfers you to the function panel for the corresponding function that is consistent with the data type.
- If you want to enter a variable name, press <CTRL-T> to change this ring control to a manual input box.
- If the attribute in this ring control has named constants as valid values, you can view the constants by moving to the Attribute Value control and pressing <ENTER>.
attributeValue
Variable Type ViSession
Pass the value which you want to verify as a valid value for the attribute.
From the function panel window, you can use this control as follows.
- If the attribute currently showing in the Attribute ID ring control has constants as valid values, you can view a list of the constants by pressing <ENTER> on this control. Select a value by double-clicking on it or by selecting it and then pressing <ENTER>.
Note: Some of the values might not be valid depending on the current settings of the instrument session.
Default Value: none
Return Value
Returns the status code of this operation. The status code either
IVI Driver Manual Lx / Ls Series
25
indicates success or describes an error or warning condition. You examine the status code from each call to an instrument driver function to determine if an error occurred.
To obtain a text description of the status code, call the ciLxs_error_message function. To obtain additional information about the error condition, call the ciLxs_GetError function. To clear the error information from the driver, call the ciLxs_ClearError function.
The general meaning of the status code is as follows:
Value Meaning
------------------------------­ 0 Success Positive Values Warnings Negative Values Errors
This driver defines the following status codes:
Status Description
------------------------------------------------­ ERRORS: BFFA1001 The trigger source is not software trigger.
This instrument driver also returns errors and warnings defined by other sources. The following table defines the ranges of additional status codes that this driver can return. The table lists the different include files that contain the defined constants for the particular status codes:
Numeric Range (in Hex) Status Code Types
------------------------------------------------­ 3FFA0000 to 3FFA1FFF IVI Warnings 3FFF0000 to 3FFFFFFF VISA Warnings 3FFC0000 to 3FFCFFFF VXIPnP Driver Warnings
BFFA0000 to BFFA1FFF IVI Errors BFFF0000 to BFFFFFFF VISA Errors BFFC0000 to BFFCFFFF VXIPnP Driver Errors
________________________________________________________________________________
IVI Driver Manual Lx / Ls Series
26
ciLxs_CheckAttributeViString
ViStatus ciLxs_CheckAttributeViString (ViSession instrumentHandle, ViChar _VI_FAR channelName[], ViAttr attributeID, ViChar _VI_FAR attributeValue[]);
Purpose
This function checks the validity of a value you specify for a ViString attribute.
Parameter List
instrumentHandle
Variable Type ViSession
The ViSession handle that you obtain from the ciLxs_init or ciLxs_InitWithOptions function. The handle identifies a particular instrument session.
Default Value: None
channelName
Variable Type ViChar[]
If the attribute is channel-based, this parameter specifies the name of the channel on which to check the attribute value. If the attribute is not channel-based, then you set this control to empty string or VI_NULL.
Pass the virtual channel name that you assign to the instrument in the Configuration Utility.
Virtual channel names are aliases for instrument-specific channel strings. The instrument-specific channel strings can differ from one instrument to another. Virtual channel names allow you to use and swap instruments without having to change the channel names in your source code. You assign a virtual channel name to an instrument-specific channel through the Configuration Utility. This control accepts virtual channel names you have assigned to the specific instrument you are using. It also accepts the instrument-specific channel names.
Default Value: ""
Notes:
(1) You can specify the channel name as a string variable or as a literal enclosed in double quotes.
attributeID
Loading...
+ 245 hidden pages
Buy Points How it Works FAQ Contact Us Questions and Suggestions Privacy Policy Cookie Policy Terms of Use