portstruc Struct Reference

Port structure. More...

#include <jsondef.h>

Collaboration diagram for portstruc:

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
PORT_TYPE	type = PORT_TYPE_NONE
	Type of I/O as listed in PORT_TYPE. More...
char	name [COSMOS_MAX_DATA+1] = ""

Detailed Description

Port structure.

Contains information about I/O ports available to devices. The allstruc::portidx entry in each device structure indicates which of these ports a device will use.

Member Function Documentation

json11::Json portstruc::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 {
            { "type" , type },
            { "name" , name }
        };
    }

void portstruc::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 p = json11::Json::parse(s,error);
        if(error.empty()) {
            if(!p["type"].is_null()) { type = static_cast<PORT_TYPE>(p["type"].int_value()); }
            if(!p["name"].is_null()) { strcpy(name, p["name"].string_value().c_str()); }
        } else {
            cerr<<"ERROR: <"<<error<<">"<<endl;
        }
        return;
    }

Member Data Documentation

PORT_TYPE portstruc::type = PORT_TYPE_NONE

Type of I/O as listed in PORT_TYPE.

char portstruc::name[COSMOS_MAX_DATA+1] = ""

Name information for port. !! Do not make this string

---

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

• jsondef.h