Base class handle for an Arn Data Object. More...

#include <ArnItemB.hpp>

Inheritance diagram for ArnItemB:

[legend]

Collaboration diagram for ArnItemB:

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

Public Member Functions
	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

Base class handle for an Arn Data Object.

About Arn Data Object

This class contains the basic services, that should be apropriate for any derived class as public methods. Other non generic services that might be needed is available as protected methods. Typically derived classes can select among these protected methods and make any of them public.

See ArnItem.

Definition at line 59 of file ArnItemB.hpp.

Constructor & Destructor Documentation

◆ ArnItemB()

ArnItemB::ArnItemB ( QObject * parent = arnNullptr )

Standard constructor of a closed handle.

Parameters

[in] parent

Definition at line 61 of file ArnItemB.cpp.

◆ ~ArnItemB()

ArnItemB::~ArnItemB ( )

virtual

Definition at line 77 of file ArnItemB.cpp.

Member Function Documentation

◆ arnLinkDestroyed

void ArnItemB::arnLinkDestroyed ( )

signal

Signal emitted when the Arn Data Object is destroyed.

When the link (Arn Data Object) is destroyed, this ArnItem is closed and will give this signal. It's ok to assign values etc to a closed ArnItem, it's thrown away like a null device.

See also: destroyLink()

◆ open()

bool ArnItemB::open ( const QString & path )

Open a handle to an Arn Data Object

Parameters

[in] path The Arn Data Object path e.g. "//Measure/Water/Level/value"

Return values

false if error

Definition at line 91 of file ArnItemB.cpp.

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

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

Signals