001/*
002 *   Entity000_Null  -- A Null Entity that may be created as a result of editing a file.
003 *
004 *   Copyright (C) 2010-2025, Joseph A. Huwaldt. All rights reserved.
005 *   
006 *   This library is free software; you can redistribute it and/or
007 *   modify it under the terms of the GNU Lesser General Public
008 *   License as published by the Free Software Foundation; either
009 *   version 2.1 of the License, or (at your option) any later version.
010 *   
011 *   This library is distributed in the hope that it will be useful,
012 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
013 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014 *   Lesser General Public License for more details.
015 *
016 *   You should have received a copy of the GNU Lesser General Public License
017 *   along with this program; if not, write to the Free Software
018 *   Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
019 *   Or visit:  http://www.gnu.org/licenses/lgpl.html
020 *
021 *   Based on, but heavily modified from, IGESView ( http://ts.nist.gov/Standards/IGES/igesTools.cfm )
022 */
023package geomss.geom.reader.iges;
024
025import java.io.IOException;
026import java.io.RandomAccessFile;
027
028/**
029 * <b><i>NULL ENTITY</i></b> - An entity that may be created as a result of editing a file
030 * to delete an "undesired" entity.
031 *
032 * <p>
033 * This entity type is ignored when reading in an IGES file and can not be written out to
034 * an IGES file.
035 * </p>
036 *
037 * <p> Modified by: Joseph A. Huwaldt </p>
038 * 
039 * @author JDN, Version 1.0
040 * @version February 22, 2025
041 */
042public class Entity000_Null extends Entity {
043
044    /**
045     * Default constructor.
046     *
047     * @param p  part to which this entity is contained
048     * @param de Directory Entry for this entity
049     */
050    public Entity000_Null(Part p, DirEntry de) {
051        super(p, de);
052
053        if (Constants.DEBUG) {
054            System.out.println("Entity000 constructor called");
055        }
056    }
057
058    /**
059     * Checks to see if the entity is correct. This implementation does nothing.
060     */
061    @Override
062    public void check() { }
063
064    /**
065     * Read the Parameter Data from the String read in by the superclass. Nothing is
066     * parsed for the Null entity.
067     *
068     * @param in input file
069     * @throws java.io.IOException if the parameter could not be read in.
070     */
071    @Override
072    public void read(RandomAccessFile in) throws IOException {
073        if (Constants.DEBUG) {
074            System.out.println("Entity000.read() called");
075        }
076
077        super.read(in);
078
079        if (Constants.DEBUG) {
080            System.out.println("PD String = \"" + getPDString() + "\"");
081        }
082    }
083
084    /**
085     * Returns a short String describing this Entity object's type.
086     *
087     * @return A short String describing this Entity object's type.
088     */
089    @Override
090    public String getTypeString() {
091        return "Entity000 - Null";
092    }
093
094}