FPValue Class Reference

#include <ifnpub.h>

Inheritance diagram for FPValue:

Public Member Functions
	FPValue ()
	FPValue (const FPValue &from)
	FPValue (int type,...)
CoreExport	~FPValue ()
CoreExport void	Free ()
CoreExport void	Init ()
CoreExport void	InitTab (ParamType2 paramType, int size)
	Allocates and initializes the Tab in the FPValue for TAB types.
CoreExport FPValue &	operator= (const FPValue &sv)
CoreExport va_list	Loadva (int iType, va_list ap, bool pointer=false)
void	Load (int paramType,...)
void	LoadPtr (int paramType,...)
CoreExport IOResult	Save (ISave *isave)
	Saves the FPValue.
CoreExport IOResult	Load (ILoad *iload)
	Loads the FPValue.
CoreExport bool	operator== (const FPValue &val) const

Static Public Member Functions
static CoreExport bool	IsPointerBasedType (ParamType2 type)
	Returns true if the data associated with the type is represented by a pointer. If the type is a TAB type, whether the data in the Tab is represented by a pointer.
Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e)
	Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new (size_t size, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new (size_t size, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new[] (size_t size, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects.
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new[] (size_t size, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
static UtilExport void	operator delete (void *ptr)
	Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete (void *ptr, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete[] (void *ptr)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete[] (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete[] (void *ptr, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator.
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator.
static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary.
static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary.
static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc.

Public Attributes
ParamType2	type
union {
int   i
float   f
DWORD   d
bool   b
INT_PTR   intptr
INT64   i64
double   dbl
int *   iptr
float *   fptr
Point3 *   p
Point4 *   p4
TimeValue   t
const MCHAR *   s
MSTR *   tstr
PBBitmap *   bm
Mtl *   mtl
Texmap *   tex
INode *   n
ReferenceTarget *   r
Matrix3 *   m
AngAxis *   aa
Quat *   q
Ray *   ray
Point2 *   p2
BitArray *   bits
ClassDesc *   cd
Mesh *   msh
Object *   obj
Control *   ctrl
Interval *   intvl
POINT *   pt
HWND   hwnd
IObject *   iobj
FPInterface *   fpi
void *   ptr
Color *   clr
AColor *   aclr
FPValue *   fpv
Value *   v
DWORD *   dptr
bool *   bptr
INT_PTR *   intptrptr
INT64 *   i64ptr
double *   dblptr
Box3 *   b3
BezierShape *   bezshape
Tab< int > *   i_tab
Tab< float > *   f_tab
Tab< Point3 * > *   p_tab
Tab< Point4 * > *   p4_tab
Tab< TimeValue > *   t_tab
Tab< const MCHAR * > *   s_tab
Tab< MSTR * > *   tstr_tab
Tab< PBBitmap * > *   bm_tab
Tab< Mtl * > *   mtl_tab
Tab< Texmap * > *   tex_tab
Tab< INode * > *   n_tab
Tab< ReferenceTarget * > *   r_tab
Tab< Matrix3 * > *   m3_tab
Tab< AngAxis * > *   aa_tab
Tab< Quat * > *   q_tab
Tab< Ray * > *   ray_tab
Tab< Point2 * > *   p2_tab
Tab< BitArray * > *   bits_tab
Tab< ClassDesc * > *   cd_tab
Tab< Mesh * > *   msh_tab
Tab< Object * > *   obj_tab
Tab< Control * > *   ctrl_tab
Tab< Interval * > *   intvl_tab
Tab< POINT * > *   pt_tab
Tab< HWND > *   hwnd_tab
Tab< IObject * > *   iobj_tab
Tab< FPInterface * > *   fpi_tab
Tab< void * > *   ptr_tab
Tab< Color * > *   clr_tab
Tab< AColor * > *   aclr_tab
Tab< FPValue * > *   fpv_tab
Tab< Value * > *   v_tab
Tab< DWORD > *   d_tab
Tab< bool > *   b_tab
Tab< INT_PTR > *   intptr_tab
Tab< INT64 > *   i64_tab
Tab< double > *   dbl_tab
Tab< Box3 * > *   b3_tab
Tab< BezierShape * > *   bezshape_tab
};

Detailed Description

See also

ParamType, ParamType2,
Template Class Tab.

Description:

This class contains a single value used as part of the Function Publishing system. It's capable of holding any of the FnPub supported types. This value is used as a parameter and as a return value.

Data Members:

ParamType2 type;

This data member identifies which type of value is stored in the union below.

The following union contains a single value, pointer to a single value, or a pointer to a single table (Tab<>) of values.

union
{
    int i;
    float f;
    int* iptr;
    float* fptr;
    Point3* p;
    TimeValue t;
    MCHAR* s;
    MSTR* tstr;
    PBBitmap* bm;
    Mtl* mtl;
    Texmap* tex;
    INode* n;
    ReferenceTarget* r;
    Matrix3* m;
    AngAxis* aa;
    Quat* q;
    Ray* ray;
    Point2* p2;
    BitArray* bits;
    ClassDesc* cd;
    Mesh* msh;
    Object* obj;
    Control* ctrl;
    Interval* intvl;
    POINT* pt;
    HWND hwnd;
    IObject* iobj;
    FPInterface* fpi;
    void* ptr;
    Color* clr;
    FPValue* fpv;
    Value* v;
    DWORD* dptr;
    bool* bptr;
    INT_PTR* intptrptr;
    INT64* i64ptr;
    double* dblptr;
    Box3* b3;
// Tab<>s of above
    Tab<int>* i_tab;
    Tab<float>* f_tab;
    Tab<Point3*>* p_tab;
    Tab<TimeValue>* t_tab;
    Tab<MCHAR*>* s_tab;
    Tab<MSTR*>* tstr_tab;
    Tab<PBBitmap*>* bm_tab;
    Tab<Mtl*>* mtl_tab;
    Tab<Texmap*>* tex_tab;
    Tab<INode*>* n_tab;
    Tab<ReferenceTarget*>* r_tab;
    Tab<Matrix3*>* m3_tab;
    Tab<AngAxis*>* aa_tab;
    Tab<Quat*>* q_tab;
    Tab<Ray*>* ray_tab;
    Tab<Point2*>* p2_tab;
    Tab<BitArray*>* bits_tab;
    Tab<ClassDesc*>* cd_tab;
    Tab<Mesh*>* msh_tab;
    Tab<Object*>* obj_tab;
    Tab<Control*>* ctrl_tab;
    Tab<Interval*>* intvl_tab;
    Tab<POINT*>* pt_tab;
    Tab<HWND>* hwnd_tab;
    Tab<IObject*>* iobj_tab;
    Tab<FPInterface*>* fpi_tab;
    Tab<void*>* ptr_tab;
    Tab<Color*>* clr_tab;
    Tab<FPValue*>* fpv_tab;
    Tab<Value*>* v_tab;
    Tab<DWORD>* d_tab;
    Tab<bool>* b_tab;
    Tab<INT_PTR>* intptr_tab;
    Tab<INT64>* i64_tab;
    Tab<double>* dbl_tab;
    Tab<Box3*>* b3_tab;
};

Constructor & Destructor Documentation

FPValue() [1/3]

FPValue ( )

inline

Remarks

Constructor

Default Implementation:

{ Init(); }

{ Init(); }

FPValue() [2/3]

FPValue ( const FPValue &  from )

inline

Remarks

Copy Constructor.

Parameters:

FPValue& from

A reference to a FPValue to copy from.

Default Implementation:

{ Init(); *this = from; }

{ Init(); *this = from; }

FPValue() [3/3]

FPValue ( int  type,   ...  )

inline

Remarks

Constructor

Default Implementation:

{va_list ap; va_start(ap, type); ap = Loadva(type, ap); va_end(ap);}

{ va_list ap; va_start(ap, type); ap = Loadva(type, ap); va_end(ap); }

~FPValue()

CoreExport ~FPValue ( )

inline

Remarks

Destructor.

Default Implementation:

{ Free(); }

{ Free(); }

Member Function Documentation

Free()

CoreExport void Free

(

)

Remarks

This method will free up all memory used by the class.

Init()

CoreExport void Init

(

)

Remarks

This method will Initialize FPValue class.

Default Implementation:

{ type = (ParamType2)TYPE_INT; s = NULL; }

InitTab()

CoreExport void InitTab	(	ParamType2	paramType,
		int	size
	)

Allocates and initializes the Tab in the FPValue for TAB types.

Parameters

[in]	paramType	- The ParamType2 type to set the FPValue to.
[in]	size	- The size of the tab

operator=()

CoreExport FPValue & operator=

(

const FPValue &

sv

)

Remarks

Assignment operator.

Loadva()

CoreExport va_list Loadva	(	int	iType,
		va_list	ap,
		bool	pointer = false
	)

Load() [1/2]

void Load ( int  paramType,   ...  )

inline

Remarks

This method will load the FPValue class with the provided data.

Parameters:

int paramType

The FPValue parameter type to load.

...

This method takes a variable number of arguments.

Default Implementation:

{va_list ap; va_start(ap, type); ap = Loadva(type, ap); va_end(ap);}

{ va_list ap; va_start(ap, paramType); ap = Loadva(paramType, ap); va_end(ap); }

LoadPtr()

void LoadPtr ( int  paramType,   ...  )

inline

Remarks

This method will load the FPValue class with the provided data.

Parameters:

int paramType

The FPValue parameter type to load.

...

This method takes a variable number of arguments.

{ va_list ap; va_start(ap, paramType); ap = Loadva(paramType, ap, true); va_end(ap); }

Save()

CoreExport IOResult Save

(

ISave *

isave

)

Saves the FPValue.

Note that raw pointers are not saved. FPValues that contain a raw pointer (TYPE_IOBJECT, TYPE_INTERFACE, TYPE_VOID, TYPE_HWND) will store a pointer value of NULL.

For TYPE_VALUE values, only the following singleton values are saved and loaded: undefined, unsupplied, emptyVal, ok.

All other value types are saved as undefined.

Parameters

[in]

isave

- This class provides methods to save data to disk.

Returns

IOResult - One of the following values: IO_OK - The result was acceptable - no errors. IO_ERROR - This is returned if an error occurred.

Remarks

Saves the FPValue. Note that raw pointers are not saved. FPValues that contain a raw pointer (TYPE_IOBJECT, TYPE_INTERFACE, TYPE_VOID, TYPE_HWND) will store a pointer value of NULL. For TYPE_VALUE values, only the following singleton values are saved and loaded: undefined, unsupplied, emptyVal, ok. All other value types are saved as undefined.

Parameters:

isave

This class provides methods to save data to disk.

See also

ISave

Returns

IOResult - One of the following values:

IO_OK - The result was acceptable - no errors.

IO_ERROR - This is returned if an error occurred.

Load() [2/2]

CoreExport IOResult Load

(

ILoad *

iload

)

Loads the FPValue.

Parameters

[in]

iload

- This class provides methods to load data from disk.

Returns

IOResult - One of the following values: IO_OK - The result was acceptable - no errors. IO_ERROR - This is returned if an error occurred.

IsPointerBasedType()

static CoreExport bool IsPointerBasedType ( ParamType2  type )

static

Returns true if the data associated with the type is represented by a pointer. If the type is a TAB type, whether the data in the Tab is represented by a pointer.

Parameters

[in]

type

- The ParamType2 type to test.

Returns

bool - True if the FPValue's data, or the Tab's data if a TAB type, is a pointer

operator==()

CoreExport bool operator==

(

const FPValue &

val

)

const

Remarks

Compares this class instance to another one

Member Data Documentation

type

ParamType2 type

i

int i

f

float f

d

DWORD d

b

bool b

intptr

INT_PTR intptr

i64

INT64 i64

dbl

double dbl

iptr

int* iptr

fptr

float* fptr

p

Point3* p

p4

Point4* p4

t

TimeValue t

s

const MCHAR* s

tstr

MSTR* tstr

bm

PBBitmap* bm

mtl

Mtl* mtl

tex

Texmap* tex

n

INode* n

r

ReferenceTarget* r

m

Matrix3* m

aa

AngAxis* aa

q

Quat* q

ray

Ray* ray

p2

Point2* p2

bits

BitArray* bits

cd

ClassDesc* cd

msh

Mesh* msh

obj

Object* obj

ctrl

Control* ctrl

intvl

Interval* intvl

pt

POINT* pt

hwnd

HWND hwnd

iobj

IObject* iobj

fpi

FPInterface* fpi

ptr

void* ptr

clr

Color* clr

aclr

AColor* aclr

fpv

FPValue* fpv

v

Value* v

dptr

DWORD* dptr

bptr

bool* bptr

intptrptr

INT_PTR* intptrptr

i64ptr

INT64* i64ptr

dblptr

double* dblptr

b3

Box3* b3

bezshape

BezierShape* bezshape

i_tab

Tab<int>* i_tab

f_tab

Tab<float>* f_tab

p_tab

Tab<Point3*>* p_tab

p4_tab

Tab<Point4*>* p4_tab

t_tab

Tab<TimeValue>* t_tab

s_tab

Tab<const MCHAR*>* s_tab

tstr_tab

Tab<MSTR*>* tstr_tab

bm_tab

Tab<PBBitmap*>* bm_tab

mtl_tab

Tab<Mtl*>* mtl_tab

tex_tab

Tab<Texmap*>* tex_tab

n_tab

Tab<INode*>* n_tab

r_tab

Tab<ReferenceTarget*>* r_tab

m3_tab

Tab<Matrix3*>* m3_tab

aa_tab

Tab<AngAxis*>* aa_tab

q_tab

Tab<Quat*>* q_tab

ray_tab

Tab<Ray*>* ray_tab

p2_tab

Tab<Point2*>* p2_tab

bits_tab

Tab<BitArray*>* bits_tab

cd_tab

Tab<ClassDesc*>* cd_tab

msh_tab

Tab<Mesh*>* msh_tab

obj_tab

Tab<Object*>* obj_tab

ctrl_tab

Tab<Control*>* ctrl_tab

intvl_tab

Tab<Interval*>* intvl_tab

pt_tab

Tab<POINT*>* pt_tab

hwnd_tab

Tab<HWND>* hwnd_tab

iobj_tab

Tab<IObject*>* iobj_tab

fpi_tab

Tab<FPInterface*>* fpi_tab

ptr_tab

Tab<void*>* ptr_tab

clr_tab

Tab<Color*>* clr_tab

aclr_tab

Tab<AColor*>* aclr_tab

fpv_tab

Tab<FPValue*>* fpv_tab

v_tab

Tab<Value*>* v_tab

d_tab

Tab<DWORD>* d_tab

b_tab

Tab<bool>* b_tab

intptr_tab

Tab<INT_PTR>* intptr_tab

i64_tab

Tab<INT64>* i64_tab

dbl_tab

Tab<double>* dbl_tab

b3_tab

Tab<Box3*>* b3_tab

bezshape_tab

Tab<BezierShape*>* bezshape_tab

union { ... } @59