IDataRecord Class Reference

Abstract class defining the DataRecord public interface. More...

Inherited by MXADataRecord.

Inheritance diagram for IDataRecord:

Inheritance graph
[legend]
List of all members.

Public Types

typedef std::vector< Pointer > Container
typedef std::map< int32, Pointer > LookupTable

Public Member Functions

 IDataRecord ()
virtual ~IDataRecord ()
 MXA_SHARED_POINTERS (IDataRecord)
 MXA_TYPE_MACRO (IDataRecord)
virtual void setRecordName (std::string aValue)=0
 Setter for property name.
virtual std::string getRecordName ()=0
 Getter for property name.
virtual void setAltName (std::string aValue)=0
 Setter for property altName.
virtual std::string getAltName ()=0
 Getter for property altName.
virtual void setLuid (int32 aValue)=0
 Setter for property luid.
virtual int32 getLuid ()=0
 Getter for property luid.
virtual void setGuid (int32 aValue)=0
 Setter for property guid.
virtual int32 getGuid ()=0
 Getter for property guid.
virtual std::string generatePath ()=0
virtual std::string generateParentPath ()=0
virtual int32 writeRecord (IDataRecordWriter *writer)=0
virtual bool isValid (std::string &message)=0
 Checks some basic properties of the model to make sure they are set correctly.
virtual void setParent (IDataRecord::WeakPointer parent)=0
 Accessor for Parent iVar Sets the Parent node.
virtual IDataRecord::WeakPointer getParent ()=0
 Returns the Parent Node.
virtual void setUniqueId (int32 aValue)=0
 Setter for property guid.
virtual int32 getUniqueId ()=0
 Getter for property guid.
virtual void resetGUIDValue ()=0
 Resets the GUID value for this node.
virtual int32 getNumChildren () const=0
 Returns the number of Children of this node.
virtual bool hasChildren () const=0
 Returns TRUE if this node has children.
virtual void addChild (IDataRecord::Pointer child)=0
 Adds a child to this node.
virtual void removeChild (int index)=0
 Removes a child from this node.
virtual void removeChild (IDataRecord *child)=0
 Removes the given child from this node.
virtual void removeAllChildren ()=0
 Removes all the children of this Data Record.
virtual int32 indexOfChild (IDataRecord *child)=0
 Returns the index of a specific child.
virtual IDataRecord::Pointer getChildAt (int32 index)=0
 Returns a specific child of this node based on a given index.
virtual IDataRecord::ContainergetChildren ()=0
 Returns a reference to the children of this node.
virtual void printDataRecordTree (int32 depth=0)=0
 prints the node and the children of this node
virtual void printDataRecord (std::ostream &os, int32 indentSize=0)=0
 prints the node and the children of this node

Private Member Functions

 IDataRecord (const IDataRecord &)
void operator= (const IDataRecord &)

Detailed Description

Abstract class defining the DataRecord public interface.

Author:
Mike Jackson
Date:
March 2007
Version:
Revision
1.2


Member Typedef Documentation

typedef std::vector<Pointer> IDataRecord::Container

typedef std::map<int32, Pointer> IDataRecord::LookupTable


Constructor & Destructor Documentation

IDataRecord::IDataRecord (  )  [inline]

virtual IDataRecord::~IDataRecord (  )  [inline, virtual]

IDataRecord::IDataRecord ( const IDataRecord  )  [private]


Member Function Documentation

IDataRecord::MXA_SHARED_POINTERS ( IDataRecord   ) 

IDataRecord::MXA_TYPE_MACRO ( IDataRecord   ) 

virtual void IDataRecord::setRecordName ( std::string  aValue  )  [pure virtual]

Setter for property name.

Parameters:
aValue The new value to set for property name

Implemented in MXADataRecord.

virtual std::string IDataRecord::getRecordName (  )  [pure virtual]

Getter for property name.

Returns:
The value of name

Implemented in MXADataRecord.

virtual void IDataRecord::setAltName ( std::string  aValue  )  [pure virtual]

Setter for property altName.

Parameters:
aValue The new value to set for property altName

Implemented in MXADataRecord.

virtual std::string IDataRecord::getAltName (  )  [pure virtual]

Getter for property altName.

Returns:
The value of altName

Implemented in MXADataRecord.

virtual void IDataRecord::setLuid ( int32  aValue  )  [pure virtual]

Setter for property luid.

Parameters:
aValue The new value to set for property luid

Implemented in MXADataRecord.

virtual int32 IDataRecord::getLuid (  )  [pure virtual]

Getter for property luid.

Returns:
The value of luid

Implemented in MXADataRecord.

virtual void IDataRecord::setGuid ( int32  aValue  )  [pure virtual]

Setter for property guid.

Parameters:
aValue The new value to set for property guid

Implemented in MXADataRecord.

virtual int32 IDataRecord::getGuid (  )  [pure virtual]

Getter for property guid.

Returns:
The value of guid

Implemented in MXADataRecord.

virtual std::string IDataRecord::generatePath (  )  [pure virtual]

Implemented in MXADataRecord.

virtual std::string IDataRecord::generateParentPath (  )  [pure virtual]

Implemented in MXADataRecord.

virtual int32 IDataRecord::writeRecord ( IDataRecordWriter writer  )  [pure virtual]

Implemented in MXADataRecord.

virtual bool IDataRecord::isValid ( std::string &  message  )  [pure virtual]

Checks some basic properties of the model to make sure they are set correctly.

Parameters:
message String to hold messages concerning errors/omissions from the model
Returns:
True if the model passes the basic checks

Implemented in MXADataRecord.

virtual void IDataRecord::setParent ( IDataRecord::WeakPointer  parent  )  [pure virtual]

Accessor for Parent iVar Sets the Parent node.

Parameters:
parent The Parent node for this node

Implemented in MXADataRecord.

virtual IDataRecord::WeakPointer IDataRecord::getParent (  )  [pure virtual]

Returns the Parent Node.

Implemented in MXADataRecord.

virtual void IDataRecord::setUniqueId ( int32  aValue  )  [pure virtual]

Setter for property guid.

Parameters:
aValue The new value to set for property guid

Implemented in MXADataRecord.

virtual int32 IDataRecord::getUniqueId (  )  [pure virtual]

Getter for property guid.

Returns:
The value of guid

Implemented in MXADataRecord.

virtual void IDataRecord::resetGUIDValue (  )  [pure virtual]

Resets the GUID value for this node.

Implemented in MXADataRecord.

virtual int32 IDataRecord::getNumChildren (  )  const [pure virtual]

Returns the number of Children of this node.

Implemented in MXADataRecord.

virtual bool IDataRecord::hasChildren (  )  const [pure virtual]

Returns TRUE if this node has children.

Implemented in MXADataRecord.

virtual void IDataRecord::addChild ( IDataRecord::Pointer  child  )  [pure virtual]

Adds a child to this node.

Parameters:
child The child to add to this node

Implemented in MXADataRecord.

virtual void IDataRecord::removeChild ( int  index  )  [pure virtual]

Removes a child from this node.

Parameters:
index The index of the child to remove

Implemented in MXADataRecord.

virtual void IDataRecord::removeChild ( IDataRecord child  )  [pure virtual]

Removes the given child from this node.

Parameters:
child The child to remove

Implemented in MXADataRecord.

virtual void IDataRecord::removeAllChildren (  )  [pure virtual]

Removes all the children of this Data Record.

Implemented in MXADataRecord.

virtual int32 IDataRecord::indexOfChild ( IDataRecord child  )  [pure virtual]

Returns the index of a specific child.

Parameters:
child The child object whose index we are interested in

Implemented in MXADataRecord.

virtual IDataRecord::Pointer IDataRecord::getChildAt ( int32  index  )  [pure virtual]

Returns a specific child of this node based on a given index.

Parameters:
index The index of the child to return
Returns:
The index of the child

Implemented in MXADataRecord.

virtual IDataRecord::Container& IDataRecord::getChildren (  )  [pure virtual]

Returns a reference to the children of this node.

Implemented in MXADataRecord.

virtual void IDataRecord::printDataRecordTree ( int32  depth = 0  )  [pure virtual]

prints the node and the children of this node

Parameters:
depth The amount of indentation space

Implemented in MXADataRecord.

virtual void IDataRecord::printDataRecord ( std::ostream &  os,
int32  indentSize = 0 
) [pure virtual]

prints the node and the children of this node

Parameters:
os An ostream to print the node to
indentSize The amount of indentation space

Implemented in MXADataRecord.

void IDataRecord::operator= ( const IDataRecord  )  [private]


The documentation for this class was generated from the following file:
Generated on Tue Nov 17 18:43:13 2009 for MXADataModel by  doxygen 1.5.2