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

Information object that can be used to obtain values of environment variables. More...

#include <vtkPVEnvironmentInformation.h>

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

Public Types

typedef vtkPVInformation Superclass
 
- Public Types inherited from vtkPVInformation
typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void CopyFromObject (vtkObject *object) override
 Transfer information about a single object into this object. More...
 
void CopyToStream (vtkClientServerStream *) override
 Manage a serialized version of the information. More...
 
void CopyFromStream (const vtkClientServerStream *) override
 Manage a serialized version of the information. More...
 
virtual char * GetVariable ()
 Get the value of an environment variable. More...
 
- Public Member Functions inherited from vtkPVInformation
void PrintSelf (ostream &os, vtkIndent indent) override
 
virtual void AddInformation (vtkPVInformation *)
 Merge another information object. More...
 
virtual void CopyParametersToStream (vtkMultiProcessStream &)
 Serialize/Deserialize the parameters that control how/what information is gathered. More...
 
virtual void CopyParametersFromStream (vtkMultiProcessStream &)
 Serialize/Deserialize the parameters that control how/what information is gathered. More...
 
virtual int GetRootOnly ()
 Set/get whether to gather information only from the root. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual vtkMTimeType GetMTime ()
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 

Static Public Member Functions

static vtkPVEnvironmentInformationNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPVEnvironmentInformationSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkPVInformation
static int IsTypeOf (const char *type)
 
static vtkPVInformationSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkPVEnvironmentInformation ()
 
 ~vtkPVEnvironmentInformation () override
 
virtual void SetVariable (const char *)
 
- Protected Member Functions inherited from vtkPVInformation
 vtkPVInformation ()
 
 ~vtkPVInformation () override
 
virtual void SetRootOnly (int)
 
 vtkPVInformation (const vtkPVInformation &)=delete
 
void operator= (const vtkPVInformation &)=delete
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

char * Variable
 
- Protected Attributes inherited from vtkPVInformation
int RootOnly
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

Information object that can be used to obtain values of environment variables.

vtkPVEnvironmentInformation can be used to get values of environment variables.

Definition at line 30 of file vtkPVEnvironmentInformation.h.

Member Typedef Documentation

◆ Superclass

Definition at line 34 of file vtkPVEnvironmentInformation.h.

Constructor & Destructor Documentation

◆ vtkPVEnvironmentInformation()

vtkPVEnvironmentInformation::vtkPVEnvironmentInformation ( )
protected

◆ ~vtkPVEnvironmentInformation()

vtkPVEnvironmentInformation::~vtkPVEnvironmentInformation ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkPVEnvironmentInformation* vtkPVEnvironmentInformation::New ( )
static

◆ GetClassName()

virtual const char* vtkPVEnvironmentInformation::GetClassName ( )
virtual

Reimplemented from vtkPVInformation.

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented from vtkPVInformation.

◆ SafeDownCast()

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

◆ PrintSelf()

void vtkPVEnvironmentInformation::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Reimplemented from vtkObject.

◆ CopyFromObject()

void vtkPVEnvironmentInformation::CopyFromObject ( vtkObject object)
overridevirtual

Transfer information about a single object into this object.

The object must be a vtkPVEnvironmentInformationHelper.

Reimplemented from vtkPVInformation.

◆ CopyToStream()

void vtkPVEnvironmentInformation::CopyToStream ( vtkClientServerStream )
overridevirtual

Manage a serialized version of the information.

Implements vtkPVInformation.

◆ CopyFromStream()

void vtkPVEnvironmentInformation::CopyFromStream ( const vtkClientServerStream )
overridevirtual

Manage a serialized version of the information.

Reimplemented from vtkPVInformation.

◆ GetVariable()

virtual char* vtkPVEnvironmentInformation::GetVariable ( )
virtual

Get the value of an environment variable.

◆ SetVariable()

virtual void vtkPVEnvironmentInformation::SetVariable ( const char *  )
protectedvirtual

Member Data Documentation

◆ Variable

char* vtkPVEnvironmentInformation::Variable
protected

Definition at line 62 of file vtkPVEnvironmentInformation.h.


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