cmlabs::ParamHeader Struct Reference

Size- and type-prefixed parameter entry stored after a component record. More...

#include <ComponentMemory.h>

Public Attributes
uint32	size
	Total entry size in bytes including this header.
uint8	type
	PARAM_* data type.

Detailed Description

Size- and type-prefixed parameter entry stored after a component record.

Layout after the header: name, NUL, then the type-specific struct (ParamIntegerHeader / ParamFloatHeader / ParamCollectionHeader / string bytes).

Warning

Shared-memory layout; see MemoryManager.h for the ABI/rebuild warning.

Definition at line 205 of file ComponentMemory.h.

Member Data Documentation

size

uint32 cmlabs::ParamHeader::size

Total entry size in bytes including this header.

Definition at line 206 of file ComponentMemory.h.

Referenced by cmlabs::ComponentMemory::createParameter(), cmlabs::ComponentMemory::createParameter(), cmlabs::ComponentMemory::createParameter(), cmlabs::ComponentMemory::createParameter(), cmlabs::ComponentMemory::createParameter(), cmlabs::ComponentMemory::createParameter(), and cmlabs::ComponentMemory::deleteParameter().

type

uint8 cmlabs::ParamHeader::type

PARAM_* data type.

Definition at line 207 of file ComponentMemory.h.

Referenced by cmlabs::ComponentMemory::createParameter(), cmlabs::ComponentMemory::createParameter(), cmlabs::ComponentMemory::createParameter(), cmlabs::ComponentMemory::createParameter(), cmlabs::ComponentMemory::createParameter(), cmlabs::ComponentMemory::createParameter(), cmlabs::ComponentMemory::getParameter(), cmlabs::ComponentMemory::getParameter(), cmlabs::ComponentMemory::getParameter(), cmlabs::ComponentMemory::getParameterAsBool(), cmlabs::ComponentMemory::getParameterDataType(), cmlabs::ComponentMemory::getParameterString(), cmlabs::ComponentMemory::getParameterValueSize(), cmlabs::ComponentMemory::resetParameter(), cmlabs::ComponentMemory::setParameter(), cmlabs::ComponentMemory::setParameter(), cmlabs::ComponentMemory::setParameter(), and cmlabs::ComponentMemory::tweakParameter().

---

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

• /home/ubuntu/c/partner/psyclone2/CMSDK/include/ComponentMemory.h