Ardour  9.0-pre0-582-g084a23a80d
Public Types | Public Member Functions | Public Attributes | Private Types | Private Member Functions | Static Private Member Functions | Private Attributes | Friends | List of all members
ARDOUR::ExportFilename Class Reference

#include <export_filename.h>

Public Types

enum  DateFormat {
  D_None , D_ISO , D_ISOShortY , D_BE ,
  D_BEShortY
}
 
enum  TimeFormat { T_None , T_NoDelim , T_Delim }
 

Public Member Functions

XMLNode & get_state () const
 
int set_state (const XMLNode &)
 
std::string get_path (ExportFormatSpecPtr format) const
 
std::string get_folder () const
 
TimeFormat get_time_format () const
 
DateFormat get_date_format () const
 
std::string get_time_format_str (TimeFormat format) const
 
std::string get_date_format_str (DateFormat format) const
 
std::string get_label () const
 
uint32_t get_revision () const
 
void set_time_format (TimeFormat format)
 
void set_date_format (DateFormat format)
 
void set_label (std::string value)
 
void set_revision (uint32_t value)
 
void set_channel (uint32_t value)
 
bool set_folder (std::string path)
 
void set_timespan (ExportTimespanPtr ts)
 
void set_channel_config (ExportChannelConfigPtr cc)
 

Public Attributes

bool include_label
 
bool include_session
 
bool use_session_snapshot_name
 
bool include_revision
 
bool include_channel_config
 
bool include_format_name
 
bool include_channel
 
bool include_timespan
 
bool include_time
 
bool include_date
 

Private Types

typedef std::pair< bool, std::string > FieldPair
 

Private Member Functions

 ExportFilename (Session &session)
 
std::string get_formatted_time (std::string const &format) const
 
FieldPair get_field (XMLNode const &node, std::string const &name)
 
FieldPair analyse_folder () const
 

Static Private Member Functions

static void add_field (XMLNode *node, std::string const &name, bool enabled, std::string const &value="")
 

Private Attributes

Session & session
 
std::string label
 
uint32_t revision
 
uint32_t channel
 
std::string folder
 
DateFormat date_format
 
TimeFormat time_format
 
struct tm time_struct
 
ExportTimespanPtr timespan
 
ExportChannelConfigPtr channel_config
 

Friends

class ExportElementFactory
 

Detailed Description

Definition at line 35 of file export_filename.h.

Member Typedef Documentation

◆ FieldPair

typedef std::pair<bool, std::string> ARDOUR::ExportFilename::FieldPair
private

Definition at line 121 of file export_filename.h.

Member Enumeration Documentation

◆ DateFormat

enum ARDOUR::ExportFilename::DateFormat
Enumerator
D_None 
D_ISO 
D_ISOShortY 
D_BE 
D_BEShortY 

Definition at line 38 of file export_filename.h.

◆ TimeFormat

enum ARDOUR::ExportFilename::TimeFormat
Enumerator
T_None 
T_NoDelim 
T_Delim 

Definition at line 46 of file export_filename.h.

Constructor & Destructor Documentation

◆ ExportFilename()

ARDOUR::ExportFilename::ExportFilename ( Session &  session)
private

Member Function Documentation

◆ add_field()

static void ARDOUR::ExportFilename::add_field ( XMLNode *  node,
std::string const &  name,
bool  enabled,
std::string const &  value = "" 
)
staticprivate

◆ analyse_folder()

FieldPair ARDOUR::ExportFilename::analyse_folder ( ) const
private

◆ get_date_format()

DateFormat ARDOUR::ExportFilename::get_date_format ( ) const
inline

Definition at line 68 of file export_filename.h.

◆ get_date_format_str()

std::string ARDOUR::ExportFilename::get_date_format_str ( DateFormat  format) const

◆ get_field()

FieldPair ARDOUR::ExportFilename::get_field ( XMLNode const &  node,
std::string const &  name 
)
private

◆ get_folder()

std::string ARDOUR::ExportFilename::get_folder ( ) const
inline

Definition at line 65 of file export_filename.h.

◆ get_formatted_time()

std::string ARDOUR::ExportFilename::get_formatted_time ( std::string const &  format) const
private

◆ get_label()

std::string ARDOUR::ExportFilename::get_label ( ) const
inline

Definition at line 72 of file export_filename.h.

◆ get_path()

std::string ARDOUR::ExportFilename::get_path ( ExportFormatSpecPtr  format) const

◆ get_revision()

uint32_t ARDOUR::ExportFilename::get_revision ( ) const
inline

Definition at line 73 of file export_filename.h.

◆ get_state()

XMLNode& ARDOUR::ExportFilename::get_state ( ) const

◆ get_time_format()

TimeFormat ARDOUR::ExportFilename::get_time_format ( ) const
inline

Definition at line 67 of file export_filename.h.

◆ get_time_format_str()

std::string ARDOUR::ExportFilename::get_time_format_str ( TimeFormat  format) const

◆ set_channel()

void ARDOUR::ExportFilename::set_channel ( uint32_t  value)
inline

Definition at line 81 of file export_filename.h.

◆ set_channel_config()

void ARDOUR::ExportFilename::set_channel_config ( ExportChannelConfigPtr  cc)
inline

Definition at line 85 of file export_filename.h.

◆ set_date_format()

void ARDOUR::ExportFilename::set_date_format ( DateFormat  format)

◆ set_folder()

bool ARDOUR::ExportFilename::set_folder ( std::string  path)

◆ set_label()

void ARDOUR::ExportFilename::set_label ( std::string  value)

◆ set_revision()

void ARDOUR::ExportFilename::set_revision ( uint32_t  value)
inline

Definition at line 80 of file export_filename.h.

◆ set_state()

int ARDOUR::ExportFilename::set_state ( const XMLNode &  )

◆ set_time_format()

void ARDOUR::ExportFilename::set_time_format ( TimeFormat  format)

◆ set_timespan()

void ARDOUR::ExportFilename::set_timespan ( ExportTimespanPtr  ts)
inline

Definition at line 84 of file export_filename.h.

Friends And Related Function Documentation

◆ ExportElementFactory

friend class ExportElementFactory
friend

Definition at line 53 of file export_filename.h.

Member Data Documentation

◆ channel

uint32_t ARDOUR::ExportFilename::channel
private

Definition at line 106 of file export_filename.h.

◆ channel_config

ExportChannelConfigPtr ARDOUR::ExportFilename::channel_config
private

Definition at line 117 of file export_filename.h.

◆ date_format

DateFormat ARDOUR::ExportFilename::date_format
private

Definition at line 110 of file export_filename.h.

◆ folder

std::string ARDOUR::ExportFilename::folder
private

Definition at line 108 of file export_filename.h.

◆ include_channel

bool ARDOUR::ExportFilename::include_channel

Definition at line 95 of file export_filename.h.

◆ include_channel_config

bool ARDOUR::ExportFilename::include_channel_config

Definition at line 93 of file export_filename.h.

◆ include_date

bool ARDOUR::ExportFilename::include_date

Definition at line 98 of file export_filename.h.

◆ include_format_name

bool ARDOUR::ExportFilename::include_format_name

Definition at line 94 of file export_filename.h.

◆ include_label

bool ARDOUR::ExportFilename::include_label

Definition at line 89 of file export_filename.h.

◆ include_revision

bool ARDOUR::ExportFilename::include_revision

Definition at line 92 of file export_filename.h.

◆ include_session

bool ARDOUR::ExportFilename::include_session

Definition at line 90 of file export_filename.h.

◆ include_time

bool ARDOUR::ExportFilename::include_time

Definition at line 97 of file export_filename.h.

◆ include_timespan

bool ARDOUR::ExportFilename::include_timespan

Definition at line 96 of file export_filename.h.

◆ label

std::string ARDOUR::ExportFilename::label
private

Definition at line 104 of file export_filename.h.

◆ revision

uint32_t ARDOUR::ExportFilename::revision
private

Definition at line 105 of file export_filename.h.

◆ session

Session& ARDOUR::ExportFilename::session
private

Definition at line 102 of file export_filename.h.

◆ time_format

TimeFormat ARDOUR::ExportFilename::time_format
private

Definition at line 111 of file export_filename.h.

◆ time_struct

struct tm ARDOUR::ExportFilename::time_struct
private

Definition at line 113 of file export_filename.h.

◆ timespan

ExportTimespanPtr ARDOUR::ExportFilename::timespan
private

Definition at line 116 of file export_filename.h.

◆ use_session_snapshot_name

bool ARDOUR::ExportFilename::use_session_snapshot_name

Definition at line 91 of file export_filename.h.

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