Jive reference manual
List of all members | Public Member Functions | Public Attributes | Protected Member Functions
jive::util::PointSet Class Referenceabstract

#include <jive/util/PointSet.h>

Inheritance diagram for jive::util::PointSet:
Inheritance graph

Public Member Functions

virtual idx_t rank () const =0
 
virtual String getItemName () const
 Returns the type name of an item. More...
 
virtual void getPointCoords (const Vector &coords, idx_t ipoint) const =0
 
virtual double getPointXCoord (idx_t ipoint, idx_t idim=0) const =0
 
virtual void getCoords (const Matrix &coords) const
 
virtual void getXCoords (const Vector &coords, idx_t idim=0) const
 
virtual void getSomeCoords (const Matrix &coords, const IdxVector &ipoints) const
 
virtual void getSomeXCoords (const Vector &coords, const IdxVector &ipoints, idx_t idim=0) const
 
virtual Matrix toMatrix () const
 
virtual void printSubset (PrintWriter &out, const IdxVector &ipoints) 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 ItemMapgetItemMap () 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 ClassgetClass () 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< Objectclone () const
 Returns a copy of this object. More...
 

Public Attributes

Event< Self & > newGeomEvent
 
Event< idx_t, Self & > newRankEvent
 
- 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

 PointSet (const String &name="")
 
virtual ~PointSet ()
 
- 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< ItemSetfind (const String &name, const Properties &globdat)
 Searches for a named item set in a (global) data set. More...
 
static jem::Ref< ItemSetget (const String &name, const Properties &globdat, const String &context)
 Returns a named item set stored in a (global) data set. More...
 
static jem::Ref< DictgetAll (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 ClassgetType ()
 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::PointSet::PointSet ( const String name = "")
explicitprotected
virtual jive::util::PointSet::~PointSet ( )
protectedvirtual

Member Function Documentation

virtual idx_t jive::util::PointSet::rank ( ) const
pure virtual

Implemented in jive::util::StdPointSet.

virtual String jive::util::PointSet::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::StdPointSet.

virtual void jive::util::PointSet::getPointCoords ( const Vector coords,
idx_t  ipoint 
) const
pure virtual

Implemented in jive::util::StdPointSet.

virtual double jive::util::PointSet::getPointXCoord ( idx_t  ipoint,
idx_t  idim = 0 
) const
pure virtual

Implemented in jive::util::StdPointSet.

virtual void jive::util::PointSet::getCoords ( const Matrix coords) const
virtual

Reimplemented in jive::util::StdPointSet.

virtual void jive::util::PointSet::getXCoords ( const Vector coords,
idx_t  idim = 0 
) const
virtual

Reimplemented in jive::util::StdPointSet.

virtual void jive::util::PointSet::getSomeCoords ( const Matrix coords,
const IdxVector &  ipoints 
) const
virtual

Reimplemented in jive::util::StdPointSet.

virtual void jive::util::PointSet::getSomeXCoords ( const Vector coords,
const IdxVector &  ipoints,
idx_t  idim = 0 
) const
virtual

Reimplemented in jive::util::StdPointSet.

virtual Matrix jive::util::PointSet::toMatrix ( ) const
virtual
virtual void jive::util::PointSet::printSubset ( PrintWriter out,
const IdxVector &  ipoints 
) const
virtual

Member Data Documentation

Event< Self& > jive::util::PointSet::newGeomEvent
Event< idx_t, Self& > jive::util::PointSet::newRankEvent