Simias::Storage::Property Class Reference

Represents a property name/value pair for a node. Properties have well-defined syntax types. More...

Collaboration diagram for Simias::Storage::Property:

List of all members.

Public Member Functions

Property (string name, Syntax syntax, string propertyValue)

Constructs a property object.

Property (Property property)

Constructs a property.

Property (string name, object propertyValue)

Constructs a property.

Property (string name, string propertyValue)

Constructs a property.

Property (string name, sbyte propertyValue)

Constructs a property.

Property (string name, byte propertyValue)

Constructs a property.

Property (string name, short propertyValue)

Constructs a property.

Property (string name, ushort propertyValue)

Constructs a property.

Property (string name, int propertyValue)

Constructs a property.

Property (string name, uint propertyValue)

Constructs a property.

Property (string name, long propertyValue)

Constructs a property.

Property (string name, ulong propertyValue)

Constructs a property.

Property (string name, char propertyValue)

Constructs a property.

Property (string name, float propertyValue)

Constructs a property.

Property (string name, bool propertyValue)

Constructs a property.

Property (string name, DateTime propertyValue)

Constructs a property.

Property (string name, Uri propertyValue)

Constructs a property.

Property (string name, XmlDocument propertyValue)

Constructs a property.

Property (string name, TimeSpan propertyValue)

Constructs a property.

Property (string name, Relationship relationship)

Constructs a property.

void DeleteProperty ()

Deletes this property from the property list.

void Delete ()

Deletes this property from the property list.

bool IsSystemProperty ()

Determines if the property is a system (non-editable) property.

void SetValue (Property propertyValue)

Sets the value of this property.

void SetValue (object propertyValue)

Sets the value of this property.

void SetValue (string propertyValue)

Sets a string value into the property.

void SetValue (sbyte propertyValue)

Sets an sbyte value into the property.

void SetValue (byte propertyValue)

Sets a byte value into the property.

void SetValue (short propertyValue)

Sets a short value into the property.

void SetValue (ushort propertyValue)

Sets a ushort value into the property.

void SetValue (int propertyValue)

Sets an int value into the property.

void SetValue (uint propertyValue)

Sets a uint value into the property.

void SetValue (long propertyValue)

Sets a long value into the property.

void SetValue (ulong propertyValue)

Sets a ulong value into the property.

void SetValue (char propertyValue)

Sets a char value into the property.

void SetValue (float propertyValue)

Sets a float value into the property.

void SetValue (bool propertyValue)

Sets a bool value into the property.

void SetValue (DateTime propertyValue)

Sets a DateTime value into the property.

void SetValue (Uri propertyValue)

Sets a Uri value into the property.

void SetValue (XmlDocument propertyValue)

Sets an Xml value into the property.

void SetValue (TimeSpan propertyValue)

Sets a TimeSpan value into the property.

void SetValue (Relationship propertyValue)

Sets a Relationship value into the property.

override string ToString ()

Converts the property value of this instance to its equivalent string.

string ToString (IFormatProvider ifProvider)

Converts the property value of this instance to its equivalent string using the specified culture-specific format information.

string ToString (string format)

Converts the property value of this instance to its equivalent string using the specified format.

string ToString (string format, IFormatProvider ifProvider)

Converts the numeric value of this instance to its equivalent string using the specified format and culture-specific format information.

Properties

string Name [get]

Gets the name of this property.

Syntax Type [get]

Gets and sets the syntax type of this property.

ushort Flags [get, set]

Gets and sets the flags for this property.

object Value [get, set]

Gets and sets the value of this property as an object.

bool IsAssociatedProperty [get]

Gets whether this property is associated with a node or if it is a new property object.

bool LocalProperty [get, set]

Gets and sets the transient status of a property. If this flag is false, this property will synchronize to other stores. If it is true, it is a property local to this store only. This flag is set to false by default.

bool ServerOnlyProperty [get, set]

Gets and sets the transient status of a property. If this flag is false, this property will synchronize to other slaves and client also. If it is true, it is a property local to server only flag is set to false by default.

bool MultiValuedProperty [get, set]

Gets and sets the multivalued status of a property.

Detailed Description

Represents a property name/value pair for a node. Properties have well-defined syntax types.

Constructor & Destructor Documentation

Simias::Storage::Property::Property	(	string	name,
		Syntax	syntax,
		string	propertyValue
	)			`[inline]`

Constructs a property object.

Parameters:

	name	Name of the property to construct.
	syntax	Syntax type of the value.
	propertyValue	Value of the property.

Simias::Storage::Property::Property ( Property property ) [inline]

Constructs a property.

Parameters:

property

PropertyTags.

Simias::Storage::Property::Property	(	string	name,
		object	propertyValue
	)			`[inline]`

Constructs a property.

Parameters:

	name	Name of the property.
	propertyValue	Object representation of the value.

Simias::Storage::Property::Property	(	string	name,
		string	propertyValue
	)			`[inline]`

Constructs a property.

Parameters:

	name	Name of the property.
	propertyValue	String value of the property.

Simias::Storage::Property::Property	(	string	name,
		sbyte	propertyValue
	)			`[inline]`

Constructs a property.

Parameters:

	name	Name of the property.
	propertyValue	Signed 8-bit value of the property.

Simias::Storage::Property::Property	(	string	name,
		byte	propertyValue
	)			`[inline]`

Constructs a property.

Parameters:

	name	Name of the property.
	propertyValue	Unsigned 8-bit value of the property.

Simias::Storage::Property::Property	(	string	name,
		short	propertyValue
	)			`[inline]`

Constructs a property.

Parameters:

	name	Name of the property.
	propertyValue	Signed 16-bit value of the property.

Simias::Storage::Property::Property	(	string	name,
		ushort	propertyValue
	)			`[inline]`

Constructs a property.

Parameters:

	name	Name of the property.
	propertyValue	Unsigned 16-bit value of the property.

Simias::Storage::Property::Property	(	string	name,
		int	propertyValue
	)			`[inline]`

Constructs a property.

Parameters:

	name	Name of the property.
	propertyValue	Signed 32-bit value of the property.

Simias::Storage::Property::Property	(	string	name,
		uint	propertyValue
	)			`[inline]`

Constructs a property.

Parameters:

	name	Name of the property.
	propertyValue	Unsigned 32-bit value of the property.

Simias::Storage::Property::Property	(	string	name,
		long	propertyValue
	)			`[inline]`

Constructs a property.

Parameters:

	name	Name of the property.
	propertyValue	Signed 64-bit value of the property.

Simias::Storage::Property::Property	(	string	name,
		ulong	propertyValue
	)			`[inline]`

Constructs a property.

Parameters:

	name	Name of the property.
	propertyValue	Unsigned 64-bit value of the property.

Simias::Storage::Property::Property	(	string	name,
		char	propertyValue
	)			`[inline]`

Constructs a property.

Parameters:

	name	Name of the property.
	propertyValue	Unicode character value of the property.

Simias::Storage::Property::Property	(	string	name,
		float	propertyValue
	)			`[inline]`

Constructs a property.

Parameters:

	name	Name of the property.
	propertyValue	Single precision 32-bit value of the property.

Simias::Storage::Property::Property	(	string	name,
		bool	propertyValue
	)			`[inline]`

Constructs a property.

Parameters:

	name	Name of the property.
	propertyValue	Boolean value of the property.

Simias::Storage::Property::Property	(	string	name,
		DateTime	propertyValue
	)			`[inline]`

Constructs a property.

Parameters:

	name	Name of the property.
	propertyValue	DateTime object of the property.

Simias::Storage::Property::Property	(	string	name,
		Uri	propertyValue
	)			`[inline]`

Constructs a property.

Parameters:

	name	Name of the property.
	propertyValue	Uri object of the property.

Simias::Storage::Property::Property	(	string	name,
		XmlDocument	propertyValue
	)			`[inline]`

Constructs a property.

Parameters:

	name	Name of the property.
	propertyValue	XmlDocument object of the property.

Simias::Storage::Property::Property	(	string	name,
		TimeSpan	propertyValue
	)			`[inline]`

Constructs a property.

Parameters:

	name	Name of the property.
	propertyValue	TimeSpan object of the property.

Simias::Storage::Property::Property	(	string	name,
		Relationship	relationship
	)			`[inline]`

Constructs a property.

Parameters:

	name	Name of the property.
	relationship	Relationship object.

Member Function Documentation

void Simias::Storage::Property::DeleteProperty ( ) [inline]

Deletes this property from the property list.

void Simias::Storage::Property::Delete ( ) [inline]

Deletes this property from the property list.

bool Simias::Storage::Property::IsSystemProperty ( ) [inline]

Determines if the property is a system (non-editable) property.

Returns:: True if propertyName specifies a system property, otherwise false is returned.

void Simias::Storage::Property::SetValue ( Property propertyValue ) [inline]

Sets the value of this property.

Parameters:

propertyValue

Property value to set.

void Simias::Storage::Property::SetValue ( object propertyValue ) [inline]

Sets the value of this property.

Parameters:

propertyValue

Property value to set.

void Simias::Storage::Property::SetValue ( string propertyValue ) [inline]

Sets a string value into the property.

Parameters:

propertyValue

string value to set in property.

void Simias::Storage::Property::SetValue ( sbyte propertyValue ) [inline]

Sets an sbyte value into the property.

Parameters:

propertyValue

sbyte value to set in property.

void Simias::Storage::Property::SetValue ( byte propertyValue ) [inline]

Sets a byte value into the property.

Parameters:

propertyValue

byte value to set in property.

void Simias::Storage::Property::SetValue ( short propertyValue ) [inline]

Sets a short value into the property.

Parameters:

propertyValue

short value to set in property.

void Simias::Storage::Property::SetValue ( ushort propertyValue ) [inline]

Sets a ushort value into the property.

Parameters:

propertyValue

ushort value to set in property.

void Simias::Storage::Property::SetValue ( int propertyValue ) [inline]

Sets an int value into the property.

Parameters:

propertyValue

int value to set in property.

void Simias::Storage::Property::SetValue ( uint propertyValue ) [inline]

Sets a uint value into the property.

Parameters:

propertyValue

uint value to set in property.

void Simias::Storage::Property::SetValue ( long propertyValue ) [inline]

Sets a long value into the property.

Parameters:

propertyValue

long value to set in property.

void Simias::Storage::Property::SetValue ( ulong propertyValue ) [inline]

Sets a ulong value into the property.

Parameters:

propertyValue

ulong value to set in property.

void Simias::Storage::Property::SetValue ( char propertyValue ) [inline]

Sets a char value into the property.

Parameters:

propertyValue

char value to set in property.

void Simias::Storage::Property::SetValue ( float propertyValue ) [inline]

Sets a float value into the property.

Parameters:

propertyValue

float value to set in property.

void Simias::Storage::Property::SetValue ( bool propertyValue ) [inline]

Sets a bool value into the property.

Parameters:

propertyValue

bool value to set in property.

void Simias::Storage::Property::SetValue ( DateTime propertyValue ) [inline]

Sets a DateTime value into the property.

Parameters:

propertyValue

DateTime value to set in property.

void Simias::Storage::Property::SetValue ( Uri propertyValue ) [inline]

Sets a Uri value into the property.

Parameters:

propertyValue

Uri value to set in property.

void Simias::Storage::Property::SetValue ( XmlDocument propertyValue ) [inline]

Sets an Xml value into the property.

Parameters:

propertyValue

Xml value to set in property.

void Simias::Storage::Property::SetValue ( TimeSpan propertyValue ) [inline]

Sets a TimeSpan value into the property.

Parameters:

propertyValue

TimeSpan value to set in property.

void Simias::Storage::Property::SetValue ( Relationship propertyValue ) [inline]

Sets a Relationship value into the property.

Parameters:

propertyValue

Relationship value to set in property.

override string Simias::Storage::Property::ToString ( ) [inline]

Converts the property value of this instance to its equivalent string.

Returns:: A string representing the value of this object.

string Simias::Storage::Property::ToString ( IFormatProvider ifProvider ) [inline]

Converts the property value of this instance to its equivalent string using the specified culture-specific format information.

Parameters:

ifProvider

An IFormatProvider that supplies culture-specific formatting information.

Returns:: A string representing the value of this object.

string Simias::Storage::Property::ToString ( string format ) [inline]

Converts the property value of this instance to its equivalent string using the specified format.

Parameters:

format

A string that specifies the return format.

Returns:: A string representing the value of this object.

string Simias::Storage::Property::ToString	(	string	format,
		IFormatProvider	ifProvider
	)			`[inline]`

Converts the numeric value of this instance to its equivalent string using the specified format and culture-specific format information.

Parameters:

	format	A string that specifies the return format.
	ifProvider	An IFormatProvider that supplies culture-specific formatting information.

Returns:: A string representing the value of this object.

Property Documentation

string Simias::Storage::Property::Name [get]

Gets the name of this property.

Syntax Simias::Storage::Property::Type [get]

Gets and sets the syntax type of this property.

ushort Simias::Storage::Property::Flags [get, set]

Gets and sets the flags for this property.

object Simias::Storage::Property::Value [get, set]

Gets and sets the value of this property as an object.

bool Simias::Storage::Property::IsAssociatedProperty [get]

Gets whether this property is associated with a node or if it is a new property object.

bool Simias::Storage::Property::LocalProperty [get, set]

Gets and sets the transient status of a property. If this flag is false, this property will synchronize to other stores. If it is true, it is a property local to this store only. This flag is set to false by default.

bool Simias::Storage::Property::ServerOnlyProperty [get, set]

Gets and sets the transient status of a property. If this flag is false, this property will synchronize to other slaves and client also. If it is true, it is a property local to server only flag is set to false by default.

bool Simias::Storage::Property::MultiValuedProperty [get, set]

Gets and sets the multivalued status of a property.

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

src/core/CollectionStore/Property.cs


Public Member Functions
	Property (string name, Syntax syntax, string propertyValue)
	Constructs a property object.
	Property (Property property)
	Constructs a property.
	Property (string name, object propertyValue)
	Constructs a property.
	Property (string name, string propertyValue)
	Constructs a property.
	Property (string name, sbyte propertyValue)
	Constructs a property.
	Property (string name, byte propertyValue)
	Constructs a property.
	Property (string name, short propertyValue)
	Constructs a property.
	Property (string name, ushort propertyValue)
	Constructs a property.
	Property (string name, int propertyValue)
	Constructs a property.
	Property (string name, uint propertyValue)
	Constructs a property.
	Property (string name, long propertyValue)
	Constructs a property.
	Property (string name, ulong propertyValue)
	Constructs a property.
	Property (string name, char propertyValue)
	Constructs a property.
	Property (string name, float propertyValue)
	Constructs a property.
	Property (string name, bool propertyValue)
	Constructs a property.
	Property (string name, DateTime propertyValue)
	Constructs a property.
	Property (string name, Uri propertyValue)
	Constructs a property.
	Property (string name, XmlDocument propertyValue)
	Constructs a property.
	Property (string name, TimeSpan propertyValue)
	Constructs a property.
	Property (string name, Relationship relationship)
	Constructs a property.
void	DeleteProperty ()
	Deletes this property from the property list.
void	Delete ()
	Deletes this property from the property list.
bool	IsSystemProperty ()
	Determines if the property is a system (non-editable) property.
void	SetValue (Property propertyValue)
	Sets the value of this property.
void	SetValue (object propertyValue)
	Sets the value of this property.
void	SetValue (string propertyValue)
	Sets a string value into the property.
void	SetValue (sbyte propertyValue)
	Sets an sbyte value into the property.
void	SetValue (byte propertyValue)
	Sets a byte value into the property.
void	SetValue (short propertyValue)
	Sets a short value into the property.
void	SetValue (ushort propertyValue)
	Sets a ushort value into the property.
void	SetValue (int propertyValue)
	Sets an int value into the property.
void	SetValue (uint propertyValue)
	Sets a uint value into the property.
void	SetValue (long propertyValue)
	Sets a long value into the property.
void	SetValue (ulong propertyValue)
	Sets a ulong value into the property.
void	SetValue (char propertyValue)
	Sets a char value into the property.
void	SetValue (float propertyValue)
	Sets a float value into the property.
void	SetValue (bool propertyValue)
	Sets a bool value into the property.
void	SetValue (DateTime propertyValue)
	Sets a DateTime value into the property.
void	SetValue (Uri propertyValue)
	Sets a Uri value into the property.
void	SetValue (XmlDocument propertyValue)
	Sets an Xml value into the property.
void	SetValue (TimeSpan propertyValue)
	Sets a TimeSpan value into the property.
void	SetValue (Relationship propertyValue)
	Sets a Relationship value into the property.
override string	ToString ()
	Converts the property value of this instance to its equivalent string.
string	ToString (IFormatProvider ifProvider)
	Converts the property value of this instance to its equivalent string using the specified culture-specific format information.
string	ToString (string format)
	Converts the property value of this instance to its equivalent string using the specified format.
string	ToString (string format, IFormatProvider ifProvider)
	Converts the numeric value of this instance to its equivalent string using the specified format and culture-specific format information.
Properties
string	Name `[get]`
	Gets the name of this property.
Syntax	Type `[get]`
	Gets and sets the syntax type of this property.
ushort	Flags `[get, set]`
	Gets and sets the flags for this property.
object	Value `[get, set]`
	Gets and sets the value of this property as an object.
bool	IsAssociatedProperty `[get]`
	Gets whether this property is associated with a node or if it is a new property object.
bool	LocalProperty `[get, set]`
	Gets and sets the transient status of a property. If this flag is false, this property will synchronize to other stores. If it is true, it is a property local to this store only. This flag is set to false by default.
bool	ServerOnlyProperty `[get, set]`
	Gets and sets the transient status of a property. If this flag is false, this property will synchronize to other slaves and client also. If it is true, it is a property local to server only flag is set to false by default.
bool	MultiValuedProperty `[get, set]`
	Gets and sets the multivalued status of a property.