GeMarker Class Reference

#include <c4d_gemarker.h>

Public Member Functions
	GeMarker ()
Bool	Content () const
Bool	IsEqual (const GeMarker &m) const
Int32	Compare (const GeMarker &m) const
void	Set (const GeMarker &m)
Bool	Read (HyperFile *hf)
Bool	Write (HyperFile *hf) const
void	GetMemory (void *&data, Int32 &size) const

Static Public Member Functions
static GeMarker *	Alloc ()
static void	Free (GeMarker *&obj)

Private Attributes
UChar	uniqueid [16]

Friends
GeMarker	GeGetNewMarker ()
Bool	operator== (const GeMarker &m1, const GeMarker &m2)
Bool	operator!= (const GeMarker &m1, const GeMarker &m2)
Bool	operator< (const GeMarker &m1, const GeMarker &m2)
Bool	operator> (const GeMarker &m1, const GeMarker &m2)

Detailed Description

A unique marker that identifies an object derived from one of the base lists.

Constructor & Destructor Documentation

GeMarker()

GeMarker

(

)

Default constructor.

Member Function Documentation

Alloc()

static GeMarker* Alloc ( )

static

Allocates a marker. Destroy the allocated marker with Free().

Returns

The allocated marker, or nullptr if the allocation failed.

Free()

static void Free ( GeMarker *&  obj )

static

Destructs markers allocated with Alloc().

Parameters

[in,out]

obj

The marker to destruct. If the pointer is nullptr nothing happens. The pointer is assigned nullptr afterwards.

Content()

Bool Content

(

)

const

Checks if the marker is empty.

Returns

true if the marker has been set, otherwise false.

IsEqual()

Bool IsEqual

(

const GeMarker &

m

)

const

Checks if two markers are equal.

Parameters

[in]

m

The marker to compare with.

Returns

true if if both markers are equal, otherwise false.

Compare()

Int32 Compare

(

const GeMarker &

m

)

const

Compares two markers. Basically it works like memcmp().

Parameters

[in]

m

The marker to compare with.

Returns

0 if the markers are identical and != 0 if different.

Set()

void Set

(

const GeMarker &

m

)

Sets a marker the same as another marker.

Parameters

[in]

m

The new marker.

Read()

Bool Read

(

HyperFile *

hf

)

Private.

Write()

Bool Write

(

HyperFile *

hf

)

const

Private.

GetMemory()

void GetMemory	(	void *&	data,
		Int32 &	size
	)		const

Gets a memory pointer and the size of the memory block. Used for instance to create a checksum.

Note

The memory must not be freed.

Parameters

[in]	data	The memory pointer.
[in]	size	The size of the memory block.

Friends And Related Function Documentation

GeGetNewMarker

GeMarker GeGetNewMarker ( )

friend

Gets a new marker.

Returns

A new marker.

operator==

Bool operator== ( const GeMarker &  m1, const GeMarker &  m2  )

friend

Equality operator.

Parameters

[in]	m1	Left operand.
[in]	m2	Right operand.

Returns

true if markers are equal, otherwise false.

operator!=

Bool operator!= ( const GeMarker &  m1, const GeMarker &  m2  )

friend

Inequality operator.

Parameters

[in]	m1	Left operand.
[in]	m2	Right operand.

Returns

true if markers are not equal, otherwise false.

operator<

Bool operator< ( const GeMarker &  m1, const GeMarker &  m2  )

friend

Inferior operator.

Parameters

[in]	m1	Left operand.
[in]	m2	Right operand.

Returns

true if Left operand marker is inferior to right operand marker, otherwise false.

operator>

Bool operator> ( const GeMarker &  m1, const GeMarker &  m2  )

friend

Superior operator.

Parameters

[in]	m1	Left operand.
[in]	m2	Right operand.

Returns

true if Left operand marker is superior to right operand marker, otherwise false.

Member Data Documentation

uniqueid

UChar uniqueid[16]

private