ProducerEventIds Class Reference

manages event IDs for producers classes Allocates a set of LCC Event IDs. Use by producer classes that need to produce (send) event IDs More...

#include <LccNodeCommons.h>

Public Member Functions
openlcb::EventId	getEventId (uint8_t cardNum, uint8_t offset)
	obtains an Event ID value from the set of producer events More...
void	setEventId (uint8_t cardNum, uint8_t offset, openlcb::EventId eventId)
	sets the value of an Event ID within the set of Event IDs previously allocated by invoking createEventIds() More...

Detailed Description

manages event IDs for producers classes Allocates a set of LCC Event IDs. Use by producer classes that need to produce (send) event IDs

---

Parameters

numEventIds

is the number of event IDs to allocate. For example, an INPUT (sensor) card support 16 pins would typically request 32 Event IDs, two per pin for indicating ON/OFF of the pin

Note

setEventId() must be invoked to set the Event ID value

Definition at line 68 of file LccNodeCommons.h.

Member Function Documentation

getEventId()

openlcb::EventId ProducerEventIds::getEventId ( uint8_t  cardNum, uint8_t  offset  )

inline

obtains an Event ID value from the set of producer events

Parameters

cardNum	specifes which card the event Id is for
offset	specifies the offset into the Event ID set

Returns

the Event ID value at the offset into the Event ID set

Definition at line 94 of file LccNodeCommons.h.

Here is the caller graph for this function:

setEventId()

void ProducerEventIds::setEventId ( uint8_t  cardNum, uint8_t  offset, openlcb::EventId  eventId  )

inline

sets the value of an Event ID within the set of Event IDs previously allocated by invoking createEventIds()

Parameters

cardNum	specifes which card the event Id is for
eventId	is the event Id value to store
offset	spcifies which Event ID to set within the set of Event IDs

Definition at line 108 of file LccNodeCommons.h.

Here is the caller graph for this function:

---

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

• Node_Card/LccNodeCommons.h