Skip to content
Snippets Groups Projects
Commit 089a7cf1 authored by Florian Prill's avatar Florian Prill
Browse files

[event_generic_review] naming of new data types without leading underscore.

parent 82472058
No related branches found
No related tags found
1 merge request!3WIP: Event generic
......@@ -29,15 +29,15 @@
#define MAX_EVENTNAME_STR_LEN 132
struct _datetime;
struct _event_basic_cache;
struct t_event_basic_cache;
/**
* @struct _event_basic
* @struct event_basic
*
* @brief struct _event_basic defines events. Events are set to be triggered at pre-specified intervals.
* @brief struct t_event_basic defines events. Events are set to be triggered at pre-specified intervals.
*
*/
struct _event_basic
struct t_event_basic
{
///> Event's name.
char* eventName;
......@@ -60,17 +60,17 @@ struct _event_basic
struct _timedelta* minus_slack;
///> a number of data items which are derived from the data above.
struct _event_basic_cache *cache;
struct t_event_basic_cache *cache;
};
/**
* @struct _event_basic_cache
* @struct t_event_basic_cache
*
* @brief A number of data items which are derived from the data above.
*
*/
struct _event_basic_cache
struct t_event_basic_cache
{
struct _julianday jd_eventReferenceDateTime;
struct _juliandelta jd_eventInterval;
......@@ -88,9 +88,9 @@ struct _event_basic_cache
};
int
basicEvent_cache_init(struct _event_basic* e);
basicEvent_cache_init(struct t_event_basic* e);
struct _event_basic*
struct t_event_basic*
newBasicEventWithDataType(const char* eventName,
struct _datetime* eventReferenceDate,
struct _datetime* eventFirstDate,
......@@ -100,32 +100,32 @@ newBasicEventWithDataType(const char* eventName,
struct _timedelta* minus_slack);
void
deallocateBasicEvent(struct _event_basic* e);
deallocateBasicEvent(struct t_event_basic* e);
bool
isCurrentBasicEventActive(struct _event_basic* e,
isCurrentBasicEventActive(struct t_event_basic* e,
struct _datetime* current_dt,
struct _datetime* trigger_date);
bool
isBasicEventActiveInRange(struct _event_basic* e,
isBasicEventActiveInRange(struct t_event_basic* e,
struct _datetime* dt1,
struct _datetime* dt2);
char*
getBasicEventName(struct _event_basic* e, char* ename);
getBasicEventName(struct t_event_basic* e, char* ename);
struct _datetime*
getBasicEventReferenceDateTime(struct _event_basic* e);
getBasicEventReferenceDateTime(struct t_event_basic* e);
struct _datetime*
getBasicEventFirstDateTime(struct _event_basic* e);
getBasicEventFirstDateTime(struct t_event_basic* e);
struct _datetime*
getBasicEventLastDateTime(struct _event_basic* e);
getBasicEventLastDateTime(struct t_event_basic* e);
struct _timedelta*
getBasicEventInterval(struct _event_basic* e);
getBasicEventInterval(struct t_event_basic* e);
/**
* @}
......
......@@ -99,14 +99,14 @@ printJulianDelta(struct _juliandelta* jd)
// -----------------------------------------------------------------------
// IMPLEMENTATION OF DATA TYPE "_event_basic_cache"
// IMPLEMENTATION OF DATA TYPE "t_event_basic_cache"
// -----------------------------------------------------------------------
int
basicEvent_cache_init(struct _event_basic* e)
basicEvent_cache_init(struct t_event_basic* e)
{
if (e != NULL) {
e->cache = (struct _event_basic_cache*)calloc(1,sizeof(struct _event_basic_cache));
e->cache = (struct t_event_basic_cache*)calloc(1,sizeof(struct t_event_basic_cache));
/* convert plus_slack, minus_slack into _juliandelta data type. */
e->cache->plus_slack_ms = 0;
......@@ -187,7 +187,7 @@ basicEvent_cache_init(struct _event_basic* e)
// -----------------------------------------------------------------------
// IMPLEMENTATION OF DATA TYPE "_event_basic"
// IMPLEMENTATION OF DATA TYPE "t_event_basic"
// -----------------------------------------------------------------------
......@@ -237,7 +237,7 @@ basicEvent_cache_init(struct _event_basic* e)
* A pointer to an initialized event.
*
*/
struct _event_basic*
struct t_event_basic*
newBasicEventWithDataType(const char* _en,
struct _datetime* eventReferenceDT,
struct _datetime* eventFirstDT,
......@@ -248,7 +248,7 @@ newBasicEventWithDataType(const char* _en,
{
if ((_en != NULL) && (eventInterval != NULL) && getCalendarType())
{
struct _event_basic* e = (struct _event_basic*)calloc(1,sizeof(struct _event_basic));
struct t_event_basic* e = (struct t_event_basic*)calloc(1,sizeof(struct t_event_basic));
if (e == NULL ) return NULL;
int ret = 0;
......@@ -331,10 +331,10 @@ newBasicEventWithDataType(const char* _en,
* @brief Destructor of event.
*
* @param e
* A pointer to struct _event_basic. e is deallocated.
* A pointer to struct t_event_basic. e is deallocated.
*/
void
deallocateBasicEvent(struct _event_basic* e)
deallocateBasicEvent(struct t_event_basic* e)
{
if (e != NULL )
{
......@@ -372,7 +372,7 @@ deallocateBasicEvent(struct _event_basic* e)
* application at fixed intervals.
*
* @param event
* A pointer to struct _event_basic. This is the event being
* A pointer to struct t_event_basic. This is the event being
* tested.
*
* @param current_dt
......@@ -389,7 +389,7 @@ deallocateBasicEvent(struct _event_basic* e)
* @todo Error handling is missing!
*/
bool
isCurrentBasicEventActive(struct _event_basic* event,
isCurrentBasicEventActive(struct t_event_basic* event,
struct _datetime* current_dt,
struct _datetime* trigger_date)
{
......@@ -467,7 +467,7 @@ isCurrentBasicEventActive(struct _event_basic* event,
* true/false indicating if the event is active.
*/
bool
isBasicEventActiveInRange(struct _event_basic* event,
isBasicEventActiveInRange(struct t_event_basic* event,
struct _datetime* dt1,
struct _datetime* dt2)
{
......@@ -521,7 +521,7 @@ isBasicEventActiveInRange(struct _event_basic* event,
char*
getBasicEventName(struct _event_basic* e, char* ename)
getBasicEventName(struct t_event_basic* e, char* ename)
{
if ((e != NULL) && (ename != NULL))
{
......@@ -534,7 +534,7 @@ getBasicEventName(struct _event_basic* e, char* ename)
}
struct _datetime*
getBasicEventReferenceDateTime(struct _event_basic* e)
getBasicEventReferenceDateTime(struct t_event_basic* e)
{
if (e != NULL)
return e->eventReferenceDateTime;
......@@ -543,7 +543,7 @@ getBasicEventReferenceDateTime(struct _event_basic* e)
}
struct _datetime*
getBasicEventFirstDateTime(struct _event_basic* e)
getBasicEventFirstDateTime(struct t_event_basic* e)
{
if (e != NULL)
return e->eventFirstDateTime;
......@@ -552,7 +552,7 @@ getBasicEventFirstDateTime(struct _event_basic* e)
}
struct _datetime*
getBasicEventLastDateTime(struct _event_basic* e)
getBasicEventLastDateTime(struct t_event_basic* e)
{
if (e != NULL)
return e->eventLastDateTime;
......@@ -561,7 +561,7 @@ getBasicEventLastDateTime(struct _event_basic* e)
}
struct _timedelta*
getBasicEventInterval(struct _event_basic* e)
getBasicEventInterval(struct t_event_basic* e)
{
if (e != NULL)
return e->eventInterval;
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment