RemoteProperty Class Reference

Remote version of property; sends messages over network to Local object. More...

#include <vos/metaobjects/property/property.hh>

Inheritance diagram for RemoteProperty:

List of all members.

Public Member Functions

• RemoteProperty (MetaObject *superobject)
• virtual void read (string &target, int start, int length)

  Read a substring of decoded data into target, possibly performing decode if necesary.
  
  

• virtual void readRaw (string &target, int start, int length)

  Read substring of raw data into target.
  
  

• virtual void asyncRead ()

  Download property and call notifyPropertyReplaced when done.
  
  

• virtual void asyncRead (int start, int length)

  Download property and call notifyPropertyWrite when done.
  
  

• virtual int getLength ()

  Get length (bytes) of decoded data.
  
  

• virtual int getRawLength ()

  Get length (bytes) of undecoded, raw data.
  
  

• virtual const string getRawDataType ()

  Return type of raw, undeocded data (a typechain string).
  
  

• virtual void write (int start, const string &newdata)

  Write newdata into property value, starting at byte position start.
  
  

• virtual void clearCache ()
• virtual void replace (const string &newdata, const string &newtype="?")

  Completely change the value and type of data stored in this property.
  
  

• virtual void addPropertyListener (PropertyListener *pl, bool refresh=true)

  Add a new property listener to this property.
  
  

• virtual void removePropertyListener (PropertyListener *pl)

  Remove the property listener 'pl' from this property.
  
  

Static Public Member Functions

• MetaObject * new_RemoteProperty (MetaObject *superobject, const string &type)

Protected Member Functions

• virtual void checkDecoded ()

  Decodes data if need be.
  
  

Protected Attributes

• int offset
• bool first_read

---

Detailed Description

Remote version of property; sends messages over network to Local object.

Definition at line 549 of file property.hh.

---

Constructor & Destructor Documentation

RemoteProperty::RemoteProperty (  MetaObject *  superobject  )

Definition at line 33 of file remoteproperty.cc. Referenced by new_RemoteProperty().

---

Member Function Documentation

void RemoteProperty::addPropertyListener (  PropertyListener *  pl, bool  refresh = true )  [virtual]

Add a new property listener to this property. This listener's methods will be called when the property is modified. See also: PropertyListener Parameters: pl  The new property listener. If it is also a RefCounted object, references will be acquired correctly. Reimplemented from Property. Definition at line 281 of file remoteproperty.cc.

void RemoteProperty::asyncRead (  int  start, int  length )  [virtual]

Download property and call notifyPropertyWrite when done. Reimplemented from Property. Definition at line 144 of file remoteproperty.cc.

void RemoteProperty::asyncRead (   )  [virtual]

Download property and call notifyPropertyReplaced when done. Reimplemented from Property. Definition at line 118 of file remoteproperty.cc.

void RemoteProperty::checkDecoded (   )  [protected, virtual]

Decodes data if need be. Reimplemented from Property. Definition at line 46 of file remoteproperty.cc.

void RemoteProperty::clearCache (   )  [virtual]

Definition at line 340 of file remoteproperty.cc.

int RemoteProperty::getLength (   )  [virtual]

Get length (bytes) of decoded data. Reimplemented from Property. Reimplemented in ExtrapolatedRemoteProperty. Definition at line 71 of file remoteproperty.cc. Referenced by BufferedRemoteProperty::replace().

const string RemoteProperty::getRawDataType (   )  [virtual]

Return type of raw, undeocded data (a typechain string). Reimplemented from Property. Definition at line 78 of file remoteproperty.cc. Referenced by addPropertyListener(), asyncRead(), BufferedRemoteProperty::flush(), and replace().

int RemoteProperty::getRawLength (   )  [virtual]

Get length (bytes) of undecoded, raw data. Reimplemented from Property. Reimplemented in ExtrapolatedRemoteProperty. Definition at line 55 of file remoteproperty.cc. Referenced by addPropertyListener(), BufferedRemoteProperty::flush(), and ExtrapolatedRemoteProperty::getRawLength().

MetaObject * RemoteProperty::new_RemoteProperty (  MetaObject *  superobject, const string &  type )  [static]

Definition at line 276 of file remoteproperty.cc. Referenced by Property::registerExtenders().

void RemoteProperty::read (  string &  target, int  start, int  length )  [virtual]

Read a substring of decoded data into target, possibly performing decode if necesary. Parameters: target  Place data in this string start  Byte offset to start reading length  Number of bytes to read. If this parameter is -1, read until the end of the data. Reimplemented from Property. Reimplemented in ExtrapolatedRemoteProperty. Definition at line 88 of file remoteproperty.cc.

void RemoteProperty::readRaw (  string &  target, int  start, int  length )  [virtual]

Read substring of raw data into target. This is the fundamental method which the other read() methods are based on, so you only have to override this. Parameters: target  The data is copied into this string. start  Offset (bytes) from which to start reading. length  Number of bytes to read. If this is -1, read until the end of the data. Reimplemented from Property. Reimplemented in ExtrapolatedRemoteProperty. Definition at line 95 of file remoteproperty.cc.

void RemoteProperty::removePropertyListener (  PropertyListener *  pl  )  [virtual]

Remove the property listener 'pl' from this property. Parameters: pl  Listener to remove. If it is also a RefCounted object, references will be released correctly. Reimplemented from Property. Definition at line 323 of file remoteproperty.cc.

void RemoteProperty::replace (  const string &  newdata, const string &  newtype = "?" )  [virtual]

Completely change the value and type of data stored in this property. Parameters: newdata  New data. newtype  The type of the new datatype. If no type identifier was supplied, the previous one is kept. NOTE: the initial datatype (set by the constructor) is "?" which is (or should be) an invalid value for any application. Reimplemented from Property. Reimplemented in BufferedRemoteProperty. Definition at line 188 of file remoteproperty.cc.

void RemoteProperty::write (  int  start, const string &  newdata )  [virtual]

Write newdata into property value, starting at byte position start. Reimplemented from Property. Reimplemented in BufferedRemoteProperty. Definition at line 175 of file remoteproperty.cc.

---

Member Data Documentation

bool RemoteProperty::first_read [protected]

Definition at line 560 of file property.hh. Referenced by checkDecoded().

int RemoteProperty::offset [protected]

Definition at line 558 of file property.hh. Referenced by clearCache().

---

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

• vos/metaobjects/property/property.hh
• vos/metaobjects/property/remoteproperty.cc

---