RWDBCheckConstraintList Class Reference

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

#include <rw/db/checkconstr.h>

Public Member Functions
	RWDBCheckConstraintList ()
	RWDBCheckConstraintList (const RWDBCheckConstraintList &aList)
	~RWDBCheckConstraintList ()
RWDBCheckConstraint *	append (RWDBCheckConstraint *cc)
RWspace	binaryStoreSize () const
void	clear ()
void	clearAndDestroy ()
RWDBCheckConstraintList	clone () const
size_t	entries () const
RWDBCheckConstraint &	operator() (size_t index)
const RWDBCheckConstraint &	operator() (size_t index) const
RWDBCheckConstraintList &	operator= (const RWDBCheckConstraintList &aList)
RWDBCheckConstraint &	operator[] (size_t index)
const RWDBCheckConstraint &	operator[] (size_t index) const
RWDBCheckConstraint *	removeAt (size_t index)
void	restoreGuts (RWFile &f)
void	restoreGuts (RWvistream &s)
void	saveGuts (RWFile &f) const
void	saveGuts (RWvostream &s) const

Detailed Description

RWDBCheckConstraintList is an ordered collection of RWDBCheckConstraint instances. RWDBCheckConstraintList is used by the DB Interface Module as an input/output parameter in the function RWDBTable::checkConstraints(). When the list is populated with instances of RWDBCheckConstraint, the instances are owned by the containing list. The destructor deallocates the contents of the RWDBCheckConstraintList by calling clearAndDestroy().

Synopsis

#include <rw/db/checkconstr.h>
RWDBCheckConstraintList aList;
 
aStatus = aTable.checkConstraints("aConstraintName", aList);

Constructor & Destructor Documentation

RWDBCheckConstraintList() [1/2]

RWDBCheckConstraintList::RWDBCheckConstraintList ( )

inline

Constructor.

RWDBCheckConstraintList() [2/2]

RWDBCheckConstraintList::RWDBCheckConstraintList ( const RWDBCheckConstraintList & aList )

inline

Copy constructor. Makes a copy of aList.

~RWDBCheckConstraintList()

RWDBCheckConstraintList::~RWDBCheckConstraintList ( )

inline

Destructor. This deletes the objects in the list.

Member Function Documentation

append()

RWDBCheckConstraint * RWDBCheckConstraintList::append ( RWDBCheckConstraint * cc )

inline

Adds cc to the end of the collection and returns it. If successful, self assumes ownership of cc. Returns rwnil if the insertion was unsuccessful.

binaryStoreSize()

RWspace RWDBCheckConstraintList::binaryStoreSize ( ) const

inline

Returns the number of bytes required to store self using the saveGuts() method.

clear()

void RWDBCheckConstraintList::clear ( )

inline

Removes all objects from the collection. Does not delete the objects themselves.

clearAndDestroy()

void RWDBCheckConstraintList::clearAndDestroy ( )

inline

Removes all objects from the collection and deletes them. Takes into account duplicate objects within the collection and only deletes them once. However, it does not take into account objects shared with another collection.

clone()

RWDBCheckConstraintList RWDBCheckConstraintList::clone ( ) const

inline

Returns a new list that is a deep copy of self.

entries()

size_t RWDBCheckConstraintList::entries ( ) const

inline

Returns the total number of items in the collection.

operator()() [1/2]

RWDBCheckConstraint & RWDBCheckConstraintList::operator() ( size_t index )

inline

Returns a reference to the RWDBCheckConstraint at a position index in self. Bounds checking is enabled by defining the preprocessor directive RWBOUNDS_CHECK before including the header file rw\db\checkconstr.h. In this case, throws RWBoundsErr if the index is out of range.

operator()() [2/2]

const RWDBCheckConstraint & RWDBCheckConstraintList::operator() ( size_t index ) const

inline

Returns a reference to the RWDBCheckConstraint at a position index in self. Bounds checking is enabled by defining the preprocessor directive RWBOUNDS_CHECK before including the header file rw\db\checkconstr.h. In this case, throws RWBoundsErr if the index is out of range.

operator=()

RWDBCheckConstraintList & RWDBCheckConstraintList::operator= ( const RWDBCheckConstraintList & aList )

inline

Assignment operator. Destroys the contents of self and makes a copy of aList.

operator[]() [1/2]

RWDBCheckConstraint & RWDBCheckConstraintList::operator[] ( size_t index )

inline

Returns a reference to the RWDBCheckConstraint at a position index in self. Throws RWBoundsErr if the index is out of range.

operator[]() [2/2]

const RWDBCheckConstraint & RWDBCheckConstraintList::operator[] ( size_t index ) const

inline

Returns a reference to the RWDBCheckConstraint at a position index in self. Throws RWBoundsErr if the index is out of range.

removeAt()

RWDBCheckConstraint * RWDBCheckConstraintList::removeAt ( size_t index )

inline

Removes the oject at the position /a index in the collection and returns it. It is up to the user to delete the returned object.

restoreGuts() [1/2]

void RWDBCheckConstraintList::restoreGuts ( RWFile & f )

inline

Reads f, replacing the contents of self.

restoreGuts() [2/2]

void RWDBCheckConstraintList::restoreGuts ( RWvistream & s )

inline

Reads s, replacing the contents of self.

saveGuts() [1/2]

void RWDBCheckConstraintList::saveGuts ( RWFile & f ) const

inline

Writes the contents of self to f.

saveGuts() [2/2]

void RWDBCheckConstraintList::saveGuts ( RWvostream & s ) const

inline

Writes the contents of self to s.