ParCompMark::Context Class Reference

#include <PCMContext.h>

Collaboration diagram for ParCompMark::Context:

Detailed Description

Class containing PC context information.

Definition at line 65 of file PCMContext.h.


Public Types
typedef Pointer< Context, DummyLock >	Pointer
	Type for pointer on this class.
	MASTER = 0
	Master context.
	SLAVE = 1
	Slave context.
enum	ContextType { MASTER = 0, SLAVE = 1 }
	The control type of PC context (local, global). More...
Public Member Functions
Constructors & destructor
	Context ()
	Default constructor for Squirrel compatibility.
	Context (Process *parent)
	Create Context.
virtual	~Context ()
	The destructor.
Getters & setters
const int &	getID () const
	Getter of mID.
void	setID (const int &id)
	Setter of mID.
bool &	getUseGLFrameletEXT ()
	Getter of mUseGLFrameletEXT.
void	setUseGLFrameletEXT (const bool useglframeletext)
	Setter of mUseGLFrameletEXT.
Context::ContextType &	getContextType ()
	Getter of mContextType.
void	setContextType (const Context::ContextType &contexttype)
	Setter of mContextType.
PCid &	getFrameID ()
	Getter of mFrameID.
PCint &	getFrameWidth ()
	Getter of mFrameWidth.
void	setFrameWidth (const PCint framewidth)
	Setter of mFrameWidth.
PCint &	getFrameHeight ()
	Getter of mFrameHeight.
void	setFrameHeight (const PCint frameheight)
	Setter of mFrameHeight.
PCint &	getColourFormat ()
	Getter of mColourFormat.
void	setColourFormat (const PCint colourformat)
	Setter of mColourFormat.
PCint &	getDepthFormat ()
	Getter of mDepthFormat.
void	setDepthFormat (const PCint depthformat)
	Setter of mDepthFormat.
const PCint &	getPixelFormat () const
	Getter of mPixelFormat.
PCint &	getCompositeType ()
	Getter of mCompositeType.
void	setCompositeType (const PCint compositetype)
	Setter of mCompositeType.
PCint &	getCompressionHint ()
	Getter of mCompressionHint.
void	setCompressionHint (const PCint compressionhint)
	Setter of mCompressionHint.
PCint &	getRetainOutputCount ()
	Getter of mRetainOutputCount.
void	setRetainOutputCount (const PCint retainoutputcount)
	Setter of mRetainOutputCount.
PCint &	getVolatileFrameletCount ()
	Getter of mVolatileFrameletCount.
void	setVolatileFrameletCount (const PCint volatileframeletcount)
	Setter of mVolatileFrameletCount.
bool &	getOutputDepth ()
	Getter of mOutputDepth.
void	setOutputDepth (const bool outputdepth)
	Setter of mOutputDepth.
PCstring *	getProcesses () const
	Getter of mProcesses.
const PCint &	getProcessCount () const
	Getter of mProcessCount.
int &	getProcessIndex ()
	Getter of mProcessIndex.
void	setProcessIndex (const int processindex)
	Setter of mProcessIndex.
const PCint &	getHostIndex () const
	Getter of mHostIndex.
PCint &	getNetworkID ()
	Getter of mNetworkID.
void	setNetworkID (const PCint networkid)
	Setter of mNetworkID.
const PCcontext &	getContext () const
	Getter of mContext.
Process *	getParent ()
	Getter of mParent.
const bool &	getInitialized () const
	Getter of mInitialized.
Methods
virtual void	setProcesses (const char *processList)
	Create process array from string separated by semicolons.
virtual void	initialize ()
	Init the PC context.
virtual void	finalize ()
	Finalize the PC context.
virtual void	setContextTypeSq (const int contextType)
	Alternate squirrel setter of mContextType.
virtual int	getContextTypeSq ()
	Alternate squirrel setter of mContextType.
Static Public Member Functions
Scripting binding
static void	squirrelGlue ()
	Static glue code method for Squirrel-C++ binding.
Protected Attributes
Variables
int	mID
	ID for sorting contexts.
bool	mUseGLFrameletEXT
	Use OpenGL framelet PC library extension.
ContextType	mContextType
	Type of the context.
PCid	mFrameID
	The current frame id.
PCint	mFrameWidth
	Width of rendered frame by the context.
PCint	mFrameHeight
	Height of rendered frame by the context.
PCint	mColourFormat
	Colour format of rendered frame by the context.
PCint	mDepthFormat
	Depth format of rendered frame by the context.
PCint	mPixelFormat
	The pixel format.
PCint	mCompositeType
	Type of composition.
PCint	mCompressionHint
	Compression hint.
PCint	mRetainOutputCount
	The output of a frame is available between a pcFrameEnd and the following "mRetainOutput"th pcFrameBegin.
PCint	mVolatileFrameletCount
	How many frames in the future the application will resuse the buffer.
bool	mOutputDepth
	Needs depth information of the composition.
PCstring *	mProcesses
	Processes in the context.
PCint	mProcessCount
	Number of processes (PC nomenclature nodes) in this context.
int	mProcessIndex
	Position of the parent process in mProcesses array.
PCint	mHostIndex
	The own host index.
PCint	mNetworkID
	The network ID.
PCcontext	mContext
	The PC context.
Process *	mParent
	Parent Process of this Context.
bool	mInitialized
	The context is initialized.

Member Typedef Documentation

typedef Pointer< Context, DummyLock > ParCompMark::Context::Pointer

Type for pointer on this class.

Definition at line 153 of file PCMContext.h.

Member Enumeration Documentation

enum ParCompMark::Context::ContextType

The control type of PC context (local, global).

Enumerator:

MASTER	Master context.
SLAVE	Slave context.

Definition at line 135 of file PCMContext.h.

Constructor & Destructor Documentation

ParCompMark::Context::Context ( )

Default constructor for Squirrel compatibility.

Calling this constructor always raises an exception.

Definition at line 46 of file PCMContext.cpp.

References Except.

ParCompMark::Context::Context ( Process * parent )

Create Context.

Normally Process calls this constructor.

Parameters:

[in] parent Parent host

Definition at line 77 of file PCMContext.cpp.

References Assert, ParCompMark::Singleton< T >::getInstance(), ParCompMark::Name::getName(), mColourFormat, mCompositeType, mCompressionHint, mContext, mContextType, mDepthFormat, mFrameHeight, mFrameID, mFrameWidth, mHostIndex, mInitialized, mNetworkID, mOutputDepth, mParent, mPixelFormat, mProcessCount, mProcesses, mRetainOutputCount, mUseGLFrameletEXT, mVolatileFrameletCount, ParCompMark::Logger::NOTICE, and SLAVE.

Here is the call graph for this function:

ParCompMark::Context::~Context ( ) [virtual]

The destructor.

This class has virtual destructor.

Definition at line 133 of file PCMContext.cpp.

References finalize(), ParCompMark::Singleton< T >::getInstance(), ParCompMark::Name::getName(), mInitialized, mParent, mProcessCount, mProcesses, and ParCompMark::Logger::NOTICE.

Here is the call graph for this function:

Member Function Documentation

void ParCompMark::Context::finalize ( ) [virtual]

Finalize the PC context.

Definition at line 323 of file PCMContext.cpp.

References Assert, ParCompMark::Logger::DEBUG, Except, ParCompMark::Singleton< T >::getInstance(), ParCompMark::Name::getName(), mContext, mInitialized, and mParent.

Referenced by ~Context().

Here is the call graph for this function:

PCint & ParCompMark::Context::getColourFormat ( ) [inline]

Getter of mColourFormat.

Returns value of mColourFormat.

Returns:: The value of mColourFormat

Definition at line 764 of file PCMContext.h.

Referenced by squirrelGlue().

PCint & ParCompMark::Context::getCompositeType ( ) [inline]

Getter of mCompositeType.

Returns value of mCompositeType.

Returns:: The value of mCompositeType

Definition at line 801 of file PCMContext.h.

Referenced by squirrelGlue().

PCint & ParCompMark::Context::getCompressionHint ( ) [inline]

Getter of mCompressionHint.

Returns value of mCompressionHint.

Returns:: The value of mCompressionHint

Definition at line 815 of file PCMContext.h.

Referenced by squirrelGlue().

const PCcontext & ParCompMark::Context::getContext ( ) const [inline]

Getter of mContext.

Returns value of mContext.

Returns:: The value of mContext

Definition at line 920 of file PCMContext.h.

Context::ContextType & ParCompMark::Context::getContextType ( ) [inline]

Getter of mContextType.

Returns value of mContextType.

Returns:: The value of mContextType

Definition at line 715 of file PCMContext.h.

Referenced by squirrelGlue().

int ParCompMark::Context::getContextTypeSq ( ) [inline, virtual]

Alternate squirrel setter of mContextType.

Returns:: Context type int value (0 means MASTER, 1 means SLAVE).

Definition at line 952 of file PCMContext.h.

Referenced by squirrelGlue().

PCint & ParCompMark::Context::getDepthFormat ( ) [inline]

Getter of mDepthFormat.

Returns value of mDepthFormat.

Returns:: The value of mDepthFormat

Definition at line 779 of file PCMContext.h.

Referenced by squirrelGlue().

PCint & ParCompMark::Context::getFrameHeight ( ) [inline]

Getter of mFrameHeight.

Returns value of mFrameHeight.

Returns:: The value of mFrameHeight

Definition at line 750 of file PCMContext.h.

Referenced by squirrelGlue().

PCid & ParCompMark::Context::getFrameID ( ) [inline]

Getter of mFrameID.

Returns value of mFrameID.

Returns:: The value of mFrameID

Definition at line 729 of file PCMContext.h.

PCint & ParCompMark::Context::getFrameWidth ( ) [inline]

Getter of mFrameWidth.

Returns value of mFrameWidth.

Returns:: The value of mFrameWidth

Definition at line 736 of file PCMContext.h.

Referenced by squirrelGlue().

const PCint & ParCompMark::Context::getHostIndex ( ) const [inline]

Getter of mHostIndex.

Returns value of mHostIndex.

Returns:: The value of mHostIndex

Definition at line 899 of file PCMContext.h.

const int & ParCompMark::Context::getID ( ) const [inline]

Getter of mID.

Returns value of mID.

Returns:: The value of mID

Definition at line 687 of file PCMContext.h.

const bool & ParCompMark::Context::getInitialized ( ) const [inline]

Getter of mInitialized.

Returns value of mInitialized.

Returns:: The value of mInitialized

Definition at line 934 of file PCMContext.h.

PCint & ParCompMark::Context::getNetworkID ( ) [inline]

Getter of mNetworkID.

Returns value of mNetworkID.

Returns:: The value of mNetworkID

Definition at line 906 of file PCMContext.h.

Referenced by squirrelGlue().

bool & ParCompMark::Context::getOutputDepth ( ) [inline]

Getter of mOutputDepth.

Returns value of mOutputDepth.

Returns:: The value of mOutputDepth

Definition at line 857 of file PCMContext.h.

Referenced by squirrelGlue().

Process * ParCompMark::Context::getParent ( ) [inline]

Getter of mParent.

Returns value of mParent.

Returns:: The value of mParent

Definition at line 927 of file PCMContext.h.

const PCint & ParCompMark::Context::getPixelFormat ( ) const [inline]

Getter of mPixelFormat.

Returns value of mPixelFormat.

Returns:: The value of mPixelFormat

Definition at line 794 of file PCMContext.h.

const PCint & ParCompMark::Context::getProcessCount ( ) const [inline]

Getter of mProcessCount.

Returns value of mProcessCount.

Returns:: The value of mProcessCount

Definition at line 878 of file PCMContext.h.

PCstring * ParCompMark::Context::getProcesses ( ) const [inline]

Getter of mProcesses.

Returns value of mProcesses.

Returns:: The value of mProcesses

Definition at line 871 of file PCMContext.h.

int & ParCompMark::Context::getProcessIndex ( ) [inline]

Getter of mProcessIndex.

Returns value of mProcessIndex.

Returns:: The value of mProcessIndex

Definition at line 885 of file PCMContext.h.

Referenced by squirrelGlue().

PCint & ParCompMark::Context::getRetainOutputCount ( ) [inline]

Getter of mRetainOutputCount.

Returns value of mRetainOutputCount.

Returns:: The value of mRetainOutputCount

Definition at line 829 of file PCMContext.h.

Referenced by squirrelGlue().

bool & ParCompMark::Context::getUseGLFrameletEXT ( ) [inline]

Getter of mUseGLFrameletEXT.

Returns value of mUseGLFrameletEXT.

Returns:: The value of mUseGLFrameletEXT

Definition at line 701 of file PCMContext.h.

Referenced by squirrelGlue().

PCint & ParCompMark::Context::getVolatileFrameletCount ( ) [inline]

Getter of mVolatileFrameletCount.

Returns value of mVolatileFrameletCount.

Returns:: The value of mVolatileFrameletCount

Definition at line 843 of file PCMContext.h.

Referenced by squirrelGlue().

void ParCompMark::Context::initialize ( ) [virtual]

Init the PC context.

Definition at line 192 of file PCMContext.cpp.

References Assert, Except, ParCompMark::Singleton< T >::getInstance(), ParCompMark::Name::getName(), ParCompMark::Process::getStartTime(), ParCompMark::Timer::getSystemTime(), MASTER, mColourFormat, mCompositeType, mCompressionHint, mContext, mContextType, mFrameHeight, mFrameWidth, mHostIndex, mInitialized, mNetworkID, mOutputDepth, mParent, mPixelFormat, mProcessCount, mProcesses, mProcessIndex, mRetainOutputCount, mUseGLFrameletEXT, mVolatileFrameletCount, ParCompMark::Logger::NOTICE, ParCompMark::Process::setStartTime(), SLAVE, and ParCompMark::StringConverter::toString().

Here is the call graph for this function:

void ParCompMark::Context::setColourFormat ( const PCint colourformat ) [inline]

Setter of mColourFormat.

Sets value of mColourFormat.

Parameters:

[in] colourformat The value of mColourFormat

Definition at line 771 of file PCMContext.h.

Referenced by squirrelGlue().

void ParCompMark::Context::setCompositeType ( const PCint compositetype ) [inline]

Setter of mCompositeType.

Sets value of mCompositeType.

Parameters:

[in] compositetype The value of mCompositeType

Definition at line 808 of file PCMContext.h.

Referenced by squirrelGlue().

void ParCompMark::Context::setCompressionHint ( const PCint compressionhint ) [inline]

Setter of mCompressionHint.

Sets value of mCompressionHint.

Parameters:

[in] compressionhint The value of mCompressionHint

Definition at line 822 of file PCMContext.h.

Referenced by squirrelGlue().

void ParCompMark::Context::setContextType ( const Context::ContextType & contexttype ) [inline]

Setter of mContextType.

Sets value of mContextType.

Parameters:

[in] contexttype The value of mContextType

Definition at line 722 of file PCMContext.h.

Referenced by squirrelGlue().

void ParCompMark::Context::setContextTypeSq ( const int contextType ) [inline, virtual]

Alternate squirrel setter of mContextType.

Parameters:

[in] contextType Context type int value (0 means MASTER, 1 means SLAVE).

Definition at line 945 of file PCMContext.h.

Referenced by squirrelGlue().

void ParCompMark::Context::setDepthFormat ( const PCint depthformat ) [inline]

Setter of mDepthFormat.

Sets value of mDepthFormat.

Parameters:

[in] depthformat The value of mDepthFormat

Definition at line 786 of file PCMContext.h.

Referenced by squirrelGlue().

void ParCompMark::Context::setFrameHeight ( const PCint frameheight ) [inline]

Setter of mFrameHeight.

Sets value of mFrameHeight.

Parameters:

[in] frameheight The value of mFrameHeight

Definition at line 757 of file PCMContext.h.

Referenced by squirrelGlue().

void ParCompMark::Context::setFrameWidth ( const PCint framewidth ) [inline]

Setter of mFrameWidth.

Sets value of mFrameWidth.

Parameters:

[in] framewidth The value of mFrameWidth

Definition at line 743 of file PCMContext.h.

Referenced by squirrelGlue().

void ParCompMark::Context::setID ( const int & id ) [inline]

Setter of mID.

Sets value of mID.

Parameters:

[in] id The value of mID

Definition at line 694 of file PCMContext.h.

void ParCompMark::Context::setNetworkID ( const PCint networkid ) [inline]

Setter of mNetworkID.

Sets value of mNetworkID.

Parameters:

[in] networkid The value of mNetworkID

Definition at line 913 of file PCMContext.h.

Referenced by squirrelGlue().

void ParCompMark::Context::setOutputDepth ( const bool outputdepth ) [inline]

Setter of mOutputDepth.

Sets value of mOutputDepth.

Parameters:

[in] outputdepth The value of mOutputDepth

Definition at line 864 of file PCMContext.h.

Referenced by squirrelGlue().

void ParCompMark::Context::setProcesses ( const char * processList ) [virtual]

Create process array from string separated by semicolons.

Parameters:

[in] processList Process list separated by semicolons (C string for squirrel compatibility).

Definition at line 161 of file PCMContext.cpp.

References mProcessCount, and mProcesses.

Referenced by squirrelGlue().

void ParCompMark::Context::setProcessIndex ( const int processindex ) [inline]

Setter of mProcessIndex.

Sets value of mProcessIndex.

Parameters:

[in] processindex The value of mProcessIndex

Definition at line 892 of file PCMContext.h.

Referenced by squirrelGlue().

void ParCompMark::Context::setRetainOutputCount ( const PCint retainoutputcount ) [inline]

Setter of mRetainOutputCount.

Sets value of mRetainOutputCount.

Parameters:

[in] retainoutputcount The value of mRetainOutputCount

Definition at line 836 of file PCMContext.h.

Referenced by squirrelGlue().

void ParCompMark::Context::setUseGLFrameletEXT ( const bool useglframeletext ) [inline]

Setter of mUseGLFrameletEXT.

Sets value of mUseGLFrameletEXT.

Parameters:

[in] useglframeletext The value of mUseGLFrameletEXT

Definition at line 708 of file PCMContext.h.

Referenced by squirrelGlue().

void ParCompMark::Context::setVolatileFrameletCount ( const PCint volatileframeletcount ) [inline]

Setter of mVolatileFrameletCount.

Sets value of mVolatileFrameletCount.

Parameters:

[in] volatileframeletcount The value of mVolatileFrameletCount

Definition at line 850 of file PCMContext.h.

Referenced by squirrelGlue().

static void ParCompMark::Context::squirrelGlue ( ) [inline, static]

Static glue code method for Squirrel-C++ binding.

This method should be call from each Squirrel virtual machines to generate the proper Squirrel glue code. To content of this method is fully autogenerated in the header implementation file, you should not modify it.

Definition at line 89 of file PCMContext.h.

References getColourFormat(), getCompositeType(), getCompressionHint(), getContextType(), getContextTypeSq(), getDepthFormat(), getFrameHeight(), getFrameWidth(), getNetworkID(), getOutputDepth(), getProcessIndex(), getRetainOutputCount(), getUseGLFrameletEXT(), getVolatileFrameletCount(), MASTER, setColourFormat(), setCompositeType(), setCompressionHint(), setContextType(), setContextTypeSq(), setDepthFormat(), setFrameHeight(), setFrameWidth(), setNetworkID(), setOutputDepth(), setProcesses(), setProcessIndex(), setRetainOutputCount(), setUseGLFrameletEXT(), setVolatileFrameletCount(), and SLAVE.