mrpt::system::os Namespace Reference

This namespace provides a OS-independent interface to low-level functions. More...

Functions
int BASE_IMPEXP	sprintf (char buf, size_t bufSize, const char format,...) MRPT_NO_THROWS MRPT_printf_format_check(3
	An OS-independent version of sprintf (Notice the bufSize param, which may be ignored in some compilers).
int BASE_IMPEXP int BASE_IMPEXP	vsprintf (char buf, size_t bufSize, const char format, va_list args) MRPT_NO_THROWS
	An OS-independent version of vsprintf (Notice the bufSize param, which may be ignored in some compilers).
int BASE_IMPEXP	vsnprintf (char buf, size_t bufSize, const char format, va_list args) MRPT_NO_THROWS
	An OS-independent version of vsnprintf (Notice the bufSize param, which may be ignored in some compilers).
FILE BASE_IMPEXP *	fopen (const char fileName, const char mode) MRPT_NO_THROWS
	An OS-independent version of fopen.
FILE BASE_IMPEXP *	fopen (const std::string &fileName, const char *mode) MRPT_NO_THROWS
	An OS-independent version of fopen (std::string version).
int BASE_IMPEXP	fprintf (FILE fil, const char format,...) MRPT_NO_THROWS MRPT_printf_format_check(2
	An OS-independent version of fprintf.
int BASE_IMPEXP void BASE_IMPEXP	fclose (FILE *f)
	An OS-independent version of fscanf.
char BASE_IMPEXP *	strcat (char dest, size_t destSize, const char source) MRPT_NO_THROWS
	An OS-independent version of strcat.
char BASE_IMPEXP *	strcpy (char dest, size_t destSize, const char source) MRPT_NO_THROWS
	An OS-independent version of strcpy.
int BASE_IMPEXP	_strcmp (const char str1, const char str2) MRPT_NO_THROWS
	An OS-independent version of strcmp.
int BASE_IMPEXP	_strcmpi (const char str1, const char str2) MRPT_NO_THROWS
	An OS-independent version of strcmpi.
int64_t BASE_IMPEXP	_strtoll (const char nptr, char *endptr, int base)
	An OS-independent version of strtoll.
uint64_t BASE_IMPEXP	_strtoull (const char nptr, char *endptr, int base)
	An OS-independent version of strtoull.
time_t BASE_IMPEXP	timegm (struct tm *tm)
	An OS-independent version of timegm (which is not present in all compilers): converts a time structure into an UTM time_t.
void BASE_IMPEXP	memcpy (void dest, size_t destSize, const void src, size_t copyCount) MRPT_NO_THROWS
	An OS and compiler independent version of "memcpy".
int BASE_IMPEXP	getch () MRPT_NO_THROWS
	An OS-independent version of getch, which waits until a key is pushed.
bool BASE_IMPEXP	kbhit () MRPT_NO_THROWS
	An OS-independent version of kbhit, which returns true if a key has been pushed.
Aligned memory management

void BASE_IMPEXP *	aligned_malloc (size_t bytes, size_t alignment)
	Returns an aligned memory block.
void *	aligned_calloc (size_t bytes, size_t alignment)
	Identical to aligned_malloc, but it zeroes the reserved memory block.
void BASE_IMPEXP *	aligned_realloc (void *old_ptr, size_t bytes, size_t alignment)
	Frees a memory block reserved by aligned_malloc.
void BASE_IMPEXP	aligned_free (void *p)
	Frees a memory block reserved by aligned_malloc.
template<typename _Tp >
_Tp *	align_ptr (_Tp *ptr, int n=(int) sizeof(_Tp))
	Returns a pointer a bit forward in memory so it's aligned for the given boundary size.

Detailed Description

This namespace provides a OS-independent interface to low-level functions.

Most of these functions are converted into calls to standard functions, unless we are into Visual Studio 2005 (or newer). In that case the secure version of the standard library functions (prefix "_s") are used instead.

Function Documentation

int BASE_IMPEXP mrpt::system::os::_strcmp	(	const char *	str1,
		const char *	str2
	)

An OS-independent version of strcmp.

Returns:: It will return 0 when both strings are equal, casi sensitive.

int BASE_IMPEXP mrpt::system::os::_strcmpi	(	const char *	str1,
		const char *	str2
	)

An OS-independent version of strcmpi.

Returns:: It will return 0 when both strings are equal, casi insensitive.

Referenced by mrpt::utils::CMHPropertiesValuesList::getElemental(), and mrpt::utils::CMHPropertiesValuesList::setElemental().

int64_t BASE_IMPEXP mrpt::system::os::_strtoll	(	const char *	nptr,
		char **	endptr,
		int	base
	)

An OS-independent version of strtoll.

uint64_t BASE_IMPEXP mrpt::system::os::_strtoull	(	const char *	nptr,
		char **	endptr,
		int	base
	)

An OS-independent version of strtoull.

template<typename _Tp >

_Tp* mrpt::system::os::align_ptr	(	_Tp *	ptr,
		int	n = `(int)sizeof(_Tp)`
	)			`[inline]`

Returns a pointer a bit forward in memory so it's aligned for the given boundary size.

Note:: Function copied from OpenCV with a different name to avoid conflicts.

Definition at line 105 of file memory.h.

void* mrpt::system::os::aligned_calloc	(	size_t	bytes,
		size_t	alignment
	)			`[inline]`

Identical to aligned_malloc, but it zeroes the reserved memory block.

Definition at line 83 of file memory.h.

References aligned_malloc().

Referenced by mrpt::math::CMatrixTemplate< TPoint3D >::insertRowsAndCols(), and mrpt::math::CMatrixTemplate< TPoint3D >::realloc().

void BASE_IMPEXP mrpt::system::os::aligned_free ( void * p )

Frees a memory block reserved by aligned_malloc.

See also:: aligned_malloc

Referenced by mrpt::math::CMatrixTemplate< TPoint3D >::insertRowsAndCols(), and mrpt::math::CMatrixTemplate< TPoint3D >::realloc().

void BASE_IMPEXP* mrpt::system::os::aligned_malloc	(	size_t	bytes,
		size_t	alignment
	)

Returns an aligned memory block.

Parameters:

alignment

The desired alignment, typ. 8 or 16 bytes. 1 means no alignment required. It must be a power of two.

See also:: aligned_free, aligned_realloc, aligned_calloc

Note:: Based on code by William Chan

Referenced by aligned_calloc().

void BASE_IMPEXP* mrpt::system::os::aligned_realloc	(	void *	old_ptr,
		size_t	bytes,
		size_t	alignment
	)

Frees a memory block reserved by aligned_malloc.

Parameters:

alignment

The desired alignment, typ. 8 or 16 bytes. 1 means no alignment required. If old_ptr is NULL, a new block will be reserved from scratch.

See also:: aligned_malloc, aligned_free

Referenced by mrpt::math::CMatrixTemplate< TPoint3D >::realloc().

int BASE_IMPEXP void BASE_IMPEXP mrpt::system::os::fclose ( FILE * f )

An OS-independent version of fscanf.

Returns:: The number of fields correctly assigned An OS-independent version of fclose.

Exceptions:

std::exception

On trying to close a NULL file descriptor.

Referenced by mrpt::math::detail::saveMatrixToTextFile(), and mrpt::utils::CDynamicGrid< TGasConcentrationCell >::saveToTextFile().

FILE BASE_IMPEXP* mrpt::system::os::fopen	(	const std::string &	fileName,
		const char *	mode
	)

An OS-independent version of fopen (std::string version).

Returns:: It will always return NULL on any error.

FILE BASE_IMPEXP* mrpt::system::os::fopen	(	const char *	fileName,
		const char *	mode
	)

An OS-independent version of fopen.

Returns:: It will always return NULL on any error.

Referenced by mrpt::math::detail::saveMatrixToTextFile(), and mrpt::utils::CDynamicGrid< TGasConcentrationCell >::saveToTextFile().

int BASE_IMPEXP mrpt::system::os::fprintf	(	FILE *	fil,
		const char *	format,
			...
	)

An OS-independent version of fprintf.

Referenced by mrpt::math::detail::saveMatrixToTextFile(), and mrpt::utils::CDynamicGrid< TGasConcentrationCell >::saveToTextFile().

int BASE_IMPEXP mrpt::system::os::getch ( )

An OS-independent version of getch, which waits until a key is pushed.

Returns:: The pushed key code

bool BASE_IMPEXP mrpt::system::os::kbhit ( )

An OS-independent version of kbhit, which returns true if a key has been pushed.

void BASE_IMPEXP mrpt::system::os::memcpy	(	void *	dest,
		size_t	destSize,
		const void *	src,
		size_t	copyCount
	)

An OS and compiler independent version of "memcpy".

Referenced by mrpt::math::CArrayPOD< T, N >::CArrayPOD(), mrpt::math::CVectorTemplate< KFTYPE >::extract_array(), mrpt::bayes::CKalmanFilterCapable< 7, 3, 3, 7 >::getLandmarkMean(), mrpt::math::CVectorTemplate< KFTYPE >::insert_array(), mrpt::bayes::CKalmanFilterCapable< 7, 3, 3, 7 >::KF_aux_estimate_obs_Hx_jacobian(), mrpt::bayes::CKalmanFilterCapable< 7, 3, 3, 7 >::KF_aux_estimate_obs_Hy_jacobian(), and mrpt::bayes::CKalmanFilterCapable< 7, 3, 3, 7 >::runOneKalmanIteration().

int BASE_IMPEXP mrpt::system::os::sprintf	(	char *	buf,
		size_t	bufSize,
		const char *	format,
			...
	)

An OS-independent version of sprintf (Notice the bufSize param, which may be ignored in some compilers).

See also:: utils::format

char BASE_IMPEXP* mrpt::system::os::strcat	(	char *	dest,
		size_t	destSize,
		const char *	source
	)

An OS-independent version of strcat.

Returns:: It will always return the "dest" pointer.

char BASE_IMPEXP* mrpt::system::os::strcpy	(	char *	dest,
		size_t	destSize,
		const char *	source
	)

An OS-independent version of strcpy.

Returns:: It will always return the "dest" pointer.

time_t BASE_IMPEXP mrpt::system::os::timegm ( struct tm * tm )

An OS-independent version of timegm (which is not present in all compilers): converts a time structure into an UTM time_t.

int BASE_IMPEXP mrpt::system::os::vsnprintf	(	char *	buf,
		size_t	bufSize,
		const char *	format,
		va_list	args
	)

An OS-independent version of vsnprintf (Notice the bufSize param, which may be ignored in some compilers).

int BASE_IMPEXP int BASE_IMPEXP mrpt::system::os::vsprintf	(	char *	buf,
		size_t	bufSize,
		const char *	format,
		va_list	args
	)

An OS-independent version of vsprintf (Notice the bufSize param, which may be ignored in some compilers).

mrpt::system::os Namespace Reference

Functions

Detailed Description

Function Documentation