Main Page   Namespace List   Class Hierarchy   Compound List   File List   Compound Members   File Members  

LibGPIB::GPIBEquipment Class Reference

The GPIBEquipment class provides basic routines to access GPIB equipment. Class for controlling GPIB equipment. More...

#include <GPIBEquipment.h>

Inheritance diagram for LibGPIB::GPIBEquipment:

LibGPIB::iostream LibGPIB::Agilent4279A LibGPIB::HP4156A LibGPIB::HP8110A List of all members.

Public Methods

void SetController (GPIBController *controller)
 Set the controller for this device. More...

void Clear ()
 Send a clear signal to the device.

int PrimAddress (const int addr)
 Set the primary address of the device.

int PrimAddress () const
 Get the primary address of the device.

int SecAddress (const int addr)
 Set the secondary address of the device.

int SecAddress () const
 Get the secondary address of the device.

int DeviceID () const
 Get the device ID of the device.

void SendCommand (const string command)
 Send the specified string to a given device.

const string ReadData (int read_bytes)
 Read data from the specified device.

void SetLocal ()
 Set the device in local mode.

 GPIBEquipment ()
 The default constructor.

virtual ~GPIBEquipment ()
 The default destructor.


Public Attributes

friend GPIBEquipmentBuffer

Protected Methods

GPIBController& Controller ()
 Returns a reference to the controller for this equipment.


Protected Attributes

int mDeviceID
 Device ID used by NI488 functions.


Private Attributes

int mAddress
 The primary GPIB address of this equipment.

int mSecAddress
 The secondary GPIB address of the equipment.

GPIBController* mController
 The GPIB controller to which this device is connected.

GPIBEquipmentBuffer* mBuffer
 The streambuf used to communicate with the GPIBEquipment.

Detailed Description

The GPIBEquipment class provides basic routines to access GPIB equipment. Class for controlling GPIB equipment.

One can use this as a base class to contruct classes to access specific GPIB instruments.

Author(s):
$Author: pagey $ Manish P. Pagey
Version:
$Id: GPIBEquipment.h,v 0.11 2000/08/04 09:48:04 pagey Exp $

Definition at line 220 of file GPIBEquipment.h.

Constructor & Destructor Documentation

LibGPIB::GPIBEquipment::GPIBEquipment ( )

The default constructor.

LibGPIB::GPIBEquipment::~GPIBEquipment ( ) [virtual]

The default destructor.

Member Function Documentation

void LibGPIB::GPIBEquipment::Clear ( )

Send a clear signal to the device.

GPIBController & LibGPIB::GPIBEquipment::Controller ( ) [protected]

Returns a reference to the controller for this equipment.

int LibGPIB::GPIBEquipment::DeviceID ( ) const [inline]

Get the device ID of the device.

Definition at line 372 of file GPIBEquipment.h.

int LibGPIB::GPIBEquipment::PrimAddress ( ) const [inline]

Get the primary address of the device.

Definition at line 360 of file GPIBEquipment.h.

int LibGPIB::GPIBEquipment::PrimAddress ( int addr ) [inline]

Set the primary address of the device.

Definition at line 356 of file GPIBEquipment.h.

const string LibGPIB::GPIBEquipment::ReadData ( int read_bytes )

Read data from the specified device.

int LibGPIB::GPIBEquipment::SecAddress ( ) const [inline]

Get the secondary address of the device.

Definition at line 368 of file GPIBEquipment.h.

int LibGPIB::GPIBEquipment::SecAddress ( int addr ) [inline]

Set the secondary address of the device.

Definition at line 364 of file GPIBEquipment.h.

void LibGPIB::GPIBEquipment::SendCommand ( string command )

Send the specified string to a given device.

void LibGPIB::GPIBEquipment::SetController ( GPIBController * controller )

Set the controller for this device.

If the equipment is already connected to another controller, it will be disconnected from that controller first. A NULL pointer can be passed to this routine to indicate that the equipment is not to be connected to any controller.

Parameters:
controller   The GPIB controller to which this device will be connected. If NULL, the device will be not connected to any controller.

void LibGPIB::GPIBEquipment::SetLocal ( )

Set the device in local mode.

Member Data Documentation

GPIBEquipmentBuffer

Definition at line 222 of file GPIBEquipment.h.

int LibGPIB::GPIBEquipment::mAddress [private]

The primary GPIB address of this equipment.

Definition at line 325 of file GPIBEquipment.h.

GPIBEquipmentBuffer * LibGPIB::GPIBEquipment::mBuffer [private]

The streambuf used to communicate with the GPIBEquipment.

Definition at line 340 of file GPIBEquipment.h.

GPIBController * LibGPIB::GPIBEquipment::mController [private]

The GPIB controller to which this device is connected.

Definition at line 335 of file GPIBEquipment.h.

int LibGPIB::GPIBEquipment::mDeviceID [protected]

Device ID used by NI488 functions.

Definition at line 345 of file GPIBEquipment.h.

int LibGPIB::GPIBEquipment::mSecAddress [private]

The secondary GPIB address of the equipment.

Definition at line 330 of file GPIBEquipment.h.

The documentation for this class was generated from the following file:
Generated at Tue Aug 8 01:37:56 2000 for libgpib by doxygen1.1.4 written by Dimitri van Heesch, © 1997-2000