PartitionInfo Class Reference

Holds RIP data relating to a single partition. More...

#include <rip.h>

Inheritance diagram for PartitionInfo:

RefCount IRefCount List of all members.

Public Member Functions

 PartitionInfo (PartitionPtr Part=NULL, Position Offset=-1, UInt32 SID=0)
 PartitionInfo constructor.
bool operator< (PartitionInfo &Other)
 Comparison function to allow sorting.
PartitionPtrGetPartition (void)
 Get a pointer to the actual partition.
void SetPartition (PartitionPtr Val)
 Set the actual partition.
UInt32 GetBodySID (void) const
 Get the BodySID.
void SetBodySID (UInt32 Val)
 Set the BodySID.
UInt32 GetIndexSID (void) const
 Get the IndexSID.
void SetIndexSID (UInt32 Val)
 Set the IndexSID.
bool SIDsKnown (void) const
 Get KnownSIDs flag.
void SetKnownSIDs (bool Val)
 Set KnownSIDs flag.
void SetSIDs (UInt32 NewBodySID, UInt32 NewIndexSID)
 Set BodySID and IndexSID, and set KnownSIDs to true.
Position GetByteOffset (void) const
 Get the byte offset of this partition pack in the file (if known), or -1 if not known.
void SetByteOffset (Position Val)
 Set the byte offset of this partition pack in the file (if known), or -1 if not known.
Position GetStreamOffset (void) const
 Get the stream offset of the first data byte in this partition (if known), or -1 if not known.
void SetStreamOffset (Position Val)
 Set the stream offset of the first data byte in this partition (if known), or -1 if not known.
Position GetEstimatedStreamOffset (void) const
 Get the estimated stream offset of the first data byte in this partition (if known), or -1 if no idea.
void SetEstimatedStreamOffset (Position Val)
 Set the estimated stream offset of the first data byte in this partition (if known), or -1 if no idea.
Position GetEssenceStart (void) const
 Get the essence start as a byte offset in the file (if known), or -1 if not known.
void SetEssenceStart (Position Val)
 Set the essence start as a byte offset in the file (if known), or -1 if not known.

Public Attributes

PartitionPtr ThePartition
 The actual partition.
Position ByteOffset
 Byte offset into the file for the start of this partition.
UInt32 BodySID
 Stream ID of any essence in this partition (0 if none).

Protected Attributes

UInt32 IndexSID
 Index SID of any index table in this partition (0 if none or not known).
bool KnownSIDs
 Set true once we know for sure what the SIDs are, including IndexSID.
Position StreamOffset
 Stream offset of the first byte of essence, or generic stream, data in the partition.
Length StreamByteCount
 Count of stream data bytes in the partition.
Position EstStreamOffset
 Estimated Stream offset of the first byte of essence, or generic stream, data in the partition
Length EstStreamByteCount
 Estimated Count of stream data bytes in the partition
Position EssenceStart
 Actual byte offset in the file where the essence starts for this partition, if known, else -1.

Detailed Description

Holds RIP data relating to a single partition.


Constructor & Destructor Documentation

PartitionInfo ( PartitionPtr  Part = NULL,
Position  Offset = -1,
UInt32  SID = 0 
)

PartitionInfo constructor.


Member Function Documentation

bool operator< ( PartitionInfo Other  )  [inline]

Comparison function to allow sorting.

PartitionPtr& GetPartition ( void   )  [inline]

Get a pointer to the actual partition.

void SetPartition ( PartitionPtr  Val  )  [inline]

Set the actual partition.

UInt32 GetBodySID ( void   )  const [inline]

Get the BodySID.

void SetBodySID ( UInt32  Val  )  [inline]

Set the BodySID.

UInt32 GetIndexSID ( void   )  const [inline]

Get the IndexSID.

void SetIndexSID ( UInt32  Val  )  [inline]

Set the IndexSID.

bool SIDsKnown ( void   )  const [inline]

Get KnownSIDs flag.

void SetKnownSIDs ( bool  Val  )  [inline]

Set KnownSIDs flag.

void SetSIDs ( UInt32  NewBodySID,
UInt32  NewIndexSID 
) [inline]

Set BodySID and IndexSID, and set KnownSIDs to true.

Position GetByteOffset ( void   )  const [inline]

Get the byte offset of this partition pack in the file (if known), or -1 if not known.

void SetByteOffset ( Position  Val  )  [inline]

Set the byte offset of this partition pack in the file (if known), or -1 if not known.

Position GetStreamOffset ( void   )  const [inline]

Get the stream offset of the first data byte in this partition (if known), or -1 if not known.

void SetStreamOffset ( Position  Val  )  [inline]

Set the stream offset of the first data byte in this partition (if known), or -1 if not known.

Position GetEstimatedStreamOffset ( void   )  const [inline]

Get the estimated stream offset of the first data byte in this partition (if known), or -1 if no idea.

void SetEstimatedStreamOffset ( Position  Val  )  [inline]

Set the estimated stream offset of the first data byte in this partition (if known), or -1 if no idea.

Position GetEssenceStart ( void   )  const [inline]

Get the essence start as a byte offset in the file (if known), or -1 if not known.

void SetEssenceStart ( Position  Val  )  [inline]

Set the essence start as a byte offset in the file (if known), or -1 if not known.


Member Data Documentation

PartitionPtr ThePartition

The actual partition.

Note:
This is public for compatibility only ** use accessors **

Position ByteOffset

Byte offset into the file for the start of this partition.

Note:
This is public for compatibility only ** use accessors **

Version 11 of the MXF spec uses a UInt64 for this field but we are using a Position type here as it makes more sense, and allows distingushed value -1

Distinguished value -1 is used where the location in the file is not known

UInt32 BodySID

Stream ID of any essence in this partition (0 if none).

Note:
This is public for compatibility only ** use accessors **

0 is also used if the existance of essence is has not yet been determined

UInt32 IndexSID [protected]

Index SID of any index table in this partition (0 if none or not known).

bool KnownSIDs [protected]

Set true once we know for sure what the SIDs are, including IndexSID.

This will be false when we have read a version 1 RIP as all that is known is the SID, which could possibly be an index SID for index-only partitions, but will be true once we have either parsed the partition pack itself, written one ourselves, or read a version 2 RIP (complete with detailed partion layout)

Position StreamOffset [protected]

Stream offset of the first byte of essence, or generic stream, data in the partition.

Set to -1 if not known

Length StreamByteCount [protected]

Count of stream data bytes in the partition.

Set to -1 if not known

Position EstStreamOffset [protected]

Estimated Stream offset of the first byte of essence, or generic stream, data in the partition

Set to -1 if not known

Length EstStreamByteCount [protected]

Estimated Count of stream data bytes in the partition

Set to -1 if not known

Position EssenceStart [protected]

Actual byte offset in the file where the essence starts for this partition, if known, else -1.


The documentation for this class was generated from the following files:
Generated on Mon Apr 2 15:21:01 2007 for MXFLib by  doxygen 1.5.1-p1