ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkSMDataTypeDomain Class Reference

restricts the input proxies to one or more data types More...

#include <vtkSMDataTypeDomain.h>

Inheritance diagram for vtkSMDataTypeDomain:
Inheritance graph
[legend]
Collaboration diagram for vtkSMDataTypeDomain:
Collaboration graph
[legend]

Public Types

typedef vtkSMDomain Superclass
 
- Public Types inherited from vtkSMDomain
typedef vtkSMSessionObject Superclass
 
- Public Types inherited from vtkSMSessionObject
typedef vtkSMObject Superclass
 
- Public Types inherited from vtkSMObject
typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual int IsInDomain (vtkSMProperty *property)
 Returns true if the value of the propery is in the domain. More...
 
int IsInDomain (vtkSMSourceProxy *proxy, int outputport=0)
 Returns true if all parts of the source proxy are in the domain. More...
 
unsigned int GetNumberOfDataTypes ()
 Returns the number of acceptable data types. More...
 
const char * GetDataType (unsigned int idx)
 Returns a data type. More...
 
- Public Member Functions inherited from vtkSMDomain
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void Update (vtkSMProperty *requestingProperty)
 Update self based on the "unchecked" values of all required properties. More...
 
virtual void SetAnimationValue (vtkSMProperty *, int vtkNotUsed(index), double vtkNotUsed(value))
 Set the value of an element of a property from the animation editor. More...
 
virtual int SetDefaultValues (vtkSMProperty *, bool vtkNotUsed(use_unchecked_values))
 A vtkSMProperty is often defined with a default value in the XML itself. More...
 
vtkSMPropertyGetProperty ()
 Provides access to the vtkSMProperty on which this domain is hooked up. More...
 
virtual char * GetXMLName ()
 Assigned by the XML parser. More...
 
virtual bool GetIsOptional ()
 When the IsOptional flag is set, IsInDomain() always returns true. More...
 
- Public Member Functions inherited from vtkSMSessionObject
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual vtkSMSessionProxyManagerGetSessionProxyManager ()
 Return the corresponding ProxyManager if any. More...
 
virtual void SetSession (vtkSMSession *)
 Get/Set the session on wihch this object exists. More...
 
virtual vtkSMSessionGetSession ()
 Get/Set the session on wihch this object exists. More...
 
- Public Member Functions inherited from vtkSMObject
void PrintSelf (ostream &os, vtkIndent indent)
 

Static Public Member Functions

static vtkSMDataTypeDomainNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMDataTypeDomainSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMDomain
static int IsTypeOf (const char *type)
 
static vtkSMDomainSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMSessionObject
static vtkSMSessionObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMSessionObjectSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMObject
static vtkSMObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMObjectSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkSMDataTypeDomain ()
 
 ~vtkSMDataTypeDomain ()
 
virtual int ReadXMLAttributes (vtkSMProperty *prop, vtkPVXMLElement *element)
 Set the appropriate ivars from the xml element. More...
 
virtual void SetCompositeDataSupported (int)
 
virtual int GetCompositeDataSupported ()
 
- Protected Member Functions inherited from vtkSMDomain
 vtkSMDomain ()
 
 ~vtkSMDomain ()
 
virtual int LoadState (vtkPVXMLElement *vtkNotUsed(domainElement), vtkSMProxyLocator *vtkNotUsed(loader))
 Load the state of the domain from the XML. More...
 
vtkSMPropertyGetRequiredProperty (const char *function)
 Returns a given required property of the given function. More...
 
void RemoveRequiredProperty (vtkSMProperty *prop)
 Remove the given property from the required properties list. More...
 
void AddRequiredProperty (vtkSMProperty *prop, const char *function)
 Add a new required property to this domain. More...
 
virtual vtkPVDataInformationGetInputDataInformation (const char *function, int index=0)
 Helper method to get vtkPVDataInformation from input proxy connected to the required property with the given function. More...
 
void DomainModified ()
 Invokes DomainModifiedEvent. More...
 
void InvokeModified ()
 
unsigned int GetNumberOfRequiredProperties ()
 Gets the number of required properties added. More...
 
void SetProperty (vtkSMProperty *)
 Set the domain's property. More...
 
void SaveState (vtkPVXMLElement *parent, const char *uid)
 Add the header and creates a new vtkPVXMLElement for the domain, fills it up with the common attributes. More...
 
virtual void ChildSaveState (vtkPVXMLElement *domainElement)
 Add the header and creates a new vtkPVXMLElement for the domain, fills it up with the common attributes. More...
 
virtual void SetIsOptional (bool)
 When the IsOptional flag is set, IsInDomain() always returns true. More...
 
virtual void SetXMLName (const char *)
 Assigned by the XML parser. More...
 
- Protected Member Functions inherited from vtkSMSessionObject
 vtkSMSessionObject ()
 
 ~vtkSMSessionObject ()
 
- Protected Member Functions inherited from vtkSMObject
 vtkSMObject ()
 
 ~vtkSMObject ()
 

Protected Attributes

vtkSMDataTypeDomainInternals * DTInternals
 
int CompositeDataSupported
 
- Protected Attributes inherited from vtkSMDomain
char * XMLName
 
bool IsOptional
 
vtkSMDomainInternals * Internals
 
- Protected Attributes inherited from vtkSMSessionObject
vtkWeakPointer< vtkSMSessionSession
 

Detailed Description

restricts the input proxies to one or more data types

vtkSMDataTypeDomain restricts the input proxies to one or more data types. These data types are specified in the XML with the <DataType> element. VTK class names are used. It is possible to specify a superclass (i.e. vtkDataSet) for a more general domain. Works with vtkSMSourceProxy only. Valid XML elements are:

* * <DataType value=""> where value is the classname for the data type
* for example: vtkDataSet, vtkImageData,...
* 
See also
vtkSMDomain vtkSMSourceProxy

Definition at line 42 of file vtkSMDataTypeDomain.h.

Member Typedef Documentation

§ Superclass

Definition at line 46 of file vtkSMDataTypeDomain.h.

Constructor & Destructor Documentation

§ vtkSMDataTypeDomain()

vtkSMDataTypeDomain::vtkSMDataTypeDomain ( )
protected

§ ~vtkSMDataTypeDomain()

vtkSMDataTypeDomain::~vtkSMDataTypeDomain ( )
protected

Member Function Documentation

§ New()

static vtkSMDataTypeDomain* vtkSMDataTypeDomain::New ( )
static

§ GetClassName()

virtual const char* vtkSMDataTypeDomain::GetClassName ( )
virtual

Reimplemented from vtkSMDomain.

§ IsTypeOf()

static int vtkSMDataTypeDomain::IsTypeOf ( const char *  type)
static

§ IsA()

virtual int vtkSMDataTypeDomain::IsA ( const char *  type)
virtual

Reimplemented from vtkSMDomain.

§ SafeDownCast()

static vtkSMDataTypeDomain* vtkSMDataTypeDomain::SafeDownCast ( vtkObject *  o)
static

§ PrintSelf()

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

§ IsInDomain() [1/2]

virtual int vtkSMDataTypeDomain::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 all data types of the input's parts are in the domain, it returns. It returns 0 otherwise.

Implements vtkSMDomain.

§ IsInDomain() [2/2]

int vtkSMDataTypeDomain::IsInDomain ( vtkSMSourceProxy proxy,
int  outputport = 0 
)

Returns true if all parts of the source proxy are in the domain.

§ GetNumberOfDataTypes()

unsigned int vtkSMDataTypeDomain::GetNumberOfDataTypes ( )

Returns the number of acceptable data types.

§ GetDataType()

const char* vtkSMDataTypeDomain::GetDataType ( unsigned int  idx)

Returns a data type.

§ ReadXMLAttributes()

virtual int vtkSMDataTypeDomain::ReadXMLAttributes ( vtkSMProperty prop,
vtkPVXMLElement element 
)
protectedvirtual

Set the appropriate ivars from the xml element.

Should be overwritten by subclass if adding ivars.

Reimplemented from vtkSMDomain.

§ SetCompositeDataSupported()

virtual void vtkSMDataTypeDomain::SetCompositeDataSupported ( int  )
protectedvirtual

§ GetCompositeDataSupported()

virtual int vtkSMDataTypeDomain::GetCompositeDataSupported ( )
protectedvirtual

Member Data Documentation

§ DTInternals

vtkSMDataTypeDomainInternals* vtkSMDataTypeDomain::DTInternals
protected

Definition at line 82 of file vtkSMDataTypeDomain.h.

§ CompositeDataSupported

int vtkSMDataTypeDomain::CompositeDataSupported
protected

Definition at line 84 of file vtkSMDataTypeDomain.h.


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