#include <Bridges.h>

Detailed Description

This class contains methods to connect and transmit a user's data structure representation to the Bridges server.

If the FORCE_BRIDGES_APIKEY environment variable is set, use the environment variable as APIkey in all cases.

If the FORCE_BRIDGES_USERNAME environment variable is set, use the environment variable as username in all cases.

If the FORCE_BRIDGES_ASSIGNMENT environment variable is set, use the environment variable as assignment number in all cases.

Author: Kalpathi Subramanian, Dakota Carmer, Erik Saule

Date: 7/26/15, 6/5/17, 10/30/18, 7/12/19

Public Member Functions
	Bridges ()

	Bridges (const string &name, const string &key)
	constructor to bridges More...

	Bridges (unsigned int num, const string &name, const string &key)
	constructor to bridges More...

bool	getVisualizeJSONFlag () const

void	postVisualizationLink (bool link_url)

void	setVisualizeJSONFlag (bool flag)

const string &	getUserName () const

void	setUserName (string name)
	Set user name. More...

const string &	getApiKey () const

void	setApiKey (string key)
	Set API key credentials. More...

unsigned int	getAssignment () const

void	setAssignment (unsigned int num)

const string &	getTitle () const

void	setTitle (const string &t)

const string &	getDescription () const

void	setDescription (const string &descr)

void	setDataStructure (DataStructure *ds)

void	setDataStructure (DataStructure &ds)

DataStructure *	getDataStructure ()

void	initialize (unsigned int num, const string &username, const string &apikey)
	Sets Bridges assignment and credential information. More...

void	setServer (const string &server_type)

void	setMapOverlay (bool overlay_flag)
	Turns on map overlay for subsequent visualizations - used with location specific datasets. More...

void	setCoordSystemType (string coord)

const string &	getCoordSystemType ()

void	setWindow (int xmin, int xmax, int ymin, int ymax)

void	setWindow (double xmin, double xmax, double ymin, double ymax)
	sets the world coordinate window defining the space of the user defined objects (or nodes) More...

void	visualize ()

Constructor & Destructor Documentation

◆ Bridges() [1/3]

bridges::Bridges::Bridges ( )

inline

◆ Bridges() [2/3]

bridges::Bridges::Bridges	(	const string &	name,
		const string &	key
	)

inline

constructor to bridges

If the FORCE_BRIDGES_APIKEY environment variable is set, use the environment variable as APIkey in all cases.

If the FORCE_BRIDGES_USERNAME environment variable is set, use the environment variable as username in all cases.

Parameters

name	Bridges username
key	Bridges APIKey of the name account. (Note that it is not the password, but the API Key one can find in the user profile.)

◆ Bridges() [3/3]

bridges::Bridges::Bridges	(	unsigned int	num,
		const string &	name,
		const string &	key
	)

inline

constructor to bridges

If the FORCE_BRIDGES_APIKEY environment variable is set, use the environment variable as APIkey in all cases.

If the FORCE_BRIDGES_USERNAME environment variable is set, use the environment variable as username in all cases.

If the FORCE_BRIDGES_ASSIGNMENT environment variable is set, use the environment variable as assignment number in all cases.

Parameters

num	assignment ID
name	Bridges username
key	Bridges APIKey of the name account. (Note that it is not the password, but the API Key one can find in the user profile.)

Member Function Documentation

◆ getApiKey()

const string& bridges::Bridges::getApiKey ( ) const

inline

Get API key credentials

Returns: BRIDGES api key credential for the server

◆ getAssignment()

unsigned int bridges::Bridges::getAssignment ( ) const

inline

Return assignmet id

Returns: assignment number for holding the visualization on the server

◆ getCoordSystemType()

const string& bridges::Bridges::getCoordSystemType ( )

inline

Gets the coordinate system type for location specific datasets

Returns: coord system type ; will be one of ['cartesian', 'albersUsa', 'equirectangular']. 'cartesian'

◆ getDataStructure()

DataStructure* bridges::Bridges::getDataStructure ( )

inline

Returns: member holding the data structure handle

◆ getDescription()

const string& bridges::Bridges::getDescription ( ) const

inline

Get visualization description

Returns: description of visualization

◆ getTitle()

const string& bridges::Bridges::getTitle ( ) const

inline

Get the visualization title

Returns: title of visualization

◆ getUserName()

const string& bridges::Bridges::getUserName ( ) const

inline

Get user name

Returns: reference to member holding the BRIDGES username credential for the server

◆ getVisualizeJSONFlag()

bool bridges::Bridges::getVisualizeJSONFlag ( ) const

inline

Returns: flag indicating if JSON should be printed upon visualization

◆ initialize()

void bridges::Bridges::initialize	(	unsigned int	num,
		const string &	username,
		const string &	apikey
	)

inline

Sets Bridges assignment and credential information.

If the FORCE_BRIDGES_APIKEY environment variable is set, use the environment variable as APIkey in all cases.

If the FORCE_BRIDGES_USERNAME environment variable is set, use the environment variable as username in all cases.

If the FORCE_BRIDGES_ASSIGNMENT environment variable is set, use the environment variable as assignment number in all cases.

Parameters

num	The assignment number
apikey	The API key on the BRIDGES server (this is not your password, find the API Key on the profile page)
username	The username on the BRIDGES server

◆ postVisualizationLink()

void bridges::Bridges::postVisualizationLink ( bool link_url )

inline

This method is used to suppress the visualization link that is usually printed to the console

Parameters

link_url flag that controls if the link is printed to console

Returns: none

◆ setApiKey()

void bridges::Bridges::setApiKey ( string key )

inline

Set API key credentials.

If the FORCE_BRIDGES_APIKEY environment variable is set, use the environment variable as key and disregard the parameter.

Parameters

key	API key to set for user

◆ setAssignment()

void bridges::Bridges::setAssignment ( unsigned int num )

inline

Set the assignment number

If the FORCE_BRIDGES_ASSIGNMENT environment variable is set, use the environment variable as assignment number in all cases.

Parameters

num	assignment number to set

◆ setCoordSystemType()

void bridges::Bridges::setCoordSystemType ( string coord )

inline

Sets the coordinate system type for location specific data; default is cartesian

Parameters

coord this is the desired coordinate space argument Options are: ['cartesian', 'albersusa', 'equirectangular', 'window']. 'cartesian' is the default

◆ setDataStructure() [1/2]

void bridges::Bridges::setDataStructure ( DataStructure * ds )

inline

set handle to data structure

Parameters

ds	pointer to user's data Structure

◆ setDataStructure() [2/2]

void bridges::Bridges::setDataStructure ( DataStructure & ds )

inline

set handle to data structure

Parameters

ds	reference to user's data Structure

◆ setDescription()

void bridges::Bridges::setDescription ( const string & descr )

inline

Set visualization description

Returns: descr description of visualization

◆ setMapOverlay()

void bridges::Bridges::setMapOverlay ( bool overlay_flag )

inline

Turns on map overlay for subsequent visualizations - used with location specific datasets.

Parameters

overlay_flag true to display the map overlay

◆ setServer()

void bridges::Bridges::setServer ( const string & server_type )

inline

Set server type

Parameters

server_type server to which to connect. Options are: ['live', 'local', 'games', 'clone'], and 'live' is the default;

◆ setTitle()

void bridges::Bridges::setTitle ( const string & t )

inline

Set title of visualization

Parameters

t	title of visualization

◆ setUserName()

void bridges::Bridges::setUserName ( string name )

inline

Set user name.

If the FORCE_BRIDGES_USERNAME environment variable is set, use the environment variable as username in all cases.

Parameters

name	BRIDGES user id to set

◆ setVisualizeJSONFlag()

void bridges::Bridges::setVisualizeJSONFlag ( bool flag )

inline

Parameters

flag	indicating if JSON should be printed upon visualization

◆ setWindow() [1/2]

void bridges::Bridges::setWindow	(	int	xmin,
		int	xmax,
		int	ymin,
		int	ymax
	)

inline

Sets the world coordinate window defining the space of the user defined objects (or nodes)

Parameters

xmin	minimum window x
ymin	minimum window y
xmax	maximum window x
ymax	maximum window y

◆ setWindow() [2/2]

void bridges::Bridges::setWindow	(	double	xmin,
		double	xmax,
		double	ymin,
		double	ymax
	)

inline

sets the world coordinate window defining the space of the user defined objects (or nodes)

Parameters

xmin	minimum window x
ymin	minimum window y
xmax	maximum window x
ymax	maximum window y

◆ visualize()

void bridges::Bridges::visualize ( )

inline

Sends relevant meta-data and representation of the data structure to the BRIDGES server, and upon successful completion, prints the URL to display the Bridges visualization.

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

/home/erik/work/bridges/bridges-cxx/src/Bridges.h

Detailed Description

Public Member Functions

Constructor & Destructor Documentation

◆ Bridges() [1/3]

◆ Bridges() [2/3]

◆ Bridges() [3/3]

Member Function Documentation

◆ getApiKey()

◆ getAssignment()

◆ getCoordSystemType()

◆ getDataStructure()

◆ getDescription()

◆ getTitle()

◆ getUserName()

◆ getVisualizeJSONFlag()

◆ initialize()

◆ postVisualizationLink()

◆ setApiKey()

◆ setAssignment()

◆ setCoordSystemType()

◆ setDataStructure() [1/2]

◆ setDataStructure() [2/2]

◆ setDescription()

◆ setMapOverlay()

◆ setServer()

◆ setTitle()

◆ setUserName()

◆ setVisualizeJSONFlag()

◆ setWindow() [1/2]

◆ setWindow() [2/2]

◆ visualize()