Signal Class

See the Signal Entity for generic information.

class SignalClass : public EntityClass

SignalClass is the interface to digital pins configured to produce square wave signals.

This class is designed to allow for square waves at various frequencies and duty cycles. Control is defined by specifying the wave period as (T3Time) and the active portion of the cycle as (T2Time). See the entity overview section of the reference for more detail regarding the timing.

Public Functions

SignalClass()

Constructors.

~SignalClass()

Destructor.

!SignalClass ()

Finalizer.

void init (BrainStem2CLI::ModuleClass^ module, const unsigned char index)

Initializes the class. Should only be called when manually creating classes.

Parameters:

• pModule – The module.

• index – The cmdSIGNAL index to be addressed.

aErr setEnable(const unsigned char enable)

Enable/Disable the signal output.

Parameters:

enable – True to enable, false to disable

Returns:

Returns common entity return values

aErr getEnable(unsigned char %enable)

Get the Enable/Disable of the signal.

Parameters:

enable – True to enable, false to disable

Returns:

Returns common entity return values

aErr setInvert(const unsigned char invert)

Invert the signal output.

Normal mode is High on t0 then low at t2. Inverted mode is Low at t0 on period start and high at t2.

Parameters:

invert – True to invert, false for normal mode.

Returns:

Returns common entity return values

aErr getInvert(unsigned char %invert)

Get the invert status the signal output.

Normal mode is High on t0 then low at t2. Inverted mode is Low at t0 on period start and high at t2.

Parameters:

invert – True to invert, false for normal mode.

Returns:

Returns common entity return values

aErr setT3Time(const int t3_nsec)

Set the signal period or T3 in nanoseconds.

Parameters:

t3_nsec – Integer not larger than unsigned 32 bit max value representing the wave period in nanoseconds.

Returns:

Returns common entity return values

aErr getT3Time(unsigned int %t3_nsec)

Get the signal period or T3 in nanoseconds.

Parameters:

t3_nsec – Integer not larger than unsigned 32 bit max value representing the wave period in nanoseconds.

Returns:

Returns common entity return values

aErr setT2Time(const int t2_nsec)

Set the signal active period or T2 in nanoseconds.

Parameters:

t2_nsec – Integer not larger than unsigned 32 bit max value representing the wave active period in nanoseconds.

Returns:

Returns common entity return values

aErr getT2Time(unsigned int %t2_nsec)

Get the signal active period or T2 in nanoseconds.

Parameters:

t2_nsec – Integer not larger than unsigned 32 bit max value representing the wave active period in nanoseconds.

Returns:

Returns common entity return values