VersionProperty Class Reference

Detailed Description

Contains a version number for an SBOL object.

The VersionProperty follows Maven versioning semantics and includes a major, minor, and patch version number.

Public Member Functions
void	incrementMajor ()
	Increment major version.
void	incrementMinor ()
	Increment minor version.
void	incrementPatch ()
	Increment patch version.
void	decrementMinor ()
	Decrement major version.
void	decrementMajor ()
	Decrement major version.
void	decrementPatch ()
	Decrement major version.
int	major ()
	Get major version. More...
int	minor ()
	Get minor version. More...
int	patch ()
	Get patch version. More...
	VersionProperty (void *property_owner, rdf_type type_uri, char lower_bound, char upper_bound, std::string initial_value)
	Initialize the VersionProperty with a version string. 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

VersionProperty()

VersionProperty ( void *  property_owner, rdf_type  type_uri, char  lower_bound, char  upper_bound, std::string  initial_value  )

inline

Initialize the VersionProperty with a version string.

If a version is specified, it will be checked to confirm it follows Maven versioning semantics.

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

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 ( )

virtualinherited

Basic getter for all SBOL literal properties.

Returns

A string literal

major()

int major

(

)

Get major version.

Returns

The major version as an integer Splits the version string by a delimiter and returns the major version number

minor()

int minor

(

)

Get minor version.

Returns

The minor version as an integer Splits the version string by a delimiter and returns the minor version number

operator[]()

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

inherited

Retrieve the indexed value in a list container.

Parameters

nIndex

A numerical index

patch()

int patch

(

)

Get patch version.

Returns

The patch version as an integer Splits the version string by a delimiter and returns the patch version

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/properties.cpp

Inheritance diagram for VersionProperty: