libSBOL  2.3.3
Public Member Functions | List of all members
FloatProperty Class Reference

Detailed Description

FloatProperty objects are used to contain floats.

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

Public Member Functions

 FloatProperty (void *property_owner, rdf_type type_uri, char lower_bound, char upper_bound, ValidationRules validation_rules, double initial_value)
 Initialize the IntProperty with a value. More...
 
 FloatProperty (void *property_owner, rdf_type type_uri, char lower_bound, char upper_bound, ValidationRules validation_rules)
 Initialize a FloatProperty without a value. More...
 
virtual double get ()
 Get the float value. 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< double > &target_property)
 Copy property values to a target object's property fields.
 

Constructor & Destructor Documentation

◆ FloatProperty() [1/2]

FloatProperty ( void *  property_owner,
rdf_type  type_uri,
char  lower_bound,
char  upper_bound,
ValidationRules  validation_rules,
double  initial_value 
)
inline

Initialize the IntProperty with a value.

Validation rules are checked upon initialization.

Parameters
type_uriAn RDF type for the property which determines how the property is serialized in SBOL files
lower_boundA char flag (typically '0' or '1') indicating the minimum number of values allowed for this property
upper_boundA char flag (typically '1' or '*') indicating the maximum number of values allowed for this property
validation_rulesA vector of pointers to the validation functions

◆ FloatProperty() [2/2]

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

Initialize a FloatProperty without a value.

No validation rules are run upon initialization.

Parameters
type_uriAn RDF type for the property which determines how the property is serialized in SBOL files
lower_boundA char flag (typically '0' or '1') indicating the minimum number of values allowed for this property
upper_boundA char flag (typically '1' or '*') indicating the maximum number of values allowed for this property
validation_rulesA 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_valueA new string which will be added to a list of values.

◆ get()

double get ( )
virtual

Get the float value.

Returns
An integer

◆ operator[]()

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

Retrieve the indexed value in a list container.

Parameters
nIndexA numerical index

◆ set() [1/3]

void set ( std::string  new_value)
virtualinherited

Basic setter for SBOL TextProperty and URIProperty.

Parameters
new_valueA new string value for the Property.

◆ set() [2/3]

void set ( int  new_value)
virtualinherited

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

Parameters
new_valueA 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_valueA 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:
Inheritance diagram for FloatProperty:
Inheritance graph