#include <CollectionBase/CollectionColumn.h>

Inheritance diagram for pool::CollectionColumn:

Collaboration diagram for pool::CollectionColumn:

Public Member Functions
	CollectionColumn ()
	Default constructor. More...

	CollectionColumn (const std::string &name, const std::string &type, int maxSize=0, bool sizeIsFixed=true)
	Constructor that takes the column properties as input. More...

	CollectionColumn (const CollectionColumn &rhs)
	Copy constructor. More...

	~CollectionColumn ()
	Default destructor. More...

CollectionColumn &	operator= (const CollectionColumn &rhs)
	Assignment operator. More...

bool	operator== (const CollectionColumn &rhs) const
	Equality operator. More...

bool	operator!= (const CollectionColumn &rhs) const
	Inequality operator. More...

virtual void	setName (const std::string &name)
	Sets the name of the column. More...

virtual void	setType (const std::string &type)
	Sets the data type of the column. More...

virtual void	setType (const std::type_info &type)
	Sets the data type of the column. More...

virtual void	setMaxSize (int maxSize)
	Sets the maximum size of the column data type. More...

virtual void	setSizeIsFixed (bool sizeIsFixed)
	Sets a flag indicating whether the size of the column data type may vary. More...

virtual void	setId (int id)
	Sets the position of the column in its associated collection fragment. More...

virtual void	setAnnotation (const std::string &anno)
	Returns the user annotation for this column. More...

virtual const std::string &	name () const
	Returns the name of the column. More...

virtual const std::string &	type () const
	Returns the data type of the column. More...

virtual const std::string &	annotation () const
	Returns the user annotation for this column. More...

virtual int	maxSize () const
	Returns the maximum size of the column data type. More...

virtual bool	sizeIsFixed () const
	Indicates whether the data type of the column can vary in size. More...

virtual int	id () const
	Returns the position of the column in its associated collection fragment. More...

Private Attributes
std::string	m_name
	Name of column. More...

std::string	m_type
	Data type of column. More...

std::string	m_annotation
	User annotation. More...

int	m_maxSize
	Maximum size of column data type. More...

bool	m_sizeIsFixed
	Flag indicating whether data type of column can vary in size. More...

int	m_id
	Position of column in associated collection fragment. More...

Detailed Description

An implementation of the ICollectionColumn interface for retrieving a description of a column of a collection.

Definition at line 23 of file CollectionColumn.h.

Constructor & Destructor Documentation

◆ CollectionColumn() [1/3]

pool::CollectionColumn::CollectionColumn ( )

inline

Default constructor.

Definition at line 27 of file CollectionColumn.h.

       : m_name( "" ),
         m_type( "" ),
         m_maxSize( 0 ),
         m_sizeIsFixed( true ),
         m_id( 0 ) {}

◆ CollectionColumn() [2/3]

pool::CollectionColumn::CollectionColumn	(	const std::string &	name,
		const std::string &	type,
		int	maxSize = `0`,
		bool	sizeIsFixed = `true`
	)

inline

Constructor that takes the column properties as input.

Parameters

name	Name of column.
type	Data type of column.
maxSize	Maximum size of column data type.
sizeIsFixed	Flag to allow column data type to vary in size.

Definition at line 42 of file CollectionColumn.h.

       : m_name( name ),
         m_type( type ),
         m_maxSize( maxSize ),
         m_sizeIsFixed( sizeIsFixed ),
         m_id( 0 ) {}

◆ CollectionColumn() [3/3]

pool::CollectionColumn::CollectionColumn ( const CollectionColumn & rhs )

inline

Copy constructor.

Definition at line 53 of file CollectionColumn.h.

       : ICollectionColumn(),
         m_name( rhs.m_name ),
         m_type( rhs.m_type ),
         m_maxSize( rhs.m_maxSize ),
         m_sizeIsFixed( rhs.m_sizeIsFixed ),
         m_id( rhs.m_id ) 
     {}

◆ ~CollectionColumn()

pool::CollectionColumn::~CollectionColumn ( )

inline

Default destructor.

Definition at line 63 of file CollectionColumn.h.

63 {}

Member Function Documentation

◆ annotation()

virtual const std::string& pool::CollectionColumn::annotation ( ) const

inlinevirtual

Returns the user annotation for this column.

Implements pool::ICollectionColumn.

Definition at line 146 of file CollectionColumn.h.

146 { return m_annotation; }

◆ id()

virtual int pool::CollectionColumn::id ( ) const

inlinevirtual

Returns the position of the column in its associated collection fragment.

Implements pool::ICollectionColumn.

Definition at line 161 of file CollectionColumn.h.

161 { return m_id; }

◆ maxSize()

virtual int pool::CollectionColumn::maxSize ( ) const

inlinevirtual

Returns the maximum size of the column data type.

This information is useful for data of type string or blob.

Implements pool::ICollectionColumn.

Definition at line 152 of file CollectionColumn.h.

152 { return m_maxSize; }

◆ name()

virtual const std::string& pool::CollectionColumn::name ( ) const

inlinevirtual

Returns the name of the column.

Implements pool::ICollectionColumn.

Definition at line 140 of file CollectionColumn.h.

140 { return m_name; }

◆ operator!=()

bool pool::CollectionColumn::operator!= ( const CollectionColumn & rhs ) const

inline

Inequality operator.

Definition at line 90 of file CollectionColumn.h.

     {
       return !( *this == rhs );
     }

◆ operator=()

CollectionColumn& pool::CollectionColumn::operator= ( const CollectionColumn & rhs )

inline

Assignment operator.

Definition at line 66 of file CollectionColumn.h.

     {
       m_name = rhs.m_name;
       m_type = rhs.m_type;
       m_maxSize = rhs.m_maxSize;
       m_sizeIsFixed = rhs.m_sizeIsFixed;
       m_id = rhs.m_id; 
    
       return *this;
     }

◆ operator==()

bool pool::CollectionColumn::operator== ( const CollectionColumn & rhs ) const

inline

Equality operator.

Definition at line 78 of file CollectionColumn.h.

     {
       return
      m_name == rhs.m_name &&
      m_type == rhs.m_type &&
      m_maxSize == rhs.m_maxSize &&
      m_sizeIsFixed == rhs.m_sizeIsFixed
      // && m_id == rhs.m_id   //MN - does not matter?
      ;
     }

◆ setAnnotation()

virtual void pool::CollectionColumn::setAnnotation ( const std::string & anno )

inlinevirtual

Returns the user annotation for this column.

Definition at line 137 of file CollectionColumn.h.

137 { m_annotation = anno; }

◆ setId()

virtual void pool::CollectionColumn::setId ( int id )

inlinevirtual

Sets the position of the column in its associated collection fragment.

Definition at line 134 of file CollectionColumn.h.

134 { m_id = id; }

◆ setMaxSize()

virtual void pool::CollectionColumn::setMaxSize ( int maxSize )

inlinevirtual

Sets the maximum size of the column data type.

This method is useful for data of type string or blob.

Parameters

maxSize Maximum size of column data type.

Definition at line 123 of file CollectionColumn.h.

123 { m_maxSize = maxSize; }

◆ setName()

virtual void pool::CollectionColumn::setName ( const std::string & name )

inlinevirtual

Sets the name of the column.

Parameters

name	Name of column.

Definition at line 100 of file CollectionColumn.h.

100 { m_name = name; }

◆ setSizeIsFixed()

virtual void pool::CollectionColumn::setSizeIsFixed ( bool sizeIsFixed )

inlinevirtual

Sets a flag indicating whether the size of the column data type may vary.

This method is useful for data of type string or blob.

Parameters

sizeIsFixed Flag to allow column data type to vary in size.

Definition at line 131 of file CollectionColumn.h.

131 { m_sizeIsFixed = sizeIsFixed; }

◆ setType() [1/2]

virtual void pool::CollectionColumn::setType ( const std::string & type )

inlinevirtual

Sets the data type of the column.

Parameters

type	Data type of column.

Definition at line 107 of file CollectionColumn.h.

107 { m_type = type; }

◆ setType() [2/2]

virtual void pool::CollectionColumn::setType ( const std::type_info & type )

inlinevirtual

Sets the data type of the column.

Parameters

type	Data type of column.

Definition at line 114 of file CollectionColumn.h.

115 { m_type = coral::AttributeSpecification::typeNameForId( type ); }

◆ sizeIsFixed()

virtual bool pool::CollectionColumn::sizeIsFixed ( ) const

inlinevirtual

Indicates whether the data type of the column can vary in size.

This information is useful for data of type string or blob.

Implements pool::ICollectionColumn.

Definition at line 158 of file CollectionColumn.h.

158 { return m_sizeIsFixed; }

◆ type()

virtual const std::string& pool::CollectionColumn::type ( ) const

inlinevirtual

Returns the data type of the column.

Implements pool::ICollectionColumn.

Definition at line 143 of file CollectionColumn.h.

143 { return m_type; }

Member Data Documentation

◆ m_annotation

std::string pool::CollectionColumn::m_annotation

private

User annotation.

Definition at line 171 of file CollectionColumn.h.

◆ m_id

int pool::CollectionColumn::m_id

private

Position of column in associated collection fragment.

Definition at line 181 of file CollectionColumn.h.

◆ m_maxSize

int pool::CollectionColumn::m_maxSize

private

Maximum size of column data type.

Definition at line 175 of file CollectionColumn.h.

◆ m_name

std::string pool::CollectionColumn::m_name

private

Name of column.

Definition at line 165 of file CollectionColumn.h.

◆ m_sizeIsFixed

bool pool::CollectionColumn::m_sizeIsFixed

private

Flag indicating whether data type of column can vary in size.

Definition at line 178 of file CollectionColumn.h.

◆ m_type

std::string pool::CollectionColumn::m_type

private

Data type of column.

Definition at line 168 of file CollectionColumn.h.

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

CollectionColumn.h

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CollectionColumn() [1/3]

◆ CollectionColumn() [2/3]

◆ CollectionColumn() [3/3]

◆ ~CollectionColumn()

Member Function Documentation

◆ annotation()

◆ id()

◆ maxSize()

◆ name()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ setAnnotation()

◆ setId()

◆ setMaxSize()

◆ setName()

◆ setSizeIsFixed()

◆ setType() [1/2]

◆ setType() [2/2]

◆ sizeIsFixed()

◆ type()

Member Data Documentation

◆ m_annotation

◆ m_id

◆ m_maxSize

◆ m_name

◆ m_sizeIsFixed

◆ m_type