FileFormatGFSetBodyC - GF File format information.

User Documentation

Centre for Vision, Speech & Signal Processing

Parent Classes:

FileFormatBodyC

Methods:

FileFormatGFSetBodyC(): Default constructor.
const type_info & ProbeLoad(IStreamC & in,const type_info & obj_type) const: Is stream in std stream format ?
const type_info & ProbeLoad(const FilenameC & filename,IStreamC & in,const type_info & obj_type) const: Probe for load.
const type_info & ProbeSave(const FilenameC & filename,const type_info & obj_type,BooleanT forceFormat) const: Probe for Save.
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.
IntT Priority() const: Find the priority of the format. the higher the better.
Default is zero, this is worse than the default (streams.)
BooleanT IsStream() const: Test if format is a fully streamable.
i.e. check if you can read/write more than object object.

#include "amma/DP/FileFormat.hh"

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' ? typeid(void) == no, otherwise returns the prefered load type.
const type_info & ProbeLoad(const FilenameC & filename,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' ? If used with a empty filename asks: Can load this type of object ? typeid(void) == no, otherwise returns the prefered load type.
const type_info & ProbeLoad(const FilenameC & filename,const type_info & obj_type) const: Is stream in this format ?
This asks the question: Can stream 'in' be loaded into object 'obj_type' ? If used with a empty filename asks: Can load this type of object ? typeid(void) == no, otherwise returns the prefered load type.
const type_info & ProbeLoad(const type_info & obj_type) const: Is stream in this format ?
Alias for ProbeLoad("",IStreamC(),obj_type); typeid(void) == no, otherwise returns the prefered load type.
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' ? If used with a empty filename asks: Can save this type of object ? typeid(void) == no, otherwise returns the prefered save type.
const type_info & ProbeSave(const type_info & obj_type) const: Alias for ProbeSave("",IStreamC(),obj_type);
typeid(void) == no, otherwise returns the prefered save type.
DPIPortBaseC CreateInput(const FilenameC & filename,const type_info & obj_type) const: Create a input port for loading from file 'filename'.
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 to file 'filename'..
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 from stream 'in'.
Will create an Invalid port if not supported.
DPOPortBaseC CreateOutput(OStreamC & out,const type_info & obj_type) const: Create a output port for saving to stream 'out'.
Will create an Invalid port if not supported.
const type_info & DefaultType() const: Get prefered IO type.
This specifies the native class for representing the data in a file.
typeid(void) if none, indicates an indirect driver.
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. (Default value of this function is TRUE).
BooleanT ReadString(IStreamC & is,StringC & buff,UIntT maxLen = 256): read a string form the input.
returns false if the stream contains non text charators or is longer than the given length. This will also restore the file read position after the read.
StringC ExtractDevice(const StringC & nm): Get the device from the full name.
For use in '@X:' style device formats.
StringC ExtractParams(const StringC & nm): Get the device from the full name.
For use in '@X:' style device formats.

#include "amma/DP/Entity.hh"

BooleanT Save(ostream & out) const: Save to ostream.
BodyRefCounterVC & Copy() const: Creat a copy of this object.

#include "amma/BRefCntV.hh"

BodyRefCounterVC & Copy() const: Creat a copy of this object.
BooleanT operator==(const BodyRefCounterVC & oth) const: Compair identitys.
BooleanT operator!=(const BodyRefCounterVC & oth) const: Compair identitys.
BooleanT Save(ostream & out) const: Save to ostream.

#include "amma/BRefCnt.hh"

void AddReference(): Another reference to the object has been created.
void RemoveReference(): One reference to the object was deleted.
Locking scheme -------------- The object is possible to lock (to make constant). The scheme assumes that the object is created, it can be locked, after that it can only be destroyed. The locked object cannot be unlocked. This locking scheme is very useful during debugging, using assert() function, when it is necassary to check that object is treated as constant and the constancy is not violated by any casting or passing through the copy constructor of shared objects.
void SetConst(void) const: This locks the object.
Often objects you wish to lock are already const.
void SetConst(void): This locks the object.
BooleanT IsConst(void) const: Returns TRUE if the object is locked, ie. it is assumed to be constant.
BooleanT IsNotConst(void) const: Returns TRUE if the object is unlocked.
ie. there is no special information if the object is constant or not. Counter state information -------------------------
BooleanT ToBeDeleted() const: Returns TRUE if there is only one reference to the object and the whole object or its reference counting part can be deleted.
BooleanT ToBeDeletedRemoveIgnoreNoRemove(): Decrement refrence by 1 return true if this leaves no refrences to the object.
BooleanT ToBeDeletedRemove(): Decrement refrence by 1 return true if this leaves no refrences to the object. This also checks the NoRemove flag.
BooleanT BodyMightBeDeleted() const: Returns TRUE if the reference counted part of the object can be deleted, ie. flag NOREMOVE is false .
BooleanT IsCountZero() const: Are there any refrences left ?
BooleanT BRCPtrCanDeleteObject() const: Used by BRRCPtrC to establish if an object has ZERO refrences and can be deleted.
IntT Count() const: Returns the current state of the counter, ie. how many references to this object exist.
const BodyRefCounterC & operator=(const BodyRefCounterC & b): It has not meaning to assign object 'b' to this object because it would destroy a history of the object which is counted. So this is a dummy function.
BooleanT IsValidObject() const: Test if object is valid.
When amma check is disabled this always returns true.
BooleanT UserBitTest(IntT x) const: Test user flag.
void UserBitSet(IntT x,BooleanT setit = TRUE): Test user flag.
void UserBitZero(IntT x): Set bit to zero.
void ReportBRCError(char * Msg): Report error, used in BRCPtrC.
UIntT Hash() const: Hash on address of object.

#include "amma/RefCBase.hh"

LabelT Label() const: Returns the label of this reference counter.
The member function is useful mainly to recognize objects during debugging. The value of the label is uniquely defined pointer.

Programmer:Charles Galambos, Documentation by CxxDoc: Tue Mar 20 10:48:08 2001

FileFormatGFSetBodyC

GF File format information.

include	"amma/DP/FileFormatGFSet.hh"
User Level:	Default
Library:	DPGeomIO
Example:	exDPSplit.cc
Section:	default.Charles Galambos
In Scope:	std