| GL Studio C++ Runtime API

Public Member Functions | Protected Attributes | List of all members
DistiAttributeConnectionGlsAngularScaleDataArray Class Reference

`#include <gls_angular_scale.h>`

Inheritance diagram for DistiAttributeConnectionGlsAngularScaleDataArray:

## Public Member Functions
| DistiAttributeConnectionGlsAngularScaleDataArray (CallbackMethodCallerBase *callback, const AttributeName &name, GlsAngularScaleDataArray *attribPtr, int arraySize)
virtual bool | OkToWrite () const DISTI_METHOD_OVERRIDE
virtual std::ostream & | WriteValue (std::ostream &outstr) DISTI_METHOD_OVERRIDE
virtual std::istream & | ReadValue (std::istream &instr) DISTI_METHOD_OVERRIDE
std::string | Type () const DISTI_METHOD_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 std::string | Type () const
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

## Protected Attributes
GlsAngularScaleDataArray * | _attribPtr
| Observer of the underlying storage for the property.
unsigned int | _arraySize
| Always GLS_ANGULAR_SCALE_MAX.
Protected Attributes inherited from DistiAttributeBase
AttributeName | _name
CallbackMethodCallerBase * | _callback
ScopedPtr< DistiAttributeObserverList > | _observerList
bool | _localStorage
Protected Attributes inherited from WeakReferenceableMixin
DynamicArray< WeakReference * > * | _weakRefs

## 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 ()

## Detailed Description

Metadata for scale data

## Constructor & Destructor Documentation

## ◆ DistiAttributeConnectionGlsAngularScaleDataArray()

DistiAttributeConnectionGlsAngularScaleDataArray | ( | CallbackMethodCallerBase * | callback,
|  | const AttributeName & | name,
|  | GlsAngularScaleDataArray * | attribPtr,
|  | int | arraySize
| ) |  |
| inline

Constructor

Parameters

  callback | The callback method to call when this property changes.
  name | The name of this attribute.
  attribPtr | A pointer to the underlying storage for this property.
  arraySize | Always GLS_ANGULAR_SCALE_MAX.

## Member Function Documentation

## ◆ OkToWrite()

virtual bool OkToWrite | ( |  | ) | const
| virtual

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 writing "NAME: ", OkToWrite() can be called to see if it will have a valid value.

Returns
  True if this object is ready to have its WriteValue() called.

Reimplemented from DistiAttributeBase.

## ◆ ReadValue()

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.

Parameters

  instr | The stream to read from.

Returns
  The input stream in its current state.

Implements DistiAttributeBase.

## ◆ Type()

std::string Type | ( |  | ) | const
| virtual

This method isn't pure virtual to maintain backward compatibility with existing user code.

Returns
  The unmangled type name of the underlying storage.

Reimplemented from DistiAttributeBase.

## ◆ WriteValue()

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.

Parameters

  outstr | The stream to write to.

Returns
  The output stream in its current state.

Implements DistiAttributeBase.

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

- gls_angular_scale.h