spdfadditionalmetadata__define.pro (Complete CDAS R1.8.20 Web Services API)

;
; NOSA HEADER START
;
; The contents of this file are subject to the terms of the NASA Open 
; Source Agreement (NOSA), Version 1.3 only (the "Agreement").  You may 
; not use this file except in compliance with the Agreement.
;
; You can obtain a copy of the agreement at
;   docs/NASA_Open_Source_Agreement_1.3.txt
; or 
;   https://cdaweb.gsfc.nasa.gov/WebServices/NASA_Open_Source_Agreement_1.3.txt.
;
; See the Agreement for the specific language governing permissions
; and limitations under the Agreement.
;
; When distributing Covered Code, include this NOSA HEADER in each
; file and include the Agreement file at 
; docs/NASA_Open_Source_Agreement_1.3.txt.  If applicable, add the 
; following below this NOSA HEADER, with the fields enclosed by 
; brackets "[]" replaced with your own identifying information: 
; Portions Copyright [yyyy] [name of copyright owner]
;
; NOSA HEADER END
;
; Copyright (c) 2024 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.
;
;



;+
; This class is an IDL representation of the AdditionalMetadata element from 
; the
; <a href="https://cdaweb.gsfc.nasa.gov/">Coordinated Data Analysis System</a>
; (CDAS) XML schema.
;
; @copyright Copyright (c) 2024 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.
;
; @author B. Harris
;-


;+
; Creates an SpdfAdditionalMetadata object.
;
; @param type {in} {type=string}
;            type of metadata.
; @param url {in} {type=string}
;            URL to additional metadata.
; @returns reference to an SpdfAdditionalMetadata object.
;-
function SpdfAdditionalMetadata::init, $
    type, url
    compile_opt idl2

    self.type = type
    self.url = url

    return, self
end


;+
; Performs cleanup operations when this object is destroyed.
;-
pro SpdfAdditionalMetadata::cleanup
    compile_opt idl2

end


;+
; Gets the type value.
;
; @returns type value.
;-
function SpdfAdditionalMetadata::getType
    compile_opt idl2

    return, self.type
end


;+
; Gets the URL value.
;
; @returns URL value.
;-
function SpdfAdditionalMetadata::getUrl
    compile_opt idl2

    return, self.url
end


;+
; Prints a textual representation of this object.
;-
pro SpdfAdditionalMetadata::print
    compile_opt idl2

    print, 'type: ', self.type
    print, 'url: ', self.url
end


;+
; Defines the SpdfAdditionalMetadata class.
;
; @field type type of additional metadata.
; @field url URL to additional metadata.
;-
pro SpdfAdditionalMetadata__define
    compile_opt idl2
    struct = { SpdfAdditionalMetadata, $
        type:'', $
        url:'' $
    }
end