OpalMediaOption Class Reference

#include <mediafmt.h>

Inheritance diagram for OpalMediaOption:

OpalMediaOptionEnum OpalMediaOptionOctets OpalMediaOptionString OpalMediaOptionValue< T >

List of all members.

Public Types

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

Public Member Functions

virtual Comparison Compare (const PObject &obj) const
virtual 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 PString &name)
 OpalMediaOption (const char *name, bool readOnly, MergeType merge)

Protected Attributes

PCaselessString m_name
bool m_readOnly
MergeType m_merge


Detailed Description

Base class for options attached to an OpalMediaFormat.

Member Enumeration Documentation

Enumerator:
NoMerge 
MinMerge 
MaxMerge 
EqualMerge 
NotEqualMerge 
AlwaysMerge 
AndMerge 
OrMerge 


Constructor & Destructor Documentation

OpalMediaOption::OpalMediaOption ( const PString &  name  )  [protected]

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


Member Function Documentation

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

virtual bool OpalMediaOption::Merge ( const OpalMediaOption option  )  [virtual]

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

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

PString OpalMediaOption::AsString (  )  const

bool OpalMediaOption::FromString ( const PString &  value  ) 

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

References m_name.

bool OpalMediaOption::IsReadOnly (  )  const [inline]

References m_readOnly.

void OpalMediaOption::SetReadOnly ( bool  readOnly  )  [inline]

References m_readOnly.

MergeType OpalMediaOption::GetMerge (  )  const [inline]

References m_merge.

void OpalMediaOption::SetMerge ( MergeType  merge  )  [inline]

References m_merge.


Member Data Documentation

PCaselessString OpalMediaOption::m_name [protected]

Referenced by GetName().

bool OpalMediaOption::m_readOnly [protected]

Referenced by IsReadOnly(), and SetReadOnly().

Referenced by GetMerge(), and SetMerge().


The documentation for this class was generated from the following file:

Generated on Fri Dec 11 06:24:15 2009 for OPAL by  doxygen 1.5.6