MasterScan  Lab_Matlab_control Master Branch
List of all members | Properties and Events | Methods | Protected Methods
dotsWritable Class Reference

Overview

Superclass for objects that write data.

The dotsWritable superclass provides a uniform way to write data, such as TTL pulses.

Inheritance diagram for dotsWritable:
Inheritance graph
[legend]

Properties and Events

Property isAvailable = false
 

whether or not the object is ready to read() from


 
Property clockFunction
 

any function that returns the current time as a number


 

Methods

self dotsWritable ()
 

Constructor takes no arguments.


 
 initialize (self, varargin)
 

Locate, acquire, configure, etc. device and component resources.


 
time getDeviceTime (self)
 

Get the current time from clockFunction.


 
 close (self)
 

Release any resources acquired by initialize().


 
 delete (self)
 

Automatically close when Matlab is done with this object.


 

Protected Methods

 openDevice (self)
 

Locate and acquire input device resources (for subclasses).

More...
 
 closeDevice (self)
 

Release input device resources (for subclasses).

More...
 

Methods

◆ openDevice()

openDevice ( self  )
protected

Locate and acquire input device resources (for subclasses).

Subclasses must redefine openDevice(). They should expect openDevice() to be called during initialize() and when an object is constructed. openDevice() should locate, acquire, configure, etc. major device resources required for reading data. Specific resources relating to device components, like individual buttons of a gamepad, should be handled in openComponents().

openDevice() should return true if resources were successfully acquired and individual components are ready to be opened. Otherwise, openDevice() should return false.

◆ closeDevice()

closeDevice ( self  )
protected

Release input device resources (for subclasses).

Subclasses must redefine closedevice(). Any resources that were acquired by openDevice() should be released. It should be safe to call closeDevice() multiple times in a row.


The documentation for this class was generated from the following file: