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

vtkSMNumberOfGroupsDomain Class Reference

restricts the number of groups of input More...

#include <vtkSMNumberOfGroupsDomain.h>

Inheritance diagram for vtkSMNumberOfGroupsDomain:

Inheritance graph
[legend]
Collaboration diagram for vtkSMNumberOfGroupsDomain:

Collaboration graph
[legend]
List of all members.

Public Types

enum  NumberOfGroups { NOT_SET = 0, SINGLE = 1, MULTIPLE = 2 }

Public Member Functions

 vtkTypeRevisionMacro (vtkSMNumberOfGroupsDomain, vtkSMIntRangeDomain)
void PrintSelf (ostream &os, vtkIndent indent)
virtual int IsInDomain (vtkSMProperty *property)
int IsInDomain (vtkSMSourceProxy *proxy)
virtual void Update (vtkSMProperty *)
virtual void SetGroupMultiplicity (unsigned char)
virtual unsigned char GetGroupMultiplicity ()

Static Public Member Functions

vtkSMNumberOfGroupsDomainNew ()

Protected Member Functions

 vtkSMNumberOfGroupsDomain ()
 ~vtkSMNumberOfGroupsDomain ()
virtual int ReadXMLAttributes (vtkSMProperty *prop, vtkPVXMLElement *element)
virtual void SaveState (const char *name, ostream *file, vtkIndent indent)
void Update (vtkSMProxyProperty *pp)

Protected Attributes

unsigned char GroupMultiplicity

Detailed Description

restricts the number of groups of input

vtkSMNumberOfGroupsDomain requires that the source proxy pointed by the property has an output with the specified multiplicity of groups: SINGLE or MULTIPLE. Valid XML attributes are:

 * multiplicity - can be either single or multiple
 
See also:
vtkSMDomain

Definition at line 36 of file vtkSMNumberOfGroupsDomain.h.


Member Enumeration Documentation

enum vtkSMNumberOfGroupsDomain::NumberOfGroups
 

Enumeration values:
NOT_SET 
SINGLE 
MULTIPLE 

Definition at line 65 of file vtkSMNumberOfGroupsDomain.h.


Constructor & Destructor Documentation

vtkSMNumberOfGroupsDomain::vtkSMNumberOfGroupsDomain  )  [protected]
 

vtkSMNumberOfGroupsDomain::~vtkSMNumberOfGroupsDomain  )  [protected]
 


Member Function Documentation

vtkSMNumberOfGroupsDomain* vtkSMNumberOfGroupsDomain::New  )  [static]
 

Reimplemented from vtkSMIntRangeDomain.

vtkSMNumberOfGroupsDomain::vtkTypeRevisionMacro vtkSMNumberOfGroupsDomain  ,
vtkSMIntRangeDomain 
 

void vtkSMNumberOfGroupsDomain::PrintSelf ostream &  os,
vtkIndent  indent
 

Reimplemented from vtkSMIntRangeDomain.

virtual int vtkSMNumberOfGroupsDomain::IsInDomain vtkSMProperty property  )  [virtual]
 

Returns true if the value of the propery is in the domain. The propery has to be a vtkSMProxyProperty which points to a vtkSMSourceProxy. If the number of groups contained by the source matches the criteria set in the domain, returns 1. Returns 0 otherwise.

Reimplemented from vtkSMIntRangeDomain.

int vtkSMNumberOfGroupsDomain::IsInDomain vtkSMSourceProxy proxy  ) 
 

If the number of groups contained by the source matches the criteria set in the domain, returns 1. Returns 0 otherwise.

virtual void vtkSMNumberOfGroupsDomain::Update vtkSMProperty  )  [virtual]
 

Update self checking the "unchecked" values of all required properties. Overwritten by sub-classes.

Reimplemented from vtkSMIntRangeDomain.

virtual void vtkSMNumberOfGroupsDomain::SetGroupMultiplicity unsigned  char  )  [virtual]
 

Set/get the group multiplicity. Can be either SINGLE or MULTIPLE.

virtual unsigned char vtkSMNumberOfGroupsDomain::GetGroupMultiplicity  )  [virtual]
 

Set/get the group multiplicity. Can be either SINGLE or MULTIPLE.

virtual int vtkSMNumberOfGroupsDomain::ReadXMLAttributes vtkSMProperty prop,
vtkPVXMLElement element
[protected, virtual]
 

Set the appropriate ivars from the xml element. Should be overwritten by subclass if adding ivars.

Reimplemented from vtkSMIntRangeDomain.

virtual void vtkSMNumberOfGroupsDomain::SaveState const char *  name,
ostream *  file,
vtkIndent  indent
[protected, virtual]
 

Saves the state of the object in XML format. Should be overwritten by proxies and properties.

Reimplemented from vtkSMIntRangeDomain.

void vtkSMNumberOfGroupsDomain::Update vtkSMProxyProperty pp  )  [protected]
 


Member Data Documentation

unsigned char vtkSMNumberOfGroupsDomain::GroupMultiplicity [protected]
 

Definition at line 85 of file vtkSMNumberOfGroupsDomain.h.


The documentation for this class was generated from the following file:
Generated on Tue May 30 12:40:43 2006 for ParaView by doxygen 1.3.5