Wizt::Seagrass Class Reference

The Anemone Cache, called the Seagrass, is based on Anemone objects. More...

#include </home/werner/origo/vish/ocean/Anemonia/Seagrass.hpp>

List of all members.

Public Types

• typedef MemCore::WeakPtr
  < AnemoneCreatorBase > CachedObject_t
• typedef std::list< Dependency_t > Dependencies_t

  Dependencies are given as a list of dependency objects, which are weak pointers to Creature objects.
  

• typedef MemCore::WeakPtr
  < MemCore::Creature > Dependency_t

  The dependencies of an Anemone object are Creatures.
  

Public Member Functions

• size_t cleanable () const
• void cleanup ()

  Clear anything that is scheduled for deletion.
  

• const MemCore::RefPtr
  < MemCore::Cache > & getCache () const
• bool insert (const Dependencies_t &Dependencies, const CachedObject_t &theAnemoneCreator, bool overwriteIfFound=true)

  Register dependencies for an Anemone Creator.
  

• int lawn ()

  Lawn all the seagrass contained here, i.e.
  

• void list_info (FILE *where=stderr)
• size_t memsize (bool FreeableOnly=true) const

  Get the memory occupied by all the Anemone objects stored here.
  

• size_t NumberOfAnemones () const

  Get the number of Anemone objects stored here.
  

• void prepareForDeletion (const CachedObject_t &theAnemone)
• void scheduleDeletion (const MemCore::RefPtr< Anemone > &theAnemone)
• Seagrass (MemCore::memsize_t MaxAllowedCost, const char *CacheID="GPU Objects")

  Constructor.
  

• virtual ~Seagrass ()

  Destructor.
  

---

Detailed Description

The Anemone Cache, called the Seagrass, is based on Anemone objects.

The Seagrass class manages Anemone objects, which are referred to from creator objects that are stored in application code. All these creator objects are child classes of the AnemoneCreatorBase;

Sea grass meadows are inhabited or visited by a diverse and abundant fish fauna. Resident fishes are typically small, cryptic, and of little commercial value. [...] Some higher vertebrates can also be found in sea grass meadows. [...] Sea grasses have potential for extremely high primary productivity. [...] Sea grasses are extremely efficient at capturing and utilizing nutrients. [...] (source: http://savefloridareefs.com/page2/Seagrassandmangroves.html )

---

Member Typedef Documentation

typedef MemCore::WeakPtr<MemCore::Creature> Wizt::Seagrass::Dependency_t

The dependencies of an Anemone object are Creatures.

Their important property is that they are MemCore::Intercubes. Once this Intercube dies, it will schedule all cached Anemone objects for deletion as well. However, the Anemone objects will not be deleted immediately, but only scheduled for deletion. The actual deletion must be done via the Seagrass.

The fact that Creature objects are related to cache management as well is of no relevance here, the Creature's cache is independent from the Seagrass. In particular, the Creature used here may refer to RAM objects, while Anemone objects reside on the GPU.

---

Member Function Documentation

bool Wizt::Seagrass::insert	(	const Dependencies_t &	Dependencies,
		const CachedObject_t &	theAnemoneCreator,
		bool	overwriteIfFound = true
	)

Register dependencies for an Anemone Creator.

Once those dependencies die, so will their interface die, deferred destructor objects which tell the Seagrass to delete the respective Anemone objects at next occasion.

int Wizt::Seagrass::lawn

(

)

Lawn all the seagrass contained here, i.e.

remove all stored entries. Same as purge() (a more conventional naming).

---

The documentation for this class was generated from the following files:

• ocean/Anemonia/Seagrass.hpp
• ocean/Anemonia/Seagrass.cpp