vtkPythonArgs Class Reference

#include <vtkPythonArgs.h>

List of all members.

Public Member Functions
void	Reset ()
bool	CheckArgCount (int nmin, int nmax)
bool	CheckArgCount (int n)
bool	IsBound ()
bool	IsPureVirtual ()
bool	NoArgsLeft ()
int	GetArgSize (int i)
bool	GetValue (void *&v)
bool	GetValue (const void *&v)
	vtkPythonArgs (PyObject *self, PyObject *args, const char *methodname)
	vtkPythonArgs (PyObject *args, const char *methodname)
bool	GetPythonObject (PyObject *&v)
bool	GetPythonObject (PyObject *o, PyObject *&v)
template<class T >
bool	GetVTKObject (T *&v, const char *classname)
template<class T >
bool	GetVTKObject (PyObject *o, T *&v, const char *classname)
bool	GetArray (float *v, int n)
bool	GetArray (double *v, int n)
bool	GetArray (bool *v, int n)
bool	GetArray (char *v, int n)
bool	GetArray (signed char *v, int n)
bool	GetArray (unsigned char *v, int n)
bool	GetArray (short *v, int n)
bool	GetArray (unsigned short *v, int n)
bool	GetArray (int *v, int n)
bool	GetArray (unsigned int *v, int n)
bool	GetArray (long *v, int n)
bool	GetArray (unsigned long *v, int n)
bool	GetNArray (float *v, int ndims, const int *dims)
bool	GetNArray (double *v, int ndims, const int *dims)
bool	GetNArray (bool *v, int ndims, const int *dims)
bool	GetNArray (char *v, int ndims, const int *dims)
bool	GetNArray (signed char *v, int ndims, const int *dims)
bool	GetNArray (unsigned char *v, int ndims, const int *dims)
bool	GetNArray (short *v, int ndims, const int *dims)
bool	GetNArray (unsigned short *v, int ndims, const int *dims)
bool	GetNArray (int *v, int ndims, const int *dims)
bool	GetNArray (unsigned int *v, int ndims, const int *dims)
bool	GetNArray (long *v, int ndims, const int *dims)
bool	GetNArray (unsigned long *v, int ndims, const int *dims)
bool	SetArgValue (int i, const std::string &v)
bool	SetArgValue (int i, const vtkUnicodeString &v)
bool	SetArgValue (int i, char v)
bool	SetArgValue (int i, float v)
bool	SetArgValue (int i, double v)
bool	SetArgValue (int i, bool v)
bool	SetArgValue (int i, signed char v)
bool	SetArgValue (int i, unsigned char v)
bool	SetArgValue (int i, short v)
bool	SetArgValue (int i, unsigned short v)
bool	SetArgValue (int i, int v)
bool	SetArgValue (int i, unsigned int v)
bool	SetArgValue (int i, long v)
bool	SetArgValue (int i, unsigned long v)
bool	SetArray (int i, const float *v, int n)
bool	SetArray (int i, const double *v, int n)
bool	SetArray (int i, const bool *v, int n)
bool	SetArray (int i, const char *v, int n)
bool	SetArray (int i, const signed char *v, int n)
bool	SetArray (int i, const unsigned char *v, int n)
bool	SetArray (int i, const short *v, int n)
bool	SetArray (int i, const unsigned short *v, int n)
bool	SetArray (int i, const int *v, int n)
bool	SetArray (int i, const unsigned int *v, int n)
bool	SetArray (int i, const long *v, int n)
bool	SetArray (int i, const unsigned long *v, int n)
bool	SetNArray (int i, const float *v, int n, const int *d)
bool	SetNArray (int i, const double *v, int n, const int *d)
bool	SetNArray (int i, const bool *v, int n, const int *d)
bool	SetNArray (int i, const char *v, int n, const int *d)
bool	SetNArray (int i, const signed char *v, int n, const int *d)
bool	SetNArray (int i, const unsigned char *v, int n, const int *d)
bool	SetNArray (int i, const short *v, int n, const int *d)
bool	SetNArray (int i, const unsigned short *v, int n, const int *d)
bool	SetNArray (int i, const int *v, int n, const int *d)
bool	SetNArray (int i, const unsigned int *v, int n, const int *d)
bool	SetNArray (int i, const long *v, int n, const int *d)
bool	SetNArray (int i, const unsigned long *v, int n, const int *d)
Static Public Member Functions
static vtkObjectBase *	GetSelfPointer (PyObject *self, PyObject *args)
static void *	GetSelfPointer (PyObject *self)
static bool	ErrorOccurred ()
static bool	GetValue (PyObject *o, void *&v)
static bool	GetValue (PyObject *o, const void *&v)
static PyObject *	BuildNone ()
static PyObject *	BuildVTKObject (const void *v)
static PyObject *	BuildSpecialObject (const void *v, const char *classname)
static PyObject *	BuildEnumValue (int v, const char *enumname)
static PyObject *	BuildSIPEnumValue (int v, const char *classname)
static PyObject *	BuildValue (const void *v)
static PyObject *	BuildValue (char v)
static PyObject *	BuildBytes (const char *v, int n)
static bool	ArgCountError (int n, const char *name)
static PyObject *	BuildSIPObject (const void *v, const char *classname, bool created)
static PyObject *	BuildValue (const char *v)
static PyObject *	BuildValue (const std::string &v)
static PyObject *	BuildValue (const vtkUnicodeString &v)
static PyObject *	BuildValue (double v)
static PyObject *	BuildValue (bool v)
static PyObject *	BuildValue (int v)
static PyObject *	BuildValue (unsigned int v)
static PyObject *	BuildValue (long v)
static PyObject *	BuildValue (unsigned long v)
static PyObject *	BuildTuple (const float *v, int n)
static PyObject *	BuildTuple (const double *v, int n)
static PyObject *	BuildTuple (const bool *v, int n)
static PyObject *	BuildTuple (const signed char *v, int n)
static PyObject *	BuildTuple (const unsigned char *v, int n)
static PyObject *	BuildTuple (const short *v, int n)
static PyObject *	BuildTuple (const unsigned short *v, int n)
static PyObject *	BuildTuple (const int *v, int n)
static PyObject *	BuildTuple (const unsigned int *v, int n)
static PyObject *	BuildTuple (const long *v, int n)
static PyObject *	BuildTuple (const unsigned long *v, int n)
template<class T >
static void	SaveArray (const T *a, T *b, int n)
template<class T >
static bool	ArrayHasChanged (const T *a, const T *b, int n)
static int	GetArgCount (PyObject *args)
static int	GetArgCount (PyObject *self, PyObject *args)
Protected Member Functions
bool	PureVirtualError ()
bool	ArgCountError (int m, int n)
bool	RefineArgTypeError (int i)
Static Protected Member Functions
static vtkObjectBase *	GetSelfFromFirstArg (PyObject *self, PyObject *args)
template<class T >
bool	GetSpecialObject (T *&v, PyObject *&o, const char *classname)
template<class T >
static bool	GetSpecialObject (PyObject *arg, T *&v, PyObject *&o, const char *classname)
template<class T >
bool	GetSpecialObject (T *&v, const char *classname)
template<class T >
static bool	GetSpecialObject (PyObject *o, T *&v, const char *classname)
template<class T >
bool	GetEnumValue (T &v, PyTypeObject *enumtype)
template<class T >
static bool	GetEnumValue (PyObject *o, T &v, PyTypeObject *enumtype)
template<class T >
bool	GetSIPObject (T *&v, const char *classname)
template<class T >
static bool	GetSIPObject (PyObject *o, T *&v, const char *classname)
template<class T >
bool	GetSIPEnumValue (T &v, const char *enumname)
template<class T >
static bool	GetSIPEnumValue (PyObject *o, T &v, const char *enumname)
bool	GetFunction (PyObject *&o)
static bool	GetFunction (PyObject *arg, PyObject *&o)
bool	GetValue (const char *&v)
bool	GetValue (char *&v)
bool	GetValue (std::string &v)
bool	GetValue (vtkUnicodeString &v)
static bool	GetValue (PyObject *o, const char *&v)
static bool	GetValue (PyObject *o, char *&v)
static bool	GetValue (PyObject *o, std::string &v)
static bool	GetValue (PyObject *o, vtkUnicodeString &v)
bool	GetValue (char &v)
static bool	GetValue (PyObject *o, char &v)
bool	GetValue (float &v)
bool	GetValue (double &v)
bool	GetValue (bool &v)
bool	GetValue (signed char &v)
bool	GetValue (unsigned char &v)
bool	GetValue (short &v)
bool	GetValue (unsigned short &v)
bool	GetValue (int &v)
bool	GetValue (unsigned int &v)
bool	GetValue (long &v)
bool	GetValue (unsigned long &v)
static bool	GetValue (PyObject *o, float &v)
static bool	GetValue (PyObject *o, double &v)
static bool	GetValue (PyObject *o, bool &v)
static bool	GetValue (PyObject *o, signed char &v)
static bool	GetValue (PyObject *o, unsigned char &v)
static bool	GetValue (PyObject *o, short &v)
static bool	GetValue (PyObject *o, unsigned short &v)
static bool	GetValue (PyObject *o, int &v)
static bool	GetValue (PyObject *o, unsigned int &v)
static bool	GetValue (PyObject *o, long &v)
static bool	GetValue (PyObject *o, unsigned long &v)
static PyObject *	GetArgAsPythonObject (PyObject *o, bool &valid)
PyObject *	GetArgAsPythonObject (bool &valid)
static vtkObjectBase *	GetArgAsVTKObject (PyObject *o, const char *classname, bool &valid)
vtkObjectBase *	GetArgAsVTKObject (const char *classname, bool &valid)
static void *	GetArgAsSpecialObject (PyObject *o, const char *classname, PyObject **newobj)
void *	GetArgAsSpecialObject (const char *classname, PyObject **newobj)
static int	GetArgAsEnum (PyObject *o, PyTypeObject *enumtype, bool &valid)
int	GetArgAsEnum (PyTypeObject *enumtype, bool &valid)
static void *	GetArgAsSIPObject (PyObject *o, const char *classname, bool &valid)
void *	GetArgAsSIPObject (const char *classname, bool &valid)
static int	GetArgAsSIPEnum (PyObject *o, const char *classname, bool &valid)
int	GetArgAsSIPEnum (const char *classname, bool &valid)

---

Detailed Description

Definition at line 40 of file vtkPythonArgs.h.

---

Constructor & Destructor Documentation

vtkPythonArgs::vtkPythonArgs	(	PyObject *	self,
		PyObject *	args,
		const char *	methodname
	)		[inline]

Constructor for parsing args of a vtkObjectBase object.

Definition at line 46 of file vtkPythonArgs.h.

vtkPythonArgs::vtkPythonArgs	(	PyObject *	args,
		const char *	methodname
	)		[inline]

Constructor for parsing method args.

Definition at line 56 of file vtkPythonArgs.h.

---

Member Function Documentation

void vtkPythonArgs::Reset

(

)

[inline]

Reset in order to re-parse the args.

Definition at line 65 of file vtkPythonArgs.h.

vtkObjectBase * vtkPythonArgs::GetSelfPointer	(	PyObject *	self,
		PyObject *	args
	)		[inline, static]

Get a pointer to the self object, converted to its C++ type. Returns NULL and sets a TypeError if the type is wrong. If "self" is a PyVTKClass, pull the object from the first arg.

Definition at line 576 of file vtkPythonArgs.h.

void * vtkPythonArgs::GetSelfPointer

(

PyObject *

self

)

[inline, static]

Get a pointer to the self object, converted to its C++ type. Always succeeds.

Definition at line 587 of file vtkPythonArgs.h.

bool vtkPythonArgs::CheckArgCount	(	int	nmin,
		int	nmax
	)		[inline]

Verify the arg count for a method with optional arguments.

Definition at line 597 of file vtkPythonArgs.h.

bool vtkPythonArgs::CheckArgCount

(

int

n

)

[inline]

Verify the arg count. Sets a python exception on failure.

Definition at line 610 of file vtkPythonArgs.h.

bool vtkPythonArgs::IsBound

(

)

[inline]

Returns true if self is an object, false if self is a class.

Definition at line 83 of file vtkPythonArgs.h.

bool vtkPythonArgs::IsPureVirtual

(

)

[inline]

Raise an exception if method call is not bound.

Definition at line 625 of file vtkPythonArgs.h.

bool vtkPythonArgs::ErrorOccurred

(

)

[inline, static]

Check if an error has occurred.

Definition at line 639 of file vtkPythonArgs.h.

bool vtkPythonArgs::NoArgsLeft

(

)

[inline]

Check if there are any args left.

Definition at line 92 of file vtkPythonArgs.h.

int vtkPythonArgs::GetArgSize

(

int

i

)

Get the size of an arg, if it is a sequence. If no size is available, or if the arg is out of range, then it returns 0 but doesn't set error.

bool vtkPythonArgs::GetPythonObject

(

PyObject *&

v

)

[inline]

Get the next argument as a naked Python object.

Definition at line 101 of file vtkPythonArgs.h.

bool vtkPythonArgs::GetPythonObject	(	PyObject *	o,
		PyObject *&	v
	)		[inline]

Get the next argument as a naked Python object.

Definition at line 105 of file vtkPythonArgs.h.

template<class T >

bool vtkPythonArgs::GetVTKObject	(	T *&	v,
		const char *	classname
	)		[inline]

Get the next argument as a vtkObjectBase derived type. It uses a C-style cast instead of a static_cast, which means that it works on incomplete types, and also means that it will give undefined results if "T" uses multiple inheritance.

Definition at line 117 of file vtkPythonArgs.h.

template<class T >

bool vtkPythonArgs::GetVTKObject	(	PyObject *	o,
		T *&	v,
		const char *	classname
	)		[inline]

Get the next argument as a vtkObjectBase derived type. It uses a C-style cast instead of a static_cast, which means that it works on incomplete types, and also means that it will give undefined results if "T" uses multiple inheritance.

Definition at line 122 of file vtkPythonArgs.h.

template<class T >

bool vtkPythonArgs::GetSpecialObject	(	T *&	v,
		PyObject *&	o,
		const char *	classname
	)		[inline]

Get the next argument as a special object. If a constructor was needed to convert the arg, the constructed object will be returned in "o" and must be freed after "v" is used.

Definition at line 133 of file vtkPythonArgs.h.

template<class T >

static bool vtkPythonArgs::GetSpecialObject	(	PyObject *	arg,
		T *&	v,
		PyObject *&	o,
		const char *	classname
	)		[inline, static]

Get the next argument as a special object. If a constructor was needed to convert the arg, the constructed object will be returned in "o" and must be freed after "v" is used.

Definition at line 137 of file vtkPythonArgs.h.

template<class T >

bool vtkPythonArgs::GetSpecialObject	(	T *&	v,
		const char *	classname
	)		[inline]

Get the next argument as a special object. Use this if the arg is a non-const ref, as it will disallow conversion.

Definition at line 148 of file vtkPythonArgs.h.

template<class T >

static bool vtkPythonArgs::GetSpecialObject	(	PyObject *	o,
		T *&	v,
		const char *	classname
	)		[inline, static]

Get the next argument as a special object. Use this if the arg is a non-const ref, as it will disallow conversion.

Definition at line 152 of file vtkPythonArgs.h.

template<class T >

bool vtkPythonArgs::GetEnumValue	(	T &	v,
		PyTypeObject *	enumtype
	)		[inline]

Get the next argument as an enum value.

Definition at line 161 of file vtkPythonArgs.h.

template<class T >

static bool vtkPythonArgs::GetEnumValue	(	PyObject *	o,
		T &	v,
		PyTypeObject *	enumtype
	)		[inline, static]

Get the next argument as an enum value.

Definition at line 166 of file vtkPythonArgs.h.

template<class T >

bool vtkPythonArgs::GetSIPObject	(	T *&	v,
		const char *	classname
	)		[inline]

Get the next argument as a SIP object.

Definition at line 175 of file vtkPythonArgs.h.

template<class T >

static bool vtkPythonArgs::GetSIPObject	(	PyObject *	o,
		T *&	v,
		const char *	classname
	)		[inline, static]

Get the next argument as a SIP object.

Definition at line 180 of file vtkPythonArgs.h.

template<class T >

bool vtkPythonArgs::GetSIPEnumValue	(	T &	v,
		const char *	enumname
	)		[inline]

Get the next argument as a SIP enum value.

Definition at line 189 of file vtkPythonArgs.h.

template<class T >

static bool vtkPythonArgs::GetSIPEnumValue	(	PyObject *	o,
		T &	v,
		const char *	enumname
	)		[inline, static]

Get the next argument as a SIP enum value.

Definition at line 194 of file vtkPythonArgs.h.

bool vtkPythonArgs::GetFunction

(

PyObject *&

o

)

Get the arguments needed for a SetExecuteMethod or a similar method that requires a function-pointer argument.

static bool vtkPythonArgs::GetFunction	(	PyObject *	arg,
		PyObject *&	o
	)		[static]

Get the arguments needed for a SetExecuteMethod or a similar method that requires a function-pointer argument.

bool vtkPythonArgs::GetValue

(

void *&

v

)

static bool vtkPythonArgs::GetValue	(	PyObject *	o,
		void *&	v
	)		[static]

bool vtkPythonArgs::GetValue

(

const void *&

v

)

static bool vtkPythonArgs::GetValue	(	PyObject *	o,
		const void *&	v
	)		[static]

bool vtkPythonArgs::GetValue

(

const char *&

v

)

Get the next argument as a string.

static bool vtkPythonArgs::GetValue	(	PyObject *	o,
		const char *&	v
	)		[static]

Get the next argument as a string.

bool vtkPythonArgs::GetValue

(

char *&

v

)

Get the next argument as a string.

static bool vtkPythonArgs::GetValue	(	PyObject *	o,
		char *&	v
	)		[static]

Get the next argument as a string.

bool vtkPythonArgs::GetValue

(

std::string &

v

)

Get the next argument as a string.

static bool vtkPythonArgs::GetValue	(	PyObject *	o,
		std::string &	v
	)		[static]

Get the next argument as a string.

bool vtkPythonArgs::GetValue

(

vtkUnicodeString &

v

)

Get the next argument as a string.

static bool vtkPythonArgs::GetValue	(	PyObject *	o,
		vtkUnicodeString &	v
	)		[static]

Get the next argument as a string.

bool vtkPythonArgs::GetValue

(

char &

v

)

Get the next string arg as a character.

static bool vtkPythonArgs::GetValue	(	PyObject *	o,
		char &	v
	)		[static]

Get the next string arg as a character.

bool vtkPythonArgs::GetValue

(

float &

v

)

Get the next argument. Sets a TypeError on failure.

static bool vtkPythonArgs::GetValue	(	PyObject *	o,
		float &	v
	)		[static]

Get the next argument. Sets a TypeError on failure.

bool vtkPythonArgs::GetValue

(

double &

v

)

Get the next argument. Sets a TypeError on failure.

static bool vtkPythonArgs::GetValue	(	PyObject *	o,
		double &	v
	)		[static]

Get the next argument. Sets a TypeError on failure.

bool vtkPythonArgs::GetValue

(

bool &

v

)

Get the next argument. Sets a TypeError on failure.

static bool vtkPythonArgs::GetValue	(	PyObject *	o,
		bool &	v
	)		[static]

Get the next argument. Sets a TypeError on failure.

bool vtkPythonArgs::GetValue

(

signed char &

v

)

Get the next argument. Sets a TypeError on failure.

static bool vtkPythonArgs::GetValue	(	PyObject *	o,
		signed char &	v
	)		[static]

Get the next argument. Sets a TypeError on failure.

bool vtkPythonArgs::GetValue

(

unsigned char &

v

)

Get the next argument. Sets a TypeError on failure.

static bool vtkPythonArgs::GetValue	(	PyObject *	o,
		unsigned char &	v
	)		[static]

Get the next argument. Sets a TypeError on failure.

bool vtkPythonArgs::GetValue

(

short &

v

)

Get the next argument. Sets a TypeError on failure.

static bool vtkPythonArgs::GetValue	(	PyObject *	o,
		short &	v
	)		[static]

Get the next argument. Sets a TypeError on failure.

bool vtkPythonArgs::GetValue

(

unsigned short &

v

)

Get the next argument. Sets a TypeError on failure.

static bool vtkPythonArgs::GetValue	(	PyObject *	o,
		unsigned short &	v
	)		[static]

Get the next argument. Sets a TypeError on failure.

bool vtkPythonArgs::GetValue

(

int &

v

)

Get the next argument. Sets a TypeError on failure.

static bool vtkPythonArgs::GetValue	(	PyObject *	o,
		int &	v
	)		[static]

Get the next argument. Sets a TypeError on failure.

bool vtkPythonArgs::GetValue

(

unsigned int &

v

)

Get the next argument. Sets a TypeError on failure.

static bool vtkPythonArgs::GetValue	(	PyObject *	o,
		unsigned int &	v
	)		[static]

Get the next argument. Sets a TypeError on failure.

bool vtkPythonArgs::GetValue

(

long &

v

)

Get the next argument. Sets a TypeError on failure.

static bool vtkPythonArgs::GetValue	(	PyObject *	o,
		long &	v
	)		[static]

Get the next argument. Sets a TypeError on failure.

bool vtkPythonArgs::GetValue

(

unsigned long &

v

)

Get the next argument. Sets a TypeError on failure.

static bool vtkPythonArgs::GetValue	(	PyObject *	o,
		unsigned long &	v
	)		[static]

Get the next argument. Sets a TypeError on failure.

bool vtkPythonArgs::GetArray	(	float *	v,
		int	n
	)

Get the next argument as an array.

bool vtkPythonArgs::GetArray	(	double *	v,
		int	n
	)

Get the next argument as an array.

bool vtkPythonArgs::GetArray	(	bool *	v,
		int	n
	)

Get the next argument as an array.

bool vtkPythonArgs::GetArray	(	char *	v,
		int	n
	)

Get the next argument as an array.

bool vtkPythonArgs::GetArray	(	signed char *	v,
		int	n
	)

Get the next argument as an array.

bool vtkPythonArgs::GetArray	(	unsigned char *	v,
		int	n
	)

Get the next argument as an array.

bool vtkPythonArgs::GetArray	(	short *	v,
		int	n
	)

Get the next argument as an array.

bool vtkPythonArgs::GetArray	(	unsigned short *	v,
		int	n
	)

Get the next argument as an array.

bool vtkPythonArgs::GetArray	(	int *	v,
		int	n
	)

Get the next argument as an array.

bool vtkPythonArgs::GetArray	(	unsigned int *	v,
		int	n
	)

Get the next argument as an array.

bool vtkPythonArgs::GetArray	(	long *	v,
		int	n
	)

Get the next argument as an array.

bool vtkPythonArgs::GetArray	(	unsigned long *	v,
		int	n
	)

Get the next argument as an array.

bool vtkPythonArgs::GetNArray	(	float *	v,
		int	ndims,
		const int *	dims
	)

Get the next argument as a multi-dimensional array.

bool vtkPythonArgs::GetNArray	(	double *	v,
		int	ndims,
		const int *	dims
	)

Get the next argument as a multi-dimensional array.

bool vtkPythonArgs::GetNArray	(	bool *	v,
		int	ndims,
		const int *	dims
	)

Get the next argument as a multi-dimensional array.

bool vtkPythonArgs::GetNArray	(	char *	v,
		int	ndims,
		const int *	dims
	)

Get the next argument as a multi-dimensional array.

bool vtkPythonArgs::GetNArray	(	signed char *	v,
		int	ndims,
		const int *	dims
	)

Get the next argument as a multi-dimensional array.

bool vtkPythonArgs::GetNArray	(	unsigned char *	v,
		int	ndims,
		const int *	dims
	)

Get the next argument as a multi-dimensional array.

bool vtkPythonArgs::GetNArray	(	short *	v,
		int	ndims,
		const int *	dims
	)

Get the next argument as a multi-dimensional array.

bool vtkPythonArgs::GetNArray	(	unsigned short *	v,
		int	ndims,
		const int *	dims
	)

Get the next argument as a multi-dimensional array.

bool vtkPythonArgs::GetNArray	(	int *	v,
		int	ndims,
		const int *	dims
	)

Get the next argument as a multi-dimensional array.

bool vtkPythonArgs::GetNArray	(	unsigned int *	v,
		int	ndims,
		const int *	dims
	)

Get the next argument as a multi-dimensional array.

bool vtkPythonArgs::GetNArray	(	long *	v,
		int	ndims,
		const int *	dims
	)

Get the next argument as a multi-dimensional array.

bool vtkPythonArgs::GetNArray	(	unsigned long *	v,
		int	ndims,
		const int *	dims
	)

Get the next argument as a multi-dimensional array.

bool vtkPythonArgs::SetArgValue	(	int	i,
		const std::string &	v
	)

Set the value of an argument if it is an assignable type.

bool vtkPythonArgs::SetArgValue	(	int	i,
		const vtkUnicodeString &	v
	)

Set the value of an argument if it is an assignable type.

bool vtkPythonArgs::SetArgValue	(	int	i,
		char	v
	)

Set the value of an argument if it is an assignable type.

bool vtkPythonArgs::SetArgValue	(	int	i,
		float	v
	)

Set the value of an argument if it is an assignable type.

bool vtkPythonArgs::SetArgValue	(	int	i,
		double	v
	)

Set the value of an argument if it is an assignable type.

bool vtkPythonArgs::SetArgValue	(	int	i,
		bool	v
	)

Set the value of an argument if it is an assignable type.

bool vtkPythonArgs::SetArgValue	(	int	i,
		signed char	v
	)

Set the value of an argument if it is an assignable type.

bool vtkPythonArgs::SetArgValue	(	int	i,
		unsigned char	v
	)

Set the value of an argument if it is an assignable type.

bool vtkPythonArgs::SetArgValue	(	int	i,
		short	v
	)

Set the value of an argument if it is an assignable type.

bool vtkPythonArgs::SetArgValue	(	int	i,
		unsigned short	v
	)

Set the value of an argument if it is an assignable type.

bool vtkPythonArgs::SetArgValue	(	int	i,
		int	v
	)

Set the value of an argument if it is an assignable type.

bool vtkPythonArgs::SetArgValue	(	int	i,
		unsigned int	v
	)

Set the value of an argument if it is an assignable type.

bool vtkPythonArgs::SetArgValue	(	int	i,
		long	v
	)

Set the value of an argument if it is an assignable type.

bool vtkPythonArgs::SetArgValue	(	int	i,
		unsigned long	v
	)

Set the value of an argument if it is an assignable type.

bool vtkPythonArgs::SetArray	(	int	i,
		const float *	v,
		int	n
	)

Set the values in an array argument.

bool vtkPythonArgs::SetArray	(	int	i,
		const double *	v,
		int	n
	)

Set the values in an array argument.

bool vtkPythonArgs::SetArray	(	int	i,
		const bool *	v,
		int	n
	)

Set the values in an array argument.

bool vtkPythonArgs::SetArray	(	int	i,
		const char *	v,
		int	n
	)

Set the values in an array argument.

bool vtkPythonArgs::SetArray	(	int	i,
		const signed char *	v,
		int	n
	)

Set the values in an array argument.

bool vtkPythonArgs::SetArray	(	int	i,
		const unsigned char *	v,
		int	n
	)

Set the values in an array argument.

bool vtkPythonArgs::SetArray	(	int	i,
		const short *	v,
		int	n
	)

Set the values in an array argument.

bool vtkPythonArgs::SetArray	(	int	i,
		const unsigned short *	v,
		int	n
	)

Set the values in an array argument.

bool vtkPythonArgs::SetArray	(	int	i,
		const int *	v,
		int	n
	)

Set the values in an array argument.

bool vtkPythonArgs::SetArray	(	int	i,
		const unsigned int *	v,
		int	n
	)

Set the values in an array argument.

bool vtkPythonArgs::SetArray	(	int	i,
		const long *	v,
		int	n
	)

Set the values in an array argument.

bool vtkPythonArgs::SetArray	(	int	i,
		const unsigned long *	v,
		int	n
	)

Set the values in an array argument.

bool vtkPythonArgs::SetNArray	(	int	i,
		const float *	v,
		int	n,
		const int *	d
	)

Set the values in a multi-dimensional array argument.

bool vtkPythonArgs::SetNArray	(	int	i,
		const double *	v,
		int	n,
		const int *	d
	)

Set the values in a multi-dimensional array argument.

bool vtkPythonArgs::SetNArray	(	int	i,
		const bool *	v,
		int	n,
		const int *	d
	)

Set the values in a multi-dimensional array argument.

bool vtkPythonArgs::SetNArray	(	int	i,
		const char *	v,
		int	n,
		const int *	d
	)

Set the values in a multi-dimensional array argument.

bool vtkPythonArgs::SetNArray	(	int	i,
		const signed char *	v,
		int	n,
		const int *	d
	)

Set the values in a multi-dimensional array argument.

bool vtkPythonArgs::SetNArray	(	int	i,
		const unsigned char *	v,
		int	n,
		const int *	d
	)

Set the values in a multi-dimensional array argument.

bool vtkPythonArgs::SetNArray	(	int	i,
		const short *	v,
		int	n,
		const int *	d
	)

Set the values in a multi-dimensional array argument.

bool vtkPythonArgs::SetNArray	(	int	i,
		const unsigned short *	v,
		int	n,
		const int *	d
	)

Set the values in a multi-dimensional array argument.

bool vtkPythonArgs::SetNArray	(	int	i,
		const int *	v,
		int	n,
		const int *	d
	)

Set the values in a multi-dimensional array argument.

bool vtkPythonArgs::SetNArray	(	int	i,
		const unsigned int *	v,
		int	n,
		const int *	d
	)

Set the values in a multi-dimensional array argument.

bool vtkPythonArgs::SetNArray	(	int	i,
		const long *	v,
		int	n,
		const int *	d
	)

Set the values in a multi-dimensional array argument.

bool vtkPythonArgs::SetNArray	(	int	i,
		const unsigned long *	v,
		int	n,
		const int *	d
	)

Set the values in a multi-dimensional array argument.

PyObject * vtkPythonArgs::BuildNone

(

)

[inline, static]

Build a value of None.

Definition at line 648 of file vtkPythonArgs.h.

PyObject * vtkPythonArgs::BuildVTKObject

(

const void *

v

)

[inline, static]

Build a vtkObjectBase object, use GetClassName() to get its type. If a null pointer is given, then None will be returned.

Definition at line 655 of file vtkPythonArgs.h.

PyObject * vtkPythonArgs::BuildSpecialObject	(	const void *	v,
		const char *	classname
	)		[inline, static]

Build a non-vtkObjectBase object of the specified type.

Definition at line 662 of file vtkPythonArgs.h.

PyObject * vtkPythonArgs::BuildEnumValue	(	int	v,
		const char *	enumname
	)		[inline, static]

Build an enum value object of the specified type.

Definition at line 669 of file vtkPythonArgs.h.

PyObject * vtkPythonArgs::BuildSIPObject	(	const void *	v,
		const char *	classname,
		bool	created
	)		[inline, static]

Build a SIP object of the specified type. Set "created" to true if the object was just created with new.

Definition at line 676 of file vtkPythonArgs.h.

PyObject * vtkPythonArgs::BuildSIPEnumValue	(	int	v,
		const char *	classname
	)		[inline, static]

Build a SIP enum object.

Definition at line 683 of file vtkPythonArgs.h.

PyObject * vtkPythonArgs::BuildValue

(

const void *

v

)

[inline, static]

Create a mangled string containing a memory address.

Definition at line 690 of file vtkPythonArgs.h.

PyObject * vtkPythonArgs::BuildValue

(

const char *

v

)

[inline, static]

Build a string return value.

Definition at line 702 of file vtkPythonArgs.h.

PyObject * vtkPythonArgs::BuildValue

(

const std::string &

v

)

[inline, static]

Build a string return value.

Definition at line 713 of file vtkPythonArgs.h.

PyObject * vtkPythonArgs::BuildValue

(

const vtkUnicodeString &

v

)

[inline, static]

Build a string return value.

Definition at line 719 of file vtkPythonArgs.h.

PyObject * vtkPythonArgs::BuildValue

(

char

v

)

[inline, static]

Build a char return value.

Definition at line 731 of file vtkPythonArgs.h.

PyObject * vtkPythonArgs::BuildValue

(

double

v

)

[inline, static]

Build a numeric return value.

Definition at line 740 of file vtkPythonArgs.h.

PyObject * vtkPythonArgs::BuildValue

(

bool

v

)

[inline, static]

Build a numeric return value.

Definition at line 746 of file vtkPythonArgs.h.

PyObject * vtkPythonArgs::BuildValue

(

int

v

)

[inline, static]

Build a numeric return value.

Definition at line 756 of file vtkPythonArgs.h.

PyObject * vtkPythonArgs::BuildValue

(

unsigned int

v

)

[inline, static]

Build a numeric return value.

Definition at line 762 of file vtkPythonArgs.h.

PyObject * vtkPythonArgs::BuildValue

(

long

v

)

[inline, static]

Build a numeric return value.

Definition at line 776 of file vtkPythonArgs.h.

PyObject * vtkPythonArgs::BuildValue

(

unsigned long

v

)

[inline, static]

Build a numeric return value.

Definition at line 782 of file vtkPythonArgs.h.

PyObject * vtkPythonArgs::BuildBytes	(	const char *	v,
		int	n
	)		[inline, static]

Build a bytes object (or string).

Definition at line 836 of file vtkPythonArgs.h.

static PyObject* vtkPythonArgs::BuildTuple	(	const float *	v,
		int	n
	)		[static]

Build a tuple for a return value.

static PyObject* vtkPythonArgs::BuildTuple	(	const double *	v,
		int	n
	)		[static]

Build a tuple for a return value.

static PyObject* vtkPythonArgs::BuildTuple	(	const bool *	v,
		int	n
	)		[static]

Build a tuple for a return value.

static PyObject* vtkPythonArgs::BuildTuple	(	const signed char *	v,
		int	n
	)		[static]

Build a tuple for a return value.

static PyObject* vtkPythonArgs::BuildTuple	(	const unsigned char *	v,
		int	n
	)		[static]

Build a tuple for a return value.

static PyObject* vtkPythonArgs::BuildTuple	(	const short *	v,
		int	n
	)		[static]

Build a tuple for a return value.

static PyObject* vtkPythonArgs::BuildTuple	(	const unsigned short *	v,
		int	n
	)		[static]

Build a tuple for a return value.

static PyObject* vtkPythonArgs::BuildTuple	(	const int *	v,
		int	n
	)		[static]

Build a tuple for a return value.

static PyObject* vtkPythonArgs::BuildTuple	(	const unsigned int *	v,
		int	n
	)		[static]

Build a tuple for a return value.

static PyObject* vtkPythonArgs::BuildTuple	(	const long *	v,
		int	n
	)		[static]

Build a tuple for a return value.

static PyObject* vtkPythonArgs::BuildTuple	(	const unsigned long *	v,
		int	n
	)		[static]

Build a tuple for a return value.

template<class T >

static void vtkPythonArgs::SaveArray	(	const T *	a,
		T *	b,
		int	n
	)		[inline, static]

Copy an array.

Definition at line 474 of file vtkPythonArgs.h.

template<class T >

static bool vtkPythonArgs::ArrayHasChanged	(	const T *	a,
		const T *	b,
		int	n
	)		[inline, static]

Check if an array has changed.

Definition at line 482 of file vtkPythonArgs.h.

static int vtkPythonArgs::GetArgCount

(

PyObject *

args

)

[inline, static]

Get the argument count.

Definition at line 490 of file vtkPythonArgs.h.

static int vtkPythonArgs::GetArgCount	(	PyObject *	self,
		PyObject *	args
	)		[inline, static]

Get the argument count for a method that might be unbound.

Definition at line 496 of file vtkPythonArgs.h.

static bool vtkPythonArgs::ArgCountError	(	int	n,
		const char *	name
	)		[static]

Raise a type error just saying that the arg count is wrong.

static vtkObjectBase* vtkPythonArgs::GetSelfFromFirstArg	(	PyObject *	self,
		PyObject *	args
	)		[static, protected]

Get the "self" object from the first argument.

PyObject* vtkPythonArgs::GetArgAsPythonObject

(

bool &

valid

)

[protected]

Get the next argument as an object of the given type.

static PyObject* vtkPythonArgs::GetArgAsPythonObject	(	PyObject *	o,
		bool &	valid
	)		[static, protected]

Get the next argument as an object of the given type.

vtkObjectBase* vtkPythonArgs::GetArgAsVTKObject	(	const char *	classname,
		bool &	valid
	)		[protected]

Get the next argument as an object of the given type.

static vtkObjectBase* vtkPythonArgs::GetArgAsVTKObject	(	PyObject *	o,
		const char *	classname,
		bool &	valid
	)		[static, protected]

Get the next argument as an object of the given type.

void* vtkPythonArgs::GetArgAsSpecialObject	(	const char *	classname,
		PyObject **	newobj
	)		[protected]

Get the next argument as an object of the given type.

static void* vtkPythonArgs::GetArgAsSpecialObject	(	PyObject *	o,
		const char *	classname,
		PyObject **	newobj
	)		[static, protected]

Get the next argument as an object of the given type.

int vtkPythonArgs::GetArgAsEnum	(	PyTypeObject *	enumtype,
		bool &	valid
	)		[protected]

Get the next argument as an object of the given type.

static int vtkPythonArgs::GetArgAsEnum	(	PyObject *	o,
		PyTypeObject *	enumtype,
		bool &	valid
	)		[static, protected]

Get the next argument as an object of the given type.

void* vtkPythonArgs::GetArgAsSIPObject	(	const char *	classname,
		bool &	valid
	)		[protected]

Get the next argument as an object of the given type.

static void* vtkPythonArgs::GetArgAsSIPObject	(	PyObject *	o,
		const char *	classname,
		bool &	valid
	)		[static, protected]

Get the next argument as an object of the given type.

int vtkPythonArgs::GetArgAsSIPEnum	(	const char *	classname,
		bool &	valid
	)		[protected]

Get the next argument as an object of the given type.

static int vtkPythonArgs::GetArgAsSIPEnum	(	PyObject *	o,
		const char *	classname,
		bool &	valid
	)		[static, protected]

Get the next argument as an object of the given type.

bool vtkPythonArgs::PureVirtualError

(

)

[protected]

Raise a TypeError if a virtual method call was called.

bool vtkPythonArgs::ArgCountError	(	int	m,
		int	n
	)		[protected]

Raise an TypeError stating that the arg count is incorrect.

bool vtkPythonArgs::RefineArgTypeError

(

int

i

)

[protected]

Prefix a TypeError that has occurred with the arg number.

---

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

• /Users/kitware/Dashboards/MyTests/VTK_BLD_Release_docs/Utilities/Doxygen/dox/Wrapping/PythonCore/vtkPythonArgs.h