PUBLIC

FileFormatPPMC::FileFormatPPMC(void) FileFormatC::ProbeLoad(IStreamC &) const FileFormatC::ProbeLoad(const FilenameC &,IStreamC &) const FileFormatC::ProbeSave(const FilenameC &,BooleanT) const FileFormatC::CreateInput(const FilenameC &) const FileFormatC::CreateOutput(const FilenameC &) const FileFormatC::CreateInput(IStreamC &) const FileFormatC::CreateOutput(OStreamC &) const FileFormatBaseC::Name(void) const FileFormatBaseC::Description(void) const FileFormatBaseC::ProbeLoad(IStreamC &,const type_info &) const FileFormatBaseC::ProbeLoad(const FilenameC &,IStreamC &,const type_info &) const FileFormatBaseC::ProbeLoad(const FilenameC &,const type_info &) const FileFormatBaseC::ProbeSave(const FilenameC &,const type_info &,BooleanT) const FileFormatBaseC::ProbeLoad(const type_info &) const FileFormatBaseC::ProbeSave(const type_info &) const FileFormatBaseC::CreateInput(const FilenameC &,const type_info &) const FileFormatBaseC::CreateOutput(const FilenameC &,const type_info &) const FileFormatBaseC::CreateInput(IStreamC &,const type_info &) const FileFormatBaseC::CreateOutput(OStreamC &,const type_info &) const FileFormatBaseC::DefaultType(void) const FileFormatBaseC::Priority(void) const FileFormatBaseC::IsStream(void) const DPEntityC::operator=(const DPEntityC &) DPEntityC::Body(void) DPEntityC::Body(void) const DPEntityC::Save(ostream &) const RCHandleAC::Abstract(void) RCHandleAC::IsHandleType(const DT &) const RCHandleAC::CheckHandleType(const DT &) const RCHandleAC::Save(ostream &) const RCHandleAC::Copy(void) const RCHandleC::IsValid(void) const RCHandleC::IsValidObject(void) const RCHandleC::operator=(const RCHandleC &) RCHandleC::operator==(const RCHandleC &) const RCHandleC::operator!=(const RCHandleC &) const RCHandleC::Hash(void) const RCHandleC::IsConst(void) const RCHandleC::IsNotConst(void) const RCHandleC::SetConst(void) const RCHandleC::Invalidate(void) RCHandleC::Body(void) RCHandleC::Body(void) const

FileFormatPPMC
Create an instance of a PPM File Format.
include	"amma/Image/PNMFormat.hh"
User Level:	Default
Library:	DPImageIO
Example:	exImgIO.cc
Section:	Image.Image IO
In Scope:	std

Parent Classes:

public FileFormatC<class DataT>

FileFormatPPMC()

const type_info & ProbeLoad(IStreamC & in) const

Is stream in this format ?
This asks the question: Can stream 'in' be loaded into 'DataT' type ?

const type_info & ProbeLoad(const FilenameC & filename,IStreamC & in) const

Is Filename in this format ?
This asks the question: Can file 'filename' be loaded with object 'DataT' ? If used with a empty filename asks: Can load this type of object ?

const type_info & ProbeSave(const FilenameC & filename,BooleanT forceFmt = false) const

Is Filename in this format ?
This asks the question: Can file 'filename' be saved with object 'DataT' ? If used with a empty filename asks: Can save this type of object ?

DPIPortC<ImageC<ByteRGBValueC>> CreateInput(const FilenameC & filename) const

Create a input port for loading.
Will create an Invalid port if not supported.

DPOPortC<ImageC<ByteRGBValueC>> CreateOutput(const FilenameC & filename) const

Create a output port for saving.
Will create an Invalid port if not supported.

DPIPortC<ImageC<ByteRGBValueC>> CreateInput(IStreamC & in) const

Create a input port for loading.
Will create an Invalid port if not supported.

DPOPortC<ImageC<ByteRGBValueC>> CreateOutput(OStreamC & out) const

Create a output port for saving.
Will create an Invalid port if not supported.

const StringC & Name() const

Name of file format.

const StringC & Description() const

Description of fileformat.

const type_info & ProbeLoad(IStreamC & in,const type_info & obj_type) const

Is stream in this format ?
This asks the question: Can stream 'in' be loaded into object 'obj_type' ? Returns a suggested load type. (Which may or mayno match 'obj_type'.), This will be typeid(void), if failed.

const type_info & ProbeLoad(const FilenameC & filename,IStreamC & in,const type_info & obj_type) const

Is Filename in this format (for load) ?
This asks the question: Can file 'filename' be loaded with object 'obj_type' ? If used with a empty filename then in is invalid and it asks: Can load this type of object ? Returns a suggested load type. (Which may or mayno match 'obj_type'.), This will be typeid(void), if failed.

const type_info & ProbeLoad(const FilenameC & filename,const type_info & obj_type) const

Is Filename in this format (for load) ?
Returns a suggested load type. (Which may or mayno match 'obj_type'.), This will be typeid(void), if failed.

const type_info & ProbeSave(const FilenameC & filename,const type_info & obj_type,BooleanT forceFormat) const

Is Filename in this format ?
This asks the question: Can file 'filename' be saved with object 'obj_type' ? This uses extention to check consistancy. If used with a empty filename asks: Can save this type of object ? Returns a suggested load type. (Which may or mayno match 'obj_type'.), This will be typeid(void), if failed.

const type_info & ProbeLoad(const type_info & obj_type) const

Is Filename in this format (for load) ?
Alias for ProbeLoad("",IStreamC(),obj_type); Returns a suggested load type. (Which may or mayno match 'obj_type'.), This will be typeid(void), if failed.

const type_info & ProbeSave(const type_info & obj_type) const

Is Filename in this format ?
Alias for ProbeSave("",obj_type);

DPIPortBaseC CreateInput(const FilenameC & filename,const type_info & obj_type) const

Create a input port for loading.
Will create an Invalid port if not supported.

The default version of this functions opens the file and passes the stream to CreateInput(IStreamC ....)

DPOPortBaseC CreateOutput(const FilenameC & filename,const type_info & obj_type) const

Create a output port for saving.
Will create an Invalid port if not supported.

The default version of this functions opens the file and passes the stream to CreateOutput(OStreamC ....)

DPIPortBaseC CreateInput(IStreamC & in,const type_info & obj_type) const

Create a input port for loading.
Will create an Invalid port if not supported.

DPOPortBaseC CreateOutput(OStreamC & out,const type_info & obj_type) const

Create a output port for saving.
Will create an Invalid port if not supported.

const type_info & DefaultType() const

Get prefered IO type.
typeid(void) if none.

IntT Priority() const

Find the priority of the format. the higher the better.
Default is zero.

BooleanT IsStream() const

Test if format is a fully streamable.
i.e. check if you can read/write more than object object.

const DPEntityC & operator=(const DPEntityC & dat)

Assignment.

DPEntityBodyC & Body()

Access body.

const DPEntityBodyC & Body() const

Access body.

BooleanT Save(ostream & out) const

RCAbstractC Abstract()

Create an abstract handle to this object.

BooleanT IsHandleType(const DT &) const

Is handle of given type ?

void CheckHandleType(const DT & dummy) const

Check handle type. Throw an expception if not.

BooleanT Save(ostream & out) const

Save to ostream.

RCHandleAC<DPEntityBodyC> Copy() const

Creat a deep copy of this object.
protected:

BooleanT IsValid() const

Check its a valid handle.

BooleanT IsValidObject() const

Check its a valid handle, and that the object is pointed to is also valid.

RCHandleC<DPEntityBodyC> & operator=(const RCHandleC<DPEntityBodyC> & oth)

Assignment.

BooleanT operator==(const RCHandleC<DPEntityBodyC> & oth) const

Comparison operator.

BooleanT operator!=(const RCHandleC<DPEntityBodyC> & oth) const

Comparison operator.

UIntT Hash() const

Hash function.x

BooleanT IsConst() const

Is object constant ?

BooleanT IsNotConst() const

Is object not constant ?

void SetConst(void) const

Lock the object.
This is const as a convience though it actual modified the object, often object you wish to ensure are constant already have const set. protected:

void Invalidate()

Turn this into an invalid handle.

DPEntityBodyC & Body()

Direct access to body.

const DPEntityBodyC & Body() const

Constant access to body.