IliAttributePath Class Reference

Schema class. More...

#include <ilviews/dataccess/schema.h>

Public Member Functions
	IliAttributePath ()
	This constructor initializes an empty attribute path.
	IliAttributePath (const IliAttributePath &)
	This is the copy constructor of the IliAttributePath class.
void	appendAttribute (const char *name)
	Appends a new attribute name at the end of the path. More...
void	emit (IliString &dest) const
	Appends the sequence of attribute names to a string. More...
const char *	getAttributeAt (IlInt idx) const
	Returns an attribute name. More...
IlInt	getAttributeCount () const
	Returns the number of attribute names in this attribute path. More...
int	operator!= (const IliAttributePath &) const
	Compares two paths. More...
IliAttributePath &	operator= (const IliAttributePath &path)
	Assigns this attribute path with another attribute path. More...
int	operator== (const IliAttributePath &) const
	Compares two paths. More...
void	read (std::istream &input)
	Reads the attribute path from an input stream. More...
void	removeAttribute (IlInt idx)
	Removes the attribute name. More...
void	write (std::ostream &output) const
	Writes the definition of an attribute path to an output stream in a form suitable to be read back by the read() member function. More...

Static Public Member Functions
static IliAttributePath	Parse (const char *seq)
	This static member function expects to find a sequence of names, separated by periods (.). More...

Detailed Description

Schema class.

Library: dataccess

The IliAttributePath class defines objects that hold a sequence of attribute names. It is used to specify an access path from a given schema to a nested schema.

See also

IliSchema.

Member Function Documentation

appendAttribute()

void IliAttributePath::appendAttribute

(

const char *

name

)

Appends a new attribute name at the end of the path.

Parameters

name	The name. It is copied by this member function.

emit()

void IliAttributePath::emit

(

IliString &

dest

)

const

Appends the sequence of attribute names to a string.

Parameters

dest	The string. The attribute names are separated by a period (.) character.

getAttributeAt()

const char* IliAttributePath::getAttributeAt

(

IlInt

idx

)

const

Returns an attribute name.

Parameters

idx	The attribute position.

Returns

The attribute name positioned at idx or NULL if idx is out of range.

getAttributeCount()

IlInt IliAttributePath::getAttributeCount

(

)

const

Returns the number of attribute names in this attribute path.

Returns

The count.

operator!=()

int IliAttributePath::operator!=

(

const IliAttributePath &

)

const

Compares two paths.

Returns

0 if this attribute path has the same sequence of attributes as the path parameter and 1 otherwise.

operator=()

IliAttributePath& IliAttributePath::operator=

(

const IliAttributePath &

path

)

Assigns this attribute path with another attribute path.

Parameters

path	The new value.

operator==()

int IliAttributePath::operator==

(

const IliAttributePath &

)

const

Compares two paths.

Returns

1 if this attribute path has the same sequence of attributes as the path parameter and 0 otherwise.

Parse()

static IliAttributePath IliAttributePath::Parse ( const char *  seq )

static

This static member function expects to find a sequence of names, separated by periods (.).

Parameters

seq	The sequence.

Returns

An attribute path containing this sequence of names.

read()

void IliAttributePath::read

(

std::istream &

input

)

Reads the attribute path from an input stream.

Parameters

input

The input stream.

removeAttribute()

void IliAttributePath::removeAttribute

(

IlInt

idx

)

Removes the attribute name.

Parameters

idx	The attribute name position.

write()

void IliAttributePath::write

(

std::ostream &

output

)

const

Writes the definition of an attribute path to an output stream in a form suitable to be read back by the read() member function.

Parameters

output

The output stream.