allstruc Struct Reference

All Component structure. More...

#include <jsondef.h>

Inheritance diagram for allstruc:

Collaboration diagram for allstruc:

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
bool	enabled = true
	Enabled? More...
uint16_t	type = 0
	Component Type. More...
uint16_t	model = 0
	Device Model. More...
uint32_t	flag = 0
	Device flag - catch all for any small piece of information that might be device specific. More...
uint16_t	addr = 0
	Device specific address. More...
uint16_t	cidx = 0
	Component Index. More...
uint16_t	didx = 0
	Device specific index. More...
uint16_t	pidx = 0
	Piece index. More...
uint16_t	bidx = 0
	Power Bus index. More...
uint16_t	portidx = 0
	Connection information for device. More...
float	namp = 0.f
	Nominal Amperage. More...
float	nvolt = 0.f
	Nominal Voltage. More...
float	amp = 0.f
	Current Amperage. More...
float	volt = 0.f
	Current Voltage. More...
float	power = 0.f
	Current Power. More...
float	energy = 0.f
	Total energy usage. More...
float	drate = 0.f
	Current data rate. More...
float	temp = 0.f
	Current Temperature. More...
double	utc = 0.
	Device information time stamp. More...

Detailed Description

All Component structure.

These are the elements that are repeated in all devices. Each device specific structure has these as its first elements, followed by any specific elements. They are all then combined together in one grand union as a devicestruc.

Member Function Documentation

json11::Json allstruc::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 {
            { "enabled" , enabled },
            { "type"    , type },
            { "model"   , model },
            { "flag"    , static_cast<int>(flag) },
            { "addr"    , addr },
            { "cidx"    , cidx },
            { "didx"    , didx },
            { "pidx"    , pidx },
            { "bidx"    , bidx },
            { "portidx" , portidx },
            { "namp"    , namp},
            { "nvolt"   , nvolt },
            { "amp"  , amp },
            { "volt"    , volt },
            { "power"   , power },
            { "energy"  , energy },
            { "drate"   , drate },
            { "temp"    , temp },
            { "utc"  , utc },
        };
    }

void allstruc::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["enabled"].is_null()) { enabled = parsed["enabled"].bool_value(); }
            if(!parsed["type"].is_null()) { type = parsed["type"].int_value(); }
            if(!parsed["model"].is_null()) { model = parsed["model"].int_value(); }
            if(!parsed["flag"].is_null()) { flag = parsed["flag"].int_value(); }
            if(!parsed["addr"].is_null()) { addr = parsed["addr"].int_value(); }
            if(!parsed["cidx"].is_null()) { cidx = parsed["cidx"].int_value(); }
            if(!parsed["didx"].is_null()) { didx = parsed["didx"].int_value(); }
            if(!parsed["pidx"].is_null()) { pidx = parsed["pidx"].int_value(); }
            if(!parsed["bidx"].is_null()) { bidx = parsed["bidx"].int_value(); }
            if(!parsed["portidx"].is_null()) { portidx = parsed["portidx"].int_value(); }
            if(!parsed["namp"].is_null()) { namp = parsed["namp"].number_value(); }
            if(!parsed["nvolt"].is_null()) { nvolt = parsed["nvolt"].number_value(); }
            if(!parsed["amp"].is_null()) { amp = parsed["amp"].number_value(); }
            if(!parsed["volt"].is_null()) { volt = parsed["volt"].number_value(); }
            if(!parsed["power"].is_null()) { power = parsed["power"].number_value(); }
            if(!parsed["energy"].is_null()) { energy = parsed["energy"].number_value(); }
            if(!parsed["drate"].is_null()) { drate = parsed["drate"].number_value(); }
            if(!parsed["temp"].is_null()) { temp = parsed["temp"].number_value(); }
            if(!parsed["utc"].is_null()) { utc = parsed["utc"].number_value(); }
        } else {
            cerr<<"ERROR: <"<<error<<">"<<endl;
        }
        return;
    }

Member Data Documentation

bool allstruc::enabled = true

Enabled?

uint16_t allstruc::type = 0

Component Type.

uint16_t allstruc::model = 0

Device Model.

uint32_t allstruc::flag = 0

Device flag - catch all for any small piece of information that might be device specific.

uint16_t allstruc::addr = 0

Device specific address.

uint16_t allstruc::cidx = 0

Component Index.

uint16_t allstruc::didx = 0

Device specific index.

uint16_t allstruc::pidx = 0

Piece index.

uint16_t allstruc::bidx = 0

Power Bus index.

uint16_t allstruc::portidx = 0

Connection information for device.

float allstruc::namp = 0.f

Nominal Amperage.

float allstruc::nvolt = 0.f

Nominal Voltage.

float allstruc::amp = 0.f

Current Amperage.

float allstruc::volt = 0.f

Current Voltage.

float allstruc::power = 0.f

Current Power.

float allstruc::energy = 0.f

Total energy usage.

float allstruc::drate = 0.f

Current data rate.

float allstruc::temp = 0.f

Current Temperature.

double allstruc::utc = 0.

Device information time stamp.

---

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

• jsondef.h