powerflow/billdump.cpp

Go to the documentation of this file.

// $Id: billdump.cpp 4738 2014-07-03 00:55:39Z dchassin $
#include <stdlib.h>
#include <stdio.h>
#include <errno.h>
#include <math.h>

#include "billdump.h"

// billdump CLASS FUNCTIONS

CLASS* billdump::oclass = NULL;

billdump::billdump(MODULE *mod)
{
    if (oclass==NULL)
    {
        // register the class definition
        oclass = gl_register_class(mod,"billdump",sizeof(billdump),PC_BOTTOMUP|PC_AUTOLOCK);
        if (oclass==NULL)
            throw "unable to register class billdump";
        else
            oclass->trl = TRL_QUALIFIED;

        // publish the class properties
        if (gl_publish_variable(oclass,
            PT_char32,"group",PADDR(group),PT_DESCRIPTION,"the group ID to output data for (all nodes if empty)",
            PT_timestamp,"runtime",PADDR(runtime),PT_DESCRIPTION,"the time to check voltage data",
            PT_char256,"filename",PADDR(filename),PT_DESCRIPTION,"the file to dump the voltage data into",
            PT_int32,"runcount",PADDR(runcount),PT_ACCESS,PA_REFERENCE,PT_DESCRIPTION,"the number of times the file has been written to",
            PT_enumeration,"meter_type",PADDR(meter_type), PT_DESCRIPTION, "describes whether to collect from 3-phase or S-phase meters",
                PT_KEYWORD,"TRIPLEX_METER",(enumeration)METER_TP,
                PT_KEYWORD,"METER",(enumeration)METER_3P,
            NULL)<1) GL_THROW("unable to publish properties in %s",__FILE__);
        
    }
}


int billdump::create(void)
{
    group.erase();
    runtime = TS_NEVER;
    runcount = 0;
    meter_type = METER_TP;
    return 1;
}

int billdump::init(OBJECT *parent)
{
    return 1;
}

int billdump::isa(char *classname)
{
    return strcmp(classname,"billdump")==0;
}

void billdump::dump(TIMESTAMP t){
    char namestr[64];
    char timestr[64];
    FINDLIST *nodes = NULL;
    OBJECT *obj = NULL;
    FILE *outfile = NULL;
    gld_property *node_monthly_bill;
    gld_property *node_monthly_energy;
    double node_prev_monthly_bill, node_prev_monthly_energy;
    
//  CLASS *nodeclass = NULL;
//  PROPERTY *vA, *vB, *vC;

    if (meter_type == METER_TP)
    {
        if(group[0] == 0){
            nodes = gl_find_objects(FL_NEW,FT_CLASS,SAME,"triplex_meter",FT_END);
        } else {
            nodes = gl_find_objects(FL_NEW,FT_CLASS,SAME,"triplex_meter",AND,FT_GROUPID,SAME,group.get_string(),FT_END);
        }
    }
    else
    {
        if(group[0] == 0){
            nodes = gl_find_objects(FL_NEW,FT_CLASS,SAME,"meter",FT_END);
        } else {
            nodes = gl_find_objects(FL_NEW,FT_CLASS,SAME,"meter",AND,FT_GROUPID,SAME,group.get_string(),FT_END);
        }
    }

    if(nodes == NULL){
        gl_warning("no nodes were found to dump");
        return;
    }

    outfile = fopen(filename, "w");
    if(outfile == NULL){
        gl_error("billdump unable to open %s for output", filename.get_string());
        return;
    }

    //nodeclass = node::oclass;
    //vA=gl_find_property(nodeclass, "

    if (meter_type == METER_TP)
    {
        /* print column names */
        gl_printtime(t, timestr, 64);
        fprintf(outfile,"# %s run at %s on %i triplex meters\n", filename.get_string(), timestr, nodes->hit_count);
        fprintf(outfile,"meter_name,previous_monthly_bill,previous_monthly_energy\n");
        while (obj=gl_find_next(nodes,obj)){
            if(gl_object_isa(obj, "triplex_meter", "powerflow")){

                //Map the properties of interest - bill
                node_monthly_bill = new gld_property(obj,"previous_monthly_bill");

                //Check it
                if ((node_monthly_bill->is_valid() != true) || (node_monthly_bill->is_double() != true))
                {
                    GL_THROW("billdump - Unable to map billing property of triplex_meter:%d - %s",obj->id,(obj->name ? obj->name : "Unnamed"));
                    /*  TROUBLESHOOT
                    While the billdump object attempted to map the previous_monthly_bill or previous_monthly_energy properties, an error
                    occurred.  Please try again.  If the error persists, please submit your code via the ticketing and issues system.
                    */
                }

                //Map the other one - energy
                node_monthly_energy = new gld_property(obj,"previous_monthly_energy");

                //Check it
                if ((node_monthly_energy->is_valid() != true) || (node_monthly_energy->is_double() != true))
                {
                    GL_THROW("billdump - Unable to map billing property of triplex_meter:%d - %s",obj->id,(obj->name ? obj->name : "Unnamed"));
                    //Defined above
                }

                //Pull the values
                node_prev_monthly_bill = node_monthly_bill->get_double();
                node_prev_monthly_energy = node_monthly_energy->get_double();

                if(obj->name == NULL){
                    sprintf(namestr, "%s:%i", obj->oclass->name, obj->id);
                }
                fprintf(outfile,"%s,%f,%f\n",(obj->name ? obj->name : namestr),node_prev_monthly_bill,node_prev_monthly_energy);

                //Clear the properties
                delete node_monthly_bill;
                delete node_monthly_energy;
            }
        }
    }
    else
    {
        /* print column names */
        gl_printtime(t, timestr, 64);
        fprintf(outfile,"# %s run at %s on %i meters\n", filename.get_string(), timestr, nodes->hit_count);
        fprintf(outfile,"meter_name,previous_monthly_bill,previous_monthly_energy\n");
        while (obj=gl_find_next(nodes,obj)){
            if(gl_object_isa(obj, "meter", "powerflow")){

                //Map the properties of interest - bill
                node_monthly_bill = new gld_property(obj,"previous_monthly_bill");

                //Check it
                if ((node_monthly_bill->is_valid() != true) || (node_monthly_bill->is_double() != true))
                {
                    GL_THROW("billdump - Unable to map billing property of meter:%d - %s",obj->id,(obj->name ? obj->name : "Unnamed"));
                    /*  TROUBLESHOOT
                    While the billdump object attempted to map the previous_monthly_bill or previous_monthly_energy properties, an error
                    occurred.  Please try again.  If the error persists, please submit your code via the ticketing and issues system.
                    */
                }

                //Map the other one - energy
                node_monthly_energy = new gld_property(obj,"previous_monthly_energy");

                //Check it
                if ((node_monthly_energy->is_valid() != true) || (node_monthly_energy->is_double() != true))
                {
                    GL_THROW("billdump - Unable to map billing property of meter:%d - %s",obj->id,(obj->name ? obj->name : "Unnamed"));
                    //Defined above
                }

                //Pull the values
                node_prev_monthly_bill = node_monthly_bill->get_double();
                node_prev_monthly_energy = node_monthly_energy->get_double();

                if(obj->name == NULL){
                    sprintf(namestr, "%s:%i", obj->oclass->name, obj->id);
                }
                fprintf(outfile,"%s,%f,%f\n",(obj->name ? obj->name : namestr),node_prev_monthly_bill,node_prev_monthly_energy);

                //Clear the properties
                delete node_monthly_bill;
                delete node_monthly_energy;
            }
        }
    }
    fclose(outfile);

    //Free the findlist
    gl_free(nodes);
}

TIMESTAMP billdump::commit(TIMESTAMP t){
    if(runtime == 0){
        runtime = t;
    }
    if((t >= runtime || runtime == TS_NEVER) && (runcount < 1)){
        /* dump */
        dump(t);
        ++runcount;
    }
    return TS_NEVER;
}

// IMPLEMENTATION OF CORE LINKAGE: billdump

EXPORT int create_billdump(OBJECT **obj, OBJECT *parent)
{
    try
    {
        *obj = gl_create_object(billdump::oclass);
        if (*obj!=NULL)
        {
            billdump *my = OBJECTDATA(*obj,billdump);
            gl_set_parent(*obj,parent);
            return my->create();
        }
        else
            return 0;
    }
    CREATE_CATCHALL(billdump);
}

EXPORT int init_billdump(OBJECT *obj)
{
    try {
        billdump *my = OBJECTDATA(obj,billdump);
        return my->init(obj->parent);
    }
    INIT_CATCHALL(billdump);
}

EXPORT TIMESTAMP sync_billdump(OBJECT *obj, TIMESTAMP t1, PASSCONFIG pass)
{
    try
    {
        billdump *my = OBJECTDATA(obj,billdump);
        TIMESTAMP rv;
        obj->clock = t1;
        rv = my->runtime > t1 ? my->runtime : TS_NEVER;
        return rv;
    }
    SYNC_CATCHALL(billdump);
}

EXPORT TIMESTAMP commit_billdump(OBJECT *obj, TIMESTAMP t1, TIMESTAMP t2){
    try {
        billdump *my = OBJECTDATA(obj,billdump);
        return my->commit(t1);
    }
    I_CATCHALL(commit,billdump);
}

EXPORT int isa_billdump(OBJECT *obj, char *classname)
{
    return OBJECTDATA(obj,billdump)->isa(classname);
}

// EOF

---

GridLAB-D™ Version 4.1

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