5-relay gate w/pretend objects v.1

/*
  5-relay gate w/pretend objects v.1 ---- written with theoretical objects
  March 15, 2018

  This sketch is just for demonstration purposes--it doesn't work.
  It is only to show how small the whole sketch would be, and how easy it would be to understand,
  if the main features of the sketch were all written as classes and placed in external libraries.

  There would be lots of other code needed to make this sketch work, but that code would be in the library class files. It would not be here.
  This keeps the sketch easy to understand.

  Also note that there are no serial.print() statements here, other than the one exiting the setup() function.
  If you wanted to have serial.print() statements for all the events, it would be better to put them into the class libraries than to write them out here.
  Some of the events are private, and it is easier to write them into the object class.
  You could even have another property in each of the classes to turn them on and off, to allow testing with them but disabling them for the final version of the sketch.
*/

// @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
// Section 1:
// These are the library include statements for the classes needed:
#include <Custom_Button_01.h> // ------(the custom push-button switch library, that does not exist! --you would have to write this)
#include <Custom_Relay_01.h> // ------(the custom relay library, that does not exist! --you would have to write this)
#include <Custom_Relay_02.h> // ------(a second custom relay library, that does not exist! --you would have to write this)
// The line above operates a relay, but it does so in a different manner than the one before it.
// So it would be easier IMO to just create another library for it, rather than write one library that could handle both situations.

// @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
// Section 2:
// Below is declaring the pins to use on the Arduino. (This section is done just like normal)
const int button_Pin = 2;     // the number of the pushbutton pin
const int open_right_gate_relay_pin =  10;      // the number of the relay pin
const int open_left_gate_relay_pin =  11;      // the number of the relay pin
const int close_right_gate_relay_pin =  8;      // the number of the relay pin
const int close_left_gate_relay_pin =  9;      // the number of the relay pin
const int light_gate_relay_pin =  12;      // the number of the relay pin

// @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
// Section 3:

// Below is declaring a push-button object. (this library does not exist!)
Custom_Button_01 Button1 = Custom_Button_01(2, 500, 100);

// Below is declaring Gate_Relay objects. (this library does not exist!)
Custom_Relay_01 Open_right_gate_relay = Custom_Relay_01(open_right_gate_relay_pin, 0, 4);
Custom_Relay_01 Open_left_gate_relay = Custom_Relay_01(open_left_gate_relay_pin, 1, 4);
Custom_Relay_01 Close_right_gate_relay = Custom_Relay_01(close_right_gate_relay_pin, 2, 4);
Custom_Relay_01 Close_left_gate_relay = Custom_Relay_01(close_left_gate_relay_pin, 1, 4);

// below is declaring the Flasher1 object. (this library does not exist!)
Custom_Relay_02 Flasher1 = Custom_Relay_02(light_gate_relay_pin, 0, 500, 7.5);

// @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
// Section 4:

// The Setup() function is done the same as normal.
void setup() {
  Serial.begin(9600);
  pinMode(open_left_gate_relay_pin, OUTPUT);
  pinMode(open_right_gate_relay_pin, OUTPUT);
  pinMode(close_left_gate_relay_pin, OUTPUT);
  pinMode(close_right_gate_relay_pin, OUTPUT);
  pinMode(light_gate_relay_pin, OUTPUT);
  pinMode(button_Pin, INPUT_PULLUP);
  Serial.println("OK: exiting setup()");
}

// @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
// Section 5:

// Function prototype:
void updateHardware(); // I prefer to put the main loop() first, so any other functions must have prototype statements before they are called {in the main loop()}.

// @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
// Section 6:

void loop() {

  Button1.check(); // This would check the button's state, and it would also tell if the state has changed since the last time the button was checked.
  if (Button1.is_pressed) { // This section would run only when the button changes from [not pressed] to [pressed]. The code for figuring that out would be in Button1.
    updateHardware();
  }
  if (Button1.is_released) { // This section would run only when the button changes from [pressed] to [not pressed]. The code for figuring that out would be in Button1.
    updateHardware();
  }

} // end of main loop()

// @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
// Section 7:

void updateHardware() {
  // Any time that the button state changes, that info gets sent to all the relays:
  // Each relay has code in it to tell what to do when the button gets pushed, and what to do when the button gets released.
  Open_right_gate_relay.checkRelay(Button1.state);
  Open_left_gate_relay.checkRelay(Button1.state);
  Close_right_gate_relay.checkRelay(Button1.state);
  Close_left_gate_relay.checkRelay(Button1.state);
  Flasher1.checkFlasher(My_PushButton.state);
}


// ~~~~~~~ [end] ~~~~~~~~~~