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

restricts the proxy to have the same type as previous proxy More...

#include <vtkSMFixedTypeDomain.h>

Inheritance diagram for vtkSMFixedTypeDomain:
Inheritance graph
[legend]
Collaboration diagram for vtkSMFixedTypeDomain:
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...
 
virtual int IsInDomain (vtkSMSourceProxy *oldProxy, vtkSMSourceProxy *newProxy)
 Returns true if old and new source proxies have the same output data type, false otherwise. 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 vtkSMFixedTypeDomainNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMFixedTypeDomainSafeDownCast (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

 vtkSMFixedTypeDomain ()
 
 ~vtkSMFixedTypeDomain ()
 
- 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...
 
virtual int ReadXMLAttributes (vtkSMProperty *prop, vtkPVXMLElement *elem)
 Set the appropriate ivars from the xml element. 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 ()
 

Additional Inherited Members

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

Detailed Description

restricts the proxy to have the same type as previous proxy

vtkSMFixedTypeDomain is used by input properties of filters that can not have different input types after input is set the first time. For example, a sub-class vtkDataSetToDataSetFilter, once connected in a pipeline can not change it's input type, say, from vtkImageData to vtkUnstructuredGrid because it's output can not change.

See also
vtkSMDomain

Definition at line 36 of file vtkSMFixedTypeDomain.h.

Member Typedef Documentation

§ Superclass

Definition at line 40 of file vtkSMFixedTypeDomain.h.

Constructor & Destructor Documentation

§ vtkSMFixedTypeDomain()

vtkSMFixedTypeDomain::vtkSMFixedTypeDomain ( )
protected

§ ~vtkSMFixedTypeDomain()

vtkSMFixedTypeDomain::~vtkSMFixedTypeDomain ( )
protected

Member Function Documentation

§ New()

static vtkSMFixedTypeDomain* vtkSMFixedTypeDomain::New ( )
static

§ GetClassName()

virtual const char* vtkSMFixedTypeDomain::GetClassName ( )
virtual

Reimplemented from vtkSMDomain.

§ IsTypeOf()

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

§ IsA()

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

Reimplemented from vtkSMDomain.

§ SafeDownCast()

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

§ PrintSelf()

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

§ IsInDomain() [1/2]

virtual int vtkSMFixedTypeDomain::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 new (unchecked) source proxy has the same number of parts and data types as the old (checked) one, it returns 1. Returns 0 otherwise.

Implements vtkSMDomain.

§ IsInDomain() [2/2]

virtual int vtkSMFixedTypeDomain::IsInDomain ( vtkSMSourceProxy oldProxy,
vtkSMSourceProxy newProxy 
)
virtual

Returns true if old and new source proxies have the same output data type, false otherwise.


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