#include <jive/util/GroupSet.h>

Inheritance diagram for jive::util::GroupSet:

Public Member Functions
virtual String	getItemName () const
	Returns the type name of an item. More...

virtual idx_t	getGroupSize (idx_t igroup) const =0

virtual idx_t	getGroupMembers (const IdxVector &iitems, idx_t igroup) const =0

virtual void	getSomeGroupMembers (const IdxVector &iitems, const IdxVector &index, idx_t igroup) const

virtual idx_t	getOneGroupMember (idx_t index, idx_t igroup) const

virtual IdxVector	getMembersOf (const IdxVector &igroups) const

virtual IdxVector	getUniqueMembersOf (const IdxVector &igroups) const

virtual idx_t	maxGroupSize () const

virtual idx_t	maxGroupSizeOf (const IdxVector &igroups) const

virtual IdxVector	toVector () const

virtual Topology	toMatrix () const

virtual ItemSet *	getGroupedItems () const =0

virtual void	printSubset (PrintWriter &out, const IdxVector &igroups) const

Public Member Functions inherited from jive::util::ItemSet
virtual String	toString () const
	Returns a short textual description of this object. More...

virtual int	size () const
	Returns the size of this item set. More...

String	getName () const
	Returns the (descriptive) name of this item set. More...

virtual String	getTagName () const
	Returns an XML tag name for this item set. More...

virtual String	getItemsName () const
	Returns the plural of an item type name. More...

String	getContext () const
	Returns a context string. More...

virtual ItemMap *	getItemMap () const =0
	Returns the item map associated with this item set. More...

String	getItemPath (int itemID) const
	Returns an identification string for an item. More...

int	findItem (int itemID) const
	Returns the index of an item with a given ID. More...

int	getItemID (int iitem) const
	Returns the ID of the item with a given index. More...

virtual void	printTo (Printer &out) const
	Prints the contents of this item set. More...

void	store (const String &name, const Properties &globdat) const
	Stores this item set in a (global) data set. More...

Public Member Functions inherited from jem::Object
virtual Class *	getClass () const
	Returns the `Class` instance representing the runtime class of this object. More...

virtual long	hashValue () const
	Returns a hash value for this object. More...

virtual bool	equals (const Ref< Object > &obj) const
	Tests whether two objects are equal. More...

Ref< Object >	clone () const
	Returns a copy of this object. More...

Public Attributes
Event< Self & >	newTopoEvent

Public Attributes inherited from jive::util::ItemSet
jem::util::Event< int, Self & >	newSizeEvent
	Signals that the size of this item set has changed. More...

jem::util::Event< const IntVector &, Self & >	newOrderEvent
	Signals that the items have been re-ordered. More...

Protected Member Functions
	GroupSet (const String &name="")

virtual	~GroupSet ()

Protected Member Functions inherited from jive::util::ItemSet
	ItemSet (const String &name="")
	Constructs an item set with a given name. More...

virtual	~ItemSet ()

Protected Member Functions inherited from jem::Collectable
	Collectable ()
	Creates an empty `Collectable`. More...

	~Collectable ()
	Frees resources. More...

Additional Inherited Members
Public Types inherited from jive::util::ItemSet
typedef jem::String	String
	Represents a string type. More...

typedef jem::io::PrintWriter	Printer
	Represents a formatted output stream. More...

typedef jem::util::Dictionary	Dict
	Represents a dictionary. More...

typedef jem::util::Properties	Properties
	Represents a properties set. More...

Static Public Member Functions inherited from jive::util::ItemSet
static jem::Ref< ItemSet >	find (const String &name, const Properties &globdat)
	Searches for a named item set in a (global) data set. More...

static jem::Ref< ItemSet >	get (const String &name, const Properties &globdat, const String &context)
	Returns a named item set stored in a (global) data set. More...

static jem::Ref< Dict >	getAll (const Properties &globdat)
	Returns a dictionary containing all item sets in a (global) data set. More...

static StringVector	listAll (const Properties &globdat)
	Returns the names of all item sets stored in a (global) data set. More...

Static Public Member Functions inherited from jem::Object
static Class *	getType ()
	Returns the `Class` instance representing the `Object` class. More...

Protected Attributes inherited from jive::util::ItemSet
String	myName_
	The descriptive name of this item set. More...

Constructor & Destructor Documentation

jive::util::GroupSet::GroupSet ( const String & name = "" )

explicitprotected

virtual jive::util::GroupSet::~GroupSet ( )

protectedvirtual

Member Function Documentation

virtual String jive::util::GroupSet::getItemName ( ) const

virtual

Returns a string that can be used as the type name of an item in this set. For instance, if this item sets contains points, it could return the string "point".

The string returned by this function is mostly used to generate various types of output messagesm, including error messages.

Returns: A string denoting the type of items in this set.

Implements jive::util::ItemSet.

Reimplemented in jive::util::StdGroupSet.

virtual idx_t jive::util::GroupSet::getGroupSize ( idx_t igroup ) const

pure virtual

Implemented in jive::util::StdGroupSet.

virtual idx_t jive::util::GroupSet::getGroupMembers	(	const IdxVector &	iitems,
		idx_t	igroup
	)		const

pure virtual

Implemented in jive::util::StdGroupSet.

virtual void jive::util::GroupSet::getSomeGroupMembers	(	const IdxVector &	iitems,
		const IdxVector &	index,
		idx_t	igroup
	)		const

virtual

Reimplemented in jive::util::StdGroupSet.

virtual idx_t jive::util::GroupSet::getOneGroupMember	(	idx_t	index,
		idx_t	igroup
	)		const

virtual

Reimplemented in jive::util::StdGroupSet.

virtual IdxVector jive::util::GroupSet::getMembersOf ( const IdxVector & igroups ) const

virtual

Reimplemented in jive::util::StdGroupSet.

virtual IdxVector jive::util::GroupSet::getUniqueMembersOf ( const IdxVector & igroups ) const

virtual

virtual idx_t jive::util::GroupSet::maxGroupSize ( ) const

virtual

Reimplemented in jive::util::StdGroupSet.

virtual idx_t jive::util::GroupSet::maxGroupSizeOf ( const IdxVector & igroups ) const

virtual

Reimplemented in jive::util::StdGroupSet.

virtual IdxVector jive::util::GroupSet::toVector ( ) const

virtual

Reimplemented in jive::util::StdGroupSet.

virtual Topology jive::util::GroupSet::toMatrix ( ) const

virtual

Reimplemented in jive::util::StdGroupSet.

virtual ItemSet* jive::util::GroupSet::getGroupedItems ( ) const

pure virtual

Implemented in jive::util::StdGroupSet.

virtual void jive::util::GroupSet::printSubset	(	PrintWriter &	out,
		const IdxVector &	igroups
	)		const

virtual

Member Data Documentation

Event< Self& > jive::util::GroupSet::newTopoEvent

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation