eq::admin::Pipe Class Reference

Inheritance diagram for eq::admin::Pipe:

Collaboration diagram for eq::admin::Pipe:

Public Member Functions
EQADMIN_API	Pipe (Node *parent)
	Construct a new pipe. More...
virtual EQADMIN_API	~Pipe ()
	Destruct a pipe. More...
Data Access.
ServerPtr	getServer ()
ClientPtr	getClient ()
EQADMIN_API Config *	getConfig ()
const Config *	getConfig () const
co::CommandQueue *	getMainThreadQueue ()
Public Member Functions inherited from eq::fabric::Pipe< Node, Pipe, Window, PipeVisitor >
Node *	getNode ()
const Node *	getNode () const
const Windows &	getWindows () const
uint32_t	getPort () const
	Returns the port number of this pipe. More...
EQFABRIC_INL void	setPort (const uint32_t port)
uint32_t	getDevice () const
	Returns the device number of this pipe. More...
EQFABRIC_INL void	setDevice (const uint32_t device)
const PixelViewport &	getPixelViewport () const
EQFABRIC_INL void	setPixelViewport (const PixelViewport &pvp)
	Set the pipe's pixel viewport. More...
void	notifyPixelViewportChanged ()
EQFABRIC_INL PipePath	getPath () const
EQFABRIC_INL VisitorResult	accept (PipeVisitor &visitor)
	Perform a depth-first traversal of this pipe. More...
EQFABRIC_INL VisitorResult	accept (PipeVisitor &visitor) const
	Const-version of accept(). More...
virtual EQFABRIC_INL void	backup ()
virtual EQFABRIC_INL void	restore ()
void	create (Window **window)
void	release (Window *window)
virtual void	output (std::ostream &) const
virtual EQFABRIC_INL uint128_t	commit (const uint32_t incarnation=CO_COMMIT_NEXT)
EQFABRIC_INL void	setIAttribute (const IAttribute attr, const int32_t value)
int32_t	getIAttribute (const IAttribute attr) const
bool	isThreaded () const
Public Member Functions inherited from eq::fabric::Object
virtual EQFABRIC_API bool	isDirty () const
virtual EQFABRIC_API void	setName (const std::string &name)
	Set the name of the object. More...
EQFABRIC_API const std::string &	getName () const
EQFABRIC_API void	setUserData (co::Object *userData)
	Set user-specific data. More...
EQFABRIC_API co::Object *	getUserData ()
EQFABRIC_API const co::Object *	getUserData () const
EQFABRIC_API uint32_t	getTasks () const
	Return the set of tasks this channel might execute in the worst case. More...
EQFABRIC_API uint32_t	getSerial () const

Additional Inherited Members
Public Types inherited from eq::fabric::Pipe< Node, Pipe, Window, PipeVisitor >
typedef std::vector< Window * >	Windows
	A vector of pointers to windows. More...
enum	IAttribute
	Pipe attributes. More...
Public Types inherited from eq::fabric::Object
enum	DirtyBits {   DIRTY_NAME = Serializable::DIRTY_CUSTOM << 0, DIRTY_USERDATA = Serializable::DIRTY_CUSTOM << 1, DIRTY_TASKS = Serializable::DIRTY_CUSTOM << 2, DIRTY_REMOVED = Serializable::DIRTY_CUSTOM << 3,   DIRTY_SERIAL = Serializable::DIRTY_CUSTOM << 4, DIRTY_CUSTOM = Serializable::DIRTY_CUSTOM << 6, DIRTY_OBJECT_BITS = DIRTY_NAME | DIRTY_USERDATA }
	The changed parts of the object since the last pack(). More...
Static Public Member Functions inherited from eq::fabric::Pipe< Node, Pipe, Window, PipeVisitor >
static EQFABRIC_INL const std::string &	getIAttributeString (const IAttribute attr)
Protected Types inherited from eq::fabric::Pipe< Node, Pipe, Window, PipeVisitor >
enum	DirtyBits
Protected Member Functions inherited from eq::fabric::Pipe< Node, Pipe, Window, PipeVisitor >
	Pipe (Node *parent)
virtual void	attach (const uint128_t &id, const uint32_t instanceID)
virtual EQFABRIC_INL void	serialize (co::DataOStream &os, const uint64_t dirtyBits)
virtual EQFABRIC_INL void	deserialize (co::DataIStream &is, const uint64_t dirtyBits)
virtual EQFABRIC_INL void	notifyDetach ()
virtual EQFABRIC_INL void	setDirty (const uint64_t bits)
virtual ChangeType	getChangeType () const
Window *	_findWindow (const uint128_t &id)
virtual uint64_t	getRedistributableBits () const
Protected Member Functions inherited from eq::fabric::Object
EQFABRIC_API	Object ()
	Construct a new Object. More...
EQFABRIC_API	Object (const Object &)
	Construct an unmapped, unregistered copy of an object. More...
virtual EQFABRIC_API	~Object ()
	Destruct the object. More...
EQFABRIC_API Object &	operator= (const Object &from)
	NOP assignment operator. More...
virtual bool	hasMasterUserData ()
virtual uint32_t	getUserDataLatency () const
EQFABRIC_API void	setTasks (const uint32_t tasks)
EQFABRIC_API void	postRemove (Object *child)
virtual void	removeChild (const uint128_t &)
template<class C , class S >
void	commitChild (C *child, S *sender, uint32_t cmd, const uint32_t incarnation)
template<class C >
void	commitChild (C *child, const uint32_t incarnation)
template<class C , class S >
void	commitChildren (const std::vector< C * > &children, S *sender, uint32_t cmd, const uint32_t incarnation)
template<class C >
void	commitChildren (const std::vector< C * > &children, uint32_t cmd, const uint32_t incarnation)
template<class C >
void	commitChildren (const std::vector< C * > &children, const uint32_t incarnation)
template<class C >
void	syncChildren (const std::vector< C * > &children)
template<class P , class C >
void	releaseChildren (const std::vector< C * > &children)
EQFABRIC_API bool	_cmdSync (co::ICommand &command)

Detailed Description

Definition at line 28 of file admin/pipe.h.

Constructor & Destructor Documentation

EQADMIN_API eq::admin::Pipe::Pipe

(

Node *

parent

)

Construct a new pipe.

Version

1.0

virtual EQADMIN_API eq::admin::Pipe::~Pipe ( )

virtual

Destruct a pipe.

Version

1.0

Reimplemented from eq::fabric::Pipe< Node, Pipe, Window, PipeVisitor >.

Member Function Documentation

ClientPtr eq::admin::Pipe::getClient

(

)

Returns

the local client node

EQADMIN_API Config* eq::admin::Pipe::getConfig

(

)

Returns

the parent configuration

const Config* eq::admin::Pipe::getConfig

(

)

const

Returns

the parent configuration

ServerPtr eq::admin::Pipe::getServer

(

)

Returns

the server node

---

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

• admin/pipe.h