Developer Documentation
Developer Documentation
USER IN NAMESPACE AMMA TREE ROOT AMMA SEARCH AMMA HOME
 

namespace StdIO
AMMA Configureation information.

User Level:Default
Library: Mtype

Comments:

Endian of machine. Compiler information GPUG_NEWTEMPLATE - New template friend functions with extra <>'s CPUG_ANSICPPHEADERS - Use std headers without .h extention CPUG_USEEXECPTIONHDR - Use header CPUG_USEPOSIXTHREADS - Use posix style reentrant functions. CPUG_HASUNIXDIRFUNCS - OS has unix style directory functions. We appear to have posix threads everywhere now.

Child Classes:

#include "amma/DP/SubSequenceSpec.hh"

SubSequenceSpecC Specification for sub sequence.
SubSequenceSpecBodyC Specification for sub sequence.
#include "amma/DP/EditSpec.hh"

EditSpecBodyC Edit spec.
EditSpecC Edit spec.
#include "amma/DP/PlayList.hh"

PlayListBodyC Play list body
PlayListC Play list.
#include "amma/DP/CompositeStream.hh"

CompositeStreamBaseBodyC Stream Composition base class.
CompositeIStreamBodyC Input Stream Composition.
CompositeIStreamC Input Stream Composition.
CompositeOStreamBodyC Output Stream Composition body
CompositeOStreamC Output Stream Composition.
#include "amma/DP/FileFormatComposite.hh"

FileFormatCompositeBodyC Stream File Format.
FileFormatCompositeC Create an instance of a stream File Format.
#include "amma/ConfigFile.hh"

ConfigFileC Config file.
ConfigFileBodyC Iterate variables. Config file body.
#include "amma/Packet.hh"

NetPacketC High level network packet.
#include "amma/NetEndPoint.hh"

NetEndPointC An end point for a network packet base protocol.
NetEndPointBodyC An end point for a network packet base protocol.
#include "amma/NetMessage.hh"

NetMsgRegisterBodyC Net message body.
NetMsgRegisterC Net message handle.
#include "amma/NetMsgCall.hh"

NetMsgCall0BodyC
NetMsgCall0C
NetMsgCall1BodyC
NetMsgCall1C
NetMsgCall2BodyC
NetMsgCall2C
#include "amma/NetMsgSig.hh"
NetMsgSig0BodyC Net message Signal0
NetMsgSig0C Net message Signal0
NetMsgSig1BodyC Net message Signal1
NetMsgSig1C Net message Signal1
NetMsgSig2BodyC
NetMsgSig2C
Typedefs:

#include "amma/ConfigFile.hh"
typedef HashIterC<StringC,StringC> ConfigFileIterVarC;
Iterate variables. Config file body.

Variables:

#include "amma/DP/BinFileIO.hh"
const UInt16T AMMABinaryID = 0x4142;
AB Amma Binary file id.

Methods:

#include "amma/Config.hh"
const char * InstallDirectory()
Location where project has been installed.

const char * Arch()
Architecture ID.
e.g. sol2,linux,sgi,alpha_linux

bool CheckingEnabled()
Internal checking enabled ?

char * ConfigFlags()
Configuration flags.
GNU NDEBUG AMMA_CHECK UNIX

bool SMPSafe()
Is this version of AMMA SMP safe ?
Currently TRUE on sol2,linux and sgi

#include "amma/EntryPnt.hh"
bool UsingStdMain()
Are we using AMMA_ENTRY_POINT.
Used to decide how to handle some internal errors.

int StdMain(int argc,char * argv[],ScopePath (*)(FuncArgList) func)
Call through function.

#include "amma/DP/FileFormat.hh"
DListC<FileFormatBaseC> & Formats()
Get list of supported file formats.

HashARC<StringC,DListC<FileFormatBaseC>> & FormatByName()
Map format name to a list of actual formats.

FileFormatBaseC FindFormat(BooleanT forLoad,StringC formatName,const type_info & atype = typeid(void),BooleanT useInDirect = TRUE)
Find a format.
This can be input or output.

FileFormatBaseC FindFormat(BooleanT forLoad,const FilenameC & filename,const type_info & atype = typeid(void),StringC formatName = "",BooleanT useInDirect = TRUE)
Find the format of the file.
This can be input or output.

FileFormatBaseC FindFormat(IStreamC & in,const type_info & atype = typeid(void),StringC formatName = "",BooleanT useInDirect = TRUE)
Find the format of the file.
This can only be input.

BooleanT FindInputFormat(FileFormatDescC & fmtInfo,StringC filename,StringC format,const type_info & obj_type,BooleanT verbose = FALSE)
Search for input format.

BooleanT FindOutputFormat(FileFormatDescC & fmtInfo,StringC filename,StringC format,const type_info & obj_type,BooleanT verbose = FALSE)
Search for output format.

DPIPortBaseC CreateInput(StringC filename,StringC format,const type_info & obj_type,BooleanT verbose = FALSE)
Create an input pipe.
if obj_type is typeid(void), then the default load type of the file is used.

DPOPortBaseC CreateOutput(StringC filename,StringC format,const type_info & obj_type,BooleanT verbose = FALSE)
Create an input pipe.

DPIPortBaseC CreateInput(IStreamC & from,StringC format,const type_info & obj_type,BooleanT verbose = FALSE)
Create an input pipe.
if obj_type is typeid(void), then the default load type of the file is used.

DPOPortBaseC CreateOutput(OStreamC & to,StringC format,const type_info & obj_type,BooleanT verbose = FALSE)
Create an input pipe.

#include "amma/DP/TypeInfo.hh"
const DPTypeInfoC & TypeInfo(const type_info & ti)
Access extra information about a type.

const DPTypeInfoC & TypeInfo(const char * tn)
Access extra information about a type.

#include "amma/DP/FileFormatIO.hh"
BooleanT Load(const FilenameC & filename,DataT & obj,StringC fileformat = "",BooleanT verbose = FALSE)
Load a single object.
filenamename of file containing object
objname of C++ object
fileformatformat of object file. If fileformat string is empty, the file format is detected automatically. To get a list of file formats, type conv -lf
verbose if true, a message is printed to stdout describing the filename, the format used, the object type being loaded and any status information.
More information here

BooleanT Save(const FilenameC & filename,const DataT & obj,StringC fileformat = "",BooleanT verbose = FALSE)
Save a single object.
filenamename of file containing object
objname of C++ object
fileformatformat of object file. If fileformat string is empty, the file format is detected automatically. To get a list of file formats, type conv -lf
verbose if true, a message is printed to stdout describing the filename, the format used, the object type being loaded and any status information.
More information here

BooleanT Load(IStreamC & is,DataT & obj,StringC fileformat = "",BooleanT verbose = FALSE)
Load a single object from a stream
osstream from which to load object.
objname of C++ object
fileformatformat of object file. If fileformat string is empty, the file format is detected automatically. To get a list of file formats, type conv -lf
verbose if true, a message is printed to stdout describing the filename, the format used, the object type being loaded and any status information.
More information here

BooleanT Save(OStreamC & os,const DataT & obj,StringC fileformat = "",BooleanT verbose = FALSE)
Save a single object to a stream
osWhere to save the stream to.
objname of C++ object
fileformatformat of object file. If fileformat string is empty, the file format is detected automatically. To get a list of file formats, type conv -lf
verbose if true, a message is printed to stdout describing the filename, the format used, the object type being loaded and any status information.
More information here

BooleanT Load(const FilenameC & filename,RCWrapBaseC & obj,StringC fileformat,BooleanT verbose)
Load to an abstract object handle.
NB. an instace of TypeInfoInstC must exists for the contained class if this is to work.

BooleanT Save(const FilenameC & filename,const RCWrapBaseC & obj,StringC fileformat,BooleanT verbose)
Save an abstract object handle.
NB. an instace of TypeInfoInstC must exists for the contained class if this is to work.

DListC<FileFormatBaseC> ListFormats(BooleanT forLoad,const StringC & fileFormat = "",const type_info & typespec = typeid(void))
List all file formats that support the given type.
forLoad == TRUE, then for load. forLoad == FALSE, then for save.

If fileFormat string is empty then all file formats are listed.

If typespec is void then all types are listed.


FileFormatBaseC Identify(const FilenameC & afile)
Identify a file.
If file format is unrecognised the returned FileFormatBaseC will be an invalid handle.

FileFormatBaseC Identify(IStreamC & is)
Identify a stream.
If file format is unrecognised the returned FileFormatBaseC will be an invalid handle.

DPIPortBaseC BaseLoad(const FilenameC & filename,StringC fformat,const type_info & obj_type,BooleanT verbose = FALSE)
Base load function.
If fileformat string is empty, the file format is detected automaticly. When verbose flag is TRUE, a message is printed to stdout describing the filename, the format used and the object type being loaded.

DPOPortBaseC BaseSave(const FilenameC & filename,StringC fformat,const type_info & obj_type,BooleanT verbose = FALSE)
Base save function.
If fileformat string is empty, the default file format for the type is used. When verbose flag is TRUE, a message is printed to stdout describing the filename, the format used and the object type being saved.

DPIPortBaseC BaseLoad(IStreamC & is,StringC fformat,const type_info & obj_type,BooleanT verbose = FALSE)
Base load function for streams.
If fileformat string is empty, the file format is detected automaticly. When verbose flag is TRUE, a message is printed to stdout describing the filename, the format used and the object type being loaded.

DPOPortBaseC BaseSave(OStreamC & os,StringC fformat,const type_info & obj_type,BooleanT verbose = FALSE)
Base save function for streams
If fileformat string is empty, the default file format for the type is used. When verbose flag is TRUE, a message is printed to stdout describing the filename, the format used and the object type being saved.

#include "amma/DP/SequenceIO.hh"
BooleanT OpenISequenceBase(DPIPortBaseC & ip,DPSeekCtrlC & sc,const StringC & filename,const StringC & fileformat,const type_info & obj_type,BooleanT verbose = FALSE)
Open input stream base.
Returns TRUE on succcess.

BooleanT OpenOSequenceBase(DPOPortBaseC & op,DPSeekCtrlC & sc,const StringC & filename,const StringC & fileformat,const type_info & obj_type,BooleanT verbose = FALSE)
Open output stream base.
Returns TRUE on succcess.

BooleanT OpenOSequence(DPOSPortC<DataT> & op,const StringC & fn,const StringC & fileformat = "",BooleanT verbose = FALSE)
Open a seekable output stream.
- Not all streams are seekable, the seek/tell functions are not garanteed to work for all formats.

- If a fileformat is a zero length string, all formats are considered. Returns TRUE on succcess.


BooleanT OpenISequence(DPISPortC<DataT> & ip,const StringC & fn,const StringC & fileformat = "",BooleanT verbose = FALSE)
Open a seekable input stream.
Note: Not all streams are seekable, the seek/tell functions are not garanteed to work for all formats.

- If a fileformat is a zero length string, all formats are considered. Returns TRUE on succcess.


BooleanT OpenOSequence(DPOPortC<DataT> & op,const StringC & fn,const StringC & fileformat = "",BooleanT verbose = FALSE)
Open a normal output stream
- If a fileformat is a zero length string, all formats are considered. Returns TRUE on succcess.

BooleanT OpenISequence(DPIPortC<DataT> & ip,const StringC & fn,const StringC & fileformat = "",BooleanT verbose = FALSE)
Open a normal input stream
- If a fileformat is a zero length string, all formats are considered. Returns TRUE on succcess.

#include "amma/DP/SubSequenceSpec.hh"
ostream & operator<<(ostream & strm,const SubSequenceSpecC & str)
Output to ostream.

istream & operator>>(istream & strm,SubSequenceSpecC & str)
Input from istream.

BinOStreamC & operator<<(BinOStreamC & strm,const SubSequenceSpecC & str)
Output to BinOStreamC.

BinIStreamC & operator>>(BinIStreamC & strm,SubSequenceSpecC & str)
Input from BinIStreamC.

#include "amma/DP/PlayList.hh"
ostream & operator<<(ostream & strm,const PlayListC & str)
Output to ostream.

istream & operator>>(istream & strm,PlayListC & str)
Input from istream.

BinOStreamC & operator<<(BinOStreamC & strm,const PlayListC & str)
Output to BinOStreamC.

BinIStreamC & operator>>(BinIStreamC & strm,PlayListC & str)
Input from BinIStreamC.

#include "amma/Packet.hh"
BinOStreamC & operator<<(BinOStreamC & strm,const NetPacketC & pkt)

BinIStreamC & operator>>(BinIStreamC & strm,NetPacketC & pkt)

#include "amma/NumImage.hh"
BooleanT Load(const FilenameC & filename,NumImageC<DataT> & obj,StringC fileformat = "",BooleanT verbose = FALSE)

BooleanT Save(const FilenameC & filename,const NumImageC<DataT> & obj,StringC fileformat = "",BooleanT verbose = FALSE)

#include "amma/Thread/Ticker.hh"
TickerC Ticker(RealT delay,ScopePath (*)(FuncArgList) func,const DataT & dat = DataT())


Documentation by CxxDoc: Tue Mar 20 10:50:54 2001
Centre for Vision, Speech & Signal Processing