vtkGenericAttribute Class Reference

abstract class defined API for attribute data More...

#include <vtkGenericAttribute.h>

Inheritance diagram for vtkGenericAttribute:

Collaboration diagram for vtkGenericAttribute:

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkGenericAttribute *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual const char *	GetName ()=0
	Name of the attribute.
virtual int	GetNumberOfComponents ()=0
	Dimension of the attribute.
virtual int	GetCentering ()=0
	Is the attribute centered either on points, cells or boundaries?
virtual int	GetType ()=0
	Type of the attribute: scalar, vector, normal, texture coordinate, tensor.
virtual int	GetComponentType ()=0
	Type of the components of the attribute: int, float, double.
virtual vtkIdType	GetSize ()=0
	Number of tuples.
virtual unsigned long	GetActualMemorySize ()=0
	Size in kibibytes (1024 bytes) taken by the attribute.
virtual double *	GetRange (int component=0)=0
	Range of the attribute component ‘component’.
virtual void	GetRange (int component, double range[2])=0
	Range of the attribute component ‘component’.
virtual double	GetMaxNorm ()=0
	Return the maximum euclidean norm for the tuples.
virtual double *	GetTuple (vtkGenericAdaptorCell *c)=0
	Attribute at all points of cell ‘c’.
virtual void	GetTuple (vtkGenericAdaptorCell *c, double *tuple)=0
	Put attribute at all points of cell ‘c’ in ‘tuple’.
virtual double *	GetTuple (vtkGenericCellIterator *c)=0
	Attribute at all points of cell ‘c’.
virtual void	GetTuple (vtkGenericCellIterator *c, double *tuple)=0
	Put attribute at all points of cell ‘c’ in ‘tuple’.
virtual double *	GetTuple (vtkGenericPointIterator *p)=0
	Value of the attribute at position ‘p’.
virtual void	GetTuple (vtkGenericPointIterator *p, double *tuple)=0
	Put the value of the attribute at position ‘p’ into ‘tuple’.
virtual void	GetComponent (int i, vtkGenericCellIterator *c, double *values)=0
	Put component ‘i’ of the attribute at all points of cell ‘c’ in ‘values’.
virtual double	GetComponent (int i, vtkGenericPointIterator *p)=0
	Value of the component ‘i’ of the attribute at position ‘p’.
virtual void	DeepCopy (vtkGenericAttribute *other)=0
	Recursive duplication of ‘other’ in ‘this’.
virtual void	ShallowCopy (vtkGenericAttribute *other)=0
	Update ‘this’ using fields of ‘other’.
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
vtkTypeBool	HasObserver (unsigned long event)
vtkTypeBool	HasObserver (const char *event)
vtkTypeBool	InvokeEvent (unsigned long event)
vtkTypeBool	InvokeEvent (const char *event)
std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.
vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
vtkTypeBool	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.
virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses vtkGarbageCollector or not.

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)
static vtkGenericAttribute *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkGenericAttribute ()
	~vtkGenericAttribute () override
Protected Member Functions inherited from vtkObject
	vtkObject ()
	~vtkObject () override
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
virtual void	ObjectFinalize ()
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
std::string	ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Detailed Description

abstract class defined API for attribute data

vtkGenericAttribute is an abstract class that defines an API for attribute data. Attribute data is data associated with the topology or geometry of a dataset (i.e., points, cells, etc.). vtkGenericAttribute is part of the adaptor framework (see GenericFiltering/README.html).

vtkGenericAttribute provides a more general interface to attribute data than its counterpart vtkDataArray (which assumes a linear, contiguous array). It adopts an iterator interface, and allows attributes to be associated with points, edges, faces, or edges.

Tests:

vtkGenericAttribute (Tests)

Definition at line 39 of file vtkGenericAttribute.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkGenericAttribute::Superclass

Definition at line 42 of file vtkGenericAttribute.h.

Constructor & Destructor Documentation

vtkGenericAttribute()

vtkGenericAttribute::vtkGenericAttribute ( )

protected

~vtkGenericAttribute()

vtkGenericAttribute::~vtkGenericAttribute ( )

overrideprotected

Member Function Documentation

IsTypeOf()

static vtkTypeBool vtkGenericAttribute::IsTypeOf ( const char *  type )

static

IsA()

virtual vtkTypeBool vtkGenericAttribute::IsA ( const char *  name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObjectBase.

SafeDownCast()

static vtkGenericAttribute * vtkGenericAttribute::SafeDownCast ( vtkObjectBase *  o )

static

NewInstanceInternal()

virtual vtkObjectBase * vtkGenericAttribute::NewInstanceInternal ( ) const

protectedvirtual

NewInstance()

vtkGenericAttribute * vtkGenericAttribute::NewInstance

(

)

const

PrintSelf()

void vtkGenericAttribute::PrintSelf ( ostream &  os, vtkIndent  indent  )

overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObjectBase.

GetName()

virtual const char * vtkGenericAttribute::GetName ( )

pure virtual

Name of the attribute.

(e.g. "velocity")

Postcondition

result_may_not_exist: result!=0 || result==0

GetNumberOfComponents()

virtual int vtkGenericAttribute::GetNumberOfComponents ( )

pure virtual

Dimension of the attribute.

(1 for scalar, 3 for velocity)

Postcondition

positive_result: result>=0

GetType()==VTK_SCALARS implies result==1

(GetType()==VTK_VECTORS||(GetType()==VTK_NORMALS)||(GetType()==VTK_TCOORDS) implies result==3

GetType()==VTK_TENSORS implies result==6

GetCentering()

virtual int vtkGenericAttribute::GetCentering ( )

pure virtual

Is the attribute centered either on points, cells or boundaries?

Postcondition

valid_result: (result==vtkPointCentered)||(result==vtkCellCentered)

GetType()

virtual int vtkGenericAttribute::GetType ( )

pure virtual

Type of the attribute: scalar, vector, normal, texture coordinate, tensor.

Postcondition

valid_result: (result==vtkDataSetAttributes::SCALARS) ||(result==vtkDataSetAttributes::VECTORS) ||(result==vtkDataSetAttributes::NORMALS) ||(result==vtkDataSetAttributes::TCOORDS) ||(result==vtkDataSetAttributes::TENSORS)

GetComponentType()

virtual int vtkGenericAttribute::GetComponentType ( )

pure virtual

Type of the components of the attribute: int, float, double.

Postcondition

valid_result: (result==VTK_BIT) ||(result==VTK_CHAR) ||(result==VTK_UNSIGNED_CHAR) ||(result==VTK_SHORT) ||(result==VTK_UNSIGNED_SHORT)||(result==VTK_INT) ||(result==VTK_UNSIGNED_INT) ||(result==VTK_LONG) ||(result==VTK_UNSIGNED_LONG) ||(result==VTK_FLOAT) ||(result==VTK_DOUBLE) ||(result==VTK_ID_TYPE)

GetSize()

virtual vtkIdType vtkGenericAttribute::GetSize ( )

pure virtual

Number of tuples.

Postcondition

valid_result: result>=0

GetActualMemorySize()

virtual unsigned long vtkGenericAttribute::GetActualMemorySize ( )

pure virtual

Size in kibibytes (1024 bytes) taken by the attribute.

GetRange() [1/2]

virtual double * vtkGenericAttribute::GetRange ( int  component = 0 )

pure virtual

Range of the attribute component ‘component’.

If ‘component’==-1, it returns the range of the magnitude (euclidean norm). It returns double, even if GetType()==VTK_INT. NOT THREAD SAFE

Precondition

valid_component: (component>=-1)&&(component<GetNumberOfComponents())

Postcondition

result_exists: result!=0

GetRange() [2/2]

virtual void vtkGenericAttribute::GetRange ( int  component, double  range[2]  )

pure virtual

Range of the attribute component ‘component’.

If ‘component’==-1, it returns the range of the magnitude (euclidean norm). THREAD SAFE

Precondition

valid_component: (component>=-1)&&(component<GetNumberOfComponents())

GetMaxNorm()

virtual double vtkGenericAttribute::GetMaxNorm ( )

pure virtual

Return the maximum euclidean norm for the tuples.

Postcondition

positive_result: result>=0

GetTuple() [1/6]

virtual double * vtkGenericAttribute::GetTuple ( vtkGenericAdaptorCell *  c )

pure virtual

Attribute at all points of cell ‘c’.

Precondition

c_exists: c!=0

c_valid: !c->IsAtEnd()

Postcondition

result_exists: result!=0

valid_result: sizeof(result)==GetNumberOfComponents()*c->GetCell()->GetNumberOfPoints()

GetTuple() [2/6]

virtual void vtkGenericAttribute::GetTuple ( vtkGenericAdaptorCell *  c, double *  tuple  )

pure virtual

Put attribute at all points of cell ‘c’ in ‘tuple’.

Precondition

c_exists: c!=0

c_valid: !c->IsAtEnd()

tuple_exists: tuple!=0

valid_tuple: sizeof(tuple)>=GetNumberOfComponents()*c->GetCell()->GetNumberOfPoints()

GetTuple() [3/6]

virtual double * vtkGenericAttribute::GetTuple ( vtkGenericCellIterator *  c )

pure virtual

Attribute at all points of cell ‘c’.

Precondition

c_exists: c!=0

c_valid: !c->IsAtEnd()

Postcondition

result_exists: result!=0

valid_result: sizeof(result)==GetNumberOfComponents()*c->GetCell()->GetNumberOfPoints()

GetTuple() [4/6]

virtual void vtkGenericAttribute::GetTuple ( vtkGenericCellIterator *  c, double *  tuple  )

pure virtual

Put attribute at all points of cell ‘c’ in ‘tuple’.

Precondition

c_exists: c!=0

c_valid: !c->IsAtEnd()

tuple_exists: tuple!=0

valid_tuple: sizeof(tuple)>=GetNumberOfComponents()*c->GetCell()->GetNumberOfPoints()

GetTuple() [5/6]

virtual double * vtkGenericAttribute::GetTuple ( vtkGenericPointIterator *  p )

pure virtual

Value of the attribute at position ‘p’.

Precondition

p_exists: p!=0

p_valid: !p->IsAtEnd()

Postcondition

result_exists: result!=0

valid_result_size: sizeof(result)==GetNumberOfComponents()

GetTuple() [6/6]

virtual void vtkGenericAttribute::GetTuple ( vtkGenericPointIterator *  p, double *  tuple  )

pure virtual

Put the value of the attribute at position ‘p’ into ‘tuple’.

Precondition

p_exists: p!=0

p_valid: !p->IsAtEnd()

tuple_exists: tuple!=0

valid_tuple_size: sizeof(tuple)>=GetNumberOfComponents()

GetComponent() [1/2]

virtual void vtkGenericAttribute::GetComponent ( int  i, vtkGenericCellIterator *  c, double *  values  )

pure virtual

Put component ‘i’ of the attribute at all points of cell ‘c’ in ‘values’.

Precondition

valid_component: (i>=0) && (i<GetNumberOfComponents())

c_exists: c!=0

c_valid: !c->IsAtEnd()

values_exist: values!=0

valid_values: sizeof(values)>=c->GetCell()->GetNumberOfPoints()

GetComponent() [2/2]

virtual double vtkGenericAttribute::GetComponent ( int  i, vtkGenericPointIterator *  p  )

pure virtual

Value of the component ‘i’ of the attribute at position ‘p’.

Precondition

valid_component: (i>=0) && (i<GetNumberOfComponents())

p_exists: p!=0

p_valid: !p->IsAtEnd()

DeepCopy()

virtual void vtkGenericAttribute::DeepCopy ( vtkGenericAttribute *  other )

pure virtual

Recursive duplication of ‘other’ in ‘this’.

Precondition

other_exists: other!=0

not_self: other!=this

ShallowCopy()

virtual void vtkGenericAttribute::ShallowCopy ( vtkGenericAttribute *  other )

pure virtual

Update ‘this’ using fields of ‘other’.

Precondition

other_exists: other!=0

not_self: other!=this

---

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

• Common/DataModel/vtkGenericAttribute.h