makVrv::DtWindowConfiguration Class Reference

This owns a list of channel configurations.

Examples

• exampleConfiguration

Inheritance diagram for makVrv::DtWindowConfiguration:

Public Types
enum	WindowType { NoWindow, Window, FullscreenWindow, EmbeddedWindow }
Public Types inherited from makVrv::DtConfiguration
typedef std::map< std::string, std::string >	ParameterMap

Public Member Functions
	DtWindowConfiguration (const std::string &name=DefaultWindowString)
	DtWindowConfiguration (const DtWindowConfiguration &copy)
DtWindowConfiguration &	operator= (const DtWindowConfiguration &copy)
virtual	~DtWindowConfiguration ()
WindowType	windowType () const
void	setWindowType (WindowType wt)
bool	windowStaysOnTop () const
void	setWindowStaysOnTop (bool stayOnTop)
int	screenNumber () const
void	setScreenNumber (int number)
int	x () const
int	y () const
void	setPosition (int x, int y)
unsigned int	width () const
unsigned int	height () const
void	setSize (unsigned int width, unsigned int height)
bool	isFixedSize () const
void	setFixedSize (bool fixed)
DtChannelConfigurations &	channelConfigurations ()
const DtChannelConfigurations &	channelConfigurations () const
Public Member Functions inherited from makVrv::DtConfiguration
	DtConfiguration (const std::string &name="")
	DtConfiguration (const DtConfiguration &)
DtConfiguration &	operator= (const DtConfiguration &)
virtual	~DtConfiguration ()
virtual const std::string &	name () const
virtual void	setName (const std::string &name)
virtual const std::string *	findOptionalParameter (const std::string &name) const
virtual void	setOptionalParameter (const std::string &name, const std::string &value)
virtual void	setOptionalParameters (const ParameterMap &)
virtual void	removeOptionalParameter (const std::string &name)
const ParameterMap &	optionalParameters () const

Static Public Attributes
static const char *	DefaultWindowString

Protected Member Functions
template<class Archive >
void	_serialize (Archive &ar, const unsigned int version)
Protected Member Functions inherited from makVrv::DtConfiguration
template<class Archive >
void	_serialize (Archive &ar, const unsigned int version)

Protected Attributes
DtChannelConfigurations	myChannelConfigurations
WindowType	myWindowType
bool	myStaysOnTop
int	myScreenNumber
int	myX
int	myY
unsigned int	myWidth
unsigned int	myHeight
bool	myFixedSizeFlag
Protected Attributes inherited from makVrv::DtConfiguration
std::string	myName
ParameterMap	myOptionalParameters
DtProxyWP	myAttachedInterface

Member Enumeration Documentation

enum makVrv::DtWindowConfiguration::WindowType

Enumerator
NoWindow
Window
FullscreenWindow
EmbeddedWindow

Constructor & Destructor Documentation

makVrv::DtWindowConfiguration::DtWindowConfiguration

(

const std::string &

name = DefaultWindowString

)

CTOR A window will start with a single default channel configuration.

makVrv::DtWindowConfiguration::DtWindowConfiguration

(

const DtWindowConfiguration &

copy

)

Copy CTOR All channels configurations are duplicated (not shared).

virtual makVrv::DtWindowConfiguration::~DtWindowConfiguration ( )

virtual

DTOR.

Member Function Documentation

DtWindowConfiguration& makVrv::DtWindowConfiguration::operator=

(

const DtWindowConfiguration &

copy

)

Assignment OP All channels configurations are duplicated (not shared).

DtChannelConfigurations& makVrv::DtWindowConfiguration::channelConfigurations

(

)

Get the channel configurations for this window.

const DtChannelConfigurations& makVrv::DtWindowConfiguration::channelConfigurations

(

)

const

Get the channel configurations for this window.

WindowType makVrv::DtWindowConfiguration::windowType

(

)

const

WindowType accessor.

void makVrv::DtWindowConfiguration::setWindowType

(

WindowType

wt

)

WindowType setter.

bool makVrv::DtWindowConfiguration::windowStaysOnTop

(

)

const

Window stays on top accessor.

void makVrv::DtWindowConfiguration::setWindowStaysOnTop

(

bool

stayOnTop

)

Window stays on top setter.

int makVrv::DtWindowConfiguration::screenNumber

(

)

const

Get the window number the window is configured for.

void makVrv::DtWindowConfiguration::setScreenNumber

(

int

number

)

Set the window number to place the window. If the system is configured with only one window this number is ignored.

int makVrv::DtWindowConfiguration::x

(

)

const

Get the x coordinate (screen space) of the window's top left corner.

int makVrv::DtWindowConfiguration::y

(

)

const

Get the y coordinate (screen space) of the window's top left corner.

void makVrv::DtWindowConfiguration::setPosition	(	int	x,
		int	y
	)

Set the x & y coordinates (screen space) of the window's top left corner.

unsigned int makVrv::DtWindowConfiguration::width

(

)

const

Get the width.

unsigned int makVrv::DtWindowConfiguration::height

(

)

const

Get the height.

void makVrv::DtWindowConfiguration::setSize	(	unsigned int	width,
		unsigned int	height
	)

Set the window size.

bool makVrv::DtWindowConfiguration::isFixedSize

(

)

const

Get if the window should be fixed size.

void makVrv::DtWindowConfiguration::setFixedSize

(

bool

fixed

)

Set if the window is fixed size.

template<class Archive >

void makVrv::DtWindowConfiguration::_serialize ( Archive &  ar, const unsigned int  version  )

inlineprotected

Declare serialize functions Call via serialize(Archive ar, unsigned int version); Where Archive can be any of : xml_oarchive,xml_iarchive,binary_oarchive binary_iarchive,text_oarchive, or text_iarchive.

References DT_SERIALIZE_BASE, and DT_SERIALIZE_MEMBER.

Member Data Documentation

const char* makVrv::DtWindowConfiguration::DefaultWindowString

static

DtChannelConfigurations makVrv::DtWindowConfiguration::myChannelConfigurations

protected

All copy semantics members.

Default has a single default channel.

WindowType makVrv::DtWindowConfiguration::myWindowType

protected

Default is Window.

bool makVrv::DtWindowConfiguration::myStaysOnTop

protected

Default is false.

int makVrv::DtWindowConfiguration::myScreenNumber

protected

Default is 0.

int makVrv::DtWindowConfiguration::myX

protected

Default is 100.

int makVrv::DtWindowConfiguration::myY

protected

Default is 100.

unsigned int makVrv::DtWindowConfiguration::myWidth

protected

Default is 300.

unsigned int makVrv::DtWindowConfiguration::myHeight

protected

Default is 300.

bool makVrv::DtWindowConfiguration::myFixedSizeFlag

protected

Default is False.

---

The documentation for this class was generated from the following file:

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrvUtil/DtWindowConfiguration.h