#include <vtkPythonArgs.h>

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)

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, const char *enumname)
template<class T >
static bool	GetEnumValue (PyObject o, T &v, const char enumname)
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 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, const char classname, bool &valid)
int	GetArgAsEnum (const char *classname, 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 557 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 568 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 578 of file vtkPythonArgs.h.

bool vtkPythonArgs::CheckArgCount ( int n ) [inline]

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

Definition at line 591 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 606 of file vtkPythonArgs.h.

bool vtkPythonArgs::ErrorOccurred ( ) [inline, static]

Check if an error has occurred.

Definition at line 620 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.

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 105 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 110 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 121 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 125 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 136 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 140 of file vtkPythonArgs.h.

template<class T >

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

Get the next argument as an enum value.

Definition at line 149 of file vtkPythonArgs.h.

template<class T >

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

Get the next argument as an enum value.

Definition at line 154 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 163 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 168 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 177 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 182 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 )