NXTModule Struct Reference

Abstraction for NXT iModule interface. More...

#include <comm.h>

List of all members.

Public Member Functions
	NXTModule ()
	The NXTModule constructor.
	NXTModule (nFANTOM100::iModule *m)
	This constructs an NXTModule from the Fantom module type. Only in the Windows version.
int	getName (std::string &name)
	Retrieves the name of the module.
int	getModuleID (int &id)
	Retrieves the ID of the module.
int	getModuleSize (int &size)
	Retrieves the size of the module.
int	getIOMapSize (int &size)
	Retrieves the IOMap size.
int	readIOMap (ViPByte buffer, int offset, int number_of_bytes)
	Reads the IOMap into a buffer.
int	writeIOMap (const ViPByte, int offset, int number_of_bytes)
	Writes data to the IOMap.
Public Attributes
nFANTOM100::iModule *	internalModule
	The Fantom module pointer. Only in the Windows version.

---

Detailed Description

Abstraction for NXT iModule interface.

Definition at line 134 of file comm.h.

---

Constructor & Destructor Documentation

NXTModule::NXTModule

(

)

[inline]

The NXTModule constructor.

Definition at line 137 of file comm.h.

NXTModule::NXTModule

(

nFANTOM100::iModule *

m

)

[inline]

This constructs an NXTModule from the Fantom module type. Only in the Windows version.

Definition at line 142 of file comm.h.

References internalModule.

---

Member Function Documentation

int NXTModule::getName

(

std::string &

name

)

Retrieves the name of the module.

int NXTModule::getModuleID

(

int &

id

)

Retrieves the ID of the module.

int NXTModule::getModuleSize

(

int &

size

)

Retrieves the size of the module.

int NXTModule::getIOMapSize

(

int &

size

)

Retrieves the IOMap size.

int NXTModule::readIOMap	(	ViPByte	buffer,
		int	offset,
		int	number_of_bytes
	)

Reads the IOMap into a buffer.

int NXTModule::writeIOMap	(	const	ViPByte,
		int	offset,
		int	number_of_bytes
	)

Writes data to the IOMap.

---

Member Data Documentation

nFANTOM100::iModule* NXTModule::internalModule

The Fantom module pointer. Only in the Windows version.

Definition at line 148 of file comm.h.

Referenced by NXTModule().

---

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

• C:/Documents and Settings/Owner/My Documents/My Code/NXT++/files/include/comm.h