#include <IsActive.h>

Inheritance diagram for CIsActive:

Collaboration diagram for CIsActive:

Public Member Functions
	CIsActive (Tcl_Interp *pInterp, DAQ::DDAS::Configuration &config)

virtual	~CIsActive ()

virtual int	operator() (std::vector< Tcl_Obj * > &objv)

Public Member Functions inherited from CTclCommand
	CTclCommand (Tcl_Interp pInterp, const char cmdName)

virtual	~CTclCommand ()

virtual int	operator() (std::vector< Tcl_Obj * > &argv)=0

Additional Inherited Members
Protected Member Functions inherited from CTclCommand
Tcl_Interp *	getInterpreter ()

void	requireExactly (std::vector< Tcl_Obj * > &objv, int nParams)

void	requireAtMost (std::vector< Tcl_Obj * > &objv, int max)

void	setResult (const char *result)

void	setResult (Tcl_Obj *result)

void	setResult (double value)

void	setResult (int value)

int	getInteger (Tcl_Obj *intObj)

double	getDouble (Tcl_Obj *dblObj)

Detailed Description

Returns information about which modules are actively taking data. The command, pixie16::isActive can be issued either with no parameters or with a module number parameter. If issued with a module number the active state of that module is returned as the result as a bool. Without a parameter it will produce a list of module statuses for each module in the configuration. This list will contain a first element which is the or of the status of all elements (e.g. a boolean that is true if any module in the configuration is active an false if none are). The remaining elements are three elements sublists that contain, in order the following elements:

Module id. (unsigned integer)
Slot Number (unsigned integer).
Status (bool true if active, false if not)

Constructor & Destructor Documentation

◆ CIsActive()

CIsActive::CIsActive	(	Tcl_Interp *	pInterp,
		DAQ::DDAS::Configuration &	config
	)

constructor Construct the command.

Parameters

pInterp	- Interpreter on which the command will be registered.
config	- Reference to the module configuration.

◆ ~CIsActive()

CIsActive::~CIsActive ( )

virtual

destructor

Member Function Documentation

◆ operator()()

int CIsActive::operator() ( std::vector< Tcl_Obj * > & objv )

virtual

operator() Executes the command.

Parameters

objv	- the command words.

Returns: int - TCL_OK On success, TCL_ERROR on failure.

Note: see the header comments for a description of the result on a successful return. on a TCL_ERROR, the result contains a human readable error message.

Implements CTclCommand.

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