a collection of attributes More...

#include <vtkGenericAttributeCollection.h>

Inheritance diagram for vtkGenericAttributeCollection:

Collaboration diagram for vtkGenericAttributeCollection:

Public Member Functions
int	GetNumberOfAttributes ()
	Return the number of attributes (e.g., instances of vtkGenericAttribute) in the collection.
int	GetNumberOfComponents ()
	Return the number of components.
int	GetNumberOfPointCenteredComponents ()
	Return the number of components.
int	GetMaxNumberOfComponents ()
	Maximum number of components encountered among all attributes.
unsigned long	GetActualMemorySize ()
	Actual size of the data in kibibytes (1024 bytes); only valid after the pipeline has updated.
int	IsEmpty ()
	Indicate whether the collection contains any attributes.
vtkGenericAttribute *	GetAttribute (int i)
	Return a pointer to the ith instance of vtkGenericAttribute.
void	InsertAttribute (int i, vtkGenericAttribute *a)
	Return the index of the attribute named `name'.
void	Reset ()
	Remove the attribute at `i'.
void	DeepCopy (vtkGenericAttributeCollection *other)
	Copy, without reference counting, the other attribute array.
void	ShallowCopy (vtkGenericAttributeCollection *other)
	Copy, via reference counting, the other attribute array.
vtkMTimeType	GetMTime () override
	vtkAttributeCollection is a composite object and needs to check each member of its collection for modified time.
void	SetActiveAttribute (int attribute, int component=0)
	Set the scalar attribute to be processed.
int *	GetAttributesToInterpolate ()
	Indices of attributes to interpolate.

virtual int	GetActiveAttribute ()
	Index of the attribute to be processed (not necessarily scalar).

virtual int	GetActiveComponent ()
	Component of the active attribute to be processed.

virtual int	GetNumberOfAttributesToInterpolate ()
	Number of attributes to interpolate.
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.
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 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 vtkGenericAttributeCollection *	New ()
	Create an empty collection.
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.
typedef vtkObject	Superclass
	Standard type definition and print methods for a VTK class.
static vtkTypeBool	IsTypeOf (const char *type)
	Standard type definition and print methods for a VTK class.
static vtkGenericAttributeCollection *	SafeDownCast (vtkObjectBase *o)
	Standard type definition and print methods for a VTK class.
virtual vtkTypeBool	IsA (const char *type)
	Standard type definition and print methods for a VTK class.
vtkGenericAttributeCollection *	NewInstance () const
	Standard type definition and print methods for a VTK class.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard type definition and print methods for a VTK class.
virtual vtkObjectBase *	NewInstanceInternal () const
	Standard type definition and print methods for a VTK class.
vtkGenericAttributeInternalVector *	AttributeInternalVector
	STL vector for storing attributes.
vtkIntInternalVector *	AttributeIndices
	STL vector for storing index of point centered attributes.
int	ActiveAttribute
	STL vector for storing attributes.
int	ActiveComponent
	STL vector for storing attributes.
int	NumberOfAttributesToInterpolate
	STL vector for storing attributes.
int	AttributesToInterpolate [10]
	STL vector for storing attributes.
int	NumberOfComponents
	STL vector for storing attributes.
int	NumberOfPointCenteredComponents
	STL vector for storing attributes.
int	MaxNumberOfComponents
	STL vector for storing attributes.
unsigned long	ActualMemorySize
	STL vector for storing attributes.
vtkTimeStamp	ComputeTime
	STL vector for storing attributes.
void	SetAttributesToInterpolate (int size, int *attributes)
	Does the array attributes' of size size' have `attribute'?
void	SetAttributesToInterpolateToAll ()
	STL vector for storing attributes.
	vtkGenericAttributeCollection ()
	Default constructor: empty collection.
	~vtkGenericAttributeCollection () override
	Destructor.
void	ComputeNumbers ()
	Compute number of components, max number of components and actual memory size.

Additional Inherited Members
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	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)
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

a collection of attributes

vtkGenericAttributeCollection is a class that collects attributes (represented by vtkGenericAttribute).

Tests:: vtkGenericAttributeCollection (Tests)

Definition at line 25 of file vtkGenericAttributeCollection.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkGenericAttributeCollection::Superclass

Standard type definition and print methods for a VTK class.

Definition at line 37 of file vtkGenericAttributeCollection.h.

Constructor & Destructor Documentation

◆ vtkGenericAttributeCollection()

vtkGenericAttributeCollection::vtkGenericAttributeCollection ( )

protected

Default constructor: empty collection.

◆ ~vtkGenericAttributeCollection()

vtkGenericAttributeCollection::~vtkGenericAttributeCollection ( )

overrideprotected

Destructor.

Member Function Documentation

◆ New()

vtkGenericAttributeCollection * vtkGenericAttributeCollection::New ( )

static

Create an empty collection.

◆ IsTypeOf()

vtkTypeBool vtkGenericAttributeCollection::IsTypeOf ( const char * type )

static

Standard type definition and print methods for a VTK class.

◆ IsA()

virtual vtkTypeBool vtkGenericAttributeCollection::IsA ( const char * type )

virtual

Standard type definition and print methods for a VTK class.

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

vtkGenericAttributeCollection * vtkGenericAttributeCollection::SafeDownCast ( vtkObjectBase * o )

static

Standard type definition and print methods for a VTK class.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkGenericAttributeCollection::NewInstanceInternal ( ) const

protectedvirtual

Standard type definition and print methods for a VTK class.

◆ NewInstance()

vtkGenericAttributeCollection * vtkGenericAttributeCollection::NewInstance ( ) const

Standard type definition and print methods for a VTK class.

◆ PrintSelf()

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

overridevirtual

Standard type definition and print methods for a VTK class.

Reimplemented from vtkObjectBase.

◆ GetNumberOfAttributes()

int vtkGenericAttributeCollection::GetNumberOfAttributes ( )

Return the number of attributes (e.g., instances of vtkGenericAttribute) in the collection.

Postcondition: positive_result: result>=0

◆ GetNumberOfComponents()

int vtkGenericAttributeCollection::GetNumberOfComponents ( )

Return the number of components.

This is the sum of all components found in all attributes.

Postcondition: positive_result: result>=0

◆ GetNumberOfPointCenteredComponents()

int vtkGenericAttributeCollection::GetNumberOfPointCenteredComponents ( )

Return the number of components.

This is the sum of all components found in all point centered attributes.

Postcondition: positive_result: result>=0

◆ GetMaxNumberOfComponents()

int vtkGenericAttributeCollection::GetMaxNumberOfComponents ( )

Maximum number of components encountered among all attributes.

Postcondition: positive_result: result>=0; valid_result: result<=GetNumberOfComponents()

◆ GetActualMemorySize()

unsigned long vtkGenericAttributeCollection::GetActualMemorySize ( )

Actual size of the data in kibibytes (1024 bytes); only valid after the pipeline has updated.

It is guaranteed to be greater than or equal to the memory required to represent the data.

◆ IsEmpty()

int vtkGenericAttributeCollection::IsEmpty ( )

Indicate whether the collection contains any attributes.

Postcondition: definition: result==(GetNumberOfAttributes()==0)

◆ GetAttribute()

vtkGenericAttribute * vtkGenericAttributeCollection::GetAttribute ( int i )

Return a pointer to the ith instance of vtkGenericAttribute.

Precondition: not_empty: !IsEmpty(); valid_i: i>=0 && i<GetNumberOfAttributes()

Postcondition: result_exists: result!=0

◆ InsertAttribute()

void vtkGenericAttributeCollection::InsertAttribute	(	int	i,
		vtkGenericAttribute *	a )

Return the index of the attribute named `name'.

Return the non-negative index if found. Return -1 otherwise.

Precondition: name_exists: name!=0

Postcondition: valid_result: (result==-1) || (result>=0) && (result<=GetNumberOfAttributes()) */ int FindAttribute(const char* name);

/** Return the index of the first component of attribute `i' in an array of format attrib0comp0 attrib0comp1 ... attrib4comp0 ...

Precondition: valid_i: i>=0 && i<GetNumberOfAttributes(); is_point_centered: GetAttribute(i)->GetCentering()==vtkPointCentered */ int GetAttributeIndex(int i);

/** Add the attribute `a' to the end of the collection.

Precondition: a_exists: a!=0

Postcondition: more_items: GetNumberOfAttributes()==old GetNumberOfAttributes()+1; a_is_set: GetAttribute(GetNumberOfAttributes()-1)==a */ void InsertNextAttribute(vtkGenericAttribute* a);

/** Replace the attribute at index i' by a'.

Precondition: not_empty: !IsEmpty(); a_exists: a!=0; valid_i: i>=0 && i<GetNumberOfAttributes()

Postcondition: same_size: GetNumberOfAttributes()==old GetNumberOfAttributes(); item_is_set: GetAttribute(i)==a

◆ Reset()

void vtkGenericAttributeCollection::Reset ( )

Remove the attribute at `i'.

Precondition: not_empty: !IsEmpty(); valid_i: i>=0 && i<GetNumberOfAttributes()

Postcondition: fewer_items: GetNumberOfAttributes()==old GetNumberOfAttributes()-1 */ void RemoveAttribute(int i);

/** Remove all attributes.

Postcondition: is_empty: GetNumberOfAttributes()==0

◆ DeepCopy()

void vtkGenericAttributeCollection::DeepCopy ( vtkGenericAttributeCollection * other )

Copy, without reference counting, the other attribute array.

Precondition: other_exists: other!=0; not_self: other!=this

Postcondition: same_size: GetNumberOfAttributes()==other->GetNumberOfAttributes()

◆ ShallowCopy()

void vtkGenericAttributeCollection::ShallowCopy ( vtkGenericAttributeCollection * other )

Copy, via reference counting, the other attribute array.

Precondition: other_exists: other!=0; not_self: other!=this

Postcondition: same_size: GetNumberOfAttributes()==other->GetNumberOfAttributes()

◆ GetMTime()

vtkMTimeType vtkGenericAttributeCollection::GetMTime ( )

overridevirtual

vtkAttributeCollection is a composite object and needs to check each member of its collection for modified time.

Reimplemented from vtkObject.

◆ GetActiveAttribute()

virtual int vtkGenericAttributeCollection::GetActiveAttribute ( )

virtual

Index of the attribute to be processed (not necessarily scalar).

Precondition: not_empty: !IsEmpty()

Postcondition: valid_result: result>=0 && result<GetNumberOfAttributes()

◆ GetActiveComponent()

virtual int vtkGenericAttributeCollection::GetActiveComponent ( )

virtual

Component of the active attribute to be processed.

-1 means module.

Precondition: not_empty: GetNumberOfAttributes()>0

Postcondition: valid_result: result>=-1 && result<GetAttribute(GetActiveAttribute())->GetNumberOfComponents()

◆ SetActiveAttribute()

void vtkGenericAttributeCollection::SetActiveAttribute	(	int	attribute,
		int	component = 0 )

Set the scalar attribute to be processed.

-1 means module.

Precondition: not_empty: !IsEmpty(); valid_attribute: attribute>=0 && attribute<GetNumberOfAttributes(); valid_component: component>=-1 && component<GetAttribute(attribute)->GetNumberOfComponents()

Postcondition: is_set: GetActiveAttribute()==attribute && GetActiveComponent()==component

◆ GetNumberOfAttributesToInterpolate()

virtual int vtkGenericAttributeCollection::GetNumberOfAttributesToInterpolate ( )

virtual

Number of attributes to interpolate.

Precondition: not_empty: !IsEmpty()

Postcondition: positive_result: result>=0

◆ GetAttributesToInterpolate()

int * vtkGenericAttributeCollection::GetAttributesToInterpolate ( )

Indices of attributes to interpolate.

Precondition: not_empty: !IsEmpty()

Postcondition: valid_result: GetNumberOfAttributesToInterpolate()>0

◆ SetAttributesToInterpolate()

void vtkGenericAttributeCollection::SetAttributesToInterpolate	(	int	size,
		int *	attributes )

Does the array attributes' of size size' have `attribute'?

Precondition: positive_size: size>=0; valid_attributes: size>0 implies attributes!=0 */ vtkTypeBool HasAttribute(int size, int* attributes, int attribute) ;

/** Set the attributes to interpolate.

Precondition: not_empty: !IsEmpty(); positive_size: size>=0; valid_attributes: size>0 implies attributes!=0; valid_attributes_contents: attributes!=0 implies !HasAttributes(size,attributes,GetActiveAttribute())

Postcondition: is_set: (GetNumberOfAttributesToInterpolate()==size)&& (GetAttributesToInterpolate()==attributes)

◆ SetAttributesToInterpolateToAll()

void vtkGenericAttributeCollection::SetAttributesToInterpolateToAll ( )

STL vector for storing attributes.

◆ ComputeNumbers()

void vtkGenericAttributeCollection::ComputeNumbers ( )

protected

Compute number of components, max number of components and actual memory size.

Member Data Documentation

◆ AttributeInternalVector

vtkGenericAttributeInternalVector* vtkGenericAttributeCollection::AttributeInternalVector

protected

STL vector for storing attributes.

Definition at line 246 of file vtkGenericAttributeCollection.h.

◆ AttributeIndices

vtkIntInternalVector* vtkGenericAttributeCollection::AttributeIndices

protected

STL vector for storing index of point centered attributes.

Definition at line 250 of file vtkGenericAttributeCollection.h.

◆ ActiveAttribute

int vtkGenericAttributeCollection::ActiveAttribute

protected

STL vector for storing attributes.

Definition at line 252 of file vtkGenericAttributeCollection.h.

◆ ActiveComponent

int vtkGenericAttributeCollection::ActiveComponent

protected

STL vector for storing attributes.

Definition at line 253 of file vtkGenericAttributeCollection.h.

◆ NumberOfAttributesToInterpolate

int vtkGenericAttributeCollection::NumberOfAttributesToInterpolate

protected

STL vector for storing attributes.

Definition at line 254 of file vtkGenericAttributeCollection.h.

◆ AttributesToInterpolate

int vtkGenericAttributeCollection::AttributesToInterpolate[10]

protected

STL vector for storing attributes.

Definition at line 255 of file vtkGenericAttributeCollection.h.

◆ NumberOfComponents

int vtkGenericAttributeCollection::NumberOfComponents

protected

STL vector for storing attributes.

Definition at line 257 of file vtkGenericAttributeCollection.h.

◆ NumberOfPointCenteredComponents

int vtkGenericAttributeCollection::NumberOfPointCenteredComponents

protected

STL vector for storing attributes.

Definition at line 258 of file vtkGenericAttributeCollection.h.

◆ MaxNumberOfComponents

int vtkGenericAttributeCollection::MaxNumberOfComponents

protected

STL vector for storing attributes.

Definition at line 259 of file vtkGenericAttributeCollection.h.

◆ ActualMemorySize

unsigned long vtkGenericAttributeCollection::ActualMemorySize

protected

STL vector for storing attributes.

Definition at line 260 of file vtkGenericAttributeCollection.h.

◆ ComputeTime

vtkTimeStamp vtkGenericAttributeCollection::ComputeTime

protected

STL vector for storing attributes.

Definition at line 261 of file vtkGenericAttributeCollection.h.

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

Common/DataModel/vtkGenericAttributeCollection.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkGenericAttributeCollection()

◆ ~vtkGenericAttributeCollection()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ GetNumberOfAttributes()

◆ GetNumberOfComponents()

◆ GetNumberOfPointCenteredComponents()

◆ GetMaxNumberOfComponents()

◆ GetActualMemorySize()

◆ IsEmpty()

◆ GetAttribute()

◆ InsertAttribute()

◆ Reset()

◆ DeepCopy()

◆ ShallowCopy()

◆ GetMTime()

◆ GetActiveAttribute()

◆ GetActiveComponent()

◆ SetActiveAttribute()

◆ GetNumberOfAttributesToInterpolate()

◆ GetAttributesToInterpolate()

◆ SetAttributesToInterpolate()

◆ SetAttributesToInterpolateToAll()

◆ ComputeNumbers()

Member Data Documentation

◆ AttributeInternalVector

◆ AttributeIndices

◆ ActiveAttribute

◆ ActiveComponent

◆ NumberOfAttributesToInterpolate

◆ AttributesToInterpolate

◆ NumberOfComponents

◆ NumberOfPointCenteredComponents

◆ MaxNumberOfComponents

◆ ActualMemorySize

◆ ComputeTime