CDPL.Grid.AttributedGrid Class Reference

Abstract base class for grid types that also carry generic key/value properties. More...

Inheritance diagram for CDPL.Grid.AttributedGrid:

Public Member Functions
None	__init__ ()
	Initializes the AttributedGrid instance.
bool	isEmpty ()
	Tells whether the grid is empty. More...
int	getNumElements ()
	Returns the total number of grid elements. More...
int	__len__ ()
Base.Any	__getitem__ (Base.LookupKey key)
bool	__contains__ (Base.LookupKey key)
	Returns the result of the membership test operation key in self. More...
None	__setitem__ (Base.LookupKey key, Base.Any value)
bool	__delitem__ (Base.LookupKey key)
Public Member Functions inherited from CDPL.Base.PropertyContainer
int	getObjectID ()
	Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
int	getNumProperties ()
	Returns the number of property entries. More...
Any	getPropertyOrDefault (LookupKey key, Any def_value)
list	getPropertyKeys ()
list	getPropertyValues ()
list	getProperties ()
	Returns a reference to itself. More...
None	setProperty (LookupKey key, Any value)
bool	removeProperty (LookupKey key)
	Clears the value of the property specified by key. More...
Any	getProperty (LookupKey key, bool throw_=False)
	Returns the value of the property specified by key. More...
bool	isPropertySet (LookupKey key)
	Tells whether or not a value has been assigned to the property specified by key. More...
None	clearProperties ()
	Clears all property values.
None	addProperties (PropertyContainer cntnr)
	Adds the property value entries in the PropertyContainer instance cntnr. More...
None	copyProperties (PropertyContainer cntnr)
	Replaces the current set of properties by a copy of the entries in cntnr. More...
None	swap (PropertyContainer cntnr)
	Exchanges the properties of this container with the properties of the container cntnr. More...
Any	__getitem__ (LookupKey key)
bool	__contains__ (LookupKey key)
	Returns the result of the membership test operation key in self. More...
None	__setitem__ (LookupKey key, Any value)
bool	__delitem__ (LookupKey key)

Properties
	numElements = property(getNumElements)
Properties inherited from CDPL.Base.PropertyContainer
	objectID = property(getObjectID)
	propertyKeys = property(getPropertyKeys)
	propertyValues = property(getPropertyValues)
	properties = property(getProperties)
	numProperties = property(getNumProperties)

Detailed Description

Abstract base class for grid types that also carry generic key/value properties.

AttributedGrid combines the property-bag interface from Base.PropertyContainer with the minimal grid interface required to know the number of grid elements and whether the grid is empty. Concrete grid types (e.g. Grid.RegularGrid) implement the pure virtual member functions.

Member Function Documentation

isEmpty()

bool CDPL.Grid.AttributedGrid.isEmpty

(

)

Tells whether the grid is empty.

Returns

True if the grid is empty, and False otherwise.

Reimplemented in CDPL.Grid.FSpatialGrid, CDPL.Grid.FRegularGrid, CDPL.Grid.DSpatialGrid, and CDPL.Grid.DRegularGrid.

getNumElements()

int CDPL.Grid.AttributedGrid.getNumElements

(

)

Returns the total number of grid elements.

Returns

The number of grid elements.

Reimplemented in CDPL.Grid.FSpatialGrid, and CDPL.Grid.DSpatialGrid.

__len__()

int CDPL.Grid.AttributedGrid.__len__

(

)

Returns

Reimplemented from CDPL.Base.PropertyContainer.

Reimplemented in CDPL.Grid.FSpatialGrid, CDPL.Grid.FRegularGrid, CDPL.Grid.DSpatialGrid, and CDPL.Grid.DRegularGrid.

__getitem__()

Base.Any CDPL.Grid.AttributedGrid.__getitem__

(

Base.LookupKey

key

)

Parameters

key

Returns

Reimplemented in CDPL.Grid.FSpatialGrid, CDPL.Grid.FRegularGrid, CDPL.Grid.DSpatialGrid, and CDPL.Grid.DRegularGrid.

__contains__()

bool CDPL.Grid.AttributedGrid.__contains__

(

Base.LookupKey

key

)

Returns the result of the membership test operation key in self.

Parameters

key	The value to test for membership.

Returns

The result of the membership test operation.

Reimplemented in CDPL.Grid.FSpatialGrid, CDPL.Grid.FRegularGrid, CDPL.Grid.DSpatialGrid, and CDPL.Grid.DRegularGrid.

__setitem__()

None CDPL.Grid.AttributedGrid.__setitem__	(	Base.LookupKey	key,
		Base.Any	value
	)

Parameters

key
value

Reimplemented in CDPL.Grid.FSpatialGrid, CDPL.Grid.FRegularGrid, CDPL.Grid.DSpatialGrid, and CDPL.Grid.DRegularGrid.

__delitem__()

bool CDPL.Grid.AttributedGrid.__delitem__

(

Base.LookupKey

key

)

Parameters

key

Returns

Reimplemented in CDPL.Grid.FSpatialGrid, CDPL.Grid.FRegularGrid, CDPL.Grid.DSpatialGrid, and CDPL.Grid.DRegularGrid.