Skeleton Class Reference [The Grid Entity]

A Skeleton is a set of Representation object, each of them accessed by an Representer object. More...

#include <Skeleton.hpp>

List of all members.

Public Member Functions

• Skeleton (const WeakPtr< GridContainer > &C)

  Constructor.
  

• ~Skeleton ()

  Destructor.
  

• RefPtr< Representation > UniqueRepresentation () const

  Retrieve the representation in cartesian coordinates.
  

• RefPtr< Representation > FirstRepresentation () const

  Return the first representation found, which has not much usage beside retrieving general information common to all Representation, so it is not of relevance which one to use here.
  

• override int Dims () const

  Dimensionality of this base space.
  

• RefPtr< SizeInterface > getSize () const

  Provide the dimensionality of this Skeleton, which is taken from the positions field of the first representation, whatever it is.
  

Related Functions

(Note that these are not member functions.)

• typedef RefPtr< Skeleton > pSkeleton

  Shortcut for a strong pointer to a Skeleton object.
  

• typedef WeakPtr< Skeleton > wSkeleton

  Shortcut for a weak pointer to a Skeleton object.
  

---

Detailed Description

A Skeleton is a set of Representation object, each of them accessed by an Representer object.

It defines the Skeleton Space of a discretized Grid. Allows to store sets as mappings from Domain objects to corresponding Representations of the underlying discretized space.

Examples:

Sphere.cpp, and trimesh.cpp.

---

Member Function Documentation

RefPtr< Representation > Skeleton::FirstRepresentation

(

)

const

Return the first representation found, which has not much usage beside retrieving general information common to all Representation, so it is not of relevance which one to use here.

The ordering of Representations is undefined, thus this Representation is undefined as well.

Referenced by Dims(), and getSize().

RefPtr< Representation > Skeleton::UniqueRepresentation

(

)

const

Retrieve the representation in cartesian coordinates.

Return a default Representation for this Skeleton. Currently, such a default Representation is only defined if there is exactly one Representation on this Skeleton. A future version might employ the last Representation used. In any case, at least one Representation must exist yet, as the DefaultRepresention cannot decide what domain to represent initially.

---

Friends And Related Function Documentation

typedef RefPtr<Skeleton> pSkeleton [related]

Shortcut for a strong pointer to a Skeleton object.

typedef WeakPtr<Skeleton> wSkeleton [related]

Shortcut for a weak pointer to a Skeleton object.