WPVBaseTypes Namespace Reference

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

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

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. More...
std::ostream &	operator<< (std::ostream &out, const PV_TRIGGER &c)
	Write a PV_TRIGGER in string representation to the given output stream. More...
std::istream &	operator>> (std::istream &in, PV_TRIGGER &c)
	Write a PV_TRIGGER in string representation to the given input stream. More...

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.

Note

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

Typedef Documentation

PV_BOOL

typedef bool WPVBaseTypes::PV_BOOL

base type used for every WPVBool

Definition at line 106 of file WPropertyTypes.h.

PV_COLOR

typedef WColor WPVBaseTypes::PV_COLOR

base type used for every WPVColor

Definition at line 111 of file WPropertyTypes.h.

PV_DOUBLE

typedef double WPVBaseTypes::PV_DOUBLE

base type used for every WPVDouble

Definition at line 105 of file WPropertyTypes.h.

PV_INT

typedef int32_t WPVBaseTypes::PV_INT

base type used for every WPVInt

Definition at line 104 of file WPropertyTypes.h.

PV_INTERVAL

typedef WIntervalDouble WPVBaseTypes::PV_INTERVAL

base type used for every PV_INTERVAL

Definition at line 114 of file WPropertyTypes.h.

PV_MATRIX4X4

typedef WMatrix4d WPVBaseTypes::PV_MATRIX4X4

base type used for every WPVMatrix4X4

Definition at line 112 of file WPropertyTypes.h.

PV_PATH

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

base type used for every WPVFilename

Definition at line 108 of file WPropertyTypes.h.

PV_POSITION

typedef WPosition WPVBaseTypes::PV_POSITION

base type used for every WPVPosition

Definition at line 110 of file WPropertyTypes.h.

PV_SELECTION

typedef WItemSelector WPVBaseTypes::PV_SELECTION

base type used for every WPVSelection

Definition at line 109 of file WPropertyTypes.h.

PV_STRING

typedef std::string WPVBaseTypes::PV_STRING

base type used for every WPVString

Definition at line 107 of file WPropertyTypes.h.

PV_TRANSFERFUNCTION

typedef WTransferFunction WPVBaseTypes::PV_TRANSFERFUNCTION

base type for every transfer function

Definition at line 113 of file WPropertyTypes.h.

Enumeration Type Documentation

PV_TRIGGER

enum WPVBaseTypes::PV_TRIGGER

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

isPropertyGroup()

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

type	the type to check.

Returns

true if cast-able WPropertyGroupBase.

Definition at line 65 of file WPropertyTypes.cpp.

Referenced by WPropertyGroupBase::findProperty().

Here is the caller graph for this function:

operator<<()

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

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

Parameters

out	the output stream to print the value to
c	the 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.

operator>>()

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

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

Parameters

in	the input stream to read the value from
c	set 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.