VOS::RemoteProperty Class Reference

#include <remoteproperty.hh>

Inheritance diagram for VOS::RemoteProperty:

List of all members.

Detailed Description

Definition at line 33 of file remoteproperty.hh.

Public Member Functions

virtual int getLength ()
Get length (bytes) of decoded data.
virtual void read (std::string &target)
Read decoded data into target, possibly performing decode if necesary.
virtual void read (std::string &target, int start, int length)
Read a substring of decoded data into target, possibly performing decode if necesary.
virtual std::string read ()
Return decoded data, possibly performing decode if necesary.
virtual std::string read (int start, int length)
Return substring of decoded data, possibly performing decode if necesary.
virtual void write (int start, const std::string &newdata)
Write newdata into property value, starting at byte position start.
virtual void replace (const std::string &newdata, const std::string &newtype="?")
Completely change the value and type of data stored in this property.
virtual const std::string getDataType ()
Return type of decoded data (usually a MIME type).
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.
virtual void enableAsyncReplace (bool b)
Asynchronous replace means calls to "replace" will be assumed successful and immediately committed locally, without waiting for response from the remote site.
virtual const std::string getVOSType ()
Return MetaObject type, "property".

Static Public Member Functions

static MetaObject * new_RemoteProperty (VobjectBase *superobject, const std::string &type)

Protected Member Functions

RemoteProperty (VobjectBase *superobject)

Constructor & Destructor Documentation

VOS::RemoteProperty::RemoteProperty ( VobjectBase * superobject ) [protected]

Member Function Documentation

virtual void VOS::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.
	refresh	If given, determines whether the new property listener will be immediately notified of the current property value (before this method returns).

Implements VOS::Property.

virtual void VOS::RemoteProperty::enableAsyncReplace ( bool b ) [virtual]

Asynchronous replace means calls to "replace" will be assumed successful and immediately committed locally, without waiting for response from the remote site.

virtual const std::string VOS::RemoteProperty::getDataType ( ) [virtual]

Return type of decoded data (usually a MIME type).

Implements VOS::Property.

virtual int VOS::RemoteProperty::getLength ( ) [virtual]

Get length (bytes) of decoded data.

Implements VOS::Property.

virtual const std::string VOS::RemoteProperty::getVOSType ( ) [virtual]

Return MetaObject type, "property".

Implements VOS::Property.

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

virtual std::string VOS::RemoteProperty::read	(	int	start,
		int	length
	)			`[virtual]`

Return substring of decoded data, possibly performing decode if necesary.

See also:: read(std::string, int int)

Implements VOS::Property.

virtual std::string VOS::RemoteProperty::read ( ) [virtual]

Return decoded data, possibly performing decode if necesary.

See also:: read(std::string, int int)

Implements VOS::Property.

virtual void VOS::RemoteProperty::read	(	std::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.

Implements VOS::Property.

virtual void VOS::RemoteProperty::read ( std::string & target ) [virtual]

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

See also:: read(std::string, int, int)

Implements VOS::Property.

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

Remove the property listener 'pl' from this property.

Parameters:

Listener to remove. If it is also a RefCounted object, references will be released correctly.

Implements VOS::Property.

virtual void VOS::RemoteProperty::replace	(	const std::string &	newdata,
		const std::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.

Implements VOS::Property.

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

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

Implements VOS::Property.

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

/home/tetron/hack/vos/libs/vos/vos/remoteproperty.hh

[Home]	[About]
[Screenshots]	[Download]
[News]	[Community]
[Documentation]	[Manual]
[Bugs & Requests]	[Wiki]