API Reference OSGeo FDO Provider for WMS
Main Page | Alphabetical List | Class List | File List | Class Members | File Members

FdoWmsOvRasterDefinition Class Reference

#include <FdoWmsOvRasterDefinition.h>

List of all members.


Detailed Description

The FdoWmsOvRasterDefinition class defines the physical overrides for a raster property in a WMS FDO schema.

Definition at line 31 of file FdoWmsOvRasterDefinition.h.


Public Member Functions

FDOWMS_API void _writeXml (FdoXmlWriter *xmlWriter, const FdoXmlFlags *flags)
FDOWMS_API FdoString * GetBackgroundColor (void) const
 Gets the background color.
FDOWMS_API FdoString * GetElevationDimension (void) const
 Gets the elevation dimension of the requested WMS map.
FDOWMS_API FdoString * GetImageFormat (void)
 Gets the format type in which the WMS image will be generated.
FDOWMS_API FdoWmsOvLayerCollectionGetLayers (void) const
 Gets the WMS layers that will be used to construct the composite WMS image.
virtual FDOWMS_API FdoStringP GetQualifiedName ()
 Gets the fully qualified name of this element.
FDOWMS_API FdoString * GetSpatialContextName (void) const
 Gets the spatial context in which the requested WMS map will be returned.
FDOWMS_API FdoString * GetTimeDimension (void) const
 Gets the time dimension of the requested WMS map.
FDOWMS_API FdoBoolean GetTransparent (void) const
 Gets the transparency state.
FDOWMS_API FdoBoolean GetUseTileCache (void) const
 Gets the tile caching option value.
virtual FDOWMS_API void InitFromXml (FdoXmlSaxContext *pContext, FdoXmlAttributeCollection *attrs)
 DOXYGEN-IGNORE XML Serialization functions, not part of supported API.
FDOWMS_API void SetBackgroundColor (FdoString *bgColor)
 Sets the background color.
FDOWMS_API void SetElevationDimension (FdoString *dimension)
 Sets the time dimension of the requested WMS map.
FDOWMS_API void SetImageFormat (FdoString *value)
 Sets the format type in which the WMS image will be generated.
FDOWMS_API void SetSpatialContextName (FdoString *value)
 Sets the spatial context in which the requested WMS map will be returned.
FDOWMS_API void SetTimeDimension (FdoString *time)
 Sets the time dimension of the requested WMS map.
FDOWMS_API void SetTransparent (FdoBoolean transparent)
 Sets the transparency state.
FDOWMS_API void SetUseTileCache (FdoBoolean value)
 Sets the tile caching option value.
virtual FDOWMS_API FdoBoolean XmlEndElement (FdoXmlSaxContext *context, FdoString *uri, FdoString *name, FdoString *qname)
virtual FDOWMS_API FdoXmlSaxHandler * XmlStartElement (FdoXmlSaxContext *context, FdoString *uri, FdoString *name, FdoString *qname, FdoXmlAttributeCollection *atts)

Static Public Member Functions

FDOWMS_API FdoWmsOvRasterDefinitionCreate ()
 Constructs a new Raster Definition.

Protected Member Functions

FdoStringP _GetFormatAbbr () const
FdoStringP _GetTransparent (void) const
FdoStringP _GetUseTileCache (void) const
void _SetFormatAbbr (FdoString *value)
void _SetFullFormatType (FdoString *value)
void _SetTransparent (FdoString *value)
void _SetUseTileCache (FdoString *value)
FdoStringP AbbrToMIMEFormatType (FdoString *abbrFormat)
void Dispose (void)
FDOWMS_API FdoWmsOvRasterDefinition (void)
FdoStringP MIMEFormatTypeToAbbr (FdoString *fullFormat)
virtual FDOWMS_API ~FdoWmsOvRasterDefinition (void)

Friends

class FdoWmsOvClassDefinition

Constructor & Destructor Documentation

FDOWMS_API FdoWmsOvRasterDefinition::FdoWmsOvRasterDefinition void   )  [protected]
 

virtual FDOWMS_API FdoWmsOvRasterDefinition::~FdoWmsOvRasterDefinition void   )  [protected, virtual]
 


Member Function Documentation

FdoStringP FdoWmsOvRasterDefinition::_GetFormatAbbr  )  const [protected]
 

FdoStringP FdoWmsOvRasterDefinition::_GetTransparent void   )  const [protected]
 

FdoStringP FdoWmsOvRasterDefinition::_GetUseTileCache void   )  const [protected]
 

void FdoWmsOvRasterDefinition::_SetFormatAbbr FdoString *  value  )  [protected]
 

void FdoWmsOvRasterDefinition::_SetFullFormatType FdoString *  value  )  [protected]
 

void FdoWmsOvRasterDefinition::_SetTransparent FdoString *  value  )  [protected]
 

void FdoWmsOvRasterDefinition::_SetUseTileCache FdoString *  value  )  [protected]
 

FDOWMS_API void FdoWmsOvRasterDefinition::_writeXml FdoXmlWriter *  xmlWriter,
const FdoXmlFlags *  flags
 

FdoStringP FdoWmsOvRasterDefinition::AbbrToMIMEFormatType FdoString *  abbrFormat  )  [protected]
 

FDOWMS_API FdoWmsOvRasterDefinition* FdoWmsOvRasterDefinition::Create  )  [static]
 

Constructs a new Raster Definition.

Returns:
Returns the newly created FdoWmsOvRasterDefinition instance.

void FdoWmsOvRasterDefinition::Dispose void   )  [protected]
 

FDOWMS_API FdoString* FdoWmsOvRasterDefinition::GetBackgroundColor void   )  const
 

Gets the background color.

Remarks:
The background color is a string that specifies the color to be used as the background pixels of the map. The general format of the background color is a hexadecimal encoding of an RGB value where two hexadecimal characters are used for each of Red, Green, and Blue colour values. The values can range between 00 and FF for each (0 and 255, base 10). The format is 0xRRGGBB; either upper or lower case characters are allowed for RR, GG, and BB values. The "0x" prefix shall have a lower case ‘x? The default value is 0xFFFFFF (corresponding to the colour white).
Returns:
Returns a FdoString indicating the background color to be used when rendering the WMS image.

FDOWMS_API FdoString* FdoWmsOvRasterDefinition::GetElevationDimension void   )  const
 

Gets the elevation dimension of the requested WMS map.

Remarks:
If a WMS Map has a Elevation dimension defined, then in order to retrieve the map in the required dimension, the dimension property may set to 'ELEVATION=value'.
Returns:
Returns a FdoString indicating the elevation dimension of the requested WMS image.

FDOWMS_API FdoString* FdoWmsOvRasterDefinition::GetImageFormat void   ) 
 

Gets the format type in which the WMS image will be generated.

Remarks:
Allowed map formats are "picture" formats . Picture formats constitute a rectangular pixel array of fixed size. Picture formats include file types such as Portable Network Graphics (PNG), Joint Photographics Expert Group (JPEG) and file types such as Tagged Image File Format (TIFF).
Returns:
Returns the WMS image format.

FDOWMS_API FdoWmsOvLayerCollection* FdoWmsOvRasterDefinition::GetLayers void   )  const
 

Gets the WMS layers that will be used to construct the composite WMS image.

Remarks:
A WMS shall render the requested layers by drawing the first map in the list bottommost, the next one over that, and so on.
Returns:
Returns the collection of WMS layers associated to the logical FDO class definition.

virtual FDOWMS_API FdoStringP FdoWmsOvRasterDefinition::GetQualifiedName  )  [virtual]
 

Gets the fully qualified name of this element.

Returns:
Returns the qualified element name

FDOWMS_API FdoString* FdoWmsOvRasterDefinition::GetSpatialContextName void   )  const
 

Gets the spatial context in which the requested WMS map will be returned.

Remarks:
The same spatial context name applies to all layers in a single WMS class definition.
Returns:
Returns the WMS Provider's spatial context name.

FDOWMS_API FdoString* FdoWmsOvRasterDefinition::GetTimeDimension void   )  const
 

Gets the time dimension of the requested WMS map.

Remarks:
If a WMS map has a Time dimension defined, then requests may include the parameter TIME=value. For the TIME parameter, the special keyword 'current' may be used if the WMS Dimension:Name="time" service metadata element includes a nonzero value for the 'current' attribute. The expression "TIME=current" means send the most current data available. The expression "TIME=start_time/current" means send data from start_time up to the most current data available.
Returns:
Returns a FdoString indicating the time dimension of the requested WMS image.

FDOWMS_API FdoBoolean FdoWmsOvRasterDefinition::GetTransparent void   )  const
 

Gets the transparency state.

Remarks:
The transparency state specifies whether the WMS map background is to be made transparent or not. The default value is false. The ability to return an image drawn with transparent pixels allows results of different Map requests to be overlaid, producing a composite map.
Returns:
Returns an FdoBoolean indicating the state of the transparency flag.

FDOWMS_API FdoBoolean FdoWmsOvRasterDefinition::GetUseTileCache void   )  const
 

Gets the tile caching option value.

Remarks:
This option specifies whether using the tile caching method to query the raster data. The default value is true.
Returns:
Returns a FdoBoolean indicating whether using tile cache or not.

virtual FDOWMS_API void FdoWmsOvRasterDefinition::InitFromXml FdoXmlSaxContext *  pContext,
FdoXmlAttributeCollection *  attrs
[virtual]
 

DOXYGEN-IGNORE XML Serialization functions, not part of supported API.

FdoStringP FdoWmsOvRasterDefinition::MIMEFormatTypeToAbbr FdoString *  fullFormat  )  [protected]
 

FDOWMS_API void FdoWmsOvRasterDefinition::SetBackgroundColor FdoString *  bgColor  ) 
 

Sets the background color.

Remarks:
The background color is a string that specifies the color to be used as the background pixels of the map. The general format of the background color is a hexadecimal encoding of an RGB value where two hexadecimal characters are used for each of Red, Green, and Blue colour values. The values can range between 00 and FF for each (0 and 255, base 10). The format is 0xRRGGBB; either upper or lower case characters are allowed for RR, GG, and BB values. The "0x" prefix shall have a lower case ‘x? The default value is 0xFFFFFF (corresponding to the colour white).
Returns:
Returns nothing.

FDOWMS_API void FdoWmsOvRasterDefinition::SetElevationDimension FdoString *  dimension  ) 
 

Sets the time dimension of the requested WMS map.

Remarks:
If a WMS Map has a Elevation dimension defined, then in order to retrieve the map in the required dimension, the dimension property may set to 'ELEVATION=value'.
Returns:
Returns nothing.

/ Returns a FdoString indicating the elevation dimension of the requested WMS image.

FDOWMS_API void FdoWmsOvRasterDefinition::SetImageFormat FdoString *  value  ) 
 

Sets the format type in which the WMS image will be generated.

Remarks:
Allowed map formats are "picture" formats . Picture formats constitute a rectangular pixel array of fixed size. Picture formats include file types such as Portable Network Graphics (PNG), Joint Photographics Expert Group (JPEG) and file types such as Tagged Image File Format (TIFF).
Returns:
Returns nothing.

FDOWMS_API void FdoWmsOvRasterDefinition::SetSpatialContextName FdoString *  value  ) 
 

Sets the spatial context in which the requested WMS map will be returned.

Remarks:
The same spatial context name applies to all layers in a single WMS class definition.
Returns:
Returns nothing.

FDOWMS_API void FdoWmsOvRasterDefinition::SetTimeDimension FdoString *  time  ) 
 

Sets the time dimension of the requested WMS map.

Remarks:
If a WMS map has a Time dimension defined, then requests may include the parameter TIME=value. For the TIME parameter, the special keyword 'current' may be used if the WMS Dimension:Name="time" service metadata element includes a nonzero value for the 'current' attribute. The expression "TIME=current" means send the most current data available. The expression "TIME=start_time/current" means send data from start_time up to the most current data available.
Returns:
Returns nothing .

FDOWMS_API void FdoWmsOvRasterDefinition::SetTransparent FdoBoolean  transparent  ) 
 

Sets the transparency state.

Remarks:
The transparency state specifies whether the WMS map background is to be made transparent or not. The default value is false. The ability to return an image drawn with transparent pixels allows results of different Map requests to be overlaid, producing a composite map.
Returns:
Returns nothing.

FDOWMS_API void FdoWmsOvRasterDefinition::SetUseTileCache FdoBoolean  value  ) 
 

Sets the tile caching option value.

Remarks:
This option specifies whether using the tile caching method to query the raster data. The default value is true.
Returns:
Returns nothing.

virtual FDOWMS_API FdoBoolean FdoWmsOvRasterDefinition::XmlEndElement FdoXmlSaxContext *  context,
FdoString *  uri,
FdoString *  name,
FdoString *  qname
[virtual]
 

virtual FDOWMS_API FdoXmlSaxHandler* FdoWmsOvRasterDefinition::XmlStartElement FdoXmlSaxContext *  context,
FdoString *  uri,
FdoString *  name,
FdoString *  qname,
FdoXmlAttributeCollection *  atts
[virtual]
 


Friends And Related Function Documentation

friend class FdoWmsOvClassDefinition [friend]
 

Definition at line 34 of file FdoWmsOvRasterDefinition.h.


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