makVrv::DtWindowProxy Class Reference

Acts a proxy for each remote window on the master display engine. More...

Inheritance diagram for makVrv::DtWindowProxy:

Public Member Functions
virtual	~DtWindowProxy ()
	DTOR.
bool	addChannel (const DtChannelConfiguration &config)
	Operators, all behavior may not happen immediately.
void	destroyChannel (DtChannelProxySP channel)
	Destroy a channel.
bool	modifyChannel (DtChannelProxySP channel, const DtChannelConfiguration &config)
	Modifies a channel based upon the configuration.
const DtWindowConfiguration &	configuration () const
	Accessors.
DtChannelProxySP	findChannel (const std::string &channelName)
	Find a Display by name.
DtChannelProxySP	findChannelByIndex (int index)
	Get the display by index.
const std::string &	displayName () const
	Return the display engine name this window belongs to.
const std::string &	windowName () const
	Return the name of the window this proxy represents.
const unsigned int	channelCount () const
	Get a count of the channels in this window.
Public Member Functions inherited from makVrv::DtProxy
	DtProxy ()
	CTOR.
virtual void	makeInvalid ()
	Make this proxy invalid.
bool	isValid () const
	Return the valid state of the proxy.
void	validate () const
	Check to see if the proxy is valid.

Protected Member Functions
	DtWindowProxy (DtDe &de, const std::string &displayName, DtWindowConfiguration &)
	CTOR.
DtWindowProctor *	proctor ()
	Get the proctor this proxy uses.

Friends
class	DtDisplayProxy
	Creator Class.
typedef std::map< std::string, DtChannelProxyWP >	ChannelProxies
	Members.
DtDe *	myDe
	Members.
std::string	myDisplayEngineName
	Members.
DtWindowConfiguration *	myConfiguration
	Members.
DtWindowProctor *	myProctorCache
	Members.
ChannelProxies	myChannelProxies
	Members.

Additional Inherited Members
Protected Attributes inherited from makVrv::DtProxy
bool	myValidFlag

Detailed Description

Acts a proxy for each remote window on the master display engine.

Member Typedef Documentation

typedef std::map<std::string,DtChannelProxyWP> makVrv::DtWindowProxy::ChannelProxies

protected

Members.

Constructor & Destructor Documentation

virtual makVrv::DtWindowProxy::~DtWindowProxy ( )

virtual

DTOR.

makVrv::DtWindowProxy::DtWindowProxy ( DtDe &  de, const std::string &  displayName, DtWindowConfiguration &    )

protected

CTOR.

Member Function Documentation

bool makVrv::DtWindowProxy::addChannel

(

const DtChannelConfiguration &

config

)

Operators, all behavior may not happen immediately.

Add a channel based upon the configuration.

Exceptions

DtCorruptedState

if proctor is invalid.

void makVrv::DtWindowProxy::destroyChannel

(

DtChannelProxySP

channel

)

Destroy a channel.

Exceptions

DtCorruptedState

if proctor is invalid.

bool makVrv::DtWindowProxy::modifyChannel	(	DtChannelProxySP	channel,
		const DtChannelConfiguration &	config
	)

Modifies a channel based upon the configuration.

Exceptions

DtCorruptedState

if proctor is invalid.

const DtWindowConfiguration& makVrv::DtWindowProxy::configuration

(

)

const

Accessors.

Get the window configuration.

DtChannelProxySP makVrv::DtWindowProxy::findChannel

(

const std::string &

channelName

)

Find a Display by name.

Exceptions

DtCorruptedState

if proctor is invalid.

DtChannelProxySP makVrv::DtWindowProxy::findChannelByIndex

(

int

index

)

Get the display by index.

Exceptions

DtCorruptedState

if proctor is invalid.

const std::string& makVrv::DtWindowProxy::displayName

(

)

const

Return the display engine name this window belongs to.

const std::string& makVrv::DtWindowProxy::windowName

(

)

const

Return the name of the window this proxy represents.

const unsigned int makVrv::DtWindowProxy::channelCount

(

)

const

Get a count of the channels in this window.

DtWindowProctor* makVrv::DtWindowProxy::proctor ( )

protected

Get the proctor this proxy uses.

Friends And Related Function Documentation

friend class DtDisplayProxy

friend

Creator Class.

Member Data Documentation

DtDe* makVrv::DtWindowProxy::myDe

protected

Members.

std::string makVrv::DtWindowProxy::myDisplayEngineName

protected

Members.

DtWindowConfiguration* makVrv::DtWindowProxy::myConfiguration

protected

Members.

DtWindowProctor* makVrv::DtWindowProxy::myProctorCache

protected

Members.

ChannelProxies makVrv::DtWindowProxy::myChannelProxies

protected

Members.

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvCore/DtWindowProxy.h