tape/collector.c

Go to the documentation of this file.

#include <stdlib.h>
#include <stdio.h>
#include <errno.h>
#include <ctype.h>
#include "gridlabd.h"
#include "object.h"
#include "aggregate.h"

#include "tape.h"
#include "file.h"
#include "odbc.h"

CLASS *collector_class = NULL;
static OBJECT *last_collector = NULL;

EXPORT int create_collector(OBJECT **obj, OBJECT *parent)
{
    *obj = gl_create_object(collector_class);
    if (*obj!=NULL)
    {
        struct collector *my = OBJECTDATA(*obj,struct collector);
        last_collector = *obj;
        gl_set_parent(*obj,parent);
        strcpy(my->file,"");
        strcpy(my->filetype,"txt");
        strcpy(my->delim,",");
        strcpy(my->property,"(undefined)");
        strcpy(my->group,"");
        my->interval = TS_NEVER; /* transients only */
        my->dInterval = -1.0;
        my->last.ts = -1;
        strcpy(my->last.value,"");
        my->limit = 0;
        my->samples = 0;
        my->status = TS_INIT;
        my->trigger[0]='\0';
        my->format = 0;
        my->aggr = NULL;
        return 1;
    }
    return 0;
}

static int collector_open(OBJECT *obj)
{
    char32 type="file";
    char1024 fname="";
    char32 flags="w";
    TAPEFUNCS *tf = 0;
    struct collector *my = OBJECTDATA(obj,struct collector);
    
    my->interval = (int64)(my->dInterval/TS_SECOND);

    /* if prefix is omitted (no colons found) */
    if (sscanf(my->file,"%32[^:]:%1024[^:]:%[^:]",type,fname,flags)==1)
    {
        /* filename is file by default */
        strcpy(fname,my->file);
        strcpy(type,"file");
    }

    /* if no filename given */
    if (strcmp(fname,"")==0)
    {
        char *p;
        /* use group spec as default file name */
        sprintf(fname,"%s.%s",my->group,my->filetype);

        /* but change disallowed characters to _ */
        for (p=fname; *p!='\0'; p++)
        {
            if (!isalnum(*p) && *p!='-' && *p!='.')
                *p='_';
        }
    }

    /* if type is file or file is stdin */
    tf = get_ftable(type);
    if(tf == NULL)
        return 0;
    my->ops = tf->collector;
    if(my->ops == NULL)
        return 0;
    set_csv_options();
    return my->ops->open(my, fname, flags);
}

static int write_collector(struct collector *my, char *ts, char *value)
{
    int rc=my->ops->write(my, ts, value);
    if ( (my->flush==0 || (my->flush>0 && my->flush%gl_globalclock==0)) && my->ops->flush!=NULL ) 
        my->ops->flush(my);
    return rc;
}

static void close_collector(struct collector *my){
    if(my->ops){
        my->ops->close(my);
    }
}

static TIMESTAMP collector_write(OBJECT *obj)
{
    struct collector *my = OBJECTDATA(obj,struct collector);
    char ts[64];
    if (my->format==0)
    {
        //time_t t = (time_t)(my->last.ts*TS_SECOND);
        //strftime(ts,sizeof(ts),timestamp_format, gmtime(&t));

        DATETIME dt;
        gl_localtime(my->last.ts, &dt);
        gl_strtime(&dt, ts, sizeof(ts));
    }
    else
        sprintf(ts,"%" FMT_INT64 "d", my->last.ts);
    if ((my->limit>0 && my->samples>my->limit) /* limit reached */
        || write_collector(my,ts,my->last.value)==0) /* write failed */
    {
        if (my->ops){
            close_collector(my);
        } else {
            gl_error("collector_write: no TAPEOP structure when closing the tape");
        }
        my->status = TS_DONE;
    }
    else
        my->samples++;
    return TS_NEVER;
}

AGGREGATION *link_aggregates(char *aggregate_list, char *group)
{
    char *item;
    AGGREGATION *first=NULL, *last=NULL;
    char1024 list;
    strcpy(list,aggregate_list); /* avoid destroying orginal list */
    for (item=strtok(list,","); item!=NULL; item=strtok(NULL,","))
    {
        AGGREGATION *aggr = gl_create_aggregate(item,group);
        if (aggr!=NULL)
        {
            /* TODO: ideally the aggregation group program from the previous should be reused */
            if (first==NULL) first=aggr; else last->next=aggr;
            last=aggr;
            aggr->next = NULL;
        }
        else
            return NULL; // allowable to have null (zero-length) aggrs, but only give time-varying aggregates
    }
    return first;
}

int read_aggregates(AGGREGATION *aggr, char *buffer, int size)
{
    AGGREGATION *p;
    int offset=0;
    int count=0;
    char32 fmt;

    gl_global_getvar("double_format", fmt, 32);
    for (p=aggr; p!=NULL && offset<size-33; p=p->next)
    {
        if (offset>0) strcpy(buffer+offset++,",");
        offset+=sprintf(buffer+offset,fmt,gl_run_aggregate(p));
        buffer[offset]='\0';
        count++;
    }
    return count;
}



EXPORT TIMESTAMP sync_collector(OBJECT *obj, TIMESTAMP t0, PASSCONFIG pass)
{
    struct collector *my = OBJECTDATA(obj,struct collector);
    typedef enum {NONE='\0', LT='<', EQ='=', GT='>'} COMPAREOP;
    COMPAREOP comparison;
    char1024 buffer = "";
    
    if(my->status == TS_DONE){
        return TS_NEVER;
    }

    /* connect to property */
    if (my->aggr==NULL)
        my->aggr = link_aggregates(my->property,my->group);

    /* read property */
    if (my->aggr==NULL)
    {
        sprintf(buffer,"'%s' contains an aggregate that is not found in the group '%s'", my->property, my->group);
        my->status = TS_ERROR;
        goto Error;
    }
    
    if((my->status == TS_OPEN) && (t0 > obj->clock)){
        obj->clock = t0;
        if((my->interval > 0) && (my->last.ts < t0) && (my->last.value[0] != 0)){
            collector_write(obj);
            //my->last.ts = t0;
            my->last.value[0] = 0;
        }
    }

    //if(my->aggr != NULL && (my->aggr = link_aggregates(my->property,my->group)),read_aggregates(my->aggr,buffer,sizeof(buffer))==0)
    if(my->aggr != NULL && (my->interval == 0 || my->interval == -1)){
        if(read_aggregates(my->aggr,buffer,sizeof(buffer))==0)
        {
            sprintf(buffer,"unable to read aggregate '%s' of group '%s'", my->property, my->group);
            close_collector(my);
            my->status = TS_ERROR;
        }
    }

    if(my->aggr != NULL && my->interval > 0){
        if((t0 >= my->last.ts + my->interval) || (t0 == my->last.ts)){
            if(read_aggregates(my->aggr,buffer,sizeof(buffer))==0){
                sprintf(buffer,"unable to read aggregate '%s' of group '%s'", my->property, my->group);
                close_collector(my);
                my->status = TS_ERROR;
            }
            my->last.ts = t0;
        }
    }

    /* check trigger, if any */
    comparison = (COMPAREOP)my->trigger[0];
    if (comparison!=NONE)
    {
        int desired = comparison==LT ? -1 : (comparison==EQ ? 0 : (comparison==GT ? 1 : -2));

        /* if not trigger or can't get access */
        int actual = strcmp(buffer,my->trigger+1);
        if (actual!=desired || (my->status==TS_INIT && !collector_open(obj))){
            /* better luck next time */
            return (my->interval==0 || my->interval==-1) ? TS_NEVER : t0+my->interval;
        }
    }
    else if (my->status==TS_INIT && !collector_open(obj)){
        close_collector(my);
        return TS_NEVER;
    }

    if(my->last.ts < 1 && my->interval != -1){
        my->last.ts = t0;
    }

    /* write tape */
    if(my->status == TS_OPEN){  
        if(my->interval == 0 /* sample on every pass */
            || ((my->interval == -1) && my->last.ts != t0 && strcmp(buffer, my->last.value) != 0) /* sample only when value changes */
            ){
            strncpy(my->last.value, buffer, sizeof(my->last.value));
            my->last.ts = t0;
            collector_write(obj);
        } else if(my->interval > 0 && my->last.ts == t0){
            strncpy(my->last.value, buffer, sizeof(my->last.value));
        }
    }
Error:
    if (my->status==TS_ERROR)
    {
        gl_error("collector %d %s\n",obj->id, buffer);
        my->status=TS_DONE;
        return 0; /* failed */
    }

    return (my->interval==0 || my->interval==-1) ? TS_NEVER : my->last.ts+my->interval;
}

---

GridLAB-D™ Version 4.1

An open-source smart grid simulator created by PNNL for the US Department of Energy Office of Electricity