This strategy ensures that the destructors for both the child and
the parent are called at the correct time, i.e. only when all
references to both the parent and all its children are gone. */
- shared_ptr<Parent> parent;
+ shared_ptr<Parent> _parent;
/* Weak pointer for shared_from_this() implementation. */
- weak_ptr<Class> weak_this;
+ weak_ptr<Class> _weak_this;
public:
/* Note, this implementation will create a new smart_ptr if none exists. */
{
shared_ptr<Class> shared;
- if (!(shared = weak_this.lock()))
+ if (!(shared = _weak_this.lock()))
{
shared = shared_ptr<Class>((Class *) this, reset_parent);
- weak_this = shared;
+ _weak_this = shared;
}
return shared;
{
if (!parent)
throw Error(SR_ERR_BUG);
- this->parent = parent;
+ this->_parent = parent;
return shared_from_this();
}
protected:
static void reset_parent(Class *object)
{
- if (!object->parent)
+ if (!object->_parent)
throw Error(SR_ERR_BUG);
- object->parent.reset();
+ object->_parent.reset();
}
- Struct *structure;
+ Struct *_structure;
ParentOwned<Class, Parent, Struct>(Struct *structure) :
- structure(structure)
+ _structure(structure)
{
}
};
return shared;
}
protected:
- Struct *structure;
+ Struct *_structure;
UserOwned<Class, Struct>(Struct *structure) :
- structure(structure)
+ _structure(structure)
{
}
/** Create new context */
static shared_ptr<Context> create();
/** libsigrok package version. */
- string get_package_version();
+ string package_version();
/** libsigrok library version. */
- string get_lib_version();
+ string lib_version();
/** Available hardware drivers, indexed by name. */
- map<string, shared_ptr<Driver> > get_drivers();
+ map<string, shared_ptr<Driver> > drivers();
/** Available input formats, indexed by name. */
- map<string, shared_ptr<InputFormat> > get_input_formats();
+ map<string, shared_ptr<InputFormat> > input_formats();
/** Available output formats, indexed by name. */
- map<string, shared_ptr<OutputFormat> > get_output_formats();
+ map<string, shared_ptr<OutputFormat> > output_formats();
/** Current log level. */
- const LogLevel *get_log_level();
+ const LogLevel *log_level();
/** Set the log level.
* @param level LogLevel to use. */
void set_log_level(const LogLevel *level);
/** Current log domain. */
- string get_log_domain();
+ string log_domain();
/** Set the log domain.
* @param value Log domain prefix string. */
void set_log_domain(string value);
* @param header Initial data from stream. */
shared_ptr<Input> open_stream(string header);
protected:
- map<string, Driver *> drivers;
- map<string, InputFormat *> input_formats;
- map<string, OutputFormat *> output_formats;
- Session *session;
- LogCallbackFunction log_callback;
+ map<string, Driver *> _drivers;
+ map<string, InputFormat *> _input_formats;
+ map<string, OutputFormat *> _output_formats;
+ Session *_session;
+ LogCallbackFunction _log_callback;
Context();
~Context();
friend class Deleter;
{
public:
/** Name of this driver. */
- string get_name();
+ string name();
/** Long name for this driver. */
- string get_long_name();
+ string long_name();
/** Scan for devices and return a list of devices found.
* @param options Mapping of (ConfigKey, value) pairs. */
vector<shared_ptr<HardwareDevice> > scan(
map<const ConfigKey *, Glib::VariantBase> options = {});
protected:
- bool initialized;
- vector<HardwareDevice *> devices;
+ bool _initialized;
+ vector<HardwareDevice *> _devices;
Driver(struct sr_dev_driver *structure);
~Driver();
friend class Context;
{
public:
/** Description identifying this device. */
- string get_description();
+ string description();
/** Vendor name for this device. */
- string get_vendor();
+ string vendor();
/** Model name for this device. */
- string get_model();
+ string model();
/** Version string for this device. */
- string get_version();
+ string version();
/** List of the channels available on this device. */
- vector<shared_ptr<Channel> > get_channels();
+ vector<shared_ptr<Channel> > channels();
/** Channel groups available on this device, indexed by name. */
- map<string, shared_ptr<ChannelGroup> > get_channel_groups();
+ map<string, shared_ptr<ChannelGroup> > channel_groups();
/** Open device. */
void open();
/** Close device. */
~Device();
virtual shared_ptr<Device> get_shared_from_this() = 0;
shared_ptr<Channel> get_channel(struct sr_channel *ptr);
- struct sr_dev_inst *structure;
- map<struct sr_channel *, Channel *> channels;
- map<string, ChannelGroup *> channel_groups;
+ struct sr_dev_inst *_structure;
+ map<struct sr_channel *, Channel *> _channels;
+ map<string, ChannelGroup *> _channel_groups;
/** Deleter needed to allow shared_ptr use with protected destructor. */
class Deleter
{
{
public:
/** Driver providing this device. */
- shared_ptr<Driver> get_driver();
+ shared_ptr<Driver> driver();
protected:
HardwareDevice(Driver *driver, struct sr_dev_inst *structure);
~HardwareDevice();
shared_ptr<Device> get_shared_from_this();
- Driver *driver;
+ Driver *_driver;
friend class Driver;
friend class ChannelGroup;
};
{
public:
/** Current name of this channel. */
- string get_name();
+ string name();
/** Set the name of this channel. *
* @param name Name string to set. */
void set_name(string name);
/** Type of this channel. */
- const ChannelType *get_type();
+ const ChannelType *type();
/** Enabled status of this channel. */
- bool get_enabled();
+ bool enabled();
/** Set the enabled status of this channel.
* @param value Boolean value to set. */
void set_enabled(bool value);
/** Get the index number of this channel. */
- unsigned int get_index();
+ unsigned int index();
protected:
Channel(struct sr_channel *structure);
~Channel();
- const ChannelType * const type;
+ const ChannelType * const _type;
friend class Device;
friend class ChannelGroup;
friend class Session;
{
public:
/** Name of this channel group. */
- string get_name();
+ string name();
/** List of the channels in this group. */
- vector<shared_ptr<Channel> > get_channels();
+ vector<shared_ptr<Channel> > channels();
protected:
ChannelGroup(Device *device, struct sr_channel_group *structure);
~ChannelGroup();
- vector<Channel *> channels;
+ vector<Channel *> _channels;
friend class Device;
};
{
public:
/** Name of this trigger configuration. */
- string get_name();
+ string name();
/** List of the stages in this trigger. */
- vector<shared_ptr<TriggerStage> > get_stages();
+ vector<shared_ptr<TriggerStage> > stages();
/** Add a new stage to this trigger. */
shared_ptr<TriggerStage> add_stage();
protected:
Trigger(shared_ptr<Context> context, string name);
~Trigger();
- shared_ptr<Context> context;
- vector<TriggerStage *> stages;
+ shared_ptr<Context> _context;
+ vector<TriggerStage *> _stages;
friend class Deleter;
friend class Context;
friend class Session;
{
public:
/** Index number of this stage. */
- int get_number();
+ int number();
/** List of match conditions on this stage. */
- vector<shared_ptr<TriggerMatch> > get_matches();
+ vector<shared_ptr<TriggerMatch> > matches();
/** Add a new match condition to this stage.
* @param channel Channel to match on.
* @param type TriggerMatchType to apply. */
* @param value Threshold value. */
void add_match(shared_ptr<Channel> channel, const TriggerMatchType *type, float value);
protected:
- vector<TriggerMatch *> matches;
+ vector<TriggerMatch *> _matches;
TriggerStage(struct sr_trigger_stage *structure);
~TriggerStage();
friend class Trigger;
{
public:
/** Channel this condition matches on. */
- shared_ptr<Channel> get_channel();
+ shared_ptr<Channel> channel();
/** Type of match. */
- const TriggerMatchType *get_type();
+ const TriggerMatchType *type();
/** Threshold value. */
- float get_value();
+ float value();
protected:
TriggerMatch(struct sr_trigger_match *structure, shared_ptr<Channel> channel);
~TriggerMatch();
- shared_ptr<Channel> channel;
+ shared_ptr<Channel> _channel;
friend class TriggerStage;
};
void run(const struct sr_dev_inst *sdi,
const struct sr_datafeed_packet *pkt);
protected:
- DatafeedCallbackFunction callback;
+ DatafeedCallbackFunction _callback;
DatafeedCallbackData(Session *session,
DatafeedCallbackFunction callback);
- Session *session;
+ Session *_session;
friend class Session;
};
bool run(int revents);
protected:
SourceCallbackData(shared_ptr<EventSource> source);
- shared_ptr<EventSource> source;
+ shared_ptr<EventSource> _source;
friend class Session;
};
SOURCE_FD,
SOURCE_POLLFD,
SOURCE_IOCHANNEL
- } type;
- int fd;
- Glib::PollFD pollfd;
- Glib::RefPtr<Glib::IOChannel> channel;
- Glib::IOCondition events;
- int timeout;
- SourceCallbackFunction callback;
+ } _type;
+ int _fd;
+ Glib::PollFD _pollfd;
+ Glib::RefPtr<Glib::IOChannel> _channel;
+ Glib::IOCondition _events;
+ int _timeout;
+ SourceCallbackFunction _callback;
/** Deleter needed to allow shared_ptr use with protected destructor. */
class Deleter
{
* @param device Device to add. */
void add_device(shared_ptr<Device> device);
/** List devices attached to this session. */
- vector<shared_ptr<Device> > get_devices();
+ vector<shared_ptr<Device> > devices();
/** Remove all devices from this session. */
void remove_devices();
/** Add a datafeed callback to this session.
/** Append raw logic data to the session file being saved. */
void append(void *data, size_t length, unsigned int unit_size);
/** Get current trigger setting. */
- shared_ptr<Trigger> get_trigger();
+ shared_ptr<Trigger> trigger();
/** Set trigger setting.
* @param trigger Trigger object to use. */
void set_trigger(shared_ptr<Trigger> trigger);
Session(shared_ptr<Context> context);
Session(shared_ptr<Context> context, string filename);
~Session();
- const shared_ptr<Context> context;
- map<const struct sr_dev_inst *, shared_ptr<Device> > devices;
- vector<DatafeedCallbackData *> datafeed_callbacks;
- map<shared_ptr<EventSource>, SourceCallbackData *> source_callbacks;
- bool saving;
- bool save_initialized;
- string save_filename;
- uint64_t save_samplerate;
- shared_ptr<Trigger> trigger;
+ const shared_ptr<Context> _context;
+ map<const struct sr_dev_inst *, shared_ptr<Device> > _devices;
+ vector<DatafeedCallbackData *> _datafeed_callbacks;
+ map<shared_ptr<EventSource>, SourceCallbackData *> _source_callbacks;
+ bool _saving;
+ bool _save_initialized;
+ string _save_filename;
+ uint64_t _save_samplerate;
+ shared_ptr<Trigger> _trigger;
friend class Deleter;
friend class Context;
friend class DatafeedCallbackData;
{
public:
/** Type of this packet. */
- const PacketType *get_type();
+ const PacketType *type();
/** Payload of this packet. */
- shared_ptr<PacketPayload> get_payload();
+ shared_ptr<PacketPayload> payload();
protected:
Packet(shared_ptr<Device> device,
const struct sr_datafeed_packet *structure);
~Packet();
- shared_ptr<Device> device;
- PacketPayload *payload;
+ shared_ptr<Device> _device;
+ PacketPayload *_payload;
friend class Deleter;
friend class Session;
friend class Output;
{
public:
/* Feed version number. */
- int get_feed_version();
+ int feed_version();
/* Start time of this session. */
- Glib::TimeVal get_start_time();
+ Glib::TimeVal start_time();
protected:
Header(const struct sr_datafeed_header *structure);
~Header();
{
public:
/* Mapping of (ConfigKey, value) pairs. */
- map<const ConfigKey *, Glib::VariantBase> get_config();
+ map<const ConfigKey *, Glib::VariantBase> config();
protected:
Meta(const struct sr_datafeed_meta *structure);
~Meta();
shared_ptr<PacketPayload> get_shared_pointer(Packet *parent);
- map<const ConfigKey *, Glib::VariantBase> config;
+ map<const ConfigKey *, Glib::VariantBase> _config;
friend class Packet;
};
{
public:
/* Pointer to data. */
- void *get_data_pointer();
+ void *data_pointer();
/* Data length in bytes. */
- size_t get_data_length();
+ size_t data_length();
/* Size of each sample in bytes. */
- unsigned int get_unit_size();
+ unsigned int unit_size();
protected:
Logic(const struct sr_datafeed_logic *structure);
~Logic();
{
public:
/** Pointer to data. */
- float *get_data_pointer();
+ float *data_pointer();
/** Number of samples in this packet. */
- unsigned int get_num_samples();
+ unsigned int num_samples();
/** Channels for which this packet contains data. */
- vector<shared_ptr<Channel> > get_channels();
+ vector<shared_ptr<Channel> > channels();
/** Measured quantity of the samples in this packet. */
- const Quantity *get_mq();
+ const Quantity *mq();
/** Unit of the samples in this packet. */
- const Unit *get_unit();
+ const Unit *unit();
/** Measurement flags associated with the samples in this packet. */
- vector<const QuantityFlag *> get_mq_flags();
+ vector<const QuantityFlag *> mq_flags();
protected:
Analog(const struct sr_datafeed_analog *structure);
~Analog();
{
public:
/** Name of this input format. */
- string get_name();
+ string name();
/** Description of this input format. */
- string get_description();
+ string description();
/** Options supported by this input format. */
- map<string, shared_ptr<Option> > get_options();
+ map<string, shared_ptr<Option> > options();
/** Create an input using this input format.
* @param options Mapping of (option name, value) pairs. */
shared_ptr<Input> create_input(map<string, Glib::VariantBase> options = {});
{
public:
/** Virtual device associated with this input. */
- shared_ptr<InputDevice> get_device();
+ shared_ptr<InputDevice> device();
/** Send next stream data.
* @param data Next stream data. */
void send(string data);
protected:
Input(shared_ptr<Context> context, const struct sr_input *structure);
~Input();
- shared_ptr<Context> context;
- InputDevice *device;
+ shared_ptr<Context> _context;
+ InputDevice *_device;
friend class Deleter;
friend class Context;
friend class InputFormat;
InputDevice(shared_ptr<Input> input, struct sr_dev_inst *sdi);
~InputDevice();
shared_ptr<Device> get_shared_from_this();
- shared_ptr<Input> input;
+ shared_ptr<Input> _input;
friend class Input;
};
{
public:
/** Short name of this option suitable for command line usage. */
- string get_id();
+ string id();
/** Short name of this option suitable for GUI usage. */
- string get_name();
+ string name();
/** Description of this option in a sentence. */
- string get_description();
+ string description();
/** Default value for this option. */
- Glib::VariantBase get_default_value();
+ Glib::VariantBase default_value();
/** Possible values for this option, if a limited set. */
- vector<Glib::VariantBase> get_values();
+ vector<Glib::VariantBase> values();
protected:
Option(const struct sr_option *structure,
shared_ptr<const struct sr_option *> structure_array);
~Option();
- shared_ptr<const struct sr_option *> structure_array;
+ shared_ptr<const struct sr_option *> _structure_array;
friend class Deleter;
friend class InputFormat;
friend class OutputFormat;
{
public:
/** Name of this output format. */
- string get_name();
+ string name();
/** Description of this output format. */
- string get_description();
+ string description();
/** Options supported by this output format. */
- map<string, shared_ptr<Option> > get_options();
+ map<string, shared_ptr<Option> > options();
/** Create an output using this format.
* @param device Device to output for.
* @param options Mapping of (option name, value) pairs. */
Output(shared_ptr<OutputFormat> format,
shared_ptr<Device> device, map<string, Glib::VariantBase> options);
~Output();
- const shared_ptr<OutputFormat> format;
- const shared_ptr<Device> device;
- const map<string, Glib::VariantBase> options;
+ const shared_ptr<OutputFormat> _format;
+ const shared_ptr<Device> _device;
+ const map<string, Glib::VariantBase> _options;
friend class Deleter;
friend class OutputFormat;
};
{
public:
/** The enum constant associated with this value. */
- T get_id() const { return id; }
+ T id() const { return _id; }
/** The name associated with this value. */
- string get_name() const { return name; }
+ string name() const { return _name; }
protected:
- EnumValue(T id, const char name[]) : id(id), name(name) {}
+ EnumValue(T id, const char name[]) : _id(id), _name(name) {}
~EnumValue() {}
- const T id;
- const string name;
+ const T _id;
+ const string _name;
};
#include "enums.hpp"
projects / libsigrok.git / blobdiff