<< Click to Display Table of Contents >>

OGC.js

 

 

Namespace

OGC



Class

WrapProxy(object ProxyService, string Method, string URL, string Data, string MimeType, Boolean Async, Processload)







Class

WrapProxyImage(object ProxyService, string Method, string URL, string Data, ProcessLoad)







Class

URI(string URI)


Method

string

toString()

return the URI string.

Method

URIValues[3]

getType()

return URI type.

Method

URIValues[4]

getAuthority()

return URI authority.

Method

URIValues[5]

getVersion()

return the OGC version.

Method

URIValues[6]

getCode()

return URl Code

Method

Boolean

IsEqual(object URI)

default is true.





Class

CreateByURI(object URI)







Class

URLPath(string Path)


Property

string

Host

the path of the URL.

Property


Parameters

indicates the format in which the Client wishes to be notified of Service Exceptions.

Method

string

getParameterString()

return the parameter in string type.





Class

ServiceExceptionReportType(object Elem)


Property


ServiceException

service exception, which defines several exception codes

Property


version

the version of the service exception.





Class

ServiceExceptionType(object Elem)


Property


value

value of service exception.

Property


code

code for service exception.

Property


locator

locator of service exception.









Namespace

OWS


Class

GetCapabilitiesType(object Elem)

XML encoded GetCapabilities operation request. This operation allows clients to retrieve service metadata about a specific service instance. In this XML encoding, no "request" parameter is included, since the element name specifies the specific operation. This base type shall be extended by each specific OWS to include the additional required "service" attribute, with the correct value for that OWS.

Property

object

AcceptVersions

When omitted, server shall return latest supported version.

Property

object

Sections

When omitted or not supported by server, server shall return complete service metadata (Capabilities) document.

Property

object

AcceptFormats

When omitted or not supported by server, server shall return service metadata document using the MIME type "text/xml".

Property

string

updateSequence

When omitted or not supported by server, server shall return latest complete service metadata document.





Class

AcceptVersionsType(object Elem)

Prioritized sequence of one or more specification versions accepted by client, with preferred versions listed first. See Version negotiation subclause for more information.

Property

string

Version

OGC version





Class

SectionsType(object Elem)

Unordered list of zero or more names of requested sections in complete service metadata document. Each Section value shall contain an allowed section name as specified by each OWS specification. See Sections parameter subclause for more information.  

Property

string

Section

section





Class

AcceptFormatsType(object Elem)

Prioritized sequence of zero or more GetCapabilities operation response formats desired by client, with preferred formats listed first. Each response format shall be identified by its MIME type. See AcceptFormats parameter use subclause for more information.

Property

string

OutputFormat

output format





Class

CapabilitiesBaseType(object Elem)

XML encoded GetCapabilities operation response. This document provides clients with service metadata about a specific service instance, usually including metadata about the tightly-coupled data served. If the server does not implement the updateSequence parameter, the server shall always return the complete Capabilities document, without the updateSequence parameter. When the server implements the updateSequence parameter and the GetCapabilities operation request included the updateSequence parameter with the current value, the server shall return this element with only the "version" and "updateSequence" attributes. Otherwise, all optional elements shall be included or not depending on the actual value of the Contents parameter in the GetCapabilities operation request. This base type shall be extended by each specific OWS to include the additional contents needed.

Property

object

ServiceIdentification

ServiceIdentification object.

Property

object

ServiceProvider

ServicePorvider object.

Property

object

OperationsMetadata

OperationsMetadata object.

Property

srting

version

version.

Property

string

updataeSequence

for maintaining cache consistency. Its value can be an integer, a timestamp in [ISO 8601:1988(E)] format, or any other number or string.





Class

DescriptionType(object Elem)

Human-readable descriptive information for the object it is included within.
This type shall be extended if needed for specific OWS use to include additional metadata for each type of information. This type shall not be restricted for a specific OWS to change the multiplicity (or optionality) of some elements.

Property

string

Title

Title of this resource, normally used for display to a human.

Property

string

Abstract

Brief narrative description of this resource, normally used for display to a human.

Property

object

Keywords

keywords.





Class

KeywordsType(object Elem)

Unordered list of one or more commonly used or formalised word(s) or phrase(s) used to describe the subject. When needed, the optional "type" can name the type of the associated list of keywords that shall all have the same type. Also when needed, the codeSpace attribute of that "type" can reference the type name authority and/or thesaurus.
For OWS use, the optional thesaurusName element was omitted as being complex information that could be referenced by the codeSpace attribute of the Type element.

Property

string

Keyword

keyword.

Property

string

Type

type.





Class

ServiceIdentificationType(object Elem)

Identification of capabilities which a service provider makes available to a service user through a set of interfaces that define a behaviour. General metadata for this specific server. This XML Schema of this section shall be the same for all OWS.

Property

string

ServiceType

A service type name from a registry of services. For example, the values of the codeSpace URI and name and code string may be "OGC" and "catalogue." This type name is normally used for machine-to-machine communication.

Property

string

ServiceTypeVersion

Unordered list of one or more versions of this service type implemented by this server. This information is not adequate for version negotiation, and shall not be used for that purpose.

Property

string

Fees

Fees and terms for retrieving data from or otherwise using this server, including the monetary units as specified in ISO 4217. The reserved value NONE (case insensitive) shall be used to mean no fees or terms.

Property

string

AccessConstraints

Access constraint applied to assure the protection of privacy or intellectual property, or any other restrictions on retrieving or using data from or otherwise using this server. The reserved value NONE (case insensitive) shall be used to mean no access constraints are imposed.





Class

ServiceProviderType(object Elem)

Metadata about the organization that provides this specific service instance or server.

Property

string

ProviderName

A unique identifier for the service provider organization.

Property

string

ProviderSite

Reference to the most relevant web site of the service provider.

Property

string

ServiceContact

Information for contacting the service provider. The OnlineResource element within this ServiceContact element should not be used to reference a web site of the service provider.





Class

OperationsMetadataType(object Elem)

Metadata about the operations and related abilities specified by this service and implemented by this server, including the URLs for operation requests. The basic contents of this section shall be the same for all OWS types, but individual services can add elements and/or change the optionality of optional elements.

Property

object

Operation

Metadata for unordered list of all the (requests for) operations that this server interface implements. The list of required and optional operations implemented shall be specified in the Implementation Specification for this service.

Property

string

Parameter

Optional unordered list of parameter valid domains that each apply to one or more operations which this server interface implements. The list of required and optional parameter domain limitations shall be specified in the Implementation Specification for this service.

Property

string

Constraint

Optional unordered list of valid domain constraints on non-parameter quantities that each apply to this server. The list of required and optional constraints shall be specified in the Implementation Specification for this service.

Property

object

ExtendedCapabilities

Individual software vendors and servers can use this element to provide metadata about any additional server abilities.





Class

ExtendedCapabilitiesType


Individual software vendors and servers can use this element to provide metadata about any additional server abilities.





Class

OperationType(object Elem)

Metadata for one operation that this server implements.

Property

object

DCP

Unordered list of Distributed Computing Platforms (DCPs) supported for this operation. At present, only the HTTP DCP is defined, so this element will appear only once.

Property

string

Parameter

Optional unordered list of parameter domains that each apply to this operation which this server implements. If one of these Parameter elements has the same "name" attribute as a Parameter element in the OperationsMetadata element, this Parameter element shall override the other one for this operation. The list of required and optional parameter domain limitations for this operation shall be specified in the Implementation Specification for this service.

Property

string

Constraint

Optional unordered list of valid domain constraints on non-parameter quantities that each apply to this operation. If one of these Constraint elements has the same "name" attribute as a Constraint element in the OperationsMetadata element, this Constraint element shall override the other one for this operation. The list of required and optional constraints for this operation shall be specified in the Implementation Specification for this service.

Property

object

Metadata

Optional unordered list of additional metadata about this operation and its' implementation. A list of required and optional metadata elements for this operation should be specified in the Implementation Specification for this service. (Informative: This metadata might specify the operation request parameters or provide the XML Schemas for the operation request.)

Property

string

name

name of the operator.





Class

DCPType(object Elem)

Information for one distributed Computing Platform (DCP) supported for this operation. At present, only the HTTP DCP is defined, so this element only includes the HTTP element.

Property

object

HTTP

Connect point URLs for the HTTP Distributed Computing Platform (DCP). Normally, only one Get and/or one Post is included in this element. More than one Get and/or Post is allowed to support including alternative URLs for uses such as load balancing or backup.





Class

HTTPType(object Elem)

Connect point URLs for the HTTP Distributed Computing Platform (DCP). Normally, only one Get and/or one Post is included in this element. More than one Get and/or Post is allowed to support including alternative URLs for uses such as load balancing or backup.

Property

string

Get

Connect point URL prefix and any constraints for the HTTP "Get" request method for this operation request.

Property

string

Post

Connect point URL and any constraints for the HTTP "Post" request method for this operation request.





Class

RequestMethodType(object Elem)

Connect point URL and any constraints for this HTTP request method for this operation request. In the OnlineResourceType, the xlink:href attribute in the xlink:simpleLink attribute group shall be used to contain this URL. The other attributes in the xlink:simpleLink attribute group should not be used.

Property

string

Constraint

Optional unordered list of valid domain constraints on non-parameter quantities that each apply to this request method for this operation. If one of these Constraint elements has the same "name" attribute as a Constraint element in the OperationsMetadata or Operation element, this Constraint element shall override the other one for this operation. The list of required and optional constraints for this request method for this operation shall be specified in the Implementation Specification for this service.





Class

MetadataType(object Elem)

This element either references or contains more metadata about the element that includes this element. To reference metadata stored remotely, at least the xlinks:href attribute in xlink:simpleLink shall be included. Either at least one of the attributes in xlink:simpleLink or a substitute for the AbstractMetaData element shall be included, but not both. An Implementation Specification can restrict the contents of this element to always be a reference or always contain metadata. (Informative: This element was adapted from the metaDataProperty element in GML 3.0.)

Property

object

_MetaData

_MetaData object.

Property

string

about

info about the Metadata.





Class

_MetaData







Class

DomainType(object Elem)

Valid domain (or set of values) of one parameter or other quantity used by this server. A non-parameter quantity may not be explicitly represented in the server software.

Property

string

name

name of the domain.





Class

UnNamedDomainType(object Elem)


Property

object

AllowedValues

AllowedValues object.

Property

object

AnyValues

AnyValues object.

Property

object

NoValues

NoValues object.

Property

object

ValueReference

ValueReference object.

Property

string

DefaultValue

DefaultValue object.

Property

object

Meaning

Meaning object.

Property

object

DataType

DataType object.

Property

object

UOM

UOM object.

Property

object

ReferenceSystem

ReferenceSystem object.

Property

object

Metadata

Metadata object.





Class

AnyValueType()







Class

NoValueType()







Class

ValuesReferenceType(object Elem)


Property

string

value

value

Property

string

reference

reference.





Class

AllowedValuesType(object Elem)


Property

object

Value

Value object.

Property

object

Range

Range object.





Class

ValueType(object Elem)


Property

string

value

value

Method

string

toString()

convert the input to string.





Class

RangeType(object Elem)


Property

object

MinimumValue

MinimumValue object.

Property

object

MaximumValue

MaximumValue object.

Property

object

Spacing

Spacing object.

Property

string

rangeClosure

closure range.





Class

MinimumValueType(object Elem)







Class

MaximumValueType(object Elem)







Class

SpaceingType(object Elem)







Class

DomainMetadataType(object Elem)


Property

string

value

value

Property

string

reference

reference

Method

string

toString()

convert the input to string.





Class

MeaningType(object Elem)







Class

DataTypeType(object Elem)







Class

ReferenceSystemType(object Elem)







Class

UOMType(object Elem)







Class

ResponsiblePartySubsetType(object Elem)

Identification of, and means of communication with, person responsible for the server.
For OWS use in the ServiceProvider section of a service metadata document, the optional organizationName element was removed, since this type is always used with the ProviderName element which provides that information. The mandatory "role" element was changed to optional, since no clear use of this information is known in the ServiceProvider section.

Property

string

IndividualName

Name of the responsible person: surname, given name, title separated by a delimiter.

Property

string

PositionName

Role or position of the responsible person.

Property

string

ContactInfo

Address of the responsible party.

Property

string

Role

Function performed by the responsible party. Possible values of this Role shall include the values and the meanings listed in Subclause B.5.5 of ISO 19115:2003.





Class

ContactType(object Elem)

Information required to enable contact with the responsible person and/or organization.
For OWS use in the service metadata document, the optional hoursOfService and contactInstructions elements were retained, as possibly being useful in the ServiceProvider section.

Property

object

Phone

Telephone numbers at which the organization or individual may be contacted.

Property

object

Address

Physical and email address at which the organization or individual may be contacted.

Property

string

OnlineResource

On-line information that can be used to contact the individual or organization. OWS specifics: The xlink:href attribute in the xlink:simpleLink attribute group shall be used to reference this resource. Whenever practical, the xlink:href attribute with type anyURI should be a URL from which more contact information can be electronically retrieved. The xlink:title attribute with type "string" can be used to name this set of information. The other attributes in the xlink:simpleLink attribute group should not be used.

Property

string

HoursOfService

Time period (including time zone) when individuals can contact the organization or individual.

Property

string

ContactInstructions

Supplemental instructions on how or when to contact the individual or organization.





Class

OnlineResourceType(object Elem)

Reference to on-line resource from which data can be obtained.
For OWS use in the service metadata document, the CI_OnlineResource class was XML encoded as the attributeGroup "xlink:simpleLink", as used in GML.

Property

string

type

type

Property

string

href

href

Property

string

role

role

Property

string

arcrole

arcrole

Property

string

title

title

Property

string

show

show

Property

string

actuate

actuate





Class

TelephoneType(object Elem)

Telephone numbers for contacting the responsible individual or organization.

Property

string

Voice

Telephone number by which individuals can speak to the responsible organization or individual.

Property

string

Facsimile

Telephone number of a facsimile machine for the responsible organization or individual.









Class

AddressType(object Elem)

Location of the responsible individual or organization.

Property

string

DeliveryPoint

Address line for the location.

Property

string

City

City of the location.

Property

string

AdministrativeArea

State or province of the location.

Property

string

PostalCode

ZIP or other postal code.

Property

string

Country

Country of the physical address.

Property

string

ElectronicMailAddress

Address of the electronic mailbox of the responsible organization or individual.





Class

CodeType(object Elem)

Name or code with an (optional) authority. If the codeSpace attribute is present, its value should reference a dictionary, thesaurus, or authority for the name or code, such as the organisation who assigned the value, or the dictionary from which it is taken.
Type copied from basicTypes.xsd of GML 3 with documentation edited, for possible use outside the ServiceIdentification section of a service metadata document.

Property

string

value

value

Property

string

codeSpace

codeSpace

Method

string

toString()

convert the input to string.





Class

ContentsBaseType(object Elem)


Property

object

DatasetDescriptionSummary

DatasetDescriptionSummary object.

Property

string

OtherSource

other sources.





Class

DatasetDescriptionSummaryBaseType(object Elem)


Property

object

WGS84BoundingBox

WGS84BoundingBox object.

Property

object

Identifier

Identifier object.

Property

object

BoundingBox

BoundingBox object.

Property

object

Metadata

Metadata object.

Property

string

DatasetDescriptionSummary

summary of dataset description





Class

BoundingBoxType(object Elem)

XML encoded minimum rectangular bounding box (or region) parameter, surrounding all the associated data.
This type is adapted from the EnvelopeType of GML 3.1, with modified contents and documentation for encoding a MINIMUM size box SURROUNDING all associated data.

Property

string

LowerCorner

Position of the bounding box corner at which the value of each coordinate normally is the algebraic minimum within this bounding box. In some cases, this position is normally displayed at the top, such as the top left for some image coordinates.

Property

string

UpperCorner

Position of the bounding box corner at which the value of each coordinate normally is the algebraic maximum within this bounding box. In some cases, this position is normally displayed at the bottom, such as the bottom right for some image coordinates.

Property

string

crs

coordinate system.

Property

number

dimensions

number of dimesions.





Class

WGS84BoundingBoxType(object Elem)

XML encoded minimum rectangular bounding box (or region) parameter, surrounding all the associated data. This box is specialized for use with the 2D WGS 84 coordinate reference system with decimal values of longitude and latitude.
This type is adapted from the general BoundingBoxType, with modified contents and documentation for use with the 2D WGS 84 coordinate reference system.

Property

string

crs

coordinate system.

Property

number

dimensions

number of dimesions.





Class

IdentifierType(object Elem)


Unique identifier or name of this dataset.





Class

MetadataType(object Elem)

This element either references or contains more metadata about the element that includes this element. To reference metadata stored remotely, at least the xlinks:href attribute in xlink:simpleLink shall be included. Either at least one of the attributes in xlink:simpleLink or a substitute for the AbstractMetaData element shall be included, but not both. An Implementation Specification can restrict the contents of this element to always be a reference or always contain metadata.

Property

string

_MetaData

_Metadata.

Property

string

simpleAttrs

simple attributes.

Property

string

about

information about Metadata.





Class

AvailableCRSType(object Elem)

can be substituted with?ows:SupportedCRS

Property

string

value

value

Method

string

toString()

convert the input to string.





Class

SupportedCRSType(object Elem)


Coordinate reference system in which data from this data(set) or resource is available or supported. More specific parameter names should be used by specific OWS specifications wherever applicable. More than one such parameter can be included for different purposes.





Class

PositionType(object Elem)


Position instances hold the coordinates of a position in a coordinate reference system (CRS) referenced by the related "crs" attribute or elsewhere. For an angular coordinate axis that is physically continuous for multiple revolutions, but whose recorded values can be discontinuous, special conditions apply when the bounding box is continuous across the value discontinuity:
a)  If the bounding box is continuous clear around this angular axis, then ordinate values of minus and plus infinity shall be used.
b)  If the bounding box is continuous across the value discontinuity but is not continuous clear around this angular axis, then some non-normal value can be used if specified for a specific OWS use of the BoundingBoxType.
This type is adapted from DirectPositionType and doubleList of GML 3.1. The adaptations include omission of all the attributes, since the needed information is included in the BoundingBoxType.





Class

ExceptionReportType(object Elem)


Property

object

Exception

Exception object.

Property

string

version

version

Property

string

language

language





Class

ExceptionType(object Elem)


Property

string

ExceptionText

exception text.

Property

string

exceptionCode

execption code.

Property

string

locator

locator

 

 


© 2017 Supergeo Technologies Inc.