Server API

Farmer

Pool API

class concert_software_farmer.pool.SoftwarePool

Bases: object

maintains scanned software in ros package path.

get_profile(resource_name)

Returns the profile of given resource name

Returns:Software profile object Return type:SoftwareProfile Raises:SoftwareNotExistException if the software profile is not available in pool

status()

Returns the current software pool status

Returns:Avaialble Software profiles, Invalid software profiles Return type:dict, dict

class concert_software_farmer.pool.SoftwareProfile(resource_name, filepath)

Bases: object

parses software profile from file path.

to_msg()

validate_parameters(given)

validates the given parameter is usable for this software.

Parameters:rocon_std_msgs/KeyValue[] (given) – parameter to validate Returns:whether it is successful or not, the updated parameters, msg Rtypes:bool, [rocon_std_msgs.KeyValue], str

Instance API

class concert_software_farmer.instance.SoftwareInstance(profile, parameters)

Bases: object

Maintains runtime information of software. Such as users, parameters

add_user(user)

Add user to already running software instance

get_namespace()

Returns the software instance namespace

get_parameters()

Returns the software instance parameters

is_max_capacity()

Check if the software instance has reached it’s max capacity

kill_timeout = 10

remove_user(user)

remove user from running software instance

shutdown_timeout = 5

start(user)

Starts software for given user

Parameters:str (user) – user name Returns:whether it is success of not Return type:bool

stop()

stops the software instance

Returns:whether it is success of not Return type:bool

to_msg()

returns data as message format

Returns:Software Instance data as message format Return type:concert_msgs.msg.SoftwareInstance