MIP SDK — C++ 1.18
API Reference Documentation for C++
Loading...
Searching...
No Matches
MetadataAction Class Referenceabstract

An Action that adds metadata information to the content. More...

#include <mip/upe/metadata_action.h>

Inheritance diagram for MetadataAction:
Action

Public Member Functions

virtual const std::vector< std::string > & GetMetadataToRemove () const =0
 Get the list of names of metadata that should be removed from content.
 
virtual const std::vector< MetadataEntry > & GetMetadataToAdd () const =0
 Get the metadata name/value pairs that should be added to the content.
 
virtual ~MetadataAction ()
 
- Public Member Functions inherited from Action
virtual ActionType GetType () const =0
 Get the type of Action.
 
virtual ~Action ()
 
virtual void Link ()
 
virtual const std::string & GetId () const
 
virtual bool operator== (const Action &action) const
 

Protected Member Functions

 MetadataAction (const std::string &id)
 
- Protected Member Functions inherited from Action
virtual bool IsEqual (const Action &action) const =0
 
 Action ()
 
 Action (const std::string &id)
 

Detailed Description

An Action that adds metadata information to the content.

Constructor & Destructor Documentation

◆ ~MetadataAction()

virtual MetadataAction::~MetadataAction ( )
inlinevirtual

◆ MetadataAction()

MetadataAction::MetadataAction ( const std::string & id)
inlineprotected

Member Function Documentation

◆ GetMetadataToAdd()

virtual const std::vector< MetadataEntry > & MetadataAction::GetMetadataToAdd ( ) const
pure virtual

Get the metadata name/value pairs that should be added to the content.

Returns
const std::vector<MetadataEntry>&
Note
Removing metadata should be done before adding metadata.

◆ GetMetadataToRemove()

virtual const std::vector< std::string > & MetadataAction::GetMetadataToRemove ( ) const
pure virtual

Get the list of names of metadata that should be removed from content.

Returns
a vector of strings to remove.
Note
Removing metadata should be done before adding metadata.

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