GL Studio C++ Runtime API
DistiAttributeFilePathClass Class Reference

#include <file_path_class.h>

Inheritance diagram for DistiAttributeFilePathClass:
DistiAttributeBase WeakReferenceableMixin WeakReferenceable DistiAttributeCWDRelativePath

Public Member Functions

 DistiAttributeFilePathClass (const FilePathClass &basePath, CallbackMethodCallerBase *callback, const AttributeName &name, FilePathClass *attribPtr, bool useEmptyTag=false)
 
 DistiAttributeFilePathClass (const FilePathClass &basePath, CallbackMethodCallerBase *callback, const AttributeName &name, FilePathClass initialValue, bool useEmptyTag=false)
 
virtual DistiAttributeBaseoperator= (const DistiAttributeBase &oldClass) 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 DistiAttributeBaseoperator= (const DistiAttributeBase &oldClass)
 
const AttributeNameName () const
 
AttributeNameName ()
 
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 >
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) override
 
void NotifyWeakReferenceDestroyed (WeakReference *ref) override
 
virtual void AddWeakReference (WeakReference *weakRef)=0
 
virtual void NotifyWeakReferenceDestroyed (WeakReference *weakReference)=0
 

Static Public Member Functions

static const char * GetEmptyTag ()
 

Protected Attributes

FilePathClass_attribPtr
 Pointer to the actual storage location.
 
FilePathClass _localStoragePath
 Only used by local storage constructor.
 
const FilePathClass_basePath
 Used for reading relative paths.
 
bool _useEmptyTag
 true to use _emptyTag when writing path with WriteValue() if path does not have a filename.
 
- Protected Attributes inherited from DistiAttributeBase
AttributeName _name
 
CallbackMethodCallerBase_callback
 
ScopedPtr< DistiAttributeObserverList > _observerList
 
bool _localStorage
 
- Protected Attributes inherited from WeakReferenceableMixin
DynamicArray< WeakReference * > * _weakRefs
 

Static Protected Attributes

static const char _emptyTag []
 Backing storage for the string used to represent empty paths.
 

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

Attribute for reading and writing FilePathClass objects as a clear string.

Constructor & Destructor Documentation

◆ DistiAttributeFilePathClass() [1/2]

DistiAttributeFilePathClass ( const FilePathClass basePath,
CallbackMethodCallerBase callback,
const AttributeName name,
FilePathClass attribPtr,
bool  useEmptyTag = false 
)
inline

This constructor has the storage external.

Parameters
basePath
callback
name
attribPtr
useEmptyTag[optional, defaults to false] true to use _emptyTag when writing path with WriteValue() if path does not have a filename

◆ DistiAttributeFilePathClass() [2/2]

DistiAttributeFilePathClass ( const FilePathClass basePath,
CallbackMethodCallerBase callback,
const AttributeName name,
FilePathClass  initialValue,
bool  useEmptyTag = false 
)
inline

Creates local storage, and will resize as needed.

Parameters
basePath
callback
name
initialValue
useEmptyTag[optional, defaults to false] true to use _emptyTag when writing path with WriteValue() if path does not have a filename

Member Function Documentation

◆ GetEmptyTag()

static const char * GetEmptyTag ( )
inlinestatic
Returns
The string value used to represent an empty path.

◆ operator=()

virtual DistiAttributeBase & operator= ( const DistiAttributeBase oldClass)
inlineoverridevirtual

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

Parameters
oldClassThe object to copy from.
Returns
The resulting object (this).

Reimplemented from DistiAttributeBase.

◆ ReadValue()

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

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
instrThe stream to read from.
Returns
The input stream in its current state.

Implements DistiAttributeBase.

Reimplemented in DistiAttributeCWDRelativePath.

◆ WriteValue()

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

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
outstrThe stream to write to.
Returns
The output stream in its current state.

Implements DistiAttributeBase.

Reimplemented in DistiAttributeCWDRelativePath.


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