GL Studio C++ Runtime API
Public Member Functions | List of all members
DistiAttributeUCharOrBool Class Reference

#include <gls_metadata_attributes.h>

Inheritance diagram for DistiAttributeUCharOrBool:
DistiAttribute< unsigned char > DistiAttributeBase WeakReferenceableMixin WeakReferenceable

Public Member Functions

virtual DistiAttributeBase & operator= (const DistiAttributeBase &oldClass)
 
virtual long ValueInt ()
 
virtual void ValueInt (long val)
 
virtual std::ostream & WriteValue (std::ostream &outstr)
 
virtual std::istream & ReadValue (std::istream &instr)
 
- Public Member Functions inherited from DistiAttribute< unsigned char >
 DistiAttribute (CallbackMethodCallerBase *callback, const AttributeName &name, unsigned char *attribPtr)
 
 DistiAttribute (CallbackMethodCallerBase *callback, const AttributeName &name, const unsigned char &initialValue)
 
bool Copyable () const override
 
long ValueInt () override
 
void ValueInt (long val) override
 
double ValueFloat () override
 
void ValueFloat (double val) override
 
DistiAttributeBase & operator= (const DistiAttributeBase &oldClass) override
 
std::ostream & WriteValue (std::ostream &outstr) override
 
std::istream & ReadValue (std::istream &instr) override
 
virtual unsigned char Value ()
 
virtual void Value (const unsigned char &val)
 
bool operator== (const DistiAttributeBase &rArg) override
 
 ~DistiAttribute () override
 
- Public Member Functions inherited from DistiAttributeBase
 DistiAttributeBase (CallbackMethodCallerBase *callback, const AttributeName &name, bool localStorage)
 
const AttributeName & Name () const
 
AttributeName & Name ()
 
bool LocalStorage () const
 
virtual bool OkToWrite () const
 
virtual bool ValueChanged ()
 
virtual void ResetValueChanged ()
 
virtual std::string ValueString ()
 
virtual void ValueString (const std::string &s)
 
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) override
 
void NotifyWeakReferenceDestroyed (WeakReference *ref) override
 

Additional Inherited Members

- Public Types inherited from DistiAttributeBase
typedef unsigned int CallbackID
 Type for unique identifiers.
 
- Protected Member Functions inherited from WeakReferenceableMixin
 WeakReferenceableMixin (void)
 
virtual ~WeakReferenceableMixin ()
 
- Protected Attributes inherited from DistiAttribute< unsigned char >
unsigned char * _attribPtr
 
int _precision
 
- Protected Attributes inherited from DistiAttributeBase
AttributeName _name
 
CallbackMethodCallerBase * _callback
 
ScopedPtr< DistiAttributeObserverList > _observerList
 
bool _localStorage
 
- Protected Attributes inherited from WeakReferenceableMixin
DynamicArray< WeakReference * > * _weakRefs
 

Detailed Description

Special case for transitioning from a bool to an int Reads True or False, or integers. Writes only integers.

Member Function Documentation

virtual DistiAttributeBase& operator= ( const DistiAttributeBase &  oldClass)
virtual

This will perform the copy using ReadValue() and WriteValue() It can be overridden by any dervied classes to do a smarter more efficent copy.

Reimplemented from DistiAttributeBase.

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

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 long ValueInt ( )
virtual

Allows for faster access to integer types than the more generic stream operators. However, it is only faster if it is overridden.

Reimplemented from DistiAttributeBase.

virtual void ValueInt ( long  val)
virtual

Allows for faster access to integer types than the more generic stream operator. However, it is only faster if it is overridden.

Reimplemented from DistiAttributeBase.

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

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: