unitstruc Struct Reference

JSON unit type entry. More...

#include <jsondef.h>

Collaboration diagram for unitstruc:

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
string	name = ""
	JSON Unit Name. More...
uint16_t	type = JSON_UNIT_TYPE_IDENTITY
	JSON Unit conversion type. More...
float	p0 = 0.f
	0th derivative term More...
float	p1 = 0.f
	1th derivative term More...
float	p2 = 0.f
	2th derivative term More...

Detailed Description

JSON unit type entry.

To be used in the cosmosstruc table of units. Each entry represents one specific variant of one type of unit. Each entry includes:

• a name for the unit
• a type for the unit conversion: 0 = identity, 1 = linear, 2 = log
• 0th, 1st and 2nd derivative terms for any conversion

Member Function Documentation

json11::Json unitstruc::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 {
                        { "name", name },
                        { "type", type },
                        { "p0", p0 },
                        { "p1", p1 },
                        { "p2", p2 }
                };
        }

void unitstruc::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["name"].is_null()) { name = parsed["name"].string_value(); }
            if(!parsed["type"].is_null()) { type = parsed["type"].int_value(); }
            if(!parsed["p0"].is_null()) { p0 = parsed["p0"].number_value(); }
            if(!parsed["p1"].is_null()) { p1 = parsed["p1"].number_value(); }
            if(!parsed["p2"].is_null()) { p2 = parsed["p2"].number_value(); }
        } else {
            cerr<<"ERROR: <"<<error<<">"<<endl;
        }
                return;
        }

Member Data Documentation

string unitstruc::name = ""

JSON Unit Name.

uint16_t unitstruc::type = JSON_UNIT_TYPE_IDENTITY

JSON Unit conversion type.

float unitstruc::p0 = 0.f

0th derivative term

float unitstruc::p1 = 0.f

1th derivative term

float unitstruc::p2 = 0.f

2th derivative term

---

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

• jsondef.h