Main Page | Directories | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

vtkGenericAttributeCollection Class Reference

#include <vtkGenericAttributeCollection.h>

Inheritance diagram for vtkGenericAttributeCollection:

Inheritance graph
[legend]
Collaboration diagram for vtkGenericAttributeCollection:

Collaboration graph
[legend]
List of all members.

Detailed Description

a collection of attributes

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

Created by:
  • Bertel, Francois
CVS contributions (if > 5%):
  • Bertel, Francois (99%)
CVS logs (CVSweb):
  • .h (/Filtering/vtkGenericAttributeCollection.h)
  • .cxx (/Filtering/vtkGenericAttributeCollection.cxx)
Tests:
vtkGenericAttributeCollection (Tests)

Definition at line 43 of file vtkGenericAttributeCollection.h.

[NOHEADER]

typedef vtkObject Superclass
virtual const char * GetClassName ()
virtual int IsA (const char *type)
virtual void PrintSelf (ostream &os, vtkIndent indent)
int IsTypeOf (const char *type)
vtkGenericAttributeCollection * SafeDownCast (vtkObject *o)

Public Member Functions

int GetNumberOfAttributes ()
int GetNumberOfComponents ()
int GetMaxNumberOfComponents ()
unsigned long GetActualMemorySize ()
int IsEmpty ()
vtkGenericAttribute * GetAttribute (int i)
int FindAttribute (const char *name)
void InsertNextAttribute (vtkGenericAttribute *a)
void InsertAttribute (int i, vtkGenericAttribute *a)
void RemoveAttribute (int i)
void Reset ()
void DeepCopy (vtkGenericAttributeCollection *other)
void ShallowCopy (vtkGenericAttributeCollection *other)
virtual unsigned long int GetMTime ()
void SetActiveAttribute (int attribute, int component=0)
int HasAttribute (int size, int *attributes, int attribute)
virtual int GetActiveAttribute ()
virtual int GetActiveComponent ()
virtual int GetNumberOfAttributesToInterpolate ()
int * GetAttributesToInterpolate ()
void SetAttributesToInterpolate (int size, int *attributes)
void SetAttributesToInterpolateToAll ()

Static Public Member Functions

vtkGenericAttributeCollection * New ()

Protected Member Functions

 vtkGenericAttributeCollection ()
virtual ~vtkGenericAttributeCollection ()
void ComputeNumbers ()

Protected Attributes

vtkGenericAttributeInternalVector * AttributeInternalVector
int ActiveAttribute
int ActiveComponent
int NumberOfAttributesToInterpolate
int AttributesToInterpolate [10]
int NumberOfComponents
int MaxNumberOfComponents
unsigned long ActualMemorySize
vtkTimeStamp ComputeTime

Member Typedef Documentation

typedef vtkObject vtkGenericAttributeCollection::Superclass
 

Standard type definition and print methods for a VTK class.

Reimplemented from vtkObject.

Definition at line 51 of file vtkGenericAttributeCollection.h.

Constructor & Destructor Documentation

vtkGenericAttributeCollection::vtkGenericAttributeCollection (   )  [protected]
 

Default constructor: empty collection.

virtual vtkGenericAttributeCollection::~vtkGenericAttributeCollection (   )  [protected, virtual]
 

Destructor.

Member Function Documentation

vtkGenericAttributeCollection* vtkGenericAttributeCollection::New (   )  [static]
 

Create an empty collection.

Reimplemented from vtkObject.

virtual const char* vtkGenericAttributeCollection::GetClassName (   )  [virtual]
 

Standard type definition and print methods for a VTK class.

Reimplemented from vtkObject.

int vtkGenericAttributeCollection::IsTypeOf (  const char *  type  )  [static]
 

Standard type definition and print methods for a VTK class.

Reimplemented from vtkObject.

virtual int vtkGenericAttributeCollection::IsA (  const char *  type  )  [virtual]
 

Standard type definition and print methods for a VTK class.

Reimplemented from vtkObject.

vtkGenericAttributeCollection* vtkGenericAttributeCollection::SafeDownCast (  vtkObject *  o  )  [static]
 

Standard type definition and print methods for a VTK class.

Reimplemented from vtkObject.

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

Standard type definition and print methods for a VTK class.

Reimplemented from vtkObject.

int vtkGenericAttributeCollection::GetNumberOfAttributes (   ) 
 

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

Postcondition:
positive_result: result>=0

int vtkGenericAttributeCollection::GetNumberOfComponents (   ) 
 

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

Postcondition:
positive_result: result>=0

int vtkGenericAttributeCollection::GetMaxNumberOfComponents (   ) 
 

Maximum number of components encountered among all attributes.

Postcondition:
positive_result: result>=0

valid_result: result<=GetNumberOfComponents()

unsigned long vtkGenericAttributeCollection::GetActualMemorySize (   ) 
 

Actual size of the data in kilobytes; only valid after the pipeline has updated. It is guaranteed to be greater than or equal to the memory required to represent the data.

int vtkGenericAttributeCollection::IsEmpty (   ) 
 

Indicate whether the collection contains any attributes.

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

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

int vtkGenericAttributeCollection::FindAttribute (  const char *  name  ) 
 

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())

void vtkGenericAttributeCollection::InsertNextAttribute (  vtkGenericAttribute *  a  ) 
 

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 vtkGenericAttributeCollection::InsertAttribute (  int  i,
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

void vtkGenericAttributeCollection::RemoveAttribute (  int  i  ) 
 

Remove the attribute at `i'.

Precondition:
not_empty: !IsEmpty()

valid_i: i>=0 && i<GetNumberOfAttributes()

Postcondition:
fewer_items: GetNumberOfAttributes()==old GetNumberOfAttributes()-1

void vtkGenericAttributeCollection::Reset (   ) 
 

Remove all attributes.

Postcondition:
is_empty: GetNumberOfAttributes()==0

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()

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()

virtual unsigned long int vtkGenericAttributeCollection::GetMTime (   )  [virtual]
 

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

Reimplemented from vtkObject.

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()

virtual int vtkGenericAttributeCollection::GetActiveComponent (   )  [virtual]
 

Component of the active attribute to be processed.

Precondition:
not_empty: GetNumberOfAttributes()>0
Postcondition:
valid_result: result>=0 && result<GetAttribute(GetActiveAttribute())->GetNumberOfComponents()

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

Set the scalar attribute to be processed.

Precondition:
not_empty: !IsEmpty()

valid_attribute: attribute>=0 && attribute<GetNumberOfAttributes()

valid_component: component>=0 && component<GetAttribute(attribute)->GetNumberOfComponents()

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

virtual int vtkGenericAttributeCollection::GetNumberOfAttributesToInterpolate (   )  [virtual]
 

Number of attributes to interpolate.

Precondition:
not_empty: !IsEmpty()
Postcondition:
positive_result: result>=0

int* vtkGenericAttributeCollection::GetAttributesToInterpolate (   ) 
 

Indices of attributes to interpolate.

Precondition:
not_empty: !IsEmpty()
Postcondition:
valid_result: GetNumberOfAttributesToInterpolate()>0 implies result!=0

int vtkGenericAttributeCollection::HasAttribute (  int  size,
int *  attributes,
int  attribute
) 
 

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

Precondition:
positive_size: size>=0

valid_attributes: size>0 implies attributes!=0

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

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)

void vtkGenericAttributeCollection::SetAttributesToInterpolateToAll (   ) 
 

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)

void vtkGenericAttributeCollection::ComputeNumbers (   )  [protected]
 

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

Member Data Documentation

vtkGenericAttributeInternalVector* vtkGenericAttributeCollection::AttributeInternalVector [protected]
 

STL vector for storing attributes

Definition at line 188 of file vtkGenericAttributeCollection.h.

int vtkGenericAttributeCollection::ActiveAttribute [protected]
 

Definition at line 190 of file vtkGenericAttributeCollection.h.

int vtkGenericAttributeCollection::ActiveComponent [protected]
 

Definition at line 191 of file vtkGenericAttributeCollection.h.

int vtkGenericAttributeCollection::NumberOfAttributesToInterpolate [protected]
 

Definition at line 192 of file vtkGenericAttributeCollection.h.

int vtkGenericAttributeCollection::AttributesToInterpolate[10] [protected]
 

Definition at line 193 of file vtkGenericAttributeCollection.h.

int vtkGenericAttributeCollection::NumberOfComponents [protected]
 

Definition at line 195 of file vtkGenericAttributeCollection.h.

int vtkGenericAttributeCollection::MaxNumberOfComponents [protected]
 

Definition at line 196 of file vtkGenericAttributeCollection.h.

unsigned long vtkGenericAttributeCollection::ActualMemorySize [protected]
 

Definition at line 197 of file vtkGenericAttributeCollection.h.

vtkTimeStamp vtkGenericAttributeCollection::ComputeTime [protected]
 

Definition at line 198 of file vtkGenericAttributeCollection.h.

The documentation for this class was generated from the following file:
Generated on Tue Oct 5 08:45:30 2004 for VTK by Doxygen 1.3.8-20040913