#include <saftdabc/Device.h>

Inheritance diagram for saftdabc::Device:

Public Member Functions
void	AddEventStatistics (unsigned numevents)
	add numevents to the event ratemeter. More...

virtual const char *	ClassName () const
	Returns class name of the object instance. More...

bool	ClearConditions ()
	clean up all existing saftlib conditions More...

virtual dabc::Transport *	CreateTransport (dabc::Command cmd, const dabc::Reference &port)

virtual bool	DestroyByOwnThread ()
	here we may insert some actions to the device cleanup methods More...

	Device (const std::string &name, dabc::Command cmd)

virtual int	ExecuteCommand (dabc::Command cmd)
	Main method where commands are executed. More...

const std::string	GetInputDescription (guint64 event)
	Return text description of input belonging to given event id, e.g. More...

void	OnThreadAssigned ()
	need to start timeout here More...

bool	RegisterEventCondition (saftdabc::Input *receiver, guint64 id, guint64 mask, gint64 offset, unsigned char acceptflags)
	Register input event per id to snoop on NewCondition(bool active, guint64 id, guint64 mask, gint64 offset); acceptflags contain bitmask for accept flags: 0x1=late, 0x2=early, 0x4= conflict, 0x8=delayed first argument is pointer to input channel which shall receive timing event. More...

bool	RegisterInputCondition (saftdabc::Input *receiver, std::string &ioname)
	Register input of name to snoop on NewCondition(bool active, guint64 id, guint64 mask, gint64 offset); first argument is pointer to input channel which shall receive timing event. More...

void	SetInfo (const std::string &info, bool forceinfo=true)
	set info parameter. More...

virtual	~Device ()

Public Member Functions inherited from dabc::Worker
bool	ActivateTimeout (double tmout_sec)
	Method used to produce timeout events in the worker. More...

Command	Assign (Command cmd)
	! Assign command with processor before command be submitted to other processor This produce ReplyCommand() call when command execution is finished Command itself returned if operation was successful, otherwise null() command More...

void	AssignAddon (WorkerAddon *addon)
	Assigns addon to the worker Should be called before worker assigned to the thread. More...

bool	AssignToThread (ThreadRef thrd, bool sync=true)
	Assign worker to thread, worker becomes active immediately. More...

bool	CanSubmitCommand () const
	Returns true if command can be submitted to worker. More...

RecordField	Cfg (const std::string &name, Command cmd=nullptr) const
	Returns configuration field of specified name Configuration value of specified name searched in following places: More...

bool	DettachFromThread ()
	Detach worker from the thread, later worker can be assigned to some other thread Method especially useful to normally finish object recursion (if it possible). More...

bool	Execute (Command cmd, double tmout=-1.)
	Execute command in the processor. More...

bool	Execute (const std::string &cmd, double tmout=-1.)

bool	HasThread () const
	Indicates if pointer on thread is not zero; thread-safe. More...

bool	IsOwnThread () const
	Returns true if called from thread. More...

bool	MakeThreadForWorker (const std::string &thrdname="")
	Creates appropriate thread for worker and assign worker to the thread. More...

Parameter	Par (const std::string &name) const
	Returns reference on worker parameter object. More...

virtual std::string	RequiredThrdClass () const
	Method returns name of required thread class for processor. More...

void	SetWorkerPriority (int nq)

bool	Submit (Command cmd)
	Submit command for execution in the processor. More...

ThreadRef	thread ()
	Return reference on the worker thread; thread-safe. More...

std::string	ThreadName () const
	Returns name of the worker thread; thread-safe More...

	Worker (Reference parent, const std::string &name)

std::string	WorkerAddress (bool full=true)
	Return address, which can be used to submit command to the worker If full specified, command can be submitted from any node, which has connection to this node. More...

uint32_t	WorkerId () const

int	WorkerPriority () const

virtual	~Worker ()

Public Member Functions inherited from dabc::Object
bool	AddChild (Object *child, bool withmutex=true) throw ()
	Add object to list of child objects, thread safe More...

bool	AddChildAt (Object *child, unsigned pos, bool withmutex=true)
	Add object to list of child objects at specified position. More...

virtual void	BuildFieldsMap (RecordFieldsMap *cont)
	Fill fields map, which is relevant for the object Objects hierarchy produced from dabc::Manager. More...

Object *	FindChild (const char *name) const
	returns pointer on child object with given name More...

Reference	FindChildRef (const char *name, bool force=false) const throw ()
	returns reference on child object with given name More...

bool	GetAllChildRef (ReferencesVector *vect) const

Object *	GetChild (unsigned n) const
	returns pointer on child object More...

Reference	GetChildRef (unsigned n) const
	returns reference on child object More...

Reference	GetFolder (const std::string &name, bool force=false) throw ()
	Return folder of specified name, no special symbols allowed. More...

const char *	GetName () const
	Returns name of the object, thread safe More...

Object *	GetParent () const
	Returns pointer on parent object, thread safe More...

Reference	GetParentRef () const

bool	IsChildsHidden () const
	Return true if object wants to hide childs from hierarchy scan, thread safe More...

bool	IsHidden () const
	Return true if object wants to be hidden from hierarchy scan, thread safe More...

bool	IsLogging () const
	Return true if object selected for logging, thread safe More...

bool	IsName (const char *str) const
	Checks if object name is same as provided string, thread safe More...

bool	IsName (const char *str, int len) const
	Checks if object name is same as provided, thread safe More...

bool	IsName (const std::string &str) const
	Checks if object name is same as provided string, thread safe More...

bool	IsNameMatch (const std::string &mask) const
	Check if object name match to the mask. More...

bool	IsOwner () const
	Returns true if object is owner of its children, thread safe More...

bool	IsParent (Object *obj) const
	Checks if specified argument is in the list of object parents. More...

bool	IsTopXmlLevel () const
	Return true if object should be searched in the top level of the xml file, thread safe More...

std::string	ItemName (bool compact=true) const
	Produce string, which can be used as name argument in dabc::mgr.FindItem(name) call. More...

unsigned	NumChilds () const
	returns number of child objects More...

	Object (const std::string &name, unsigned flags=flIsOwner)
	Resolve problem with child-parent mutex locking. More...

	Object (Reference parent, const std::string &name, unsigned flags=flIsOwner)

virtual void	Print (int lvl=0)
	Print object content on debug output. More...

bool	RemoveChild (Object *child, bool cleanup=true) throw ()
	Detach child from parent object If cleanup==true and parent is owner of child, child will be destroyed. More...

bool	RemoveChildAt (unsigned n, bool cleanup=true) throw ()
	Detach child object from parent at specified position If cleanup==true and object is owner of child, child will be destroyed. More...

bool	RemoveChilds (bool cleanup=true)
	Remove all childs. More...

void	SetLogging (bool on=true)
	Sets logging flag, thread safe More...

virtual	~Object ()

Protected Member Functions
virtual void	ObjectCleanup ()
	Central cleanup method for worker. More...

void	RunGlibMainLoop ()
	this function keeps glib main loop alive. More...

void	SetDevInfoParName (const std::string &name)

Protected Member Functions inherited from dabc::Device
	Device (const std::string &name)

Mutex *	DeviceMutex () const
	Returns device mutex - it is just object mutex. More...

virtual bool	Find (ConfigIO &cfg)
	Method to locate object in xml file. More...

Protected Member Functions inherited from dabc::Worker
bool	_FireDoNothingEvent ()

bool	_FireEvent (uint16_t evid)

bool	_FireEvent (uint16_t evid, uint32_t arg, int pri=-1)

bool	_IsFireEvent () const

bool	ActivateMainLoop ()

virtual void	BeforeHierarchyScan (Hierarchy &h)
	Method called before publisher makes next snapshot of hierarchy. More...

void	CancelCommands ()

void	CleanupPublisher (bool sync=true)
	Release reference on publisher and unsubscribe/unpublish all registered entries. More...

CommandDefinition	CreateCmdDef (const std::string &name)

virtual Parameter	CreatePar (const std::string &name, const std::string &kind="")

bool	DestroyPar (const std::string &name)
	Method must be used if worker wants to destroy parameter. More...

virtual void	DoWorkerAfterMainLoop ()
	Internal - function executed after leaving main loop. More...

virtual void	DoWorkerMainLoop ()
	Internal - entrance function for main loop execution. More...

bool	ExecuteIn (Worker *dest, Command cmd)
	Executes command in specified worker. More...

bool	FireEvent (uint16_t evid)

bool	FireEvent (uint16_t evid, uint32_t arg, int pri=-1)

Reference	GetPublisher ()
	Return reference on publisher. More...

bool	IsWorkerActive () const
	Method indicates if worker is running in the thread and accepts normal events. More...

virtual void	ObjectDestroyed (Object *)
	Method to clear object reference, will be called from thread context (when possible) More...

virtual int	PreviewCommand (Command cmd)
	This method called before command will be executed. More...

virtual void	ProcessEvent (const EventId &)

virtual void	ProcessParameterEvent (const ParameterEvent &evnt)
	Interface method to retrieve subscribed parameter events. More...

virtual double	ProcessTimeout (double last_diff)

virtual bool	Publish (const Hierarchy &h, const std::string &path)

virtual bool	PublishPars (const std::string &path)

bool	RegisterForParameterEvent (const std::string &mask, bool onlychangeevent=true)
	Subscribe to parameter events from local or remote node. More...

virtual bool	ReplyCommand (Command cmd)
	Reimplement this method to react on command reply Return true if command can be destroyed by framework. More...

void	SetParValue (const std::string &name, const RecordField &v)
	Set parameter value and sync with worker hierarchy. More...

void	SetWorkerCfgId (int id=-1)
	Set identifier which can be used in XML configuration ${}# formula It means that correspondent to the ID element of array will be extracted. More...

bool	SingleLoop (double tmout)

virtual bool	Subscribe (const std::string &path)

virtual bool	Unpublish (const Hierarchy &h, const std::string &path)

bool	UnregisterForParameterEvent (const std::string &mask)
	Unsubscribe to parameter events from local or remote node. More...

virtual bool	Unsubscribe (const std::string &path)

	Worker (const ConstructorPair &pair)
	Special constructor, designed for inherited classes. More...

void	WorkerSleep (double tmout)

Protected Member Functions inherited from dabc::Object
virtual void	_ChildsChanged ()
	Method called when new childs are add or old are removed. More...

virtual bool	_DoDeleteItself ()
	This method is called at the moment when DecReference think that object can be destroyed and wants to return true. More...

bool	_IsNormalState ()
	Same as IsNormalState() but without mutex lock - user should lock mutex himself. More...

virtual Object *	CreateInstance (const std::string &name)
	Method used to create new item to be placed as child of the object. More...

void	DeleteThis ()
	Method should be used by the object to delete itself. More...

bool	DestroyCalledFromOwnThread ()
	Internal DABC method, should be called by thread which was requested to destroy object. More...

void	FillFullName (std::string &fullname, Object *upto, bool exclude_top_parent=false) const
	Method used to produce full item name,. More...

bool	GetFlag (unsigned fl) const
	Return value of selected flag, not thread safe More...

bool	IsNormalState ()
	Return true if object is in normal state. More...

unsigned	NumReferences ()
	Return number of references on the object. More...

	Object (const ConstructorPair &pair, unsigned flags=flIsOwner)

Mutex *	ObjectMutex () const
	Returns mutex, used for protection of Object data members. More...

void	SetAutoDestroy (bool on=true)
	Set autodestroy flag for the object Once enabled, object will be destroyed when last reference will be cleared. More...

void	SetFlag (unsigned fl, bool on=true)
	Change value of selected flag, not thread safe More...

void	SetName (const char *name)
	Changes object name. More...

void	SetNameDirect (const char *name)
	Changes object name disregard of existing references. More...

void	SetOwner (bool on=true)
	Specifies if object will be owner of its new childs. More...

Protected Attributes
std::vector< Glib::RefPtr< saftlib::SoftwareActionSink_Proxy > >	fActionSinks
	Helper vector to connect action sinks. More...

std::string	fBoardName
	name of the saftd attached board name, e.g. More...

dabc::Mutex	fConditionMutex
	Mutex to protect list of condition proxies. More...

std::vector< Glib::RefPtr< saftlib::SoftwareCondition_Proxy > >	fConditionProxies
	Helper vector to connect conditions. More...

std::string	fDevInfoName
	Name of info parameter for device messages. More...

Glib::RefPtr< Glib::MainLoop >	fGlibMainloop
	the glib main loop More...

std::map< Glib::ustring, guint64 >	fMap_PrefixName
	Translation table IO name <> prefix like in saft-io-ctl implementation. More...

Glib::RefPtr< saftlib::TimingReceiver_Proxy >	fTimingReceiver
	handle for the timing receiver instance More...

Protected Attributes inherited from dabc::Device
bool	fDeviceDestroyed
	if true, device and all transports should not be used More...

Protected Attributes inherited from dabc::Worker
WorkerAddonRef	fAddon
	extension of worker for some special events More...

Reference	fPublisher
	reference on publisher, once found, remain until end of object live More...

ThreadRef	fThread
	reference on the thread, once assigned remain whole time More...

Mutex *	fThreadMutex
	pointer on main thread mutex More...

bool	fWorkerActive
	indicates if worker can submit events to the thread More...

int	fWorkerCfgId
	special ID, can be used in XML configuration in ${}# formula More...

CommandsQueue	fWorkerCommands
	all kinds of commands, processed by the worker More...

int	fWorkerCommandsLevel
	Number of process commands recursion. More...

unsigned	fWorkerFiredEvents
	indicate current balance between fired and processed events, used to correctly halt worker More...

Hierarchy	fWorkerHierarchy
	place for publishing of worker parameters More...

uint32_t	fWorkerId
	worker id in thread list, used for events submit More...

int	fWorkerPriority
	priority of events, submitted by worker to the thread More...

Protected Attributes inherited from dabc::Object
int	fObjectBlock
	counter for blocking calls, as long as non-zero, non of child can be removed More...

ReferencesVector *	fObjectChilds
	list of the child objects More...

unsigned	fObjectFlags
	flag, protected by the mutex More...

Mutex *	fObjectMutex
	mutex protects all private property of the object More...

std::string	fObjectName
	object name More...

Reference	fObjectParent
	reference on the parent object More...

int	fObjectRefCnt
	accounts how many references existing on the object, thread safe More...

Additional Inherited Members
Public Types inherited from dabc::Worker
enum	EPriotiryLevels { priorityMaximum = 0 , priorityMinimum = -1 , priorityDefault = -7 , priorityMagic = -77 }

enum	EWorkerEventsCodes { evntFirstCore = 1 , evntFirstAddOn = 100 , evntFirstSystem = 200 , evntFirstUser = 1000 }

Static Public Member Functions inherited from dabc::Worker
static int	cmd_bool (bool v)

Static Public Member Functions inherited from dabc::Object
static void	Destroy (Object *obj) throw ()
	User method for object destroyment. More...

static void	InspectGarbageCollector ()
	\ brief Methods to inspect how many objects pointers are remained More...

static bool	NameMatch (const std::string &name, const std::string &mask)
	Check if name matches to specified mask. More...

static bool	NameMatchM (const std::string &name, const std::string &mask)
	Check if name matches to specified mask. More...

static unsigned	NumInstances ()
	Static variable counts total number of objects instances. More...

Protected Types inherited from dabc::Device
enum	EDeviceEvents { eventDeviceLast = evntFirstUser }

Protected Types inherited from dabc::Object
enum	EFlags { flStateMask = 0x000f , flIsOwner = 0x0010 , flCleanup = 0x0020 , flHasThread = 0x0040 , flAutoDestroy = 0x0080 , flLogging = 0x0100 , flNoMutex = 0x0200 , flHidden = 0x0400 , flChildsHidden = 0x0800 , flTopXmlLevel = 0x1000 }

Static Protected Member Functions inherited from dabc::Object
static ConstructorPair	MakePair (const std::string &fullname, bool withmanager=true)
	Internal DABC method, used to produce pair - object parent and object name, which is typically should be used as argument in class constructor. More...

static ConstructorPair	MakePair (Object *prnt, const std::string &fullname, bool withmanager=true)
	Internal DABC method, used to produce pair - object parent and object name, which is typically should be used as argument in class constructor. More...

static ConstructorPair	MakePair (Reference prnt, const std::string &fullname, bool withmanager=true)
	Internal DABC method, used to produce pair - object parent and object name, which is typically should be used as argument in class constructor. More...

Detailed Description

Definition at line 67 of file Device.h.

Constructor & Destructor Documentation

◆ Device()

saftdabc::Device::Device	(	const std::string &	name,
		dabc::Command	cmd
	)

Definition at line 29 of file Device.cxx.

◆ ~Device()

saftdabc::Device::~Device ( )

virtual

Reimplemented from dabc::Device.

Definition at line 86 of file Device.cxx.

Member Function Documentation

◆ OnThreadAssigned()

void saftdabc::Device::OnThreadAssigned ( )

virtual

need to start timeout here

Reimplemented from dabc::Worker.

Definition at line 61 of file Device.cxx.

◆ DestroyByOwnThread()

bool saftdabc::Device::DestroyByOwnThread ( )

virtual

here we may insert some actions to the device cleanup methods

Reimplemented from dabc::Worker.

Definition at line 92 of file Device.cxx.

◆ ClassName()

virtual const char* saftdabc::Device::ClassName ( ) const

inlinevirtual

Returns class name of the object instance.

In some cases class name used to correctly locate object in xml file

Reimplemented from dabc::Device.

Definition at line 82 of file Device.h.

◆ ExecuteCommand()

int saftdabc::Device::ExecuteCommand ( dabc::Command cmd )

virtual

Main method where commands are executed.

Reimplemented from dabc::Device.

Definition at line 114 of file Device.cxx.

◆ CreateTransport()

dabc::Transport * saftdabc::Device::CreateTransport	(	dabc::Command	cmd,
		const dabc::Reference &	port
	)

virtual

Reimplemented from dabc::Device.

Definition at line 154 of file Device.cxx.

◆ ClearConditions()

bool saftdabc::Device::ClearConditions ( )

clean up all existing saftlib conditions

Definition at line 431 of file Device.cxx.

◆ RegisterInputCondition()

bool saftdabc::Device::RegisterInputCondition	(	saftdabc::Input *	receiver,
		std::string &	ioname
	)

Register input of name to snoop on NewCondition(bool active, guint64 id, guint64 mask, gint64 offset); first argument is pointer to input channel which shall receive timing event.

Definition at line 193 of file Device.cxx.

◆ RegisterEventCondition()

bool saftdabc::Device::RegisterEventCondition	(	saftdabc::Input *	receiver,
		guint64	id,
		guint64	mask,
		gint64	offset,
		unsigned char	acceptflags
	)

Register input event per id to snoop on NewCondition(bool active, guint64 id, guint64 mask, gint64 offset); acceptflags contain bitmask for accept flags: 0x1=late, 0x2=early, 0x4= conflict, 0x8=delayed first argument is pointer to input channel which shall receive timing event.

Definition at line 296 of file Device.cxx.

◆ GetInputDescription()

const std::string saftdabc::Device::GetInputDescription ( guint64 event )

Return text description of input belonging to given event id, e.g.

"IO2 rising". Will be put into event data for unique identification in data stream

Definition at line 361 of file Device.cxx.

◆ AddEventStatistics()

void saftdabc::Device::AddEventStatistics ( unsigned numevents )

add numevents to the event ratemeter.

For webgui.

Definition at line 425 of file Device.cxx.

◆ SetInfo()

void saftdabc::Device::SetInfo	(	const std::string &	info,
		bool	forceinfo = `true`
	)

set info parameter.

For webgui.

Definition at line 178 of file Device.cxx.

◆ RunGlibMainLoop()

void saftdabc::Device::RunGlibMainLoop ( )

protected

this function keeps glib main loop alive.

Runs in main thread of the device

Definition at line 73 of file Device.cxx.

◆ ObjectCleanup()

void saftdabc::Device::ObjectCleanup ( )

protectedvirtual

Central cleanup method for worker.

Reimplemented from dabc::Device.

Definition at line 107 of file Device.cxx.

◆ SetDevInfoParName()

void saftdabc::Device::SetDevInfoParName ( const std::string & name )

inlineprotected

Definition at line 135 of file Device.h.

Field Documentation

◆ fBoardName

std::string saftdabc::Device::fBoardName

protected

name of the saftd attached board name, e.g.

baseboard

Definition at line 145 of file Device.h.

◆ fDevInfoName

std::string saftdabc::Device::fDevInfoName

protected

Name of info parameter for device messages.

Definition at line 149 of file Device.h.

◆ fGlibMainloop

Glib::RefPtr<Glib::MainLoop> saftdabc::Device::fGlibMainloop

protected

the glib main loop

Definition at line 167 of file Device.h.

◆ fTimingReceiver

Glib::RefPtr<saftlib::TimingReceiver_Proxy> saftdabc::Device::fTimingReceiver

protected

handle for the timing receiver instance

Definition at line 170 of file Device.h.

◆ fConditionProxies

std::vector<Glib::RefPtr<saftlib::SoftwareCondition_Proxy> > saftdabc::Device::fConditionProxies

protected

Helper vector to connect conditions.

Definition at line 173 of file Device.h.

◆ fActionSinks

std::vector<Glib::RefPtr<saftlib::SoftwareActionSink_Proxy> > saftdabc::Device::fActionSinks

protected

Helper vector to connect action sinks.

Definition at line 176 of file Device.h.

◆ fMap_PrefixName

std::map<Glib::ustring, guint64> saftdabc::Device::fMap_PrefixName

protected

Translation table IO name <> prefix like in saft-io-ctl implementation.

Definition at line 180 of file Device.h.

◆ fConditionMutex

dabc::Mutex saftdabc::Device::fConditionMutex

protected

Mutex to protect list of condition proxies.

Definition at line 186 of file Device.h.

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

plugins/saft/saftdabc/Device.h
plugins/verbs/src/Device.cxx

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Device()

◆ ~Device()

Member Function Documentation

◆ OnThreadAssigned()

◆ DestroyByOwnThread()

◆ ClassName()

◆ ExecuteCommand()

◆ CreateTransport()

◆ ClearConditions()

◆ RegisterInputCondition()

◆ RegisterEventCondition()

◆ GetInputDescription()

◆ AddEventStatistics()

◆ SetInfo()

◆ RunGlibMainLoop()

◆ ObjectCleanup()

◆ SetDevInfoParName()

Field Documentation

◆ fBoardName

◆ fDevInfoName

◆ fGlibMainloop

◆ fTimingReceiver

◆ fConditionProxies

◆ fActionSinks

◆ fMap_PrefixName

◆ fConditionMutex