OpenWalnut  1.4.0
Typedefs | Enumerations | Functions
WPVBaseTypes Namespace Reference

Namespace containing all base types of the WPropertyVariables. More...

Typedefs

typedef int32_t PV_INT
 base type used for every WPVInt
typedef double PV_DOUBLE
 base type used for every WPVDouble
typedef bool PV_BOOL
 base type used for every WPVBool
typedef std::string PV_STRING
 base type used for every WPVString
typedef boost::filesystem::path PV_PATH
 base type used for every WPVFilename
typedef WItemSelector PV_SELECTION
 base type used for every WPVSelection
typedef WPosition PV_POSITION
 base type used for every WPVPosition
typedef WColor PV_COLOR
 base type used for every WPVColor
typedef WMatrix4d PV_MATRIX4X4
 base type used for every WPVMatrix4X4
typedef WTransferFunction PV_TRANSFERFUNCTION
 base type for every transfer function
typedef WIntervalDouble PV_INTERVAL
 base type used for every PV_INTERVAL

Enumerations

enum  PV_TRIGGER { PV_TRIGGER_READY = 0, PV_TRIGGER_TRIGGERED }
 Enum denoting the possible trigger states. More...

Functions

bool isPropertyGroup (PROPERTY_TYPE type)
 Checks which property types are derived from WPropertyGroupBase.
std::ostream & operator<< (std::ostream &out, const PV_TRIGGER &c)
 Write a PV_TRIGGER in string representation to the given output stream.
std::istream & operator>> (std::istream &in, PV_TRIGGER &c)
 Write a PV_TRIGGER in string representation to the given input stream.

Detailed Description

Namespace containing all base types of the WPropertyVariables.

Use these types instead of issuing int32_t, double, bool, ... directly. It also contains some user defined types including the needed operators.

Notes:
You can use only types which overwrite the << and >> operators!

Typedef Documentation

typedef bool WPVBaseTypes::PV_BOOL

base type used for every WPVBool

Definition at line 106 of file WPropertyTypes.h.

typedef WColor WPVBaseTypes::PV_COLOR

base type used for every WPVColor

Definition at line 111 of file WPropertyTypes.h.

typedef double WPVBaseTypes::PV_DOUBLE

base type used for every WPVDouble

Definition at line 105 of file WPropertyTypes.h.

typedef int32_t WPVBaseTypes::PV_INT

base type used for every WPVInt

Definition at line 104 of file WPropertyTypes.h.

base type used for every PV_INTERVAL

Definition at line 114 of file WPropertyTypes.h.

base type used for every WPVMatrix4X4

Definition at line 112 of file WPropertyTypes.h.

typedef boost::filesystem::path WPVBaseTypes::PV_PATH

base type used for every WPVFilename

Definition at line 108 of file WPropertyTypes.h.

base type used for every WPVPosition

Definition at line 110 of file WPropertyTypes.h.

base type used for every WPVSelection

Definition at line 109 of file WPropertyTypes.h.

typedef std::string WPVBaseTypes::PV_STRING

base type used for every WPVString

Definition at line 107 of file WPropertyTypes.h.

base type for every transfer function

Definition at line 113 of file WPropertyTypes.h.


Enumeration Type Documentation

Enum denoting the possible trigger states.

It is used for trigger properties.

Enumerator:
PV_TRIGGER_READY 

Trigger property: is ready to be triggered (again)

PV_TRIGGER_TRIGGERED 

Trigger property: got triggered.

Definition at line 119 of file WPropertyTypes.h.


Function Documentation

bool WPVBaseTypes::isPropertyGroup ( PROPERTY_TYPE  type)

Checks which property types are derived from WPropertyGroupBase.

This, for example, is true for PV_GROUP and PV_STRUCT.

Parameters:
typethe type to check.
Returns:
true if cast-able WPropertyGroupBase.

Definition at line 65 of file WPropertyTypes.cpp.

Referenced by WPropertyGroupBase::findProperty().

std::ostream & WPVBaseTypes::operator<< ( std::ostream &  out,
const PV_TRIGGER &  c 
)

Write a PV_TRIGGER in string representation to the given output stream.

Parameters:
outthe output stream to print the value to
cthe trigger value to output
Returns:
the output stream extended by the trigger value.

Definition at line 32 of file WPropertyTypes.cpp.

References PV_TRIGGER_TRIGGERED.

std::istream & WPVBaseTypes::operator>> ( std::istream &  in,
WPVBaseTypes::PV_TRIGGER c 
)

Write a PV_TRIGGER in string representation to the given input stream.

Parameters:
inthe input stream to read the value from
cset the value red to this
Returns:
the input stream.

Definition at line 47 of file WPropertyTypes.cpp.

References PV_TRIGGER_READY, and PV_TRIGGER_TRIGGERED.