Rogue Wave Views
Data Access Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions | Static Public Member Functions
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...
 
IliAttributePathoperator= (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

void IliAttributePath::appendAttribute ( const char *  name)

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

Parameters
nameThe name. It is copied by this member function.
void IliAttributePath::emit ( IliString dest) const

Appends the sequence of attribute names to a string.

Parameters
destThe string. The attribute names are separated by a period (.) character.
const char* IliAttributePath::getAttributeAt ( IlInt  idx) const

Returns an attribute name.

Parameters
idxThe attribute position.
Returns
The attribute name positioned at idx or NULL if idx is out of range.
IlInt IliAttributePath::getAttributeCount ( ) const

Returns the number of attribute names in this attribute path.

Returns
The count.
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.
IliAttributePath& IliAttributePath::operator= ( const IliAttributePath path)

Assigns this attribute path with another attribute path.

Parameters
pathThe new value.
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.
static IliAttributePath IliAttributePath::Parse ( const char *  seq)
static

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

Parameters
seqThe sequence.
Returns
An attribute path containing this sequence of names.
void IliAttributePath::read ( std::istream &  input)

Reads the attribute path from an input stream.

Parameters
inputThe input stream.
void IliAttributePath::removeAttribute ( IlInt  idx)

Removes the attribute name.

Parameters
idxThe attribute name position.
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
outputThe output stream.

© Copyright 2016, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.