libSBOL  2.3.3
Static Public Member Functions | List of all members
Config Class Reference

Detailed Description

A class which contains global configuration variables for the libSBOL environment. Intended to be used like a static class, configuration variables are accessed through the Config::setOptions and Config::getOptions methods.

Static Public Member Functions

static void setOption (std::string option, std::string value)
 Configure options for libSBOL. More...
 
static std::string getOption (std::string option)
 Get current option value for online validation and conversion. More...
 

Member Function Documentation

◆ getOption()

std::string getOption ( std::string  option)
static

Get current option value for online validation and conversion.

Parameters
optionThe option key

◆ setOption()

void setOption ( std::string  option,
std::string  value 
)
static

Configure options for libSBOL.

Access online validation and conversion.

Option Description Values
homespace Enable validation and conversion requests through the online validator http://examples.org
sbol_compliant_uris Enables autoconstruction of SBOL-compliant URIs from displayIds True or False
sbol_typed_uris Include the SBOL type in SBOL-compliant URIs True or False
output_format File format for serialization True or False
validate Enable validation and conversion requests through the online validator True or False
validator_url The http request endpoint for validation A valid URL, set to
http://www.async.ece.utah.edu/sbol-validator/endpoint.php by default
language File format for conversion SBOL2, SBOL1, FASTA, GenBank
test_equality Report differences between two files True or False
check_uri_compliance If set to false, URIs in the file will not be checked for compliance
with the SBOL specification
True or False
check_completeness If set to false, not all referenced objects must be described within
the given main_file
True or False
check_best_practices If set to true, the file is checked for the best practice rules set
in the SBOL specification
True or False
fail_on_first_error If set to true, the validator will fail at the first error True or False
provide_detailed_stack_trace If set to true (and failOnFirstError is true) the validator will
provide a stack trace for the first validation error
True or False
uri_prefix Required for conversion from FASTA and GenBank to SBOL1 or SBOL2,
used to generate URIs
True or False
version Adds the version to all URIs and to the document A valid Maven version string
return_file Whether or not to return the file contents as a string True or False
Parameters
optionThe option key
valueThe option value

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