cmlabs::SignalSpec Struct Reference

Specification of a signal (a typed notification without payload) emitted when a trigger fires. More...

#include <Subscriptions.h>

Collaboration diagram for cmlabs::SignalSpec:

Public Member Functions
std::string	toXML ()
	Serialise as a <signal .../> XML element.
bool	fromXML (const char *xml)
	Parse from an XML string containing a <signal .../> element.
bool	fromXML (XMLNode &node)

Public Attributes
PsyType	type
	Type of the signal to emit.
char	name [MAXKEYNAMELEN+1]
	Name of this signal spec.

Detailed Description

Specification of a signal (a typed notification without payload) emitted when a trigger fires.

Definition at line 409 of file Subscriptions.h.

Member Function Documentation

fromXML() [1/2]

bool cmlabs::SignalSpec::fromXML ( const char * xml )

inline

Parse from an XML string containing a <signal .../> element.

Parameters

xml

XML text.

Returns

true if valid.

Definition at line 417 of file Subscriptions.h.

References cmlabs::XMLResults::error, cmlabs::eXMLErrorNone, fromXML(), and cmlabs::XMLNode::isEmpty().

Referenced by fromXML(), Java_com_cmlabs_cmsdk_cmsdkJNI_SignalSpec_1fromXML_1_1SWIG_10(), and cmlabs::TriggerSpec::UnitTest().

fromXML() [2/2]

bool cmlabs::SignalSpec::fromXML ( XMLNode & node )

inline

Definition at line 426 of file Subscriptions.h.

References cmlabs::XMLNode::getAttribute(), MAXKEYNAMELEN, name, cmlabs::utils::strcpyavail(), and type.

toXML()

std::string cmlabs::SignalSpec::toXML ( )

inline

Serialise as a <signal .../> XML element.

Definition at line 413 of file Subscriptions.h.

References name, cmlabs::utils::StringFormat(), and type.

Referenced by cmlabs::TriggerSpec::toXML(), and cmlabs::TriggerSpec::UnitTest().

Member Data Documentation

name

char cmlabs::SignalSpec::name[MAXKEYNAMELEN+1]

Name of this signal spec.

Definition at line 411 of file Subscriptions.h.

Referenced by _wrap_SignalSpec_name_set(), _wrap_SignalSpec_name_set(), fromXML(), cmlabs::TriggerSpec::getSignalSpec(), Java_com_cmlabs_cmsdk_cmsdkJNI_SignalSpec_1name_1set(), toXML(), and cmlabs::TriggerSpec::UnitTest().

type

PsyType cmlabs::SignalSpec::type

Type of the signal to emit.

Definition at line 410 of file Subscriptions.h.

Referenced by cmlabs::PsyAPI::emitSignal(), fromXML(), cmlabs::TriggerSpec::getSignalSpec(), toXML(), cmlabs::TriggerSpec::UnitTest(), and cmlabs::PsyAPI::waitForSignal().

---

The documentation for this struct was generated from the following file:

• /home/ubuntu/c/partner/psyclone2/CMSDK/include/Subscriptions.h