general.h File Reference

#include <aims/config/aimsdata_config.h>
#include <cartobase/type/types.h>
#include <aims/memmap/allocator.h>

Include dependency graph for general.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
	aims
	The class for EcatSino data write operation.

Macros
#define	AIMS_MAGIC_NUMBER   0x41424344

Enumerations
enum	AimsDisplayFormalism { AIMS_MATH_FORMALISM, AIMS_IMAGE_FORMALISM }
	Display formalism. More...
enum	AimsBasicType {   AIMS_SCALAR, AIMS_VECTOR, AIMS_MATRIX, AIMS_VOLUME,   AIMS_SEQVOL }
	The 5 basic types of data. More...

Functions
std::string	aims::aimsVersion ()
General AIMS functions
AIMSDATA_API void	AimsClear (void)
	Clear the screen. More...
AIMSDATA_API void	AimsPrintVersion (void)
	Print A.I.M.S. version. More...
AIMSDATA_API std::string	AimsStringTypeOf (int type)
	Send a string containing AIMS_XXXX. More...
AIMSDATA_API int	AimsNCompOf (int type)
	Return the number of components of AIMS_XXXX. More...
AIMSDATA_API double	AimsMinValOf (int type)
	Return the minimum value of a AIMS_XXXX data. More...
AIMSDATA_API double	AimsMaxValOf (int type)
	Return the maximum value of a AIMS_XXXX data. More...
AIMSDATA_API bool	AimsIsSignedType (int type)
	Return True if AIMS_XXXX is signed. More...
AIMSDATA_API bool	AimsIsComplexType (int type)
	Return True if AIMS_XXXX is complex. More...
String, Error and warning messages
AIMSDATA_API void	AimsScanNflush (char **str, char *strRef)
	Read the next word from *str, put it in strRef and move *str behind the word. More...
AIMSDATA_API void	AimsError (const std::string &message) __attribute__((__noreturn__))
	Give an error message on display. More...
AIMSDATA_API void	AimsWarning (const std::string &message)
	Give a warning message on display. More...
Getting data size of text files
AIMSDATA_API bool	AimsIsScientificNumberChar (int c)
AIMSDATA_API int	AimsSpaceLevelOf (const std::string &filename)
	Return the dimemsion of the space data (1D, 2D, 3D or 4D) More...
AIMSDATA_API int	AimsFileDimXOf (const std::string &filename)
	Return the X dimension of a text file. More...
AIMSDATA_API int	AimsFileDimYOf (const std::string &filename)
	Return the Y dimension of a text file. More...
AIMSDATA_API int	AimsFileDimZOf (const std::string &filename)
	Return the Z dimension of a text file. More...
AIMSDATA_API int	AimsFileDimTOf (const std::string &filename)
	Return the T dimension of a text file. More...
AIMSDATA_API bool	AimsIsComplexData (const std::string &filename)
	Return true if the file contains complex data. More...
AIMSDATA_API bool	AimsIsPoint2dData (const std::string &filename)
	Return true if the file contains 2D point data. More...
AIMSDATA_API bool	AimsIsPoint3dData (const std::string &filename)
	Return true if the file contains 3D point data. More...

Macro Definition Documentation

AIMS_MAGIC_NUMBER

#define AIMS_MAGIC_NUMBER   0x41424344

Definition at line 51 of file general.h.

Referenced by aims::BckReader< T >::read(), aims::BckMapReader< T >::read(), aims::BckWriter< T >::write(), aims::BckMapWriter< T >::write(), and aims::MeshWriter< D, T >::write().

Enumeration Type Documentation

AimsBasicType

enum AimsBasicType

The 5 basic types of data.

Useful enum to specify the type of data.

Enumerator
AIMS_SCALAR
AIMS_VECTOR
AIMS_MATRIX
AIMS_VOLUME
AIMS_SEQVOL

Definition at line 76 of file general.h.

AimsDisplayFormalism

enum AimsDisplayFormalism

Display formalism.

There exists 2 formalisms to display a vector or matrix. The image one consider X to be along rows and Y along columns. The mathematical one is the contrary. An uint define the formalism taken into account.

Enumerator
AIMS_MATH_FORMALISM	Mathematical formalism.
AIMS_IMAGE_FORMALISM	Image formalism.

Definition at line 64 of file general.h.

Function Documentation

AimsClear()

AIMSDATA_API void AimsClear

(

void

)

Clear the screen.

AimsError()

AIMSDATA_API void AimsError

(

const std::string &

message

)

Give an error message on display.

AimsFileDimTOf()

AIMSDATA_API int AimsFileDimTOf

(

const std::string &

filename

)

Return the T dimension of a text file.

AimsFileDimXOf()

AIMSDATA_API int AimsFileDimXOf

(

const std::string &

filename

)

Return the X dimension of a text file.

AimsFileDimYOf()

AIMSDATA_API int AimsFileDimYOf

(

const std::string &

filename

)

Return the Y dimension of a text file.

AimsFileDimZOf()

AIMSDATA_API int AimsFileDimZOf

(

const std::string &

filename

)

Return the Z dimension of a text file.

AimsIsComplexData()

AIMSDATA_API bool AimsIsComplexData

(

const std::string &

filename

)

Return true if the file contains complex data.

AimsIsComplexType()

AIMSDATA_API bool AimsIsComplexType

(

int

type

)

Return True if AIMS_XXXX is complex.

AimsIsPoint2dData()

AIMSDATA_API bool AimsIsPoint2dData

(

const std::string &

filename

)

Return true if the file contains 2D point data.

AimsIsPoint3dData()

AIMSDATA_API bool AimsIsPoint3dData

(

const std::string &

filename

)

Return true if the file contains 3D point data.

AimsIsScientificNumberChar()

AIMSDATA_API bool AimsIsScientificNumberChar

(

int

c

)

AimsIsSignedType()

AIMSDATA_API bool AimsIsSignedType

(

int

type

)

Return True if AIMS_XXXX is signed.

AimsMaxValOf()

AIMSDATA_API double AimsMaxValOf

(

int

type

)

Return the maximum value of a AIMS_XXXX data.

AimsMinValOf()

AIMSDATA_API double AimsMinValOf

(

int

type

)

Return the minimum value of a AIMS_XXXX data.

AimsNCompOf()

AIMSDATA_API int AimsNCompOf

(

int

type

)

Return the number of components of AIMS_XXXX.

AimsPrintVersion()

AIMSDATA_API void AimsPrintVersion

(

void

)

Print A.I.M.S. version.

AimsScanNflush()

AIMSDATA_API void AimsScanNflush	(	char **	str,
		char *	strRef
	)

Read the next word from *str, put it in strRef and move *str behind the word.

AimsSpaceLevelOf()

AIMSDATA_API int AimsSpaceLevelOf

(

const std::string &

filename

)

Return the dimemsion of the space data (1D, 2D, 3D or 4D)

AimsStringTypeOf()

AIMSDATA_API std::string AimsStringTypeOf

(

int

type

)

Send a string containing AIMS_XXXX.

AimsWarning()

AIMSDATA_API void AimsWarning

(

const std::string &

message

)

Give a warning message on display.