warptwin::Connection Struct Reference

Hold all information related to a connection point in the ImGUI UX. More...

#include <Connection.h>

Public Member Functions
void	fromJson (const nlohmann::json &j)
	Create Connection object from json.
nlohmann::json	toJson ()
	Create json object from Connection.
void	dump ()
	Output all connection information.

Public Attributes
std::string	name
	The name of the connection.
long	unique_id
	The unique ID of the connection given by the ImGUI UX or other.
connection_type_e	connection_type
	The type of connection.
gui_data_types_e	data_type
	The data type associated with the connection.
std::array< unsigned int, 2 >	size
	The size of the connection as rows, columns.
std::vector< std::vector< std::string > >	values
	The values held within the connection. All values are stored as string.
int	writable
	Boolean indicating whether the connection is writable (true) or not (false).
long	paired_connection_id
	The connection to which this connection is paired, given by unique ID.
std::vector< long >	log_connection_ids
	Store multiple inputs for logging connections that allow it.
long	parent_node_id
	The parent to this connection, given by its unique ID number.
int	user_set
	Flag to indicate whether user has set this value via the GUI.
std::string	displayname
	GUI display name of the connection.
std::string	description
	Description of the connection parsed from warptwin files.

Detailed Description

Hold all information related to a connection point in the ImGUI UX.

Member Function Documentation

dump()

void warptwin::Connection::dump

(

)

Output all connection information.

fromJson()

void warptwin::Connection::fromJson

(

const nlohmann::json &

j

)

Create Connection object from json.

Parameters

j	The json object from which Connection is created

toJson()

nlohmann::json warptwin::Connection::toJson

(

)

Create json object from Connection.

Returns

The json object from connection data

Member Data Documentation

connection_type

connection_type_e warptwin::Connection::connection_type

The type of connection.

data_type

gui_data_types_e warptwin::Connection::data_type

The data type associated with the connection.

description

std::string warptwin::Connection::description

Description of the connection parsed from warptwin files.

displayname

std::string warptwin::Connection::displayname

GUI display name of the connection.

log_connection_ids

std::vector<long> warptwin::Connection::log_connection_ids

Store multiple inputs for logging connections that allow it.

name

std::string warptwin::Connection::name

The name of the connection.

paired_connection_id

long warptwin::Connection::paired_connection_id

The connection to which this connection is paired, given by unique ID.

parent_node_id

long warptwin::Connection::parent_node_id

The parent to this connection, given by its unique ID number.

size

std::array<unsigned int, 2> warptwin::Connection::size

The size of the connection as rows, columns.

unique_id

long warptwin::Connection::unique_id

The unique ID of the connection given by the ImGUI UX or other.

user_set

int warptwin::Connection::user_set

Flag to indicate whether user has set this value via the GUI.

values

std::vector<std::vector<std::string> > warptwin::Connection::values

The values held within the connection. All values are stored as string.

writable

int warptwin::Connection::writable

Boolean indicating whether the connection is writable (true) or not (false).

---

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

• /Users/mickey/Documents/Projects/warptwin/cpp/src/configuration/Connection.h
• /Users/mickey/Documents/Projects/warptwin/cpp/src/configuration/Connection.cpp