vtkPVTraceHelper Class Reference

trace routines More...

#include <vtkPVTraceHelper.h>

Collaboration diagram for vtkPVTraceHelper:

[legend]List of all members.

[NOHEADER]
enum	ObjectNameState_t {   ObjectNameStateUninitialized, ObjectNameStateDefault, ObjectNameStateXMLInitialized, ObjectNameStateSelfInitialized,   ObjectNameStateUserInitialized }
virtual void	SetObjectNameState (int)
virtual int	GetObjectNameState ()
Public Types
Public Member Functions
	vtkTypeRevisionMacro (vtkPVTraceHelper, vtkObject)
void	PrintSelf (ostream &os, vtkIndent indent)
ofstream *	GetFile ()
virtual void	SetTraceObject (vtkKWObject *)
virtual vtkKWObject *	GetTraceObject ()
virtual void	SetObjectName (const char *)
virtual char *	GetObjectName ()
virtual void	SetReferenceHelper (vtkPVTraceHelper *)
virtual vtkPVTraceHelper *	GetReferenceHelper ()
virtual void	SetReferenceCommand (const char *)
virtual char *	GetReferenceCommand ()
virtual int	Initialize (ofstream *file)
virtual int	Initialize ()
virtual void	SetInitialized (int)
virtual int	GetInitialized ()
virtual void	InitializedOn ()
virtual void	InitializedOff ()
virtual void	SetStateInitialized (int)
virtual int	GetStateInitialized ()
virtual void	StateInitializedOn ()
virtual void	StateInitializedOff ()
virtual void	AddSimpleEntry (const char *trace)
virtual void	AddEntry (const char *format,...)
Static Public Member Functions
vtkPVTraceHelper *	New ()
void	OutputSimpleEntry (ostream *os, const char *trace)
void	OutputEntry (ostream *os, const char *format,...)
Protected Member Functions
	vtkPVTraceHelper ()
	~vtkPVTraceHelper ()
Static Protected Member Functions
void	OutputEntryInternal (ostream *os, int estimated_length, const char *format, va_list ap)
Protected Attributes
int	Initialized
int	StateInitialized
vtkKWObject *	TraceObject
vtkPVTraceHelper *	ReferenceHelper
char *	ReferenceCommand
char *	ObjectName
int	ObjectNameState

---

Detailed Description

trace routines

vtkPVTraceHelper provides trace features for the PV framework.

Definition at line 28 of file vtkPVTraceHelper.h.

---

Member Enumeration Documentation

enum vtkPVTraceHelper::ObjectNameState_t

Enumeration values: ObjectNameStateUninitialized  ObjectNameStateDefault  ObjectNameStateXMLInitialized  ObjectNameStateSelfInitialized  ObjectNameStateUserInitialized  Definition at line 57 of file vtkPVTraceHelper.h.

---

Constructor & Destructor Documentation

vtkPVTraceHelper::vtkPVTraceHelper (   )  [protected]

vtkPVTraceHelper::~vtkPVTraceHelper (   )  [protected]

---

Member Function Documentation

vtkPVTraceHelper* vtkPVTraceHelper::New (   )  [static]

vtkPVTraceHelper::vtkTypeRevisionMacro (  vtkPVTraceHelper  , vtkObject  )

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

virtual void vtkPVTraceHelper::SetTraceObject (  vtkKWObject *   )  [virtual]

Set/Get the object (Object) being traced. Note: Object is not reference-counted at the moment.

virtual vtkKWObject* vtkPVTraceHelper::GetTraceObject (   )  [virtual]

Set/Get the object (Object) being traced. Note: Object is not reference-counted at the moment.

virtual void vtkPVTraceHelper::SetObjectName (  const char *   )  [virtual]

If needed, a unique name for Object in the trace context.

virtual char* vtkPVTraceHelper::GetObjectName (   )  [virtual]

If needed, a unique name for Object in the trace context.

virtual void vtkPVTraceHelper::SetObjectNameState (  int   )  [virtual]

This variable is used to determine who set the trace ObjectName of Object. Initially, the ObjectName is Uninitialized. Then, usually, vtkPVXMLPackageParser assigns a Default name. Then, either it is set from XML, the user sets it or one is assigned during some other methods (like Create()).

virtual int vtkPVTraceHelper::GetObjectNameState (   )  [virtual]

virtual void vtkPVTraceHelper::SetReferenceHelper (  vtkPVTraceHelper *   )  [virtual]

Set/Get the reference trace helper (ReferenceHelper) and the initialization command (ReferenceCommand). This will allow the object being traced (Object) to be initialized/created in the trace when necessary, by recusively calling the command on the reference helper's Object: this should return the object being traced (Object). Note: ReferenceHelper is not reference counted at the moment.

virtual vtkPVTraceHelper* vtkPVTraceHelper::GetReferenceHelper (   )  [virtual]

Set/Get the reference trace helper (ReferenceHelper) and the initialization command (ReferenceCommand). This will allow the object being traced (Object) to be initialized/created in the trace when necessary, by recusively calling the command on the reference helper's Object: this should return the object being traced (Object). Note: ReferenceHelper is not reference counted at the moment.

virtual void vtkPVTraceHelper::SetReferenceCommand (  const char *   )  [virtual]

Set/Get the reference trace helper (ReferenceHelper) and the initialization command (ReferenceCommand). This will allow the object being traced (Object) to be initialized/created in the trace when necessary, by recusively calling the command on the reference helper's Object: this should return the object being traced (Object). Note: ReferenceHelper is not reference counted at the moment.

virtual char* vtkPVTraceHelper::GetReferenceCommand (   )  [virtual]

Set/Get the reference trace helper (ReferenceHelper) and the initialization command (ReferenceCommand). This will allow the object being traced (Object) to be initialized/created in the trace when necessary, by recusively calling the command on the reference helper's Object: this should return the object being traced (Object). Note: ReferenceHelper is not reference counted at the moment.

virtual int vtkPVTraceHelper::Initialize (  ofstream *  file  )  [virtual]

Initialize the trace. Returns 1 if the trace for Object has been initialized. If it has not, it tries to initialize the object by invoking an event. If this does not work, it returns 0. The argument is used to save a trace into a state file. When NULL or without argument, the Object's application trace file is used (convenience).

virtual int vtkPVTraceHelper::Initialize (   )  [virtual]

Initialize the trace. Returns 1 if the trace for Object has been initialized. If it has not, it tries to initialize the object by invoking an event. If this does not work, it returns 0. The argument is used to save a trace into a state file. When NULL or without argument, the Object's application trace file is used (convenience).

virtual void vtkPVTraceHelper::SetInitialized (  int   )  [virtual]

If a callback initializes Object, it can indicate so by setting this flag.

virtual int vtkPVTraceHelper::GetInitialized (   )  [virtual]

If a callback initializes Object, it can indicate so by setting this flag.

virtual void vtkPVTraceHelper::InitializedOn (   )  [virtual]

If a callback initializes Object, it can indicate so by setting this flag.

virtual void vtkPVTraceHelper::InitializedOff (   )  [virtual]

If a callback initializes Object, it can indicate so by setting this flag.

virtual void vtkPVTraceHelper::SetStateInitialized (  int   )  [virtual]

If a callback initializes Object in a state file, it can indicate so by setting this flag.

virtual int vtkPVTraceHelper::GetStateInitialized (   )  [virtual]

If a callback initializes Object in a state file, it can indicate so by setting this flag.

virtual void vtkPVTraceHelper::StateInitializedOn (   )  [virtual]

If a callback initializes Object in a state file, it can indicate so by setting this flag.

virtual void vtkPVTraceHelper::StateInitializedOff (   )  [virtual]

If a callback initializes Object in a state file, it can indicate so by setting this flag.

ofstream* vtkPVTraceHelper::GetFile (   )

Convenience method to get the trace file associated to the Object's application, if any. Return NULL if Object's is not defined, has no application, or no trace file.

virtual void vtkPVTraceHelper::AddSimpleEntry (  const char *  trace  )  [virtual]

Convenience method that initializes the trace for Object and and handles formating the tracecommand to Object's application's trace file (i.e, Object has to be set, and its application should be set to). The formated string should contain a command that looks like: "$kw(%s) SetValue %d", this->GetTclName(), this->GetValue().

virtual void vtkPVTraceHelper::AddEntry (  const char *  format, ...  )  [virtual]

Convenience method that initializes the trace for Object and and handles formating the tracecommand to Object's application's trace file (i.e, Object has to be set, and its application should be set to). The formated string should contain a command that looks like: "$kw(%s) SetValue %d", this->GetTclName(), this->GetValue().

void vtkPVTraceHelper::OutputSimpleEntry (  ostream *  os, const char *  trace )  [static]

Convenience *static* method that handles formating the trace command to a stream. The formated string should contain a command that looks like: "$kw(%s) SetValue %d", this->GetTclName(), this->GetValue().

void vtkPVTraceHelper::OutputEntry (  ostream *  os, const char *  format, ...  )  [static]

Convenience *static* method that handles formating the trace command to a stream. The formated string should contain a command that looks like: "$kw(%s) SetValue %d", this->GetTclName(), this->GetValue().

void vtkPVTraceHelper::OutputEntryInternal (  ostream *  os, int  estimated_length, const char *  format, va_list  ap )  [static, protected]

Internal method

---

Member Data Documentation

int vtkPVTraceHelper::Initialized [protected]

This flag indicates that a variable has been defined in the trace file for the object being traced. Definition at line 140 of file vtkPVTraceHelper.h.

int vtkPVTraceHelper::StateInitialized [protected]

This flag indicates that a variable has been defined in the state file for the object being saved. Definition at line 144 of file vtkPVTraceHelper.h.

char* vtkPVTraceHelper::ObjectName [protected]

Unique trace name Definition at line 148 of file vtkPVTraceHelper.h.

int vtkPVTraceHelper::ObjectNameState [protected]

Unique trace name Definition at line 149 of file vtkPVTraceHelper.h.

vtkKWObject* vtkPVTraceHelper::TraceObject [protected]

The object being traced Definition at line 153 of file vtkPVTraceHelper.h.

vtkPVTraceHelper* vtkPVTraceHelper::ReferenceHelper [protected]

The object being traced can be obtained from the reference helper in the trace script. Definition at line 157 of file vtkPVTraceHelper.h.

char* vtkPVTraceHelper::ReferenceCommand [protected]

The method and args that can be used to get the object being traced (Object) from the reference helper's Object (ReferenceHelper). Definition at line 161 of file vtkPVTraceHelper.h.

---

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

• GUI/Client/vtkPVTraceHelper.h

---