FDO API Reference Feature Data Objects
Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members

FdoPropertyValue Class Reference

#include <PropertyValue.h>

Inherits FdoIDisposable.

Inheritance diagram for FdoPropertyValue:

[legend]
List of all members.

Detailed Description

The FdoPropertyValue class represents a property name/value pair. Instances of this class are used to specify or hold onto a reference to a property name and the properties value.

Definition at line 36 of file PropertyValue.h.


Public Member Functions

FDO_API FdoIdentifierGetName ()
 Gets the property name as an identifier.
FDO_API FdoIStreamReaderGetStreamReader ()
 Gets the value of the property as an Stream Reader.
FDO_API FdoValueExpressionGetValue ()
 Gets the value of the property as an FdoValueExpression.
FDO_API void SetName (FdoString *value)
 Sets the property name as a string.
FDO_API void SetName (FdoIdentifier *value)
 Sets the property name as an identifier.
FDO_API void SetStreamReader (FdoIStreamReader *stream)
 Provides a Reader on a external data source to allow reading in blocks of data.
FDO_API void SetValue (FdoString *value)
 Sets the value of the property as a string. The string content will be parsed to produce the required FdoValueExpression.
FDO_API void SetValue (FdoValueExpression *value)
 Sets the value of the property as an FdoValueExpression.

Static Public Member Functions

FDO_API FdoPropertyValueCreate (FdoString *name, FdoValueExpression *value)
 Constructs an instance of an FdoPropertyValue using the specified arguments.
FDO_API FdoPropertyValueCreate (FdoIdentifier *name, FdoValueExpression *value)
 Constructs an instance of an FdoPropertyValue using the specified arguments.
FDO_API FdoPropertyValueCreate ()
 Constructs a default instance of an FdoPropertyValue.

Protected Member Functions

virtual void Dispose ()
 Dispose this object.
 FdoPropertyValue (FdoString *name, FdoValueExpression *value=NULL)
 Constructs an instance of an FdoPropertyValue using the specified arguments.
 FdoPropertyValue (FdoIdentifier *name, FdoValueExpression *value=NULL)
 Constructs an instance of an FdoPropertyValue using the specified arguments.
 FdoPropertyValue ()
 Constructs a default instance of an FdoPropertyValue.
virtual ~FdoPropertyValue ()

Constructor & Destructor Documentation

FdoPropertyValue::FdoPropertyValue  )  [protected]
 

Constructs a default instance of an FdoPropertyValue.

FdoPropertyValue::FdoPropertyValue FdoIdentifier name,
FdoValueExpression value = NULL
[protected]
 

Constructs an instance of an FdoPropertyValue using the specified arguments.

FdoPropertyValue::FdoPropertyValue FdoString name,
FdoValueExpression value = NULL
[protected]
 

Constructs an instance of an FdoPropertyValue using the specified arguments.

virtual FdoPropertyValue::~FdoPropertyValue  )  [protected, virtual]
 


Member Function Documentation

FDO_API FdoPropertyValue* FdoPropertyValue::Create FdoString name,
FdoValueExpression value
[static]
 

Constructs an instance of an FdoPropertyValue using the specified arguments.

Parameters:
name Input property name as a string
value Input value of property
Returns:
Returns FdoPropertyValue

FDO_API FdoPropertyValue* FdoPropertyValue::Create FdoIdentifier name,
FdoValueExpression value
[static]
 

Constructs an instance of an FdoPropertyValue using the specified arguments.

Parameters:
name Input property name as identifier
value Input value of property
Returns:
Returns FdoPropertyValue

FDO_API FdoPropertyValue* FdoPropertyValue::Create  )  [static]
 

Constructs a default instance of an FdoPropertyValue.

Returns:
Returns FdoPropertyValue

virtual void FdoPropertyValue::Dispose  )  [protected, virtual]
 

Dispose this object.

Returns:
Returns nothing

Implements FdoIDisposable.

FDO_API FdoIdentifier* FdoPropertyValue::GetName  ) 
 

Gets the property name as an identifier.

Returns:
Returns identifier

FDO_API FdoIStreamReader* FdoPropertyValue::GetStreamReader  ) 
 

Gets the value of the property as an Stream Reader.

Returns:
Returns FdoIStreamReader

FDO_API FdoValueExpression* FdoPropertyValue::GetValue  ) 
 

Gets the value of the property as an FdoValueExpression.

Returns:
Returns FdoValueExpression

FDO_API void FdoPropertyValue::SetName FdoString value  ) 
 

Sets the property name as a string.

Parameters:
value Input string
Returns:
Returns nothing

FDO_API void FdoPropertyValue::SetName FdoIdentifier value  ) 
 

Sets the property name as an identifier.

Parameters:
value Input identifier
Returns:
Returns nothing

FDO_API void FdoPropertyValue::SetStreamReader FdoIStreamReader stream  ) 
 

Provides a Reader on a external data source to allow reading in blocks of data.

Parameters:
stream Input reference to a stream reader
Returns:
Returns nothing

FDO_API void FdoPropertyValue::SetValue FdoString value  ) 
 

Sets the value of the property as a string. The string content will be parsed to produce the required FdoValueExpression.

Parameters:
value Input value
Returns:
Returns nothing

FDO_API void FdoPropertyValue::SetValue FdoValueExpression value  ) 
 

Sets the value of the property as an FdoValueExpression.

Parameters:
value Input value
Returns:
Returns nothing

The documentation for this class was generated from the following file:
Comments or suggestions? Send us feedback.