Bridges-Python-3.0.2  3.0.2
Bridges(PythonAPI)
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
bridges.connector.Connector Class Reference

Detailed Description

This is a class for handling calls to the BRIDGES server to transmit JSON to the server and subsequent visualization.

It is not intended for external use

Public Member Functions

def __init__ (self, key, username, assignment)
 Connector object constructor. More...
 
def set_server (self, server)
 Set the server based on a keyword for url. More...
 
def set_server_url (self, server_url)
 
def get_server_url (self)
 
def post (self, url, data)
 
def prepare (self, url)
 

Public Attributes

 key
 
 username
 
 assignment
 
 server_url
 

Static Public Attributes

string server_url_live = "http://bridges-cs.herokuapp.com"
 
string server_type = "application"
 
string server_url_clone = "http://bridges-clone.herokuapp.com"
 
string server_url_local = "http://127.0.0.1:3000"
 
string server_url_game = "http://bridges-games.herokuapp.com"
 
string key = ""
 
string username = ""
 
int pattern_found = 0
 
bool debug = False
 

Constructor & Destructor Documentation

◆ __init__()

def bridges.connector.Connector.__init__ (   self,
  key,
  username,
  assignment 
)

Connector object constructor.

Parameters
keyis the user_key
usernameis students username
assignmentis the assignment number for the assignment

Member Function Documentation

◆ get_server_url()

def bridges.connector.Connector.get_server_url (   self)

◆ post()

def bridges.connector.Connector.post (   self,
  url,
  data 
)

◆ prepare()

def bridges.connector.Connector.prepare (   self,
  url 
)

◆ set_server()

def bridges.connector.Connector.set_server (   self,
  server 
)

Set the server based on a keyword for url.

Parameters
serveris one of the three string keywords('live', 'clone', 'local') that is passed to change the server that the bridges visualization will be sent to

◆ set_server_url()

def bridges.connector.Connector.set_server_url (   self,
  server_url 
)

Member Data Documentation

◆ assignment

bridges.connector.Connector.assignment

◆ debug

bool bridges.connector.Connector.debug = False
static

◆ key [1/2]

string bridges.connector.Connector.key = ""
static

◆ key [2/2]

bridges.connector.Connector.key

◆ pattern_found

int bridges.connector.Connector.pattern_found = 0
static

◆ server_type

string bridges.connector.Connector.server_type = "application"
static

◆ server_url

bridges.connector.Connector.server_url

◆ server_url_clone

string bridges.connector.Connector.server_url_clone = "http://bridges-clone.herokuapp.com"
static

◆ server_url_game

string bridges.connector.Connector.server_url_game = "http://bridges-games.herokuapp.com"
static

◆ server_url_live

string bridges.connector.Connector.server_url_live = "http://bridges-cs.herokuapp.com"
static

◆ server_url_local

string bridges.connector.Connector.server_url_local = "http://127.0.0.1:3000"
static

◆ username [1/2]

string bridges.connector.Connector.username = ""
static

◆ username [2/2]

bridges.connector.Connector.username

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