SimplygonSDK::rdata< I > Class Template Reference

#include <SimplygonSDK.h>

Public Types
typedef I::value_type	value_type

Public Member Functions
const value_type *	Data () const
const value_type &	GetItem (rid index) const
unsigned int	GetItemCount () const
I *	GetPointer () const
bool	IsNullOrEmpty () const
	operator const value_type * () const
	operator I* () const
I *	operator-> () const
rdata< I > &	operator= (const rdata< I > &p)
const value_type &	operator[] (rid index) const
	rdata (const rdata< I > &p)
	rdata (I *p=NULL)
	~rdata ()

Detailed Description

template<class I>
class SimplygonSDK::rdata< I >

The rdata class is used to retrieve array data from the interface. Use this rather than the IData object, as this will manage reference counting automatically.

Definition at line 240 of file SimplygonSDK.h.

Member Typedef Documentation

value_type

template<class I>

typedef I::value_type SimplygonSDK::rdata< I >::value_type

Definition at line 243 of file SimplygonSDK.h.

Constructor & Destructor Documentation

rdata() [1/2]

template<class I>

SimplygonSDK::rdata< I >::rdata ( I *  p = NULL )

inline

Constructs a rdata from an IData interface pointer.

Parameters

p	is a pointer to an API object, or NULL to make the CountedPointer point at nothing.

Definition at line 249 of file SimplygonSDK.h.

rdata() [2/2]

template<class I>

SimplygonSDK::rdata< I >::rdata ( const rdata< I > &  p )

inline

Points an rdata at content of another rdata. Adds reference count ot the IData object

Parameters

p	is a CountedPointer that points at an API object.

Definition at line 258 of file SimplygonSDK.h.

~rdata()

template<class I>

SimplygonSDK::rdata< I >::~rdata ( )

inline

Destructs the rdata, and releases one reference to the IData object, if the rdata currently points at an object.

Definition at line 266 of file SimplygonSDK.h.

Member Function Documentation

Data()

template<class I>

const value_type* SimplygonSDK::rdata< I >::Data ( ) const

inline

Method to retrieve the const data pointer.

Definition at line 301 of file SimplygonSDK.h.

GetItem()

template<class I>

const value_type& SimplygonSDK::rdata< I >::GetItem ( rid  index ) const

inline

        Method to retrieve a data item value. Note that this will not check the pointer for null 

refecence and will cause a crash unless IsNullOrEmpty() is used to check the value of ptr

Definition at line 332 of file SimplygonSDK.h.

GetItemCount()

template<class I>

unsigned int SimplygonSDK::rdata< I >::GetItemCount ( ) const

inline

Method to retrieve the data size.

Definition at line 321 of file SimplygonSDK.h.

GetPointer()

template<class I>

I* SimplygonSDK::rdata< I >::GetPointer ( ) const

inline

Method that returns a standard pointer to the object the pointer is pointing at.

Returns

a pointer to the object the pointer is pointing at

Definition at line 359 of file SimplygonSDK.h.

IsNullOrEmpty()

template<class I>

bool SimplygonSDK::rdata< I >::IsNullOrEmpty ( ) const

inline

Tells whether the rdata points at an object, or nothing.

Returns

true if the pointer points at nothing, of false if the pointer points at an object

Definition at line 275 of file SimplygonSDK.h.

operator const value_type *()

template<class I>

SimplygonSDK::rdata< I >::operator const value_type * ( ) const

inline

Operator to retrieve the data.

Definition at line 311 of file SimplygonSDK.h.

operator I*()

template<class I>

SimplygonSDK::rdata< I >::operator I* ( ) const

inline

Operator that returns a standard pointer to the object the pointer is pointing at.

Returns

a pointer to the object the pointer is pointing at

Definition at line 350 of file SimplygonSDK.h.

operator->()

template<class I>

I* SimplygonSDK::rdata< I >::operator-> ( ) const

inline

Operator that returns a standard pointer to the object the pointer is pointing at.

Returns

a pointer to the object the pointer is pointing at

Definition at line 368 of file SimplygonSDK.h.

operator=()

template<class I>

rdata<I>& SimplygonSDK::rdata< I >::operator= ( const rdata< I > &  p )

inline

Operator that sets the rdata to point at the same rdata as the source rdata

Definition at line 287 of file SimplygonSDK.h.

operator[]()

template<class I>

const value_type& SimplygonSDK::rdata< I >::operator[] ( rid  index ) const

inline

        Operator to retrieve a data item value. Note that this will not check the pointer for null 

refecence and will cause a crash unless IsNullOrEmpty() is used to check the value of ptr

Definition at line 341 of file SimplygonSDK.h.

---

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

• SimplygonSDK.h