CdmHeader.java

/* Copyright 2002-2022 CS GROUP
 * Licensed to CS GROUP (CS) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * CS licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.orekit.files.ccsds.ndm.cdm;

import org.orekit.files.ccsds.section.Header;
import org.orekit.files.ccsds.section.HeaderKey;

/**
 * Header of a CCSDS Conjunction Data Message.
 * @author Melina Vanel
 * @since 11.2
 */
public class CdmHeader extends Header {

    /** ID that uniquely identifies a message from a given originator. */
    private String messageFor;

    /** User-defined free-text message classification or caveats of this CDM. */
    private String classification;

    /**
     * Constructor.
     * @param minVersionMessageId minimum version for {@link HeaderKey#MESSAGE_ID}
     */
    public CdmHeader(final double minVersionMessageId) {
        super(minVersionMessageId);
    }

    /** {@inheritDoc} */
    @Override
    public void validate(final double version) {
        super.validate(version);
    }

    /**
     * Get the spacecraft name for which the CDM is provided stored in MESSAGE_FOR key.
     * @return messageFor the spacecraft name for which the CDM is provided.
     */
    public String getMessageFor() {
        return messageFor;
    }

    /**
     * Set the spacecraft name for which the CDM is provided stored in MESSAGE_FOR key.
     * @param spacecraftNames the spacecraft name for which the CDM is provided.
     */
    public void setMessageFor(final String spacecraftNames) {
        refuseFurtherComments();
        this.messageFor = spacecraftNames;
    }

    /** Get the classification or caveats text message of this CDM.
     * @return the classification
     */
    public String getClassification() {
        return classification;
    }

    /** Set the classification or caveats text message of this CDM.
     * @param classification the classification to set
     */
    public void setClassification(final String classification) {
        this.classification = classification;
    }

}