Inheritance diagram for eq::admin::Config:

Collaboration diagram for eq::admin::Config:

Public Types
typedef fabric::Config< Server, Config, Observer, Layout, Canvas, Node, ConfigVisitor >	Super

Public Types inherited from eq::fabric::Config< Server, Config, Observer, Layout, Canvas, Node, ConfigVisitor >
typedef std::vector< Observer * >	Observers
	A vector of observers.

typedef std::vector< Layout * >	Layouts
	A vector of layouts.

typedef std::vector< Canvas * >	Canvases
	A vector of canvases.

typedef std::vector< Node * >	Nodes
	A vector of nodes.

enum	FAttribute
	Floating-point attributes.

enum	IAttribute
	Integer 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...

Public Member Functions
EQADMIN_API	Config (ServerPtr parent)
	Construct a new config. More...

virtual EQADMIN_API	~Config ()
	Destruct a config. More...

EQADMIN_API ClientPtr	getClient ()

EQADMIN_API ConstClientPtr	getClient () const

EQADMIN_API co::CommandQueue *	getMainThreadQueue ()

virtual EQADMIN_API uint128_t	commit (const uint32_t incarnation=CO_COMMIT_NEXT)
	Commit all changes on this config and its children. More...

const Channel *	findChannel (const std::string &name) const

void	output (std::ostream &) const

virtual bool	mapViewObjects () const

virtual bool	mapNodeObjects () const

Public Member Functions inherited from eq::fabric::Config< Server, Config, Observer, Layout, Canvas, Node, ConfigVisitor >
void	create (Observer **observer)

void	create (Layout **layout)

void	create (Canvas **canvas)

void	create (Node **node)

void	release (Observer *observer)

void	release (Layout *layout)

void	release (Canvas *canvas)

void	release (Node *node)

EQFABRIC_INL lunchbox::RefPtr < Server >	getServer ()

EQFABRIC_INL lunchbox::RefPtr < const Server >	getServer () const

const Observers &	getObservers () const

const Layouts &	getLayouts () const

const Canvases &	getCanvases () const

EQFABRIC_INL uint32_t	getTimeout () const

const Nodes &	getNodes () const

EQFABRIC_INL Node *	findAppNode ()

EQFABRIC_INL const Node *	findAppNode () const

EQFABRIC_INL VisitorResult	accept (ConfigVisitor &visitor)
	Perform a depth-first traversal of this config. More...

EQFABRIC_INL VisitorResult	accept (ConfigVisitor &visitor) const
	Const-version of accept(). More...

EQFABRIC_INL T *	find (const uint128_t &id)

EQFABRIC_INL const T *	find (const uint128_t &id) const

EQFABRIC_INL T *	find (const std::string &name)

EQFABRIC_INL const T *	find (const std::string &name) const

void	find (const uint128_t &id, T **result)

void	find (const std::string &name, const T **result) const

Observer *	getObserver (const ObserverPath &path)

Layout *	getLayout (const LayoutPath &path)

Canvas *	getCanvas (const CanvasPath &path)

virtual void	updateCanvas (Canvas *)

virtual void	exitCanvas (Canvas *)

virtual void	setLatency (const uint32_t latency)
	Set the maximum accepted latency for this config. More...

uint32_t	getLatency () const

virtual EQFABRIC_INL void	restore ()

void	setFAttribute (const FAttribute attr, const float value)

void	setIAttribute (const IAttribute attr, const int32_t value)

float	getFAttribute (const FAttribute attr) const

int32_t	getIAttribute (const IAttribute attr) const

Public Member Functions inherited from eq::fabric::Object
virtual EQFABRIC_API bool	isDirty () const

virtual EQFABRIC_API void	backup ()

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
Static Public Member Functions inherited from eq::fabric::Config< Server, Config, Observer, Layout, Canvas, Node, ConfigVisitor >
static const std::string &	getFAttributeString (const FAttribute attr)

static const std::string &	getIAttributeString (const IAttribute attr)

Protected Member Functions inherited from eq::fabric::Config< Server, Config, Observer, Layout, Canvas, Node, ConfigVisitor >
EQFABRIC_INL	Config (lunchbox::RefPtr< Server > parent)

virtual EQFABRIC_INL 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 void	_removeChild (const uint128_t &)

void	setAppNodeID (const co::NodeID &nodeID)

const co::NodeID &	getAppNodeID () const

EQFABRIC_INL EventOCommand	sendError (co::NodePtr node, const uint32_t event, const uint128_t &originator, const uint32_t error)

virtual void	changeLatency (const uint32_t)

virtual VisitorResult	_acceptCompounds (ConfigVisitor &)

virtual VisitorResult	_acceptCompounds (ConfigVisitor &) const

Node *	_findNode (const uint128_t &id)

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/config.h.

Constructor & Destructor Documentation

EQADMIN_API eq::admin::Config::Config ( ServerPtr parent )

Construct a new config.

Version: 1.0

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

virtual

Destruct a config.

Version: 1.0

Reimplemented from eq::fabric::Config< Server, Config, Observer, Layout, Canvas, Node, ConfigVisitor >.

Member Function Documentation

virtual EQADMIN_API uint128_t eq::admin::Config::commit ( const uint32_t incarnation = CO_COMMIT_NEXT )

virtual

Commit all changes on this config and its children.

Version: 1.0

Reimplemented from eq::fabric::Config< Server, Config, Observer, Layout, Canvas, Node, ConfigVisitor >.

EQADMIN_API ClientPtr eq::admin::Config::getClient ( )

Returns: the local client node.

Version: 1.0

EQADMIN_API ConstClientPtr eq::admin::Config::getClient ( ) const

Returns: the local client node.

Version: 1.0

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

admin/config.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation