|
Developer Documentation |
|
Centre for Vision, Speech & Signal Processing |
Parent Classes:
Methods:
- DPOImageRGBC(const StringC & fn)
-
Constructor from filename.
- DPOImageRGBC(const OStreamC & nStrm,const Index2dC & size = Index2dC(576,720))
-
Constructor from stream
- const DPOSPortC<ImageC<ByteRGBValueC>> & operator=(const DPOSPortC<ImageC<ByteRGBValueC>> & obj)
-
Assigment.
- DPOPortBodyC<ImageC<ByteRGBValueC>> & Body()
-
Access body.
- const DPOPortBodyC<ImageC<ByteRGBValueC>> & Body() const
-
Access body.
- BooleanT Put(const ImageC<ByteRGBValueC> & dat)
-
Put data to stream
Returns true if data is put into stream succesfully.
- IntT PutArray(const SArray1dC<ImageC<ByteRGBValueC>> & data)
-
Put an array of data elements into a stream.
returns the number of elements processed from the array.
- BooleanT IsPutReady() const
-
Is port ready for data ?
- BooleanT Seek(UIntT off)
-
Seek to location in stream.
Returns FALSE, if seek failed. (Maybe because its
not implemented.)
if an error occurered (Seek returned False) then stream
position will not be changed.
- BooleanT DSeek(IntT off)
-
Delta Seek, goto location relative to the current one.
The default behavour of this functions is :
Do some error checking then:
Seek((UIntT)((IntT) Tell() + off));
if an error occurered (DSeek returned False) then stream
position will not be changed.
- UIntT Tell() const
-
Find current location in stream.
Defined as the index of the next object to be written or read.
May return ((UIntT) (-1)) if not implemented.
- UIntT Size() const
-
Find the total size of the stream. (assuming it starts from 0)
May return ((UIntT) (-1)) if not implemented.
- UIntT Start() const
-
Find the offset where the stream begins, normally zero.
Defaults to 0
- DPSeekCtrlBodyC & Body()
-
Access body class.
- const DPSeekCtrlBodyC & Body() const
-
Access body class.
- DPOPortBaseBodyC & Body()
-
Access body.
- const DPOPortBaseBodyC & Body() const
-
Access body.
- void PutEOS()
-
Put End Of Stream marker.
- const type_info & OutputType() const
-
Get type of output port.
- const DPEntityC & operator=(const DPEntityC & dat)
-
Assignment.
- DPEntityBodyC & Body()
-
Access body.
- const DPEntityBodyC & Body() const
-
Access body.
- BooleanT Save(ostream & out) const
-
- DPPortBodyC & Body()
-
Access body.
- const DPPortBodyC & Body() const
-
Access body.
- BooleanT IsAsync() const
-
Does port work asynchronously ??
- DPPortC ConnectedTo() const
-
Is this port connected to another ?
If not returns invalid handle.
- BooleanT GetAttr(const StringC & attrName,StringC & attrValue)
-
Get a stream attribute.
Returns false if the attribute name is unknown.
This is for handling stream attributes such as frame rate, and compression ratios.
- BooleanT SetAttr(const StringC & attrName,const StringC & attrValue)
-
Set a stream attribute.
Returns false if the attribute name is unknown.
This is for handling stream attributes such as frame rate, and compression ratios.
- 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:
- const DPEntityC & operator=(const DPEntityC & dat)
-
Assignment.
- DPEntityBodyC & Body()
-
Access body.
- const DPEntityBodyC & Body() const
-
Access body.
- BooleanT Save(ostream & out) const
-
- 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.
|
Programmer:Charles Galambos, Documentation by CxxDoc: Tue Mar 20 10:49:27 2001
|