Fiber::FragmentID Class Reference

Identification information about a field's fragment. More...

#include <FragmentID.hpp>

Inheritance diagram for Fiber::FragmentID:

Public Member Functions
	FragmentID (const string &Name)
	Construct from name (must be unique).
	FragmentID (const string &Name, FragmentIndex_t ID, const FragmentIDCollectionWeakPtr &theFragmentIDCollection)
const string &	Name () const
	Text ID of the fragment.
FragmentIndex_t	getNumericalID () const
const FragmentIDCollectionWeakPtr &	getFragmentIDCollection () const
string	xml () const
Public Member Functions inherited from Wizt::ReferenceBase< FragmentID >
auto	getObjectCountID () const noexcept
bool	isIdentical (const WeakPtr< Object, Object > &PossibleSelf) const noexcept
void	mkAutoDestructive ()
refcount_t	refcount () const noexcept
	ReferenceBase (Object *that) noexcept
const auto &	self () const
refcount_t	wrefcount () const noexcept
Public Member Functions inherited from Wizt::Intercube
void	addInterface (const RefPtr< InterfaceBase > &I) const
void	addInterfaceData (const Data &D)
void	addInterfaceData (const Data &D)
void	clearInterfaces ()
bool	const_iterateInterfaces (const RefPtr< InterfaceIterationParameter > &IIP) const
virtual RefPtr< InterfaceBase >	createInterface (const type_info &) const
RefPtr< InterfaceBase >	findInterface (const type_info &t) const
RefPtr< InterfaceBase >	getInterface (const type_info &t)
std::string	getInterfaceNames (const char delim=';') const
bool	gotNewInterfaceData (const Data &D)
bool	gotNewInterfaceData (mutex &M, const Data &D)
bool	gotNewInterfaceData (mutex &M, const Data &D)
bool	gotNewInterfaceData (mutex &M, const Data &D, const Selector &S)
bool	gotNewInterfaceData (mutex &M, const Data &D, const Selector *S)
bool	hasChangedInterfaceData (const Data &D) const
bool	hasChangedInterfaceData (const Data &D) const
bool	hasChangedInterfaceData (const Data &D, const Selector &) const
bool	hasChangedInterfaceData (const Data &D, const Selector *) const
bool	hasInterface (const type_info &t) const
bool	iterateInterfaces (const RefPtr< InterfaceIterationParameter > &IIP)
void	printInterfaces () const
void	registerInterface (const type_info &t)
void	removeInterface ()
void	removeInterfaceBase (const type_info &InterfaceBaseID)

Static Public Member Functions
static string	Name (const RefPtr< FragmentID > &fid, const string &UnfragmentedName="")
static string	getName (const RefPtr< FragmentID > &fid, const string &UnfragmentedName="")

Protected Member Functions
	~FragmentID ()
	Destructor.
Protected Member Functions inherited from Wizt::ReferenceBase< FragmentID >
virtual void	extremeUnction ()
ReferenceBase &	operator= (const ReferenceBase &R)
void	suicide ()

Friends
class	FragmentIDCollection

Related Symbols
(Note that these are not member symbols.)
template<Dims_t Dims>
void	setFragmentOverlap (FragmentID &FID, const MultiIndex< Dims > &OverlapStart, const MultiIndex< Dims > &OverlapEnd)
	Setting the overlap property of a fragment ID, also known as the size of a field fragment's ghost zone.
template<Dims_t Dims>
void	setFragmentOverlapStart (FragmentID &FID, const MultiIndex< Dims > &OverlapStart)
	Get the overlap start property of a fragment ID.
template<Dims_t Dims>
void	setFragmentOverlapEnd (FragmentID &FID, const MultiIndex< Dims > &OverlapEnd)
	Set the overlap end property of a fragment ID.
template<Dims_t Dims>
MultiIndex< Dims > &	setFragmentOffset (FragmentID &FID, const MultiIndex< Dims > &Offset)
	Setting the offset property of a fragment ID.
template<Dims_t Dims>
bool	getFragmentOffset (FragmentID &FID, MultiIndex< Dims > &Offset)
	Get the offset property of a fragment ID.
template<Dims_t Dims>
bool	getFragmentOverlapStart (FragmentID &FID, MultiIndex< Dims > &Value)
	Get the overlap start property of a fragment ID.
template<Dims_t Dims>
bool	getFragmentOverlapEnd (FragmentID &FID, MultiIndex< Dims > &Value)
	Get the overlap end property of a fragment ID.

Additional Inherited Members
Public Types inherited from Wizt::ReferenceBase< FragmentID >
typedef Object	reference_domain_t
typedef WeakPtr< Object, Object >	SelfPtr_t

Detailed Description

Identification information about a field's fragment.

Currently, this is just an arbitrary textual description. It must be unique for a field and consistent for all fields within a Representation and all Representations in a Grid and all Grids of a Bundle. Thus, fragment ID's are shared among all fields. Renaming a fragment ID is thus globally in effect for all fields.

Additionally, a fragment ID may carry additional information in the form of Interfaces. E.g. see FragmentLocation

Friends And Related Symbol Documentation

getFragmentOffset()

template<Dims_t Dims>

bool getFragmentOffset ( FragmentID & FID, MultiIndex< Dims > & Offset )

related

Get the offset property of a fragment ID.

, Field

References FragmentID().

getFragmentOverlapEnd()

template<Dims_t Dims>

bool getFragmentOverlapEnd ( FragmentID & FID, MultiIndex< Dims > & Value )

related

Get the overlap end property of a fragment ID.

, Field

References FragmentID().

getFragmentOverlapStart()

template<Dims_t Dims>

bool getFragmentOverlapStart ( FragmentID & FID, MultiIndex< Dims > & Value )

related

Get the overlap start property of a fragment ID.

, Field

References FragmentID().

setFragmentOffset()

template<Dims_t Dims>

MultiIndex< Dims > & setFragmentOffset ( FragmentID & FID, const MultiIndex< Dims > & Offset )

related

Setting the offset property of a fragment ID.

, Field

References FragmentID().

setFragmentOverlap()

template<Dims_t Dims>

void setFragmentOverlap ( FragmentID & FID, const MultiIndex< Dims > & OverlapStart, const MultiIndex< Dims > & OverlapEnd )

related

Setting the overlap property of a fragment ID, also known as the size of a field fragment's ghost zone.

, Field

References FragmentID().

setFragmentOverlapEnd()

template<Dims_t Dims>

void setFragmentOverlapEnd ( FragmentID & FID, const MultiIndex< Dims > & OverlapEnd )

related

Set the overlap end property of a fragment ID.

, Field

References FragmentID().

setFragmentOverlapStart()

template<Dims_t Dims>

void setFragmentOverlapStart ( FragmentID & FID, const MultiIndex< Dims > & OverlapStart )

related

Get the overlap start property of a fragment ID.

, Field

References FragmentID().