makVrv::DtWindowProxy Class Reference

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

Inheritance diagram for makVrv::DtWindowProxy:

Public Member Functions
virtual	~DtWindowProxy ()
bool	addChannel (const DtChannelConfiguration &config)
void	destroyChannel (DtChannelProxySP channel)
bool	modifyChannel (DtChannelProxySP channel, const DtChannelConfiguration &config)
const DtWindowConfiguration &	configuration () const
DtChannelProxySP	findChannel (const std::string &channelName)
DtChannelProxySP	findChannelByIndex (int index)
const std::string &	displayName () const
const std::string &	windowName () const
const unsigned int	channelCount () const
Public Member Functions inherited from makVrv::DtProxy
	DtProxy ()
virtual void	makeInvalid ()
bool	isValid () const
void	validate () const

Protected Member Functions
	DtWindowProxy (DtDe &de, const std::string &displayName, DtWindowConfiguration &)
DtWindowProctor *	proctor ()

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

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

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:

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrvCore/DtWindowProxy.h