DistiAttributeVertexArray< Vertex > Class Template Reference

#include <gls_metadata_attributes.h>

Inheritance diagram for DistiAttributeVertexArray< Vertex >:

Public Member Functions
virtual bool	OkToWrite () const
virtual std::ostream &	WriteValue (std::ostream &outstr)
virtual std::istream &	ReadValue (std::istream &instr)
virtual bool	operator== (const DistiAttributeBase &rArg)
Public Member Functions inherited from DistiAttributeBase
	DistiAttributeBase (CallbackMethodCallerBase *callback, const AttributeName &name, bool localStorage)
virtual DistiAttributeBase &	operator= (const DistiAttributeBase &oldClass)
const AttributeName &	Name () const
AttributeName &	Name ()
bool	LocalStorage () const
virtual bool	Copyable () const
virtual bool	ValueChanged ()
virtual void	ResetValueChanged ()
virtual std::string	ValueString ()
virtual void	ValueString (const std::string &s)
virtual long	ValueInt ()
virtual void	ValueInt (long val)
virtual double	ValueFloat ()
virtual void	ValueFloat (double val)
virtual void	CallCallback ()
template<class valType >
DistiAttributeBase &	operator<< (const valType &val)
template<class valType >
DistiAttributeBase &	operator>> (valType &val)
virtual CallbackID	RegisterObserver (AttributeObserver *observer)
virtual void	UnregisterObserver (CallbackID id)
virtual void	NotifyObservers ()
Public Member Functions inherited from WeakReferenceableMixin
void	AddWeakReference (WeakReference *weakRef)
void	NotifyWeakReferenceDestroyed (WeakReference *ref)

Additional Inherited Members
Public Types inherited from DistiAttributeBase
typedef unsigned int	CallbackID
	Type for unique identifiers.
Public Attributes inherited from DistiAttributeBase
AttributeName	_name
CallbackMethodCallerBase *	_callback
bool	_localStorage
Protected Member Functions inherited from WeakReferenceableMixin
	WeakReferenceableMixin (void)
virtual	~WeakReferenceableMixin ()
Protected Attributes inherited from WeakReferenceableMixin
DynamicArray< WeakReference * > *	_weakRefs

Detailed Description

template<>
class disti::DistiAttributeVertexArray< Vertex >

An attribute for either a Vector or Vertex

Member Function Documentation

virtual bool OkToWrite ( ) const

inlinevirtual

Returns true if this object is ready to have its WriteValue() called This SHOULD be overriden by any derived objects that may not be ready to write at any point. The reason for this is the data is often written "NAME: VALUE". If Value is not available, we don't want to write "NAME: " first, so before writting "NAME: ", OkToWrite() can be called to see if it will have a valid value

Reimplemented from DistiAttributeBase.

virtual bool operator== ( const DistiAttributeBase &  r )

inlinevirtual

Compares name and value This can be overriden to improve speed.

Reimplemented from DistiAttributeBase.

virtual std::istream& ReadValue ( std::istream &  instr )

inlinevirtual

Pure virtual because this is specific to the data type to be contained. This should be overridden to read the data from the stream. The value read could be encoded for being read from a file as a single string, or have its own special encoding specific to its underlying type. In the case of attribute strings, this will be the GLS file encoded value. The user is responsible for encoding the value themselves, or using WriteValue which should perform encoding to maintain symmetry.

Implements DistiAttributeBase.

virtual std::ostream& WriteValue ( std::ostream &  outstr )

inlinevirtual

Pure virtual because this is specific to the data type to be contained. This should be overridden to write the data to the stream. The value written could be encoded for writing to a file as a single string, or have its own special encoding specific to its underlying type. In the case of attribute strings, this will be the GLS file encoded value. The user is responsible for decoding the value themselves, or using ReadValue which should perform decoding to maintain symmetry.

Implements DistiAttributeBase.

---

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

• gls_metadata_attributes.h