python.TrigValSteering.Input Namespace Reference

Classes
class	TrigValInput

Functions
def	load_input_json ()
def	is_input_defined (keyword)
def	get_input (keyword)

Variables
	input_json

Function Documentation

get_input()

def python.TrigValSteering.Input.get_input

(

keyword

)

Common getter function to retrieve inputs by keyword

Definition at line 96 of file Input.py.

def get_input(keyword):
    '''Common getter function to retrieve inputs by keyword'''
 
    log = get_logger()
 
    data = load_input_json()
    if keyword not in data.keys():
        log.error('Failed to find keyword "%s" in input JSON %s',
                  keyword, input_json)
        return None
 
    data_object = data[keyword]
 
    result = TrigValInput(
        keyword,
        data_object["source"],
        data_object["format"],
        data_object["paths"]
    )
 
    if result.is_valid():
        return result
    else:
        log.error('Failed to create a valid input object')
        return None

is_input_defined()

def python.TrigValSteering.Input.is_input_defined

(

keyword

)

Checks if the keyword exists in the input json file

Definition at line 90 of file Input.py.

def is_input_defined(keyword):
    '''Checks if the keyword exists in the input json file'''
    data = load_input_json()
    return keyword in data
 
 

load_input_json()

def python.TrigValSteering.Input.load_input_json

(

)

Reads the json file with input definitions and returns the data as dictionary

Definition at line 75 of file Input.py.

def load_input_json():
    '''Reads the json file with input definitions and returns the data as dictionary'''
 
    log = get_logger()
 
    input_json_fullpath = find_file_in_path(input_json, 'DATAPATH')
    if not input_json_fullpath:
        log.error('Failed to determine full path for input JSON %s', input_json)
        return None
 
    log.debug('Reading %s', input_json_fullpath)
    with open(input_json_fullpath) as data_file:
        return json.load(data_file)
 
 

Variable Documentation

input_json

python.TrigValSteering.Input.input_json

Definition at line 16 of file Input.py.