cmlabs::CrankMapEntry Struct Reference

Crank-map entry: one registered crank (user callback/script) with its function, library and inline script. More...

#include <DataMapsMemory.h>

Public Member Functions
std::string	toXML ()
bool	writeToMsg (uint32 n, DataMessage *msg)
bool	writeIDToMsg (const char *arrayname, uint32 n, DataMessage *msg)

Static Public Member Functions
static std::string	GetOuterXMLName ()

Public Attributes
uint16	id
uint8	status
uint64	time
uint32	compID
char	name [MAXKEYNAMELEN+1]
char	language [MAXKEYNAMELEN+1]
char	function [MAXKEYNAMELEN+1]
char	libraryFilename [MAXKEYNAMELEN+1]
char	script [MAXSCRIPTLEN+1]
uint64	key

Detailed Description

Crank-map entry: one registered crank (user callback/script) with its function, library and inline script.

Legacy crank-map entry (callback name, function, library, inline script).

Warning

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

Shared-memory layout.

Definition at line 146 of file DataMapsMemory.h.

Member Function Documentation

GetOuterXMLName()

std::string cmlabs::CrankMapEntry::GetOuterXMLName ( )

inlinestatic

Definition at line 164 of file DataMapsMemory.h.

toXML()

std::string cmlabs::CrankMapEntry::toXML ( )

inline

Definition at line 156 of file DataMapsMemory.h.

References compID, function, libraryFilename, name, script, status, cmlabs::utils::StringFormat(), and time.

writeIDToMsg()

bool cmlabs::CrankMapEntry::writeIDToMsg ( const char * arrayname, uint32 n, DataMessage * msg )

inline

Definition at line 178 of file DataMapsMemory.h.

References name, and cmlabs::DataMessage::setString().

writeToMsg()

bool cmlabs::CrankMapEntry::writeToMsg ( uint32 n, DataMessage * msg )

inline

Definition at line 165 of file DataMapsMemory.h.

References compID, function, language, libraryFilename, name, script, cmlabs::DataMessage::setInt(), cmlabs::DataMessage::setString(), cmlabs::DataMessage::setTime(), status, and time.

Member Data Documentation

compID

uint32 cmlabs::CrankMapEntry::compID

Definition at line 150 of file DataMapsMemory.h.

Referenced by cmlabs::DataMapsMemory::createNewCrank(), toXML(), and writeToMsg().

function

char cmlabs::CrankMapEntry::function

Definition at line 153 of file DataMapsMemory.h.

Referenced by cmlabs::MemoryMaps::CreateNewCrank(), cmlabs::DataMapsMemory::createNewCrank(), cmlabs::MemoryMaps::GetCrankFunction(), toXML(), and writeToMsg().

id

uint16 cmlabs::CrankMapEntry::id

Definition at line 147 of file DataMapsMemory.h.

key

uint64 cmlabs::CrankMapEntry::key

Definition at line 131 of file MemoryMaps.h.

language

char cmlabs::CrankMapEntry::language[MAXKEYNAMELEN+1]

Definition at line 152 of file DataMapsMemory.h.

Referenced by cmlabs::DataMapsMemory::createNewCrank(), and writeToMsg().

libraryFilename

char cmlabs::CrankMapEntry::libraryFilename

Definition at line 154 of file DataMapsMemory.h.

Referenced by cmlabs::MemoryMaps::CreateNewCrank(), cmlabs::DataMapsMemory::createNewCrank(), cmlabs::MemoryMaps::GetCrankLibraryFilename(), toXML(), and writeToMsg().

name

char cmlabs::CrankMapEntry::name

Definition at line 151 of file DataMapsMemory.h.

Referenced by toXML(), writeIDToMsg(), and writeToMsg().

script

char cmlabs::CrankMapEntry::script

Definition at line 155 of file DataMapsMemory.h.

Referenced by cmlabs::DataMapsMemory::createNewCrank(), cmlabs::MemoryMaps::GetCrankScript(), cmlabs::MemoryMaps::SetCrankScript(), toXML(), and writeToMsg().

status

uint8 cmlabs::CrankMapEntry::status

Definition at line 148 of file DataMapsMemory.h.

Referenced by toXML(), and writeToMsg().

time

uint64 cmlabs::CrankMapEntry::time

Definition at line 149 of file DataMapsMemory.h.

Referenced by cmlabs::MemoryMaps::CreateNewCrank(), cmlabs::DataMapsMemory::createNewCrank(), toXML(), and writeToMsg().

---

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

• /home/ubuntu/c/partner/psyclone2/CMSDK/include/DataMapsMemory.h
• /home/ubuntu/c/partner/psyclone2/CMSDK/include/MemoryMaps.h