ArnLib  4.0.x
Active Registry Network
ArnInterface Class Reference

#include <ArnInterface.hpp>

Inheritance diagram for ArnInterface:
Collaboration diagram for ArnInterface:

Public Types

enum  SameValue { SameValue_Accept = Arn::SameValue::Accept, SameValue_Ignore = Arn::SameValue::Ignore, SameValue_DefaultAction = Arn::SameValue::DefaultAction }
 Action when assigning same value to an ArnItem. More...
 
enum  DataType {
  DataType_Null = Arn::DataType::Null, DataType_Int = Arn::DataType::Int, DataType_Double = Arn::DataType::Double, DataType_Real = Arn::DataType::Real,
  DataType_ByteArray = Arn::DataType::ByteArray, DataType_String = Arn::DataType::String, DataType_Variant = Arn::DataType::Variant
}
 Data type of an Arn Data Object More...
 
enum  ObjectMode { ObjectMode_BiDir = Arn::ObjectMode::BiDir, ObjectMode_Pipe = Arn::ObjectMode::Pipe, ObjectMode_Save = Arn::ObjectMode::Save }
 General global mode of an Arn Data Object More...
 
enum  NameF { NameF_Default = Arn::NameF::Default, NameF_NoFolderMark = Arn::NameF::NoFolderMark, NameF_EmptyOk = Arn::NameF::EmptyOk, NameF_Relative = Arn::NameF::Relative }
 Selects a format for path or item name. More...
 

Public Slots

QVariant value (const QString &path)
 See ArnM::valueVariant() More...
 
QVariant variant (const QString &path)
 See ArnM::valueVariant() More...
 
QString string (const QString &path)
 See ArnM::valueString() More...
 
QByteArray bytes (const QString &path)
 See ArnM::valueByteArray() More...
 
double num (const QString &path)
 See ArnM::valueDouble() More...
 
int intNum (const QString &path)
 See ArnM::valueInt() More...
 
QStringList items (const QString &path)
 See ArnM::items() More...
 
bool exist (const QString &path)
 See ArnM::exist() More...
 
bool isFolder (const QString &path)
 See ArnM::isFolder() More...
 
bool isLeaf (const QString &path)
 See ArnM::isLeaf() More...
 
void setValue (const QString &path, const QVariant &value)
 See ArnM::setValue() More...
 
void setVariant (const QString &path, const QVariant &value, const QString &typeName=QString())
 See ArnM::setValue() More...
 
void setString (const QString &path, const QString &value)
 See ArnM::setValue() More...
 
void setBytes (const QString &path, const QByteArray &value)
 See ArnM::setValue() More...
 
void setNum (const QString &path, double value)
 See ArnM::setValue() More...
 
void setIntNum (const QString &path, int value)
 See ArnM::setValue() More...
 
bool isFolderPath (const QString &path)
 See Arn::isFolderPath() More...
 
bool isProviderPath (const QString &path)
 See Arn::isProviderPath() More...
 
QString itemName (const QString &path)
 See Arn::itemName() More...
 
QString twinPath (const QString &path)
 See Arn::twinPath() More...
 
QString changeBasePath (const QString &oldBasePath, const QString &newBasePath, const QString &path)
 See Arn::changeBasePath() More...
 
QString childPath (const QString &parentPath, const QString &posterityPath)
 See Arn::childPath() More...
 
QString makePath (const QString &parentPath, const QString &itemName)
 See Arn::makePath() More...
 
QString providerPath (const QString &path, bool giveProviderPath=true)
 See Arn::providerPath() More...
 

Properties

QString info
 See ArnM::info() More...
 

Detailed Description

Definition at line 39 of file ArnInterface.hpp.

Member Enumeration Documentation

◆ DataType

Data type of an Arn Data Object

Enumerator
DataType_Null 
DataType_Int 
DataType_Double 
DataType_Real 
DataType_ByteArray 
DataType_String 
DataType_Variant 

Definition at line 57 of file ArnInterface.hpp.

◆ NameF

Selects a format for path or item name.

Enumerator
NameF_Default 

Empty not ok, Path: Absolute Item: FolderMark.

NameF_NoFolderMark 

Only on discrete names, no effect on path. "test/" ==> "test".

NameF_EmptyOk 

Path: "/@/test" ==> "//test", Item: "@" ==> "".

NameF_Relative 

Only on path, no effect on discrete names. "/test/value" ==> "test/value".

Definition at line 80 of file ArnInterface.hpp.

◆ ObjectMode

General global mode of an Arn Data Object

Enumerator
ObjectMode_BiDir 

A two way object, typically for validation or pipe.

ObjectMode_Pipe 

Implies BiDir and all data is preserved as a stream.

ObjectMode_Save 

Data is persistent and will be saved.

Definition at line 69 of file ArnInterface.hpp.

◆ SameValue

Action when assigning same value to an ArnItem.

Enumerator
SameValue_Accept 

Assigning same value generates an update of the Arn Data Object

SameValue_Ignore 

Assigning same value is ignored.

SameValue_DefaultAction 

Assigning same value gives default action set in ArnM or ArnItem.

Definition at line 46 of file ArnInterface.hpp.

Member Function Documentation

◆ bytes

QByteArray ArnInterface::bytes ( const QString &  path)
inlineslot

See ArnM::valueByteArray()

Definition at line 110 of file ArnInterface.hpp.

◆ changeBasePath

QString ArnInterface::changeBasePath ( const QString &  oldBasePath,
const QString &  newBasePath,
const QString &  path 
)
inlineslot

See Arn::changeBasePath()

Definition at line 177 of file ArnInterface.hpp.

◆ childPath

QString ArnInterface::childPath ( const QString &  parentPath,
const QString &  posterityPath 
)
inlineslot

See Arn::childPath()

Definition at line 181 of file ArnInterface.hpp.

◆ exist

bool ArnInterface::exist ( const QString &  path)
inlineslot

See ArnM::exist()

Definition at line 126 of file ArnInterface.hpp.

◆ intNum

int ArnInterface::intNum ( const QString &  path)
inlineslot

See ArnM::valueInt()

Definition at line 120 of file ArnInterface.hpp.

◆ isFolder

bool ArnInterface::isFolder ( const QString &  path)
inlineslot

See ArnM::isFolder()

Definition at line 129 of file ArnInterface.hpp.

◆ isFolderPath

bool ArnInterface::isFolderPath ( const QString &  path)
inlineslot

See Arn::isFolderPath()

Definition at line 165 of file ArnInterface.hpp.

◆ isLeaf

bool ArnInterface::isLeaf ( const QString &  path)
inlineslot

See ArnM::isLeaf()

Definition at line 132 of file ArnInterface.hpp.

◆ isProviderPath

bool ArnInterface::isProviderPath ( const QString &  path)
inlineslot

See Arn::isProviderPath()

Definition at line 168 of file ArnInterface.hpp.

◆ itemName

QString ArnInterface::itemName ( const QString &  path)
inlineslot

See Arn::itemName()

Definition at line 171 of file ArnInterface.hpp.

◆ items

QStringList ArnInterface::items ( const QString &  path)
inlineslot

See ArnM::items()

Definition at line 123 of file ArnInterface.hpp.

◆ makePath

QString ArnInterface::makePath ( const QString &  parentPath,
const QString &  itemName 
)
inlineslot

See Arn::makePath()

Definition at line 185 of file ArnInterface.hpp.

◆ num

double ArnInterface::num ( const QString &  path)
inlineslot

See ArnM::valueDouble()

Definition at line 116 of file ArnInterface.hpp.

◆ providerPath

QString ArnInterface::providerPath ( const QString &  path,
bool  giveProviderPath = true 
)
inlineslot

See Arn::providerPath()

Definition at line 189 of file ArnInterface.hpp.

◆ setBytes

void ArnInterface::setBytes ( const QString &  path,
const QByteArray &  value 
)
inlineslot

See ArnM::setValue()

Definition at line 147 of file ArnInterface.hpp.

◆ setIntNum

void ArnInterface::setIntNum ( const QString &  path,
int  value 
)
inlineslot

See ArnM::setValue()

Definition at line 159 of file ArnInterface.hpp.

◆ setNum

void ArnInterface::setNum ( const QString &  path,
double  value 
)
inlineslot

See ArnM::setValue()

Definition at line 154 of file ArnInterface.hpp.

◆ setString

void ArnInterface::setString ( const QString &  path,
const QString &  value 
)
inlineslot

See ArnM::setValue()

Definition at line 143 of file ArnInterface.hpp.

◆ setValue

void ArnInterface::setValue ( const QString &  path,
const QVariant &  value 
)
inlineslot

See ArnM::setValue()

Definition at line 135 of file ArnInterface.hpp.

◆ setVariant

void ArnInterface::setVariant ( const QString &  path,
const QVariant &  value,
const QString &  typeName = QString() 
)
inlineslot

See ArnM::setValue()

Definition at line 139 of file ArnInterface.hpp.

◆ string

QString ArnInterface::string ( const QString &  path)
inlineslot

See ArnM::valueString()

Definition at line 107 of file ArnInterface.hpp.

◆ twinPath

QString ArnInterface::twinPath ( const QString &  path)
inlineslot

See Arn::twinPath()

Definition at line 174 of file ArnInterface.hpp.

◆ value

QVariant ArnInterface::value ( const QString &  path)
inlineslot

See ArnM::valueVariant()

Definition at line 101 of file ArnInterface.hpp.

◆ variant

QVariant ArnInterface::variant ( const QString &  path)
inlineslot

See ArnM::valueVariant()

Definition at line 104 of file ArnInterface.hpp.

Property Documentation

◆ info

QString ArnInterface::info
read

See ArnM::info()

Definition at line 43 of file ArnInterface.hpp.


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