GL Studio API
Public Member Functions | List of all members
DistiAttributeEncodedStdString Class Reference

#include <gls_metadata_attributes.h>

Inheritance diagram for DistiAttributeEncodedStdString:
DistiAttribute< std::string > DistiAttributeBase WeakReferenceableMixin WeakReferenceable

Public Member Functions

virtual bool OkToWrite () const
 
virtual std::string ValueString ()
 
virtual void ValueString (const std::string &s)
 
virtual std::ostream & WriteValue (std::ostream &outstr)
 
virtual std::istream & ReadValue (std::istream &instr)
 
- Public Member Functions inherited from DistiAttribute< std::string >
 DistiAttribute (CallbackMethodCallerBase *callback, const AttributeName &name, std::string *attribPtr)
 
 DistiAttribute (CallbackMethodCallerBase *callback, const AttributeName &name, const std::string &initialValue)
 
virtual bool Copyable () const
 
virtual long ValueInt ()
 
virtual void ValueInt (long val)
 
virtual double ValueFloat ()
 
virtual void ValueFloat (double val)
 
virtual DistiAttributeBaseoperator= (const DistiAttributeBase &oldClass)
 
virtual std::string Value ()
 
virtual void Value (const std::string &val)
 
virtual bool operator== (const DistiAttributeBase &rArg)
 
virtual ~DistiAttribute ()
 
- Public Member Functions inherited from DistiAttributeBase
 DistiAttributeBase (CallbackMethodCallerBase *callback, const AttributeName &name, bool localStorage)
 
const AttributeNameName () const
 
AttributeNameName ()
 
bool LocalStorage () const
 
virtual bool ValueChanged ()
 
virtual void ResetValueChanged ()
 
virtual void CallCallback ()
 
template<class valType >
DistiAttributeBaseoperator<< (const valType &val)
 
template<class valType >
DistiAttributeBaseoperator>> (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 DistiAttribute< std::string >
std::string * _attribPtr
 
int _precision
 
- Protected Attributes inherited from WeakReferenceableMixin
DynamicArray< WeakReference * > * _weakRefs
 

Detailed Description

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

Member Function Documentation

virtual bool OkToWrite ( ) const
virtual

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 std::istream& ReadValue ( std::istream &  instr)
virtual

Reads the data from the stream The ReadValue call shall consume only what it needs. It is the responsibility of the calling function to read to the end of line, or to clean up from a bad read. The calling function will also ensure that the data starts as the next byte in the stream.

Reimplemented from DistiAttribute< std::string >.

virtual std::string ValueString ( )
virtual

Returns the std::string version of the attribute data. Here in the base class it uses WriteValue()

Reimplemented from DistiAttributeBase.

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

Sets the value from a std::string argument. Here in the base class it uses ReadValue()

Reimplemented from DistiAttributeBase.

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

Writes the data to the stream

Reimplemented from DistiAttribute< std::string >.


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