Public Member Functions

cedrus::stim_tracker_t Class Reference

#include <stim_tracker_t.h>

Inheritance diagram for cedrus::stim_tracker_t:
cedrus::base_device_t

List of all members.

Public Member Functions

 stim_tracker_t (boost::shared_ptr< xid_con_t > xid_con, const std::wstring &devconfig_path=L"")
 stim_tracker_t constructor
virtual ~stim_tracker_t (void)
void raise_lines (unsigned int lines_bitmask, bool leave_remaining_lines=false)
 Raise digital output lines on the StimTracker device.
void clear_lines (unsigned int lines_bitmask, bool leave_remaining_lines=false)
 Clear digital output lines on the StimTracker device.
void set_pulse_duration (unsigned int duration)
 Set the pulse duration when raise_lines() is called.

Detailed Description

Definition at line 40 of file stim_tracker_t.h.


Constructor & Destructor Documentation

cedrus::stim_tracker_t::stim_tracker_t ( boost::shared_ptr< xid_con_t xid_con,
const std::wstring &  devconfig_path = L"" 
)

stim_tracker_t constructor

Parameters:
[in]xid_conxid_con_t object to use
[in]devconfig_pathpath to devconfig files. Defaults to an empty string. If no path is used, very conservative default values are used and reults may not be what you expect. It's highly recommended to use the devconfig files.

Definition at line 4 of file stim_tracker_t.cpp.

cedrus::stim_tracker_t::~stim_tracker_t ( void   ) [virtual]

Definition at line 13 of file stim_tracker_t.cpp.


Member Function Documentation

void cedrus::stim_tracker_t::clear_lines ( unsigned int  lines_bitmask,
bool  leave_remaining_lines = false 
)

Clear digital output lines on the StimTracker device.

Parameters:
[in]lines_bitmaskThis is a bitmask used to specify the lines to be raised on the device. Each of the 8 bits in the integer specifies a line. If bits 0 and 7 are 1, lines 1 and 8 are raised.
[in]leave_remaining_linesboolean value of whether or not to keep the current line state when applying the new bitmask.

Definition at line 25 of file stim_tracker_t.cpp.

void cedrus::stim_tracker_t::raise_lines ( unsigned int  lines_bitmask,
bool  leave_remaining_lines = false 
)

Raise digital output lines on the StimTracker device.

Parameters:
[in]lines_bitmaskThis is a bitmask used to specify the lines to be raised on the device. Each of the 8 bits in the integer specifies a line. If bits 0 and 7 are 1, lines 1 and 8 are raised.
[in]leave_remaining_linesboolean value of whether or not to keep the current line state when applying the new bitmask.

Definition at line 17 of file stim_tracker_t.cpp.

void cedrus::stim_tracker_t::set_pulse_duration ( unsigned int  duration )

Set the pulse duration when raise_lines() is called.

This is how long the line will be active.

Parameters:
[in]durationLength of time in miliseconds

Definition at line 33 of file stim_tracker_t.cpp.


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