TextProperty Class Reference

Detailed Description

TextProperty objects are used to contain string literals.

They can be used as member objects inside custom SBOL Extension classes.

Public Member Functions
	TextProperty (void *property_owner, rdf_type type_uri, char lower_bound, char upper_bound, ValidationRules validation_rules, std::string initial_value)
	Initialize the TextProperty with a value. More...
	TextProperty (void *property_owner, rdf_type type_uri, char lower_bound, char upper_bound, ValidationRules validation_rules)
	Initialize a TextProperty without a value. More...
virtual std::string	get ()
	Basic getter for all SBOL literal properties. More...
virtual void	set (std::string new_value)
	Basic setter for SBOL TextProperty and URIProperty. More...
virtual void	set (int new_value)
	Basic setter for SBOL IntProperty, but can be used with TextProperty as well. More...
virtual void	set (double new_value)
	Basic setter for SBOL IntProperty, but can be used with TextProperty as well. More...
void	add (std::string new_value)
	Appends the new value to a list of values, for properties that allow it. More...
virtual void	remove (int index=0)
	Remove a property value.
virtual void	clear ()
	Clear all property values.
virtual bool	find (std::string query)
	Check if a value in this property matches the query.
std::string	operator[] (const int nIndex)
	Retrieve the indexed value in a list container. More...
void	copy (Property< std::string > &target_property)
	Copy property values to a target object's property fields.

Constructor & Destructor Documentation

TextProperty() [1/2]

TextProperty	(	void *	property_owner,
		rdf_type	type_uri,
		char	lower_bound,
		char	upper_bound,
		ValidationRules	validation_rules,
		std::string	initial_value
	)

Initialize the TextProperty with a value.

Validation rules are checked upon initialization.

Parameters

type_uri	An RDF type for the property which determines how the property is serialized in SBOL files
lower_bound	A char flag (typically '0' or '1') indicating the minimum number of values allowed for this property
upper_bound	A char flag (typically '1' or '*') indicating the maximum number of values allowed for this property
validation_rules	A vector of pointers to the validation functions

TextProperty() [2/2]

TextProperty	(	void *	property_owner,
		rdf_type	type_uri,
		char	lower_bound,
		char	upper_bound,
		ValidationRules	validation_rules
	)

Initialize a TextProperty without a value.

No validation rules are run upon initialization.

Parameters

type_uri	An RDF type for the property which determines how the property is serialized in SBOL files
lower_bound	A char flag (typically '0' or '1') indicating the minimum number of values allowed for this property
upper_bound	A char flag (typically '1' or '*') indicating the maximum number of values allowed for this property
validation_rules	A vector of pointers to the validation functions

Member Function Documentation

add()

void add ( std::string  new_value )

inherited

Appends the new value to a list of values, for properties that allow it.

Parameters

new_value

A new string which will be added to a list of values.

get()

std::string get ( )

virtual

Basic getter for all SBOL literal properties.

Returns

A string literal

operator[]()

std::string operator[] ( const int  nIndex )

inherited

Retrieve the indexed value in a list container.

Parameters

nIndex

A numerical index

set() [1/3]

void set ( std::string  new_value )

virtualinherited

Basic setter for SBOL TextProperty and URIProperty.

Parameters

new_value

A new string value for the Property.

Reimplemented in ReferencedObject.

set() [2/3]

void set ( int  new_value )

virtualinherited

Basic setter for SBOL IntProperty, but can be used with TextProperty as well.

Parameters

new_value

A new integer value for the property, which is converted to a raw string during serialization.

set() [3/3]

void set ( double  new_value )

virtualinherited

Basic setter for SBOL IntProperty, but can be used with TextProperty as well.

Parameters

new_value

A new integer value for the property, which is converted to a raw string during serialization.

---

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

• /Users/bbartley/Dev/git/libSBOL/source/properties.h
• /Users/bbartley/Dev/git/libSBOL/source/object.cpp
• /Users/bbartley/Dev/git/libSBOL/source/properties.cpp

Inheritance diagram for TextProperty: