Classes | Namespaces | Defines | Typedefs | Variables

jaus++/2.0/include/jaus/core/types.h File Reference

This file contains definitions of and about basic data types used throughout the JAUS++ library. More...

#include <limits.h>
#include <cxutils/packet.h>
#include <cxutils/mutex.h>
#include <cxutils/thread.h>
#include <exception>
#include "jauscoredll.h"

Go to the source code of this file.

Classes

class  JAUS::Exception
 Exception thrown for various reasons. More...
class  JAUS::VarType
 VarType stands for Variable Type. This class is used to deal with fields in JAUS messages which vary based on what kind of data needs to be stored. This class encapsulates the storage of variable type information. More...
class  JAUS::Limits
 Contains constants for limit values of data members of classes. More...
class  JAUS::PresenceVector
 This class contains bit masks for bitwise operations on the presence vector for this message. More...

Namespaces

namespace  JAUS
 

Name space used for the JAUS library.


Defines

#define NULL   0

Typedefs

typedef CxUtils::Packet JAUS::Packet
 Typedef to more easily reference Packet data.
typedef CxUtils::Mutex JAUS::Mutex
 Typedef to more easily reference Mutex data.
typedef CxUtils::Thread JAUS::Thread
 Typedef to more easily reference Thread data.
typedef unsigned char JAUS::Byte
 JAUS byte (8 bit unsigned integer).
typedef short JAUS::Short
 JAUS short integer (16 bit signed integer).
typedef int JAUS::Int
 JAUS integer (32 bit signed integer).
typedef long long int JAUS::Long
 JAUS long integer (64 bit signed integer).
typedef unsigned short JAUS::UShort
 JAUS unsigned short integer (16 bit unsigned integer).
typedef unsigned int JAUS::UInt
 JAUS unsigned integer (32 bit unsigned integer).
typedef unsigned long long int JAUS::ULong
 JAUS unsigned long integer (64 bit unsigned integer).
typedef float JAUS::Float
 JAUS float (IEEE 32 8 bit floating point number).
typedef double JAUS::LongFloat
 JAUS long float (IEEE 64 bit floating point number).

Variables

const int JAUS::OK = 1
 Shorter version of JAUS_OK.
const int JAUS::FAILURE = 0
 Shorter version of JAUS_FAILURE.
const Byte JAUS::BYTE = 0
 Type enumeration number for a byte.
const Byte JAUS::SHORT = 1
 Type enumeration number for a short.
const Byte JAUS::INT = 2
 Type enumeration number for an int.
const Byte JAUS::LONG = 3
 Type enumeration number for a long.
const Byte JAUS::USHORT = 4
 Type enumeration number for an unsigned short.
const Byte JAUS::UINT = 5
 Type enumeration number for an unsigned int.
const Byte JAUS::ULONG = 6
 Type enumeration number for an unsigned long.
const Byte JAUS::FLOAT = 7
 Type enumeration number for a float.
const Byte JAUS::LONG_FLOAT = 8
 Type enumeration number for a long float.
const Byte JAUS::RGB = 9
 RGB type of data.
const Short JAUS::JAUS_SHORT_MAX = SHRT_MAX
 Maximum value of scaled short (Short).
const Short JAUS::JAUS_SHORT_MIN = SHRT_MIN
 Minimum value of a scaled short (Short).
const UShort JAUS::JAUS_USHORT_MAX = USHRT_MAX
 Maximum value of a scaled unsigned short (UShort).
const UShort JAUS::JAUS_USHORT_MIN = 0
 Minimum value of scaled unsigned short (UShort).
const Int JAUS::JAUS_INT_MIN = INT_MIN
 Minimum value of scaled integer (Int).
const Int JAUS::JAUS_INT_MAX = INT_MAX
 Maximum value of scaled integer (Int).
const UInt JAUS::JAUS_UINT_MIN = 0
 Minimum value of scaled unsigned integer (UInt).
const UInt JAUS::JAUS_UINT_MAX = UINT_MAX
 Maximum value of scaled unsigned integer (UInt).
const Long JAUS::JAUS_LONG_MIN = LLONG_MIN
 < Minimum value of long integer (Long).
const Long JAUS::JAUS_LONG_MAX = LLONG_MAX
 < Maximum value of long integer (Long).
const ULong JAUS::JAUS_ULONG_MIN = 0
 Minimum value of unsigned long integer (ULong).
const ULong JAUS::JAUS_ULONG_MAX = ULLONG_MAX
 < Maximum value of unsigned long integer (ULong).
const UInt JAUS::BYTE_SIZE = 1
 Size in bytes.
const UInt JAUS::SHORT_SIZE = 2
 Size in bytes.
const UInt JAUS::USHORT_SIZE = 2
 Size in bytes.
const UInt JAUS::INT_SIZE = 4
 Size in bytes.
const UInt JAUS::UINT_SIZE = 4
 Size in bytes.
const UInt JAUS::FLOAT_SIZE = 4
 Size in bytes.
const UInt JAUS::LONG_SIZE = 8
 Size in bytes.
const UInt JAUS::ULONG_SIZE = 8
 Size in bytes.
const UInt JAUS::LONG_FLOAT_SIZE = 8
 Size in bytes.
const UInt JAUS::BYTE_BITS = 8
 Size in bits of Byte.
const UInt JAUS::SHORT_BITS = 16
 Size in bits of Short.
const UInt JAUS::USHORT_BITS = 16
 Size in bits of UShort.
const UInt JAUS::INT_BITS = 32
 Size in bits of Int.
const UInt JAUS::UINT_BITS = 32
 Size in bits of UInt.
const UInt JAUS::FLOAT_BITS = 32
 Size in bits of Float.
const UInt JAUS::LONG_BITS = 64
 Size in bits of Long.
const UInt JAUS::ULONG_BITS = 64
 Size in bits of ULong.
const UInt JAUS::LONG_FLOAT_BITS = 64
 Size in bits of LongFloat.

Detailed Description

This file contains definitions of and about basic data types used throughout the JAUS++ library.

Author(s): Daniel Barber Created: 26 September 2009 Copyright (c) 2009 Applied Cognition and Training in Immersive Virtual Environments (ACTIVE) Laboratory Institute for Simulation and Training (IST) University of Central Florida (UCF) Email: dbarber@ist.ucf.edu Web: http://active.ist.ucf.edu

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of the ACTIVE LAB, IST, UCF, nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE ACTIVE LAB''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL UCF BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Definition in file types.h.


Define Documentation

#define NULL   0

Definition at line 51 of file types.h.

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines