vistle::Object Class Reference

#include <core/object.h>

Inheritance diagram for vistle::Object:

Collaboration diagram for vistle::Object:

Public Types
enum	InitializedFlags { Initialized }
enum	Type {   COORD = -9 , COORDWRADIUS = -8 , DATABASE = -7 , UNKNOWN = -1 ,   EMPTY = 1 , PLACEHOLDER = 11 , TEXTURE1D = 16 , POINTS = 18 ,   SPHERES = 19 , LINES = 20 , TUBES = 21 , TRIANGLES = 22 ,   POLYGONS = 23 , UNSTRUCTUREDGRID = 24 , UNIFORMGRID = 25 , RECTILINEARGRID = 26 ,   STRUCTUREDGRID = 27 , QUADS = 28 , VERTEXOWNERLIST = 95 , CELLTREE1 = 96 ,   CELLTREE2 = 97 , CELLTREE3 = 98 , NORMALS = 99 , VEC = 100 }
typedef std::shared_ptr< Object >	ptr
typedef std::shared_ptr< const Object >	const_ptr
typedef ObjectData	Data

Public Member Functions
template<class Interface >
const Interface *	getInterface () const
std::shared_ptr< const Object >	object () const override
virtual	~Object ()
bool	operator== (const Object &other) const
bool	operator!= (const Object &other) const
bool	isComplete () const
virtual std::set< Object::const_ptr >	referencedObjects () const
	check whether all references have been resolved More...
Object::ptr	clone () const
virtual Object::ptr	cloneInternal () const =0
Object::ptr	cloneType () const
virtual Object::ptr	cloneTypeInternal () const =0
virtual void	refresh () const
	refresh cached pointers from shm More...
virtual bool	check () const
virtual void	updateInternals ()
virtual bool	isEmpty () const
virtual bool	isEmpty ()
shm_handle_t	getHandle () const
Type	getType () const
std::string	getName () const
int	getBlock () const
int	getNumBlocks () const
double	getRealTime () const
int	getTimestep () const
int	getNumTimesteps () const
int	getIteration () const
int	getExecutionCounter () const
int	getCreator () const
Matrix4	getTransform () const
void	setBlock (const int block)
void	setNumBlocks (const int num)
void	setRealTime (double time)
void	setTimestep (const int timestep)
void	setNumTimesteps (const int num)
void	setIteration (const int num)
void	setExecutionCounter (const int count)
void	setCreator (const int id)
void	setTransform (const Matrix4 &transform)
const Meta &	meta () const
void	setMeta (const Meta &meta)
void	addAttribute (const std::string &key, const std::string &value="")
void	setAttributeList (const std::string &key, const std::vector< std::string > &values)
virtual void	copyAttributes (Object::const_ptr src, bool replace=true)
bool	hasAttribute (const std::string &key) const
std::string	getAttribute (const std::string &key) const
std::vector< std::string >	getAttributes (const std::string &key) const
std::vector< std::string >	getAttributeList () const
bool	addAttachment (const std::string &key, Object::const_ptr att) const
bool	hasAttachment (const std::string &key) const
void	copyAttachments (Object::const_ptr src, bool replace=true)
Object::const_ptr	getAttachment (const std::string &key) const
bool	removeAttachment (const std::string &key) const
int	ref () const
int	unref () const
int	refcount () const
template<class Archive >
void	saveObject (Archive &ar) const
Data *	d () const

Static Public Member Functions
static const char *	toString (Type v)
static const char *	typeName ()
static Object *	createEmpty (const std::string &name=std::string())
static std::shared_ptr< Object >	as (std::shared_ptr< Object > ptr)
static std::shared_ptr< const Object >	as (std::shared_ptr< const Object > ptr)
template<class Archive >
static Object *	loadObject (Archive &ar)

Protected Member Functions
	Object (Data *data)
	Object ()
Protected Member Functions inherited from vistle::ObjectInterfaceBase
virtual	~ObjectInterfaceBase ()

Static Protected Member Functions
static void	publish (const Data *d)
static Object *	create (Data *)

Protected Attributes
Data *	m_data

Friends
class	Shm
class	ObjectTypeRegistry
struct	ObjectData
template<class ObjType >
class	shm_obj_ref
void	Shm::markAsRemoved (const std::string &name)

Member Typedef Documentation

const_ptr

typedef std::shared_ptr<const Object> vistle::Object::const_ptr

Data

typedef ObjectData vistle::Object::Data

ptr

typedef std::shared_ptr<Object> vistle::Object::ptr

Member Enumeration Documentation

InitializedFlags

enum vistle::Object::InitializedFlags

Enumerator
Initialized

Type

enum vistle::Object::Type

Enumerator
COORD
COORDWRADIUS
DATABASE
UNKNOWN
EMPTY
PLACEHOLDER
TEXTURE1D
POINTS
SPHERES
LINES
TUBES
TRIANGLES
POLYGONS
UNSTRUCTUREDGRID
UNIFORMGRID
RECTILINEARGRID
STRUCTUREDGRID
QUADS
VERTEXOWNERLIST
CELLTREE1
CELLTREE2
CELLTREE3
NORMALS
VEC

Constructor & Destructor Documentation

~Object()

vistle::Object::~Object ( )

virtual

Object() [1/2]

vistle::Object::Object ( Object::Data *  data )

protected

Object() [2/2]

vistle::Object::Object ( )

protected

Member Function Documentation

addAttachment()

bool vistle::Object::addAttachment	(	const std::string &	key,
		Object::const_ptr	att
	)		const

addAttribute()

void vistle::Object::addAttribute	(	const std::string &	key,
		const std::string &	value = ""
	)

as() [1/2]

static std::shared_ptr< const Object > vistle::Object::as ( std::shared_ptr< const Object >  ptr )

inlinestatic

as() [2/2]

static std::shared_ptr< Object > vistle::Object::as ( std::shared_ptr< Object >  ptr )

inlinestatic

check()

bool vistle::Object::check ( ) const

virtual

clone()

Object::ptr vistle::Object::clone

(

)

const

cloneInternal()

virtual Object::ptr vistle::Object::cloneInternal ( ) const

pure virtual

cloneType()

Object::ptr vistle::Object::cloneType

(

)

const

cloneTypeInternal()

virtual Object::ptr vistle::Object::cloneTypeInternal ( ) const

pure virtual

copyAttachments()

void vistle::Object::copyAttachments	(	Object::const_ptr	src,
		bool	replace = true
	)

copyAttributes()

void vistle::Object::copyAttributes ( Object::const_ptr  src, bool  replace = true  )

virtual

Reimplemented in vistle::DataBase, vistle::RectilinearGrid, vistle::StructuredGrid, and vistle::UniformGrid.

create()

Object * vistle::Object::create ( Data *  data )

staticprotected

createEmpty()

Object * vistle::Object::createEmpty ( const std::string &  name = std::string() )

static

d()

Data * vistle::Object::d ( ) const

inline

getAttachment()

Object::const_ptr vistle::Object::getAttachment

(

const std::string &

key

)

const

getAttribute()

std::string vistle::Object::getAttribute

(

const std::string &

key

)

const

getAttributeList()

std::vector< std::string > vistle::Object::getAttributeList

(

)

const

getAttributes()

std::vector< std::string > vistle::Object::getAttributes

(

const std::string &

key

)

const

getBlock()

int vistle::Object::getBlock

(

)

const

getCreator()

int vistle::Object::getCreator

(

)

const

getExecutionCounter()

int vistle::Object::getExecutionCounter

(

)

const

getHandle()

shm_handle_t vistle::Object::getHandle

(

)

const

getInterface()

template<class Interface >

const Interface * vistle::Object::getInterface ( ) const

inline

getIteration()

int vistle::Object::getIteration

(

)

const

getName()

std::string vistle::Object::getName

(

)

const

getNumBlocks()

int vistle::Object::getNumBlocks

(

)

const

getNumTimesteps()

int vistle::Object::getNumTimesteps

(

)

const

getRealTime()

double vistle::Object::getRealTime

(

)

const

getTimestep()

int vistle::Object::getTimestep

(

)

const

getTransform()

Matrix4 vistle::Object::getTransform

(

)

const

getType()

Object::Type vistle::Object::getType

(

)

const

hasAttachment()

bool vistle::Object::hasAttachment

(

const std::string &

key

)

const

hasAttribute()

bool vistle::Object::hasAttribute

(

const std::string &

key

)

const

isComplete()

bool vistle::Object::isComplete

(

)

const

isEmpty() [1/2]

bool vistle::Object::isEmpty ( )

virtual

isEmpty() [2/2]

bool vistle::Object::isEmpty ( ) const

virtual

loadObject()

template<class Archive >

Object * vistle::Object::loadObject ( Archive &  ar )

static

meta()

const Meta & vistle::Object::meta

(

)

const

object()

std::shared_ptr< const Object > vistle::Object::object ( ) const

inlineoverridevirtual

Implements vistle::ObjectInterfaceBase.

operator!=()

bool vistle::Object::operator!=

(

const Object &

other

)

const

operator==()

bool vistle::Object::operator==

(

const Object &

other

)

const

publish()

void vistle::Object::publish ( const Data *  d )

staticprotected

ref()

int vistle::Object::ref

(

)

const

refcount()

int vistle::Object::refcount

(

)

const

referencedObjects()

std::set< Object::const_ptr > vistle::Object::referencedObjects ( ) const

virtual

check whether all references have been resolved

Reimplemented in vistle::Coords, vistle::DataBase, vistle::RectilinearGrid, and vistle::UniformGrid.

refresh()

void vistle::Object::refresh ( ) const

virtual

refresh cached pointers from shm

removeAttachment()

bool vistle::Object::removeAttachment

(

const std::string &

key

)

const

saveObject()

template<class Archive >

void vistle::Object::saveObject

(

Archive &

ar

)

const

setAttributeList()

void vistle::Object::setAttributeList	(	const std::string &	key,
		const std::vector< std::string > &	values
	)

setBlock()

void vistle::Object::setBlock

(

const int

block

)

setCreator()

void vistle::Object::setCreator

(

const int

id

)

setExecutionCounter()

void vistle::Object::setExecutionCounter

(

const int

count

)

setIteration()

void vistle::Object::setIteration

(

const int

num

)

setMeta()

void vistle::Object::setMeta

(

const Meta &

meta

)

setNumBlocks()

void vistle::Object::setNumBlocks

(

const int

num

)

setNumTimesteps()

void vistle::Object::setNumTimesteps

(

const int

num

)

setRealTime()

void vistle::Object::setRealTime

(

double

time

)

setTimestep()

void vistle::Object::setTimestep

(

const int

timestep

)

setTransform()

void vistle::Object::setTransform

(

const Matrix4 &

transform

)

toString()

const char * vistle::Object::toString ( Type  v )

static

typeName()

static const char * vistle::Object::typeName ( )

inlinestatic

unref()

int vistle::Object::unref

(

)

const

updateInternals()

void vistle::Object::updateInternals ( )

virtual

Reimplemented in vistle::Vec< T, Dim >, vistle::Vec< Scalar, 3 >, and vistle::Vec< Scalar >.

Friends And Related Function Documentation

ObjectData

friend struct ObjectData

friend

ObjectTypeRegistry

friend class ObjectTypeRegistry

friend

Shm

friend class Shm

friend

Shm::markAsRemoved

void Shm::markAsRemoved ( const std::string &  name )

friend

shm_obj_ref

template<class ObjType >

friend class shm_obj_ref

friend

Member Data Documentation

m_data

Data* vistle::Object::m_data

protected

---

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

• core/object.h
• core/object.cpp
• core/object_impl.h