appfwk.utils Namespace Reference

Functions
	mspec (inst, plugin, conn_refs)
	acmd (list mods)
	mcmd (str cmdid, list mods)
	mrccmd (cmdid, instate, outstate, mods)

Function Documentation

acmd()

appfwk.utils.acmd

(

list

mods

)

Helper function to create appfwk's CmdObj of Addressed module commands.
    
:param      cmdid:  The coommand id
:type       cmdid:  str
:param      mods:   List of module name/data structures 
:type       mods:   list

:returns:   A constructed Command object
:rtype:     dunedaq.appfwk.cmd.Command

Definition at line 35 of file utils.py.

def acmd(mods: list):
    """ 
    Helper function to create appfwk's CmdObj of Addressed module commands.
        
    :param      cmdid:  The coommand id
    :type       cmdid:  str
    :param      mods:   List of module name/data structures 
    :type       mods:   list
    
    :returns:   A constructed Command object
    :rtype:     dunedaq.appfwk.cmd.Command
    """
    return cmd.CmdObj(
        modules=cmd.AddressedCmds(
            cmd.AddressedCmd(match=m, data=o)
            for m,o in mods
        )
    )
 

mcmd()

appfwk.utils.mcmd	(	str	cmdid,
		list	mods )

Helper function to create appfwk's Commands addressed to modules.

:param      cmdid:  The coommand id
:type       cmdid:  str
:param      mods:   List of module name/data structures 
:type       mods:   list

:returns:   A constructed Command object
:rtype:     dunedaq.appfwk.cmd.Command

Definition at line 54 of file utils.py.

def mcmd(cmdid: str, mods: list):
    """
    Helper function to create appfwk's Commands addressed to modules.
    
    :param      cmdid:  The coommand id
    :type       cmdid:  str
    :param      mods:   List of module name/data structures 
    :type       mods:   list
    
    :returns:   A constructed Command object
    :rtype:     dunedaq.appfwk.cmd.Command
    """
    return ccmd.Command(
        id=ccmd.CmdId(cmdid),
        data=acmd(mods)
    )
 

mrccmd()

appfwk.utils.mrccmd	(		cmdid,
			instate,
			outstate,
			mods )

Helper function to create appfwk's Commands addressed to modules.

:param      cmdid:  The coommand id
:type       cmdid:  str
:param      instate:  The state before command execution
:type       instate:  str
:param      outstate:  The state after command execution
:type       outstate:  str
:param      mods:   List of module name/data structures 
:type       mods:   list

:returns:   A constructed Command object
:rtype:     dunedaq.rcif.cmd.RCCommand

Definition at line 71 of file utils.py.

def mrccmd(cmdid, instate, outstate, mods):
    """
    Helper function to create appfwk's Commands addressed to modules.
    
    :param      cmdid:  The coommand id
    :type       cmdid:  str
    :param      instate:  The state before command execution
    :type       instate:  str
    :param      outstate:  The state after command execution
    :type       outstate:  str
    :param      mods:   List of module name/data structures 
    :type       mods:   list
    
    :returns:   A constructed Command object
    :rtype:     dunedaq.rcif.cmd.RCCommand
    """
    return rccmd.RCCommand(
        id=ccmd.CmdId(cmdid),
        entry_state=rccmd.State(instate),
        exit_state=rccmd.State(outstate),
        data=cmd.CmdObj(
            modules=cmd.AddressedCmds(
                cmd.AddressedCmd(match=m, data=o)
                for m,o in mods
            )
        )
    )
 

mspec()

appfwk.utils.mspec	(		inst,
			plugin,
			conn_refs )

Helper function to create Module Specification objects

:param      inst:    Instance
:type       inst:    str
:param      plugin:  Appfwk Module Plugin name
:type       plugin:  str
:param      cinfos:  List of dunedaq.iomanager.ConnectionRef objects
:type       cinfos:  list

:returns:   A constructed ModSpec object
:rtype:     dunedaq.appfwk.app.ModSpec

Definition at line 15 of file utils.py.

def mspec(inst, plugin, conn_refs):
    """
    Helper function to create Module Specification objects
    
    :param      inst:    Instance
    :type       inst:    str
    :param      plugin:  Appfwk Module Plugin name
    :type       plugin:  str
    :param      cinfos:  List of dunedaq.iomanager.ConnectionRef objects
    :type       cinfos:  list
    
    :returns:   A constructed ModSpec object
    :rtype:     dunedaq.appfwk.app.ModSpec
    """
    return app.ModSpec(inst=inst, plugin=plugin,
            data=app.ModInit(
                conn_refs=app.ConnectionReferences_t(conn_refs)
                )
            )