ARN Item QML. More...

#include <ArnQml.hpp>

Inheritance diagram for ArnItemQml:

[legend]

Collaboration diagram for ArnItemQml:

[legend]

Public Slots
void	setBits (int mask, int value)
	AtomicOp assign an integer to specified bits in an Arn Data Object More...

void	addIntNum (int value)
	AtomicOp adds an integer to an Arn Data Object More...

void	addNum (double value)
	AtomicOp adds an ARNREAL to an Arn Data Object More...

void	addMode (ArnInterface::ObjectMode mode)
	Add general mode settings for this Arn Data Object More...

ArnInterface::ObjectMode	getMode () const

Public Slots inherited from ArnItem
void	setValue (int value)
	Assign an integer to an Arn Data Object More...

void	setValue (double value)
	Assign an ARNREAL to an Arn Data Object More...

void	setValue (bool value)
	Assign a bool to an Arn Data Object More...

void	setValue (const QString &value)
	Assign a QString to an Arn Data Object More...

void	setValue (const QByteArray &value)
	Assign a QByteArray to an Arn Data Object More...

void	setValue (const QVariant &value)
	Assign a QVariant to an Arn Data Object More...

void	setValue (const char *value)
	Assign a char* to an Arn Data Object More...

void	toggleBool ()
	Toggle the bool at the Arn Data Object More...

Properties
QString	variantType
	The type used inside the variant, e.g. QString. More...

bool	useUuid
	Select to use ArnItem::openUuid() More...

QString	path
	The path of this ArnItem. More...

ArnInterface::DataType	type
	The Arn data type of this ArnItem. More...

QVariant	variant
	The ArnItem value as a QVariant. More...

QString	string
	The ArnItem value as a QString. More...

QByteArray	bytes
	The ArnItem value as a QByteArray. More...

double	num
	The ArnItem value as an ARNREAL. More...

int	intNum
	The ArnItem value as an int. More...

bool	biDirMode
	See Arn::ObjectMode::BiDir. More...

bool	pipeMode
	See Arn::ObjectMode::Pipe. More...

bool	saveMode
	See Arn::ObjectMode::Save. More...

bool	masterMode
	See Arn::ObjectSyncMode::Master. More...

bool	autoDestroyMode
	See Arn::ObjectSyncMode::AutoDestroy. More...

bool	atomicOpProvider
	See ArnBasicItem::setAtomicOpProvider() More...

bool	ignoreSameValue
	See ArnItem::setIgnoreSameValue() More...

int	delay
	See ArnItem::setDelay() More...

Additional Inherited Members
Signals inherited from ArnItem
void	changed ()
	Signals emitted when data in Arn Data Object is changed. More...

void	changed (int value)

void	changed (double value)

void	changed (bool value)

void	changed (const QString &value)

void	changed (const QByteArray &value)

void	changed (const QVariant &value)

void	modeChanged (Arn::ObjectMode mode)
	Signal emitted when mode in Arn Data Object is changed. More...

void	arnItemCreated (const QString &path)
	Signal emitted when an Arn Data Object is created in the tree below. More...

void	arnModeChanged (const QString &path, uint linkId, Arn::ObjectMode mode)
	Signal emitted when an Arn Data Object in the tree below has a general mode change. More...

Signals inherited from ArnItemB
void	arnLinkDestroyed ()
	Signal emitted when the Arn Data Object is destroyed. More...

Public Member Functions inherited from ArnItem
	ArnItem (QObject *parent=arnNullptr)
	Standard constructor of a closed handle. More...

	ArnItem (const QString &path, QObject *parent=arnNullptr)
	Construction of a handle to a path. More...

	ArnItem (const ArnItem &itemTemplate, const QString &path, QObject *parent=arnNullptr)
	Construction of a handle to a path with a template for modes More...

virtual	~ArnItem ()

bool	openUuid (const QString &path)
	Open a handle to an Arn Object with a unique uuid name. More...

bool	openUuidPipe (const QString &path)
	Open a handle to an Arn Pipe Object with a unique uuid name. More...

bool	openFolder (const QString &path)
	Open a handle to an Arn folder. More...

bool	isFolder () const

bool	isProvider () const

Arn::DataType	type () const
	The type stored in the Arn Data Object More...

void	setIgnoreSameValue (bool isIgnore=true)
	Set skipping assignment of equal value. More...

bool	isIgnoreSameValue ()

void	addMode (Arn::ObjectMode mode)
	Add general mode settings for this Arn Data Object More...

Arn::ObjectMode	getMode () const

Arn::ObjectSyncMode	syncMode () const

ArnItem &	setTemplate (bool isTemplate=true)
	Mark this ArnItem as a template. More...

bool	isTemplate () const

ArnItem &	setBiDirMode ()
	Set general mode as Bidirectional for this Arn Data Object More...

bool	isBiDirMode () const

ArnItem &	setPipeMode ()
	Set general mode as Pipe for this Arn Data Object More...

bool	isPipeMode () const

ArnItem &	setSaveMode ()
	Set general mode as Save for this Arn Data Object More...

bool	isSaveMode () const

ArnItem &	setMaster ()
	Set client session sync mode as Master for this ArnItem. More...

bool	isMaster () const

ArnItem &	setAutoDestroy ()
	Set client session sync mode as AutoDestroy for this ArnItem. More...

bool	isAutoDestroy () const

void	setUncrossed (bool isUncrossed=true)
	Set a Bidirectional item as Uncrossed. More...

bool	isUncrossed () const
	Get the Uncrossed state of an object. More...

void	setBlockEcho (bool blockEcho=true)
	Control echo cancellation for this item. More...

void	setDelay (int delay)
	Set delay of data changed signal. More...

int	delay () const
	Get delay of data changed signal. More...

bool	isDelayPending () const

void	bypassDelayPending ()

void	arnImport (const QByteArray &data, int ignoreSame=Arn::SameValue::DefaultAction)
	Import data to an Arn Data Object More...

QByteArray	arnExport () const

int	toInt (bool *isOk=arnNullptr) const

double	toDouble (bool *isOk=arnNullptr) const

ARNREAL	toReal (bool *isOk=arnNullptr) const

bool	toBool (bool *isOk=arnNullptr) const

QString	toString (bool *isOk=arnNullptr) const

QByteArray	toByteArray (bool *isOk=arnNullptr) const

QVariant	toVariant (bool *isOk=arnNullptr) const

uint	toUInt (bool *isOk=arnNullptr) const

qint64	toInt64 (bool *isOk=arnNullptr) const

quint64	toUInt64 (bool *isOk=arnNullptr) const

ArnItem &	operator= (const ArnItem &other)

ArnItem &	operator= (int val)

ArnItem &	operator= (ARNREAL other)

ArnItem &	operator= (const QString &val)

ArnItem &	operator= (const QByteArray &val)

ArnItem &	operator= (const QVariant &val)

ArnItem &	operator= (const char *val)

ArnItem &	operator= (uint val)

ArnItem &	operator= (qint64 val)

ArnItem &	operator= (quint64 val)

ArnItem &	operator+= (int val)

ArnItem &	operator+= (ARNREAL val)

void	setValue (const ArnItem &other, int ignoreSame=Arn::SameValue::DefaultAction)
	Assign the value of an other ArnItem to an Arn Data Object More...

void	setValue (uint value, int ignoreSame=Arn::SameValue::DefaultAction)
	Assign an unsigned int to an Arn Data Object More...

void	setValue (qint64 value, int ignoreSame=Arn::SameValue::DefaultAction)
	Assign an int 64 bit to an Arn Data Object More...

void	setValue (quint64 value, int ignoreSame=Arn::SameValue::DefaultAction)
	Assign an unsigned int 64 bit to an Arn Data Object More...

void	setValue (int value, int ignoreSame)
	Assign an integer to an Arn Data Object More...

void	setValue (double value, int ignoreSame)
	Assign an ARNREAL to an Arn Data Object More...

void	setValue (bool value, int ignoreSame)
	Assign a bool to an Arn Data Object More...

void	setValue (const QString &value, int ignoreSame)
	Assign a QString to an Arn Data Object More...

void	setValue (const QByteArray &value, int ignoreSame)
	Assign a QByteArray to an Arn Data Object More...

void	setValue (const QVariant &value, int ignoreSame)
	Assign a QVariant to an Arn Data Object More...

void	setValue (const char *value, int ignoreSame)
	Assign a char* to an Arn Data Object More...

void	setBits (int mask, int value, int ignoreSame=Arn::SameValue::DefaultAction)
	AtomicOp assign an integer to specified bits in an Arn Data Object More...

void	addValue (int value)
	AtomicOp adds an integer to an Arn Data Object More...

void	addValue (ARNREAL value)
	AtomicOp adds an ARNREAL to an Arn Data Object More...

Public Member Functions inherited from ArnItemB
	ArnItemB (QObject *parent=arnNullptr)
	Standard constructor of a closed handle. More...

virtual	~ArnItemB ()

bool	open (const QString &path)
	Open a handle to an Arn Data Object More...

Public Member Functions inherited from ArnBasicItem
	ArnBasicItem ()
	Standard constructor of a closed handle. More...

virtual	~ArnBasicItem ()

bool	open (const QString &path)
	Open a handle to an Arn Data Object More...

void	close ()
	Close the handle. More...

void	destroyLink (bool isGlobal=true)
	Destroy the Arn Data Object More...

void	destroyLinkLocal ()
	Destroy the local Arn Data Object More...

bool	isOpen () const
	State of the handle. More...

QString	path (Arn::NameF nameF=Arn::NameF::EmptyOk) const
	Path of the Arn Data Object More...

QString	name (Arn::NameF nameF) const
	Name of the Arn Data Object More...

void	setReference (void *reference)
	Set an associated external reference. More...

void *	reference () const
	Get the stored external reference. More...

uint	itemId () const
	Get the id for this ArnItem. More...

uint	linkId () const
	Get the id for this Arn Data Object More...

int	refCount () const
	Get the number of refs to this Arn Data Object More...

bool	isFolder () const

bool	isProvider () const

Arn::DataType	type () const
	The type stored in the Arn Data Object More...

void	setIgnoreSameValue (bool isIgnore=true)
	Set skipping of equal value. More...

bool	isIgnoreSameValue () const

void	addMode (Arn::ObjectMode mode)
	Add general mode settings for this Arn Data Object More...

Arn::ObjectMode	getMode () const
	Use with care, link must be "referenced" before use, otherwise it might have been deleted. More...

Arn::ObjectSyncMode	syncMode () const

ArnBasicItem &	setBiDirMode ()
	Set general mode as Bidirectional for this Arn Data Object More...

bool	isBiDirMode () const

ArnBasicItem &	setPipeMode ()
	Set general mode as Pipe for this Arn Data Object More...

bool	isPipeMode () const

ArnBasicItem &	setSaveMode ()
	Set general mode as Save for this Arn Data Object More...

bool	isSaveMode () const

void	setAtomicOpProvider ()
	Set this Arn Data Object as Atomic Operator Provider More...

bool	isAtomicOpProvider () const

ArnBasicItem &	setMaster ()
	Set client session sync mode as Master for this ArnItem. More...

bool	isMaster () const

ArnBasicItem &	setAutoDestroy ()
	Set client session sync mode as AutoDestroy for this ArnItem. More...

bool	isAutoDestroy () const

void	arnImport (const QByteArray &data, int ignoreSame=Arn::SameValue::DefaultAction)
	Import data to an Arn Data Object More...

QByteArray	arnExport () const

int	toInt (bool *isOk=arnNullptr) const

double	toDouble (bool *isOk=arnNullptr) const

ARNREAL	toReal (bool *isOk=arnNullptr) const

QString	toString (bool *isOk=arnNullptr) const

QByteArray	toByteArray (bool *isOk=arnNullptr) const

QVariant	toVariant (bool *isOk=arnNullptr) const

bool	toBool (bool *isOk=arnNullptr) const

uint	toUInt (bool *isOk=arnNullptr) const

qint64	toInt64 (bool *isOk=arnNullptr) const

quint64	toUInt64 (bool *isOk=arnNullptr) const

ArnBasicItem &	operator= (const ArnBasicItem &other)

ArnBasicItem &	operator= (int val)

ArnBasicItem &	operator= (ARNREAL val)

ArnBasicItem &	operator= (const QString &val)

ArnBasicItem &	operator= (const QByteArray &val)

ArnBasicItem &	operator= (const QVariant &val)

ArnBasicItem &	operator= (const char *val)

ArnBasicItem &	operator= (uint val)

ArnBasicItem &	operator= (qint64 val)

ArnBasicItem &	operator= (quint64 val)

ArnBasicItem &	operator+= (int val)

ArnBasicItem &	operator+= (ARNREAL val)

void	setValue (const ArnBasicItem &other, int ignoreSame=Arn::SameValue::DefaultAction)

void	setValue (int value, int ignoreSame=Arn::SameValue::DefaultAction)
	Assign an integer to an Arn Data Object More...

void	setValue (ARNREAL value, int ignoreSame=Arn::SameValue::DefaultAction)
	Assign an ARNREAL to an Arn Data Object More...

void	setValue (bool value, int ignoreSame=Arn::SameValue::DefaultAction)
	Assign a bool to an Arn Data Object More...

void	setValue (const QString &value, int ignoreSame=Arn::SameValue::DefaultAction)
	Assign a QString to an Arn Data Object More...

void	setValue (const QByteArray &value, int ignoreSame=Arn::SameValue::DefaultAction)
	Assign a QByteArray to an Arn Data Object More...

void	setValue (const QVariant &value, int ignoreSame=Arn::SameValue::DefaultAction)
	Assign a QVariant to an Arn Data Object More...

void	setValue (const char *value, int ignoreSame=Arn::SameValue::DefaultAction)
	Assign a char* to an Arn Data Object More...

void	setValue (uint value, int ignoreSame=Arn::SameValue::DefaultAction)
	Assign an unsigned int to an Arn Data Object More...

void	setValue (qint64 value, int ignoreSame=Arn::SameValue::DefaultAction)
	Assign an int 64 bit to an Arn Data Object More...

void	setValue (quint64 value, int ignoreSame=Arn::SameValue::DefaultAction)
	Assign an unsigned int 64 bit to an Arn Data Object More...

void	setBits (int mask, int value, int ignoreSame=Arn::SameValue::DefaultAction)
	AtomicOp assign an integer to specified bits in an Arn Data Object More...

void	addValue (int value)
	AtomicOp adds an integer to an Arn Data Object More...

void	addValue (ARNREAL value)
	AtomicOp adds an ARNREAL to an Arn Data Object More...

QThread *	thread () const
	Get the thread affinity of this ArnBasicItem. More...

void	setEventHandler (QObject *eventHandler)
	Set event handler for this ArnBasicItem. More...

QObject *	eventHandler () const
	Get the event handler of this ArnBasicItem. More...

void	setUncrossed (bool isUncrossed=true)
	Set a Bidirectional item as Uncrossed. More...

bool	isUncrossed () const
	Get the Uncrossed state of an object. More...

bool	isAssigning () const
	Tells if this ArnItem is assigned right now. More...

Public Member Functions inherited from ArnCoreItem
	ArnCoreItem ()
	Standard constructor of a closed handle. More...

virtual	~ArnCoreItem ()

QThread *	thread () const
	Get the thread affinity of this ArnCoreItem. More...

Detailed Description

ARN Item QML.

This class is the Qml version of ArnItem.

See also: ArnQml

Example usage

// In Qml
//
import QtQuick 2.0
import ArnLib 1.0
Rectangle {
    width: 370;  height: 400
    property ArnItem arnT1: ArnItem {path: "//El/UpdClock/value"}
    ArnItem {id: arnElUpdClock;  path: "//El/UpdClock/value"}
    ArnItem {id: arnTest;        path: "//Test/test"}
    Rectangle {
        id: info
        anchors.bottom: parent.bottom; anchors.left: parent.left;  anchors.right: parent.right
        height: 80
        Column {
            anchors.fill: parent;
            Text {text: "El updClock 1: " + arnElUpdClock.intNum}
            Text {text: "El updClock 2: " + arnT1.intNum}
        }
    }
    Component.onCompleted: {
        arnTest.setValue("Start ...", Arn.SameValue_Accept);
    }
}

Definition at line 286 of file ArnQml.hpp.

Member Function Documentation

◆ addIntNum

void ArnItemQml::addIntNum ( int value )

inlineslot

AtomicOp adds an integer to an Arn Data Object

See also: ArnItem::addValue()

Definition at line 348 of file ArnQml.hpp.

◆ addMode

void ArnItemQml::addMode ( ArnInterface::ObjectMode mode )

inlineslot

Add general mode settings for this Arn Data Object

See also: ArnItem::addMode()

Definition at line 364 of file ArnQml.hpp.

◆ addNum

void ArnItemQml::addNum ( double value )

inlineslot

AtomicOp adds an ARNREAL to an Arn Data Object

See also: ArnItem::addValue()

Definition at line 357 of file ArnQml.hpp.

◆ getMode

ArnInterface::ObjectMode ArnItemQml::getMode ( ) const

inlineslot

Returns: The general mode of the Arn Data Object

See also: ArnItem::getMode()

Definition at line 370 of file ArnQml.hpp.

◆ setBits

void ArnItemQml::setBits	(	int	mask,
		int	value
	)

inlineslot

AtomicOp assign an integer to specified bits in an Arn Data Object

See also: ArnItem::setBits()

Definition at line 342 of file ArnQml.hpp.

Property Documentation

◆ atomicOpProvider

bool ArnItemQml::atomicOpProvider

readwrite

See ArnBasicItem::setAtomicOpProvider()

Definition at line 331 of file ArnQml.hpp.

◆ autoDestroyMode

bool ArnItemQml::autoDestroyMode

readwrite

See Arn::ObjectSyncMode::AutoDestroy.

Definition at line 328 of file ArnQml.hpp.

◆ biDirMode

bool ArnItemQml::biDirMode

readwrite

See Arn::ObjectMode::BiDir.

Definition at line 320 of file ArnQml.hpp.

◆ bytes

QByteArray ArnItemQml::bytes

readwrite

The ArnItem value as a QByteArray.

Definition at line 310 of file ArnQml.hpp.

◆ delay

int ArnItemQml::delay

readwrite

See ArnItem::setDelay()

Definition at line 335 of file ArnQml.hpp.

◆ ignoreSameValue

bool ArnItemQml::ignoreSameValue

readwrite

See ArnItem::setIgnoreSameValue()

Definition at line 333 of file ArnQml.hpp.

◆ intNum

int ArnItemQml::intNum

readwrite

The ArnItem value as an int.

Definition at line 318 of file ArnQml.hpp.

◆ masterMode

bool ArnItemQml::masterMode

readwrite

See Arn::ObjectSyncMode::Master.

Definition at line 326 of file ArnQml.hpp.

◆ num

double ArnItemQml::num

readwrite

The ArnItem value as an ARNREAL.

Definition at line 315 of file ArnQml.hpp.

◆ path

QString ArnItemQml::path

readwrite

The path of this ArnItem.

Definition at line 301 of file ArnQml.hpp.

◆ pipeMode

bool ArnItemQml::pipeMode

readwrite

See Arn::ObjectMode::Pipe.

Definition at line 322 of file ArnQml.hpp.

◆ saveMode

bool ArnItemQml::saveMode

readwrite

See Arn::ObjectMode::Save.

Definition at line 324 of file ArnQml.hpp.

◆ string

QString ArnItemQml::string

readwrite

The ArnItem value as a QString.

Definition at line 308 of file ArnQml.hpp.

◆ type

ArnInterface::DataType ArnItemQml::type

read

The Arn data type of this ArnItem.

Definition at line 304 of file ArnQml.hpp.

◆ useUuid

bool ArnItemQml::useUuid

readwrite

Select to use ArnItem::openUuid()

Definition at line 299 of file ArnQml.hpp.

◆ variant

QVariant ArnItemQml::variant

readwrite

The ArnItem value as a QVariant.

Definition at line 306 of file ArnQml.hpp.

◆ variantType

QString ArnItemQml::variantType

readwrite

The type used inside the variant, e.g. QString.

Definition at line 297 of file ArnQml.hpp.

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

src/ArnInc/ArnQml.hpp (4.0.0)
src/ArnQml.cpp (4.0.0)

Public Slots

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addIntNum

◆ addMode

◆ addNum

◆ getMode

◆ setBits

Property Documentation

◆ atomicOpProvider

◆ autoDestroyMode

◆ biDirMode

◆ bytes

◆ delay

◆ ignoreSameValue

◆ intNum

◆ masterMode

◆ num

◆ path

◆ pipeMode

◆ saveMode

◆ string

◆ type

◆ useUuid

◆ variant

◆ variantType