USGS

Isis 3.0 Object Programmers' Reference

 Home
Isis::CubeAttribute

Isis::CubeAttribute Class Reference
[Parsing]

#include <CubeAttribute.h>

Inheritance diagram for Isis::CubeAttribute:

Inheritance graph
[legend]
Collaboration diagram for Isis::CubeAttribute:

Collaboration graph
[legend]
List of all members.

Detailed Description

Parent class for CubeAttributeInput and CubeAttributeOutput.

This class provides common functionality for the CubeAttributeInput and CubeAttributeOutput classes. These classes are used to parse and manipulate attribute information attached to the end of a cube filename.

See also:
IsisAml IsisGui

For internal use only.

History:
2003-07-09 Stuart Sides Original version
History:
2003-07-17 Stuart Sides Added input file band attribute capabilities.
History:
2003-07-29 Stuart Sides Separated the input and output attributes into two separated class deriving off a base class, instead of one class for all cases.
History:
2003-10-03 Stuart Sides Added members HasPixelType. It was needed by the IsisCube so it could do an easy check. Added IsMsb, IsLsb, HasOrder, ByteOrderStr, ByteOrderType, Order and Order. These were needed to allow users to specify a byte order for output cubes.
History:
2004-02-03 Stuart Sides Refactor for IsisProcess and cube changes
History:
2004-03-03 Stuart Sides Modified IsisCubeAttributeOutput::Write so min and max don't get written when the pixel type is real.

Definition at line 171 of file CubeAttribute.h.

Public Member Functions

 CubeAttribute ()
 Constructs an empty CubeAttribute.
 CubeAttribute (const Isis::iString &att)
 Constructs a CubeAttribute using the argument.
virtual ~CubeAttribute ()
 Destroys the object.
virtual void Write (std::ostream &ostr) const
 Write the attributes to a stream.
virtual void Write (std::string &str) const
 Write the attributes to a string.
virtual void Write (Isis::Pvl &pvl) const
 Write the attributes to an Isis::Pvl.

Protected Attributes

Isis::iString p_attribute
 Contains the unparsed attributes with the filename stripped.

Constructor & Destructor Documentation

Isis::CubeAttribute::CubeAttribute (  ) 

Constructs an empty CubeAttribute.

Definition at line 34 of file CubeAttribute.cpp.

References p_attribute.

Isis::CubeAttribute::CubeAttribute ( const Isis::iString &  att  ) 

Constructs a CubeAttribute using the argument.

Constructs a CubeAttribute and initializes it with the contents of the string parameter. Minimal error checking is done to see if the string looks like an attribute.

Parameters:
att A string containing the file attributes. All characters before the first "+" are assumed to be the filename and are ignored.

Definition at line 39 of file CubeAttribute.cpp.

References _FILEINFO_, Isis::iException::Message(), p_attribute, and pos.

Isis::CubeAttribute::~CubeAttribute (  )  [virtual]

Destroys the object.

Definition at line 61 of file CubeAttribute.cpp.

Member Function Documentation

void Isis::CubeAttribute::Write ( Isis::Pvl &  pvl  )  const [virtual]

Write the attributes to an Isis::Pvl.

Parameters:
pvl The pvl to write the attributes to

Reimplemented in Isis::CubeAttributeInput, and Isis::CubeAttributeOutput.

Definition at line 74 of file CubeAttribute.cpp.

References p_attribute, and pvl().

void Isis::CubeAttribute::Write ( std::string &  str  )  const [virtual]

Write the attributes to a string.

Parameters:
str The string to write the attributes to

Reimplemented in Isis::CubeAttributeInput, and Isis::CubeAttributeOutput.

Definition at line 69 of file CubeAttribute.cpp.

References p_attribute.

void Isis::CubeAttribute::Write ( std::ostream &  ostr  )  const [virtual]

Write the attributes to a stream.

Parameters:
ostr The stream to write the attributes to

Reimplemented in Isis::CubeAttributeInput, and Isis::CubeAttributeOutput.

Definition at line 64 of file CubeAttribute.cpp.

References p_attribute.

Member Data Documentation

Isis::iString Isis::CubeAttribute::p_attribute [protected]

Contains the unparsed attributes with the filename stripped.

Definition at line 220 of file CubeAttribute.h.

Referenced by CubeAttribute(), Isis::CubeAttributeInput::CubeAttributeInput(), Isis::CubeAttributeOutput::CubeAttributeOutput(), and Write().

The documentation for this class was generated from the following files: