DistiAttributeEncodedString Class Reference

#include <gls_metadata_attributes.h>

Inheritance diagram for DistiAttributeEncodedString:

Public Member Functions
	DistiAttributeEncodedString (CallbackMethodCallerBase *callback, const AttributeName &name, char **attribPtr)
	DistiAttributeEncodedString (CallbackMethodCallerBase *callback, const AttributeName &name, char *initialValue)
virtual std::string	ValueString () override
virtual void	ValueString (const std::string &s) override
virtual std::ostream &	WriteValue (std::ostream &outstr) override
virtual std::istream &	ReadValue (std::istream &instr) override
Public Member Functions inherited from DistiAttributeString
	DistiAttributeString (CallbackMethodCallerBase *callback, const AttributeName &name, char **attribPtr)
	DistiAttributeString (CallbackMethodCallerBase *callback, const AttributeName &name, char *initialValue)
char *	LocalStorageString ()
virtual bool	OkToWrite () const override
virtual std::ostream &	WriteValue (std::ostream &outstr) override
virtual std::istream &	ReadValue (std::istream &instr) override
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	OkToWrite () 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 ()
	Calls callback CallType3 if it has been set.
virtual std::ostream &	WriteValue (std::ostream &outstr)=0
virtual std::istream &	ReadValue (std::istream &instr)=0
virtual bool	operator== (const DistiAttributeBase &r)
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) override
void	NotifyWeakReferenceDestroyed (WeakReference *ref) override
virtual void	AddWeakReference (WeakReference *weakRef)=0
virtual void	NotifyWeakReferenceDestroyed (WeakReference *weakReference)=0

Additional Inherited Members
Public Types inherited from DistiAttributeBase
typedef unsigned int	CallbackID
	Type for unique identifiers.
Protected Member Functions inherited from WeakReferenceableMixin
	WeakReferenceableMixin ()
virtual	~WeakReferenceableMixin ()
Protected Attributes inherited from DistiAttributeString
char **	_attribPtr
	A pointer to the pointer containing the underlying storage for this attribute.
Protected Attributes inherited from DistiAttributeBase
AttributeName	_name
CallbackMethodCallerBase *	_callback
ScopedPtr< DistiAttributeObserverList >	_observerList
bool	_localStorage
Protected Attributes inherited from WeakReferenceableMixin
DynamicArray< WeakReference * > *	_weakRefs

Detailed Description

Derived from DistiAttributeString, the only difference is that it reads and writes encoded strings instead of clear strings.

Constructor & Destructor Documentation

DistiAttributeEncodedString() [1/2]

DistiAttributeEncodedString	(	CallbackMethodCallerBase *	callback,
		const AttributeName &	name,
		char **	attribPtr
	)

Constructor, uses existing storage.

Parameters

callback	The callback function pointer to call back.
name	The name of this new attribute.
attribPtr	A pointer to a pointer to existing storage for this attribute.

DistiAttributeEncodedString() [2/2]

DistiAttributeEncodedString	(	CallbackMethodCallerBase *	callback,
		const AttributeName &	name,
		char *	initialValue
	)

Constructor, creates local storage, and will resize as needed.

Parameters

callback	The callback function pointer to call back.
name	The name of this new attribute.
initialValue	The initial string value for this attribute.

Member Function Documentation

ReadValue()

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

overridevirtual

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.

Parameters

instr

The stream to read from.

Returns

The input stream in its current state.

Reimplemented from DistiAttributeString.

ValueString() [1/2]

virtual std::string ValueString ( )

overridevirtual

Here in the base class it uses WriteValue(). If this particular attribute's underlying type is a string, this returns the unencoded value, suitable for users. If a file encoded value is required, call WriteValue instead.

Returns

The std::string version of the attribute data.

Reimplemented from DistiAttributeBase.

ValueString() [2/2]

virtual void ValueString ( const std::string &  s )

overridevirtual

Sets the value from a std::string argument. Here in the base class it uses ReadValue(). If this particular attribute's underlying type is a string, this should not be set to an encoded value. If needing to set from an encoded value, call ReadValue instead.

Parameters

s	The string value to set.

Reimplemented from DistiAttributeBase.

WriteValue()

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

overridevirtual

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.

Parameters

outstr

The stream to write to.

Returns

The output stream in its current state.

Reimplemented from DistiAttributeString.

---

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

• gls_metadata_attributes.h