CustomDataObject

CustomDataObject is a specialization of DataObjectSimple for some application-specific data in arbitrary (either custom or one of the standard ones).

The only restriction is that it is supposed that this data can be copied bitwise (i.e. with memcpy() ), so it would be a bad idea to make it contain a C++ object (though C struct is fine).

By default, CustomDataObject stores the data inside in a buffer. To put the data into the buffer you may use either SetData or TakeData depending on whether you want the object to make a copy of data or not.

This class may be used as is, but if you don’t want store the data inside the object but provide it on demand instead, you should override GetSize, GetData and SetData (or may be only the first two or only the last one if you only allow reading/writing the data).

See also

DataObject

Inheritance Diagram

Inheritance diagram for class CustomDataObject

Methods Summary

__init__	The constructor accepts a format argument which specifies the (single) format supported by this object.
GetSize	Returns the data size in bytes.

Properties Summary

Data	See GetData and SetData
Size	See GetSize

Class API

---

class CustomDataObject(DataObjectSimple)

CustomDataObject is a specialization of DataObjectSimple for some application-specific data in arbitrary (either custom or one of the standard ones).

Possible constructors:

CustomDataObject(format=FormatInvalid)

CustomDataObject(formatName)

Methods

---

__init__(self, *args, **kw)

Overloaded Implementations:

---

__init__ (self, format=FormatInvalid)

The constructor accepts a format argument which specifies the (single) format supported by this object.

If it isn’t set here, DataObjectSimple.SetFormat should be used.

Parameters:format (DataFormat) –

---

__init__ (self, formatName)

---

---

GetSize(self)

Returns the data size in bytes.

Return type:int

Properties

---

Data

See GetData and SetData

---

Size

See GetSize