OpalMediaOption Class Reference

#include <mediafmt.h>

Inheritance diagram for OpalMediaOption:

OpalMediaOptionEnum OpalMediaOptionString OpalMediaOptionValue< T > List of all members.

Public Types

enum  MergeType {
  NoMerge, MinMerge, MaxMerge, EqualMerge,
  NotEqualMerge, AlwaysMerge, AndMerge = MaxMerge, OrMerge = MinMerge,
  XorMerge = NotEqualMerge, NotXorMerge = EqualMerge
}

Public Member Functions

virtual Comparison Compare (const PObject &obj) const
bool Merge (const OpalMediaOption &option)
virtual Comparison CompareValue (const OpalMediaOption &option) const =0
virtual void Assign (const OpalMediaOption &option)=0
PString AsString () const
bool FromString (const PString &value)
const PString & GetName () const
bool IsReadOnly () const
void SetReadOnly (bool readOnly)
MergeType GetMerge () const
void SetMerge (MergeType merge)

Protected Member Functions

 OpalMediaOption (const char *name, bool readOnly, MergeType merge)

Protected Attributes

PString m_name
bool m_readOnly
MergeType m_merge

Detailed Description

Base class for options attached to an OpalMediaFormat.


Member Enumeration Documentation

enum OpalMediaOption::MergeType
 

Enumerator:
NoMerge 
MinMerge 
MaxMerge 
EqualMerge 
NotEqualMerge 
AlwaysMerge 
AndMerge 
OrMerge 
XorMerge 
NotXorMerge 


Constructor & Destructor Documentation

OpalMediaOption::OpalMediaOption const char *  name,
bool  readOnly,
MergeType  merge
[protected]
 


Member Function Documentation

virtual void OpalMediaOption::Assign const OpalMediaOption option  )  [pure virtual]
 

Implemented in OpalMediaOptionValue< T >, OpalMediaOptionEnum, and OpalMediaOptionString.

PString OpalMediaOption::AsString  )  const
 

virtual Comparison OpalMediaOption::Compare const PObject &  obj  )  const [virtual]
 

virtual Comparison OpalMediaOption::CompareValue const OpalMediaOption option  )  const [pure virtual]
 

Implemented in OpalMediaOptionValue< T >, OpalMediaOptionEnum, and OpalMediaOptionString.

bool OpalMediaOption::FromString const PString &  value  ) 
 

MergeType OpalMediaOption::GetMerge  )  const [inline]
 

const PString& OpalMediaOption::GetName  )  const [inline]
 

bool OpalMediaOption::IsReadOnly  )  const [inline]
 

bool OpalMediaOption::Merge const OpalMediaOption option  ) 
 

void OpalMediaOption::SetMerge MergeType  merge  )  [inline]
 

void OpalMediaOption::SetReadOnly bool  readOnly  )  [inline]
 


Member Data Documentation

MergeType OpalMediaOption::m_merge [protected]
 

PString OpalMediaOption::m_name [protected]
 

bool OpalMediaOption::m_readOnly [protected]
 


The documentation for this class was generated from the following file:
Generated on Mon Jan 7 22:32:53 2008 for OPAL by  doxygen 1.4.6