Complete CDAS R1.8.6 Web Services API

Generated by IDLdoc

single page | use frames     summary     class     fields     routine details     file attributes

./

spdfdataviewdescription__define.pro


This class is an IDL representation of the DataviewDescription element from the Coordinated Data Analysis System (CDAS) XML schema.

Author information

Author

B. Harris

Copyright

Copyright (c) 2010-2017 United States Government as represented by the National Aeronautics and Space Administration. No copyright is claimed in the United States under Title 17, U.S.Code. All Other Rights Reserved.

Class description for SpdfDataviewDescription

Fields

Fields in SpdfDataviewDescription

endpointAddress ''

access URL.

id ''

identifier.

noticeUrl ''

URL of notice.

overview ''

overview description.

publicAccess 0B

public-access flag.

subtitle ''

sub-title.

title ''

title.

underConstruction 0B

under-construction flag.

Routines

Routines from spdfdataviewdescription__define.pro

result = SpdfDataviewDescription::init(id, endpointAddress, title, subtitle, overview, underConstruction, noticeUrl, publicAccess)

Creates an SpdfDataviewDescription object.

result = SpdfDataviewDescription::getId()

Gets the identifier.

result = SpdfDataviewDescription::getEndpointAddress()

Gets the endpointAddress.

result = SpdfDataviewDescription::getTitle()

Gets the title.

result = SpdfDataviewDescription::getSubtitle()

Gets the sub-title.

result = SpdfDataviewDescription::getOverview()

Gets the overview description.

result = SpdfDataviewDescription::getUnderConstruction()

Gets the underConstruction flag.

result = SpdfDataviewDescription::getNoticeUrl()

Gets the notice URL.

result = SpdfDataviewDescription::getPublicAccess()

Gets the public-access flag.

SpdfDataviewDescription::print

Prints a textual representation of this object.

SpdfDataviewDescription__define

Defines the SpdfDataviewDescription class.

Routine details

top source SpdfDataviewDescription::init

result = SpdfDataviewDescription::init(id, endpointAddress, title, subtitle, overview, underConstruction, noticeUrl, publicAccess)

Creates an SpdfDataviewDescription object.

Return value

reference to an SpdfDataviewDescription object.

Parameters

id in type=string

dataview identifier.

endpointAddress in type=string

URL to access this dataview.

title in type=string

title of dataview.

subtitle in type=string

sub-title of dataview.

overview in type=string

overview description of this dataview.

underConstruction in type=byte

indicates whether the dataview is in the process of being constructed.

noticeUrl in type=string

URL of notice concerning this dataview. constructed.

publicAccess in type=byte

indicates whether the dataview requires authentication to access.

top source SpdfDataviewDescription::getId

result = SpdfDataviewDescription::getId()

Gets the identifier.

Return value

identifier value.

top source SpdfDataviewDescription::getEndpointAddress

result = SpdfDataviewDescription::getEndpointAddress()

Gets the endpointAddress.

Return value

endpointAddress value.

top source SpdfDataviewDescription::getTitle

result = SpdfDataviewDescription::getTitle()

Gets the title.

Return value

title value.

top source SpdfDataviewDescription::getSubtitle

result = SpdfDataviewDescription::getSubtitle()

Gets the sub-title.

Return value

sub-title value.

top source SpdfDataviewDescription::getOverview

result = SpdfDataviewDescription::getOverview()

Gets the overview description.

Return value

overview value

top source SpdfDataviewDescription::getUnderConstruction

result = SpdfDataviewDescription::getUnderConstruction()

Gets the underConstruction flag.

Return value

underConstruction value.

top source SpdfDataviewDescription::getNoticeUrl

result = SpdfDataviewDescription::getNoticeUrl()

Gets the notice URL.

Return value

notice URL value.

top source SpdfDataviewDescription::getPublicAccess

result = SpdfDataviewDescription::getPublicAccess()

Gets the public-access flag.

Return value

public-access value.

top source SpdfDataviewDescription::print

SpdfDataviewDescription::print

Prints a textual representation of this object.

top source SpdfDataviewDescription__define

SpdfDataviewDescription__define

Defines the SpdfDataviewDescription class.

File attributes

Modification date: Wed May 9 06:58:57 2018
Lines: 70


CDAS Feedback.