Solenoid Class Reference

#include <Solenoid.h>

Inheritance diagram for Solenoid:

Collaboration diagram for Solenoid:

List of all members.

Public Member Functions
	Solenoid (UINT32 channel)
	Solenoid (UINT8 moduleNumber, UINT32 channel)
virtual	~Solenoid ()
virtual void	Set (bool on)
virtual bool	Get ()

---

Detailed Description

Solenoid class for running high voltage Digital Output (9472 module).

The Solenoid class is typically used for pneumatics solenoids, but could be used for any device within the current spec of the 9472 module.

Definition at line 18 of file Solenoid.h.

---

Constructor & Destructor Documentation

Solenoid::Solenoid

(

UINT32

channel

)

[explicit]

Constructor.

Parameters:

channel

The channel on the solenoid module to control (1..8).

Definition at line 43 of file Solenoid.cpp.

Solenoid::Solenoid	(	UINT8	moduleNumber,
		UINT32	channel
	)

Constructor.

Parameters:

	moduleNumber	The solenoid module (1 or 2).
	channel	The channel on the solenoid module to control (1..8).

Definition at line 56 of file Solenoid.cpp.

Solenoid::~Solenoid

(

)

[virtual]

Destructor.

Definition at line 66 of file Solenoid.cpp.

---

Member Function Documentation

bool Solenoid::Get

(

)

[virtual]

Read the current value of the solenoid.

Returns:

The current value of the solenoid.

Definition at line 93 of file Solenoid.cpp.

void Solenoid::Set

(

bool

on

)

[virtual]

Set the value of a solenoid.

Parameters:

on

Turn the solenoid output off or on.

Definition at line 79 of file Solenoid.cpp.

---

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

• Solenoid.h
• Solenoid.cpp