This class is used to define a set of properties of a Edge. More...

#include <EdgeProperty.h>

Inheritance diagram for te::graph::EdgeProperty:

Public Member Functions
void	add (Property *p)
	It adds a new property to the CompositeProperty. More...

void	add (const std::vector< Property * > &ps)
	It adds a list of property types to the CompositeProperty. More...

void	add (const boost::ptr_vector< te::dt::Property > &ps)

virtual void	clear ()
	It clears the CompositeProperty definition. More...

virtual Property *	clone () const
	It returns a clone of the object. More...

void	copy (const std::vector< Property * > &ps)
	It copies the properties from the vector. More...

	EdgeProperty ()
	Default constructor. More...

Property *	findFirstPropertyOfType (const int t) const
	returns the first property of the given data type. Caller doesn't take ownership of the returned pointer. More...

const std::string &	getCompositeName () const
	It returns the name of the composite type. More...

const std::string &	getDatasetName () const
	It returns the name of the propery's dataset. More...

unsigned int	getId () const
	It returns the property identifier. More...

const std::string &	getName () const
	It returns the property name. More...

Property *	getParent () const
	It returns the parent of this property, or NULL, if it doesn't have one. More...

const std::vector< Property * > &	getProperties () const
	It returns the list of properties describing the CompositeProperty. More...

std::vector< Property * > &	getProperties ()
	It returns the list of properties describing the CompositeProperty. More...

Property *	getProperty (std::size_t i) const
	It returns the i-th property. More...

Property *	getProperty (const std::string &name) const
	It returns the property with the given name or NULL if none is found. More...

Property *	getPropertyById (unsigned int id) const
	It searches for a property with the given ID. More...

std::size_t	getPropertyPosition (const std::string &name) const
	It returns the property position based on its name. More...

std::size_t	getPropertyPosition (const Property *p) const
	It returns the property position . More...

int	getType () const
	It returns the property data type. More...

bool	has (Property *p) const
	It checks if the Property "p" is associated to this property or any other parent. More...

bool	hasPropertyOfType (const int t) const
	Tells if there is a property of the given data type. More...

virtual void	remove (Property *p)
	It removes the property from the composite. More...

void	setCompositeName (const std::string &cname)
	It sets the composite type name. More...

void	setDatasetName (const std::string &dsName)
	It sets the property name. More...

void	setId (unsigned int id)
	It sets the property identifier. More...

void	setName (const std::string &name)
	It sets the property name. More...

void	setParent (Property *p)
	It associate this property to the informed parent. More...

std::size_t	size () const
	It returns the number of properties of the CompositeProperty. More...

	~EdgeProperty ()
	Default destructor. More...

Protected Attributes
std::string	m_cname
	The composite type name. More...

std::string	m_datasetName
	The property's dataset name. More...

unsigned int	m_id
	An identification number that can be used internally. More...

std::string	m_name
	The property name. More...

Property *	m_parent
	The parent property type: it must be a CompositeProperty. More...

std::vector< Property * >	m_properties
	The list of property types that make the CompositeProperty. More...

int	m_type
	The property data type. More...

Detailed Description

This class is used to define a set of properties of a Edge.

Definition at line 51 of file EdgeProperty.h.

Constructor & Destructor Documentation

te::graph::EdgeProperty::EdgeProperty ( )

Default constructor.

te::graph::EdgeProperty::~EdgeProperty ( )

Default destructor.

Member Function Documentation

void te::dt::CompositeProperty::add ( Property * p )

inherited

It adds a new property to the CompositeProperty.

Parameters

p	The property to be inserted.

Precondition: The Property p must be valid.; The Property p must not be associated to another property.

Postcondition: The property p will be associated to CompositeProperty.; The CompositeProperty takes the ownership of the property.

void te::dt::CompositeProperty::add ( const std::vector< Property * > & ps )

inherited

It adds a list of property types to the CompositeProperty.

Parameters

ps	The list of properties to be added.

Precondition: The properties must be valid.; The properties must not be associated to another property.

Note: The CompositeProperty takes the ownership of the properties.

void te::dt::CompositeProperty::add ( const boost::ptr_vector< te::dt::Property > & ps )

inherited

virtual void te::dt::CompositeProperty::clear ( )

virtualinherited

It clears the CompositeProperty definition.

Reimplemented in te::da::DataSetType.

virtual Property* te::dt::CompositeProperty::clone ( ) const

virtualinherited

It returns a clone of the object.

The new property will NOT have associations to other elements.

Returns: A clone of the object.

Implements te::dt::Property.

Reimplemented in te::da::DataSetType.

void te::dt::CompositeProperty::copy ( const std::vector< Property * > & ps )

inherited

It copies the properties from the vector.

Parameters

ps	The list of properties to be copied.

Note: The CompositeProperty will not take the ownership of the properties, it will clone each one. So, it is the caller responsability to release them.

Property * te::dt::CompositeProperty::findFirstPropertyOfType ( const int t ) const

inlineinherited

returns the first property of the given data type. Caller doesn't take ownership of the returned pointer.

Definition at line 278 of file CompositeProperty.h.

const std::string& te::dt::CompositeProperty::getCompositeName ( ) const

inlineinherited

It returns the name of the composite type.

Returns: The name of the composite type.

Note: This name may be different from the property name (returned by getName method)!

Definition at line 96 of file CompositeProperty.h.

const std::string& te::dt::Property::getDatasetName ( ) const

inlineinherited

It returns the name of the propery's dataset.

Returns: The the propery's dataset name.

Definition at line 144 of file Property.h.

unsigned int te::dt::Property::getId ( ) const

inlineinherited

It returns the property identifier.

Returns: A number used to identify the property.

Warning: The identifier value may be used by data source implementations. So, don't rely on its value!

Definition at line 109 of file Property.h.

const std::string& te::dt::Property::getName ( ) const

inlineinherited

It returns the property name.

Returns: The property name.

Note: For DataSetTypes the name can have namespace prefix or schema name prefix, it will depend on the data source implementation.

Definition at line 127 of file Property.h.

Property* te::dt::Property::getParent ( ) const

inlineinherited

It returns the parent of this property, or NULL, if it doesn't have one.

Returns: The parent of this property, or NULL, if it doesn't have one.

Definition at line 168 of file Property.h.

const std::vector<Property*>& te::dt::CompositeProperty::getProperties ( ) const

inlineinherited

It returns the list of properties describing the CompositeProperty.

Returns: The list of Propertys describing the CompositeProperty.

Definition at line 153 of file CompositeProperty.h.

std::vector<Property*>& te::dt::CompositeProperty::getProperties ( )

inlineinherited

It returns the list of properties describing the CompositeProperty.

Returns: The list of Propertys describing the CompositeProperty.

Definition at line 160 of file CompositeProperty.h.

Property* te::dt::CompositeProperty::getProperty ( std::size_t i ) const

inlineinherited

It returns the i-th property.

Parameters

i	The property position in the property array.

Returns: A pointer to the i-th property. Don't delete it, as it belongs to the CompositeProperty.

Precondition: i must be in the valid range [0, size()).

Definition at line 171 of file CompositeProperty.h.

Property* te::dt::CompositeProperty::getProperty ( const std::string & name ) const

inherited

It returns the property with the given name or NULL if none is found.

Parameters

name	The name of the property we are looking for.

Returns: A pointer to a property or NULL if none is found. Don't delete it, as it belongs to the CompositeProperty.

Property* te::dt::CompositeProperty::getPropertyById ( unsigned int id ) const

inherited

It searches for a property with the given ID.

Parameters

id	The property ID.

Returns: A pointer to the first property with the given ID if found or NULL otherwise. Don't delete it, as it belongs to the CompositeProperty.

std::size_t te::dt::CompositeProperty::getPropertyPosition ( const std::string & name ) const

inherited

It returns the property position based on its name.

Parameters

name	The property name.

Returns: A property position in the property array.

std::size_t te::dt::CompositeProperty::getPropertyPosition ( const Property * p ) const

inherited

It returns the property position .

Parameters

p	The property.

Returns: A property position in the property array.

int te::dt::Property::getType ( ) const

inlineinherited

It returns the property data type.

Returns: The property data type.

Definition at line 161 of file Property.h.

bool te::dt::CompositeProperty::has ( Property * p ) const

virtualinherited

It checks if the Property "p" is associated to this property or any other parent.

Parameters

p	The Property we are checking.

Returns: True if the given Property "p" is associated to to this Property, otherwise, returns false.

Implements te::dt::Property.

bool te::dt::CompositeProperty::hasPropertyOfType ( const int t ) const

inlineinherited

Tells if there is a property of the given data type.

Definition at line 273 of file CompositeProperty.h.

virtual void te::dt::CompositeProperty::remove ( Property * p )

virtualinherited

It removes the property from the composite.

Parameters

p	The property to be removed from the composite.

Postcondition: The property pointer will be invalidated.

void te::dt::CompositeProperty::setCompositeName ( const std::string & cname )

inlineinherited

It sets the composite type name.

Parameters

name	The composite type name.

Definition at line 103 of file CompositeProperty.h.

void te::dt::Property::setDatasetName ( const std::string & dsName )

inlineinherited

It sets the property name.

Parameters

name	The new property name.

Warning: Take care when calling this method for a DataSetType associated to a DataSourceCatalog. Prefer using the rename method on the DataSourceCatalog API instead of using this method.

Definition at line 154 of file Property.h.

void te::dt::Property::setId ( unsigned int id )

inlineinherited

It sets the property identifier.

Parameters

id	A number used to identify the property.

Warning: The identifier value may be used by data source implementations. So, don't rely on its value!

Definition at line 118 of file Property.h.

void te::dt::Property::setName ( const std::string & name )

inlineinherited

It sets the property name.

Parameters

name	The new property name.

Warning: Take care when calling this method for a DataSetType associated to a DataSourceCatalog. Prefer using the rename method on the DataSourceCatalog API instead of using this method.

Definition at line 137 of file Property.h.

void te::dt::Property::setParent ( Property * p )

inlineinherited

It associate this property to the informed parent.

Parameters

p	Teh parent property.

Warning: Don't use this method without knowing the internal details of its use.

Definition at line 177 of file Property.h.

std::size_t te::dt::CompositeProperty::size ( ) const

inlineinherited

It returns the number of properties of the CompositeProperty.

Returns: The number of properties of the CompositeProperty.

Definition at line 146 of file CompositeProperty.h.

Member Data Documentation

std::string te::dt::CompositeProperty::m_cname

protectedinherited

The composite type name.

Definition at line 269 of file CompositeProperty.h.

std::string te::dt::Property::m_datasetName

protectedinherited

The property's dataset name.

Definition at line 208 of file Property.h.

unsigned int te::dt::Property::m_id

protectedinherited

An identification number that can be used internally.

Definition at line 205 of file Property.h.

std::string te::dt::Property::m_name

protectedinherited

The property name.

Definition at line 207 of file Property.h.

Property* te::dt::Property::m_parent

protectedinherited

The parent property type: it must be a CompositeProperty.

Definition at line 204 of file Property.h.

std::vector<Property*> te::dt::CompositeProperty::m_properties

protectedinherited

The list of property types that make the CompositeProperty.

Definition at line 270 of file CompositeProperty.h.

int te::dt::Property::m_type

protectedinherited

The property data type.

Definition at line 206 of file Property.h.

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

/home/castejon/castejon_files/develop/terralib5/git_master/src/terralib/graph/core/EdgeProperty.h

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation