makVrv::DtWindowConfiguration Class Reference

This owns a list of channel configurations. More...

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)
	CTOR A window will start with a single default channel configuration.
	DtWindowConfiguration (const DtWindowConfiguration &copy)
	Copy CTOR All channels configurations are duplicated (not shared).
DtWindowConfiguration &	operator= (const DtWindowConfiguration &copy)
	Assignment OP All channels configurations are duplicated (not shared).
virtual	~DtWindowConfiguration ()
	DTOR.
WindowType	windowType () const
	WindowType accessor.
void	setWindowType (WindowType wt)
	WindowType setter.
int	screenNumber () const
	Get the window number the window is configured for.
void	setScreenNumber (int number)
	Set the window number to place the window.
int	x () const
	Get the x coordinate (screen space) of the window's top left corner.
int	y () const
	Get the y coordinate (screen space) of the window's top left corner.
void	setPosition (int x, int y)
	Set the x & y coordinates (screen space) of the window's top left corner.
unsigned int	width () const
	Get the width.
unsigned int	height () const
	Get the height.
void	setSize (unsigned int width, unsigned int height)
	Set the window size.
bool	isFixedSize () const
	Get if the window should be fixed size.
void	setFixedSize (bool fixed)
	Set if the window is fixed size.
DtChannelConfigurations &	channelConfigurations ()
	Get the channel configurations for this window.
const DtChannelConfigurations &	channelConfigurations () const
Public Member Functions inherited from makVrv::DtConfiguration
	DtConfiguration (const std::string &name="")
	CTOR.
	DtConfiguration (const DtConfiguration &)
	Copy CTOR.
DtConfiguration &	operator= (const DtConfiguration &)
	Assignment OP.
virtual	~DtConfiguration ()
	DTOR.
virtual const std::string &	name () const
	Get the configuration name.
virtual void	setName (const std::string &name)
	Set the configuration name.
virtual const std::string *	findOptionalParameter (const std::string &name) const
	Find an optional parameters.
virtual void	setOptionalParameter (const std::string &name, const std::string &value)
	Set an optional parameter.
virtual void	setOptionalParameters (const ParameterMap &)
	Set an optional parameters.
virtual void	removeOptionalParameter (const std::string &name)
	Remove an optional parameter.
const ParameterMap &	optionalParameters () const
	Get the optional parameters.

Static Public Attributes
static const char *	DefaultWindowString

Protected Member Functions
template<class Archive >
void	_serialize (Archive &ar, const unsigned int version)
	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.

Protected Attributes
DtChannelConfigurations	myChannelConfigurations
	All copy semantics members.
WindowType	myWindowType
	Default is Window.
int	myScreenNumber
	Default is 0.
int	myX
	Default is 100.
int	myY
	Default is 100.
unsigned int	myWidth
	Default is 300.
unsigned int	myHeight
	Default is 300.
bool	myFixedSizeFlag
	Default is False.
Protected Attributes inherited from makVrv::DtConfiguration
std::string	myName
ParameterMap	myOptionalParameters
DtProxyWP	myAttachedInterface

Detailed Description

This owns a list of channel configurations.

Examples

• exampleConfiguration

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

WindowType makVrv::DtWindowConfiguration::windowType

(

)

const

WindowType accessor.

void makVrv::DtWindowConfiguration::setWindowType

(

WindowType

wt

)

WindowType 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.

Reimplemented from makVrv::DtConfiguration.

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.

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:

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-6-branch/include/vrvUtil/DtWindowConfiguration.h