channelfinder::cfUpdate::CFUpdateIOC Namespace Reference

Functions
def	getArgsFromFilename
def	getPVNames
def	updateChannelFinder
def	updateChannel
def	createChannel
def	checkPropertiesExist
def	ifNoneReturnDefault
def	mainRun
def	main
def	getPassword

---

Detailed Description

Copyright (c) 2010 Brookhaven National Laboratory
All rights reserved. Use is subject to license terms and conditions.

Created on Apr 1, 2011

@author: shroffk

CFUpdateIOC provides a command like client to update channelfinder
with a list of process variables (usually the output of the dbl command).

---

Function Documentation

def channelfinder::cfUpdate::CFUpdateIOC::checkPropertiesExist	(		client,
			propOwner
	)

Checks if the properties used by dbUpdate are present if not it creates them

def channelfinder::cfUpdate::CFUpdateIOC::createChannel	(		chName,
			chOwner,
			hostName = None,
			iocName = None
	)

Helper to create a channel object with the required properties

def channelfinder::cfUpdate::CFUpdateIOC::getPassword	(		option,
			opt_str,
			value,
			parser
	)

Simple method to prompt user for password
TODO do not show the password.

def channelfinder::cfUpdate::CFUpdateIOC::ifNoneReturnDefault	(		object,
			default
	)

if the object is None or empty string then this function returns the default value

def channelfinder::cfUpdate::CFUpdateIOC::mainRun	(		opts,
			args
	)

the main is broken so that the unit test can use mock opt objects for testing

def channelfinder::cfUpdate::CFUpdateIOC::updateChannel	(		channel,
			owner,
			hostName = None,
			iocName = None
	)

Helper to update a channel object so as to not affect the existing properties

def channelfinder::cfUpdate::CFUpdateIOC::updateChannelFinder	(		pvNames,
			hostName,
			iocName,
			owner,
			service = None,
			username = None,
			password = None
	)

pvNames = list of pvNames 
([] permitted will effectively remove the hostname, iocname from all channels)
hostName = pv hostName (None not permitted)
iocName = pv iocName (None not permitted)
owner = the owner of the channels and properties being added, this can be different from the user
e.g. user = abc might create a channel with owner = group-abc
[optional] if not specified the default values are used by the 
channelfinderapi lib
service = channelfinder service URL
username = channelfinder username
password = channelfinder password