battstruc Struct Reference

Battery (BATT) structure. More...

#include <jsondef.h>

Collaboration diagram for battstruc:

Public Member Functions
json11::Json	to_json () const
	Convert class contents to JSON object. More...
void	from_json (const string &s)
	Set class contents from JSON string. More...

Public Attributes
float	capacity = 0.f
	Capacity in amp hours. More...
float	efficiency = 0.f
	Charge conversion efficiency. More...
float	charge = 0.f
	Charge in amp hours. More...
float	r_in = 0.f
	Resistance in. More...
float	r_out = 0.f
	Resistance out. More...
float	percentage = 0.f
	Battery Percentage Remaining. More...
float	time_remaining = 0.f
	Time Remaining. More...

Detailed Description

Battery (BATT) structure.

Member Function Documentation

json11::Json battstruc::to_json ( ) const

inline

Convert class contents to JSON object.

Returns a json11 JSON object of the class

Returns

A json11 JSON object containing every member variable within the class

                               {
        return json11::Json::object {
            { "capacity"  , capacity },
            { "efficiency", efficiency },
            { "charge"  , charge },
            { "r_in"  , r_in },
            { "r_out" , r_out },
            { "percentage", percentage },
            { "time_remaining" , time_remaining }
        };
    }

void battstruc::from_json ( const string &  s )

inline

Set class contents from JSON string.

Parses the provided JSON-formatted string and sets the class data. String should be formatted like the string returned from to_json()

Parameters

s	JSON-formatted string to set class contents to

Returns

n/a

                                    {
        string error;
        json11::Json parsed = json11::Json::parse(s,error);
        if(error.empty()) {
            if(!parsed["capacity"].is_null()) { capacity = parsed["capacity"].number_value(); }
            if(!parsed["efficiency"].is_null()) { efficiency = parsed["efficiency"].number_value(); }
            if(!parsed["charge"].is_null()) { charge = parsed["charge"].number_value(); }
            if(!parsed["r_in"].is_null()) { r_in = parsed["r_in"].number_value(); }
            if(!parsed["r_out"].is_null()) { r_out = parsed["r_out"].number_value(); }
            if(!parsed["percentage"].is_null()) { percentage = parsed["percentage"].number_value(); }
            if(!parsed["time_remaining"].is_null()) { time_remaining = parsed["time_remaining"].number_value(); }
        } else {
            cerr<<"ERROR: <"<<error<<">"<<endl;
        }
        return;
    }

Member Data Documentation

float battstruc::capacity = 0.f

Capacity in amp hours.

float battstruc::efficiency = 0.f

Charge conversion efficiency.

float battstruc::charge = 0.f

Charge in amp hours.

float battstruc::r_in = 0.f

Resistance in.

float battstruc::r_out = 0.f

Resistance out.

float battstruc::percentage = 0.f

Battery Percentage Remaining.

float battstruc::time_remaining = 0.f

Time Remaining.

---

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

• jsondef.h