CCfits - HEASARC - NASA

CCfits - HEASARC - NASA CCfits - HEASARC - NASA

heasarc.gsfc.nasa.gov
from heasarc.gsfc.nasa.gov More from this publisher
27.01.2015 Views

24.3 CCfits::Column Class Reference 49 24.2.3.2 void CCfits::BinTable::readData ( bool readFlag = false, const std::vector< String > & keys = std::vector() ) [virtual] read columns and keys specified in the input array. See Table class documentation for further details. Implements CCfits::ExtHDU. The documentation for this class was generated from the following files: • BinTable.h • BinTable.cxx 24.3 CCfits::Column Class Reference Abstract base class for Column objects. #include Inherited by CCfits::ColumnData< T >, and CCfits::ColumnVectorData< T >. Classes • class InsufficientElements Exception thrown if the data supplied for a write operation is less than declared. • class InvalidDataType Exception thrown for invalid data type inputs. • class InvalidNumberOfRows Exception thrown if user enters a non-positive number for the number of rows to write. • class InvalidRowNumber Exception thrown on attempting to read a row number beyond the end of a table. • class InvalidRowParameter Exception thrown on incorrect row writing request. • class NoNullValue Exception thrown if a null value is specified without support from existing column header. • class RangeError exception to be thrown for inputs that cause range errors in column read operations. • class WrongColumnType Exception thrown on attempting to access a scalar column as vector data. Generated on Tue Dec 6 2011 16:12:51 for CCfits by Doxygen

24.3 CCfits::Column Class Reference 50 Public Member Functions • Column (const Column &right) copy constructor, used in copying Columns to standard library containers. • virtual ∼Column () destructor. • template void addNullValue (T nullVal) Set the TNULLn keyword for the column. • const String & dimen () const return TDIMn keyword • const String & display () const return TDISPn keyword • const String & format () const return TFORMn keyword • template bool getNullValue (T ∗nullVal) const Get the value of the TNULLn keyword for the column. • int index () const get the Column index (the n in TTYPEn etc). • bool isRead () const flag set to true if the entire column data has been read from disk • const String & name () const return name of Column (TTYPEn keyword) • Table ∗ parent () const return a pointer to the Table which owns this Column • template void read (std::vector< S > &vals, long first, long last) Retrieve data from a scalar column into a std::vector. • template void read (std::valarray< S > &vals, long first, long last) Retrieve data from a scalar column into a std::valarray. • template void read (std::valarray< S > &vals, long rows) return a single row of a vector column into a std::valarray • template void read (std::vector< S > &vals, long first, long last, S ∗nullValue) Retrieve data from a scalar column into a std::vector>, applying nullValue when relevant. • template void read (std::valarray< S > &vals, long first, long last, S ∗nullValue) Generated on Tue Dec 6 2011 16:12:51 for CCfits by Doxygen

24.3 <strong>CCfits</strong>::Column Class Reference 50<br />

Public Member Functions<br />

• Column (const Column &right)<br />

copy constructor, used in copying Columns to standard library containers.<br />

• virtual ∼Column ()<br />

destructor.<br />

• template<br />

void addNullValue (T nullVal)<br />

Set the TNULLn keyword for the column.<br />

• const String & dimen () const<br />

return TDIMn keyword<br />

• const String & display () const<br />

return TDISPn keyword<br />

• const String & format () const<br />

return TFORMn keyword<br />

• template<br />

bool getNullValue (T ∗nullVal) const<br />

Get the value of the TNULLn keyword for the column.<br />

• int index () const<br />

get the Column index (the n in TTYPEn etc).<br />

• bool isRead () const<br />

flag set to true if the entire column data has been read from disk<br />

• const String & name () const<br />

return name of Column (TTYPEn keyword)<br />

• Table ∗ parent () const<br />

return a pointer to the Table which owns this Column<br />

• template<br />

void read (std::vector< S > &vals, long first, long last)<br />

Retrieve data from a scalar column into a std::vector.<br />

• template<br />

void read (std::valarray< S > &vals, long first, long last)<br />

Retrieve data from a scalar column into a std::valarray.<br />

• template<br />

void read (std::valarray< S > &vals, long rows)<br />

return a single row of a vector column into a std::valarray<br />

• template<br />

void read (std::vector< S > &vals, long first, long last, S ∗nullValue)<br />

Retrieve data from a scalar column into a std::vector>, applying nullValue when<br />

relevant.<br />

• template<br />

void read (std::valarray< S > &vals, long first, long last, S ∗nullValue)<br />

Generated on Tue Dec 6 2011 16:12:51 for <strong>CCfits</strong> by Doxygen

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!