SourcePro® API Reference Guide

 
Loading...
Searching...
No Matches
RWDBForeignKeyList Class Reference

Holds an ordered collection of RWDBForeignKey instances. More...

#include <rw/db/forkey.h>

Inheritance diagram for RWDBForeignKeyList:
RWOrdered RWSequenceable RWCollection RWCollectable

Public Member Functions

 RWDBForeignKeyList ()
 
 RWDBForeignKeyList (const RWDBForeignKeyList &aList)
 
RWDBForeignKeyList clone () const
 
RWDBForeignKeyListoperator= (const RWDBForeignKeyList &aList)
 
RWDBForeignKeyoperator[] (size_t index) const
 
- Public Member Functions inherited from RWOrdered
 RWOrdered ()
 
 RWOrdered (const RWOrdered &o)
 
 RWOrdered (RWOrdered &&o)
 
 RWOrdered (size_t size)
 
virtual RWCollectableappend (RWCollectable *a)
 
virtual void apply (RWapplyCollectable ap, void *x)
 
virtual RWCollectable *& at (size_t i)
 
virtual const RWCollectableat (size_t i) const
 
virtual void clear ()
 
virtual RWCollectablecopy () const
 
virtual size_t entries () const
 
virtual RWCollectablefind (const RWCollectable *target) const
 
virtual RWCollectablefirst () const
 
virtual size_t index (const RWCollectable *c) const
 
virtual RWCollectableinsert (RWCollectable *c)
 
virtual RWCollectableinsertAt (size_t indx, RWCollectable *e)
 
virtual RWClassID isA () const
 
virtual bool isEmpty () const
 
virtual bool isEqual (const RWCollectable *a) const
 
virtual RWCollectablelast () const
 
virtual size_t newCapacity (size_t) const
 
virtual RWConstIteratornewConstIterator () const
 
virtual RWIteratornewIterator ()
 
virtual RWCollectablenewSpecies () const
 
virtual size_t occurrencesOf (const RWCollectable *target) const
 
RWCollectable *& operator() (size_t i)
 
RWOrderedoperator= (const RWOrdered &o)
 
RWOrderedoperator= (RWOrdered &&o)
 
bool operator== (const RWOrdered &od) const
 
RWCollectable *& operator[] (size_t i)
 
RWCollectablepop ()
 
virtual RWCollectableprepend (RWCollectable *c)
 
void push (RWCollectable *c)
 
virtual RWCollectableremove (const RWCollectable *target)
 
RWCollectableremoveAt (size_t index)
 
void swap (RWOrdered &o)
 
RWCollectabletop () const
 
- Public Member Functions inherited from RWCollection
virtual ~RWCollection ()
 
RWBag asBag () const
 
RWBinaryTree asBinaryTree () const
 
RWOrdered asOrderedCollection () const
 
RWSet asSet () const
 
RWBinaryTree asSortedCollection () const
 
virtual RWspace binaryStoreSize () const
 
virtual void clearAndDestroy ()
 
virtual bool contains (const RWCollectable *target) const
 
void operator+= (const RWCollection &c)
 
void operator-= (const RWCollection &c)
 
virtual void removeAndDestroy (const RWCollectable *target)
 
virtual void restoreGuts (RWFile &)
 
virtual void restoreGuts (RWvistream &)
 
virtual void saveGuts (RWFile &) const
 
virtual void saveGuts (RWvostream &) const
 
RWCollectionselect (RWtestCollectable tst, void *vp) const
 
- Public Member Functions inherited from RWCollectable
virtual ~RWCollectable ()
 
virtual int compareTo (const RWCollectable *) const
 
virtual unsigned hash () const
 
RWspace recursiveStoreSize () const
 
RWStringID stringID () const
 

Additional Inherited Members

- Static Public Member Functions inherited from RWCollectable
static RWClassID classID (const RWStringID &name)
 
static RWClassID classIsA ()
 
static bool isAtom (RWClassID id)
 
static RWspace nilStoreSize ()
 
- Static Public Attributes inherited from RWCollection
static size_t DEFAULT_CAPACITY
 

Detailed Description

RWDBForeignKeyList is an ordered collection of RWDBForeignKey instances. RWDBForeignKeyList is a relatively low-level construct used by the DB Interface Module as an input/output parameter in the functions RWDBTable::foreignKeys() and RWDBTable::referredToBy().

All RWDBForeignKeyList methods are inherited from RWOrdered.

The only semantics that RWDBForeignKeyList adds to RWOrdered are:

Synopsis
#include <rw/db/forkey.h>
RWDBStatus aStatus = aTable.foreignKeys("targetTable", aList);
Holds an ordered collection of RWDBForeignKey instances.
Definition forkey.h:493
Encapsulates the error state of an object or operation.
Definition status.h:80

Constructor & Destructor Documentation

◆ RWDBForeignKeyList() [1/2]

RWDBForeignKeyList::RWDBForeignKeyList ( )

The default constructor produces an empty RWDBForeignKeyList.

◆ RWDBForeignKeyList() [2/2]

RWDBForeignKeyList::RWDBForeignKeyList ( const RWDBForeignKeyList & aList)
inline

Copy constructor. Makes a copy of aList.

Member Function Documentation

◆ clone()

RWDBForeignKeyList RWDBForeignKeyList::clone ( ) const
inline

Returns a deep copy of self.

◆ operator=()

RWDBForeignKeyList & RWDBForeignKeyList::operator= ( const RWDBForeignKeyList & aList)
inline

Assignment operator. Destroys existing contents and makes a copy of aList.

◆ operator[]()

RWDBForeignKey & RWDBForeignKeyList::operator[] ( size_t index) const

Returns a reference to the RWDBForeignKey at a position index in self. The call is forwarded to RWOrdered, which throws an exception of type RWBoundsErr if the index is out of range.

Copyright © 2024 Rogue Wave Software, Inc., a Perforce company. All Rights Reserved.