All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | List of all members
risc::Socket Class Reference

#include <socket.h>

Inheritance diagram for risc::Socket:
Inheritance graph
Collaboration diagram for risc::Socket:
Collaboration graph

Public Types

enum  Type {
  CThreadType, ChannelType, ChannelInstanceType, ClassType,
  DefinitionType, EventType, FunctionType, HierarchicalChannelType,
  HierarchicalChannelInstanceType, InOutPortType, InPortType, InstanceType,
  InterfaceType, MethodType, ModuleType, ModuleInstanceType,
  ObjectType, OutPortType, PortType, PrimitiveChannelType,
  PrimitiveChannelInstanceType, ThreadType, VariableType, SocketType,
  InitiatorSocketType, TargetSocketType
}
 We are using these enums to identify type type of and instance or definition during traversal. More...
 

Public Member Functions

 Socket (SgVariableDefinition *ast_node, Class *parent, Type type=SocketType)
 default constructor More...
 
virtual std::string get_ast_type_name ()
 Get function for the name of the ast type of the socket. More...
 
SgVariableDefinition * get_ast_node ()
 Returns the ast definition of the object. More...
 
bool is_array ()
 checks if this object is an array More...
 
bool is_reference ()
 checks if this object is a reference More...
 
bool is_pointer ()
 checks if this object is a pointer More...
 
virtual std::string get_name ()
 Get function for the name of the module instance variable. More...
 
SgVariableSymbol * get_symbol ()
 return the symbol of the object More...
 
virtual SgType * get_ast_type ()
 Returns the type of the ast node. More...
 
bool has_source_location ()
 Determines if a ast node has an associated ast node. More...
 
std::string get_file_name ()
 Get the name of the file where the declaration is located. More...
 
int get_line_number ()
 Get the line number of the instance. More...
 
int get_position_in_line ()
 Get the position of the in declaration in the corresponding line In other words the column in the line. More...
 

Public Attributes

Classparent_
 
int id_
 
bool is_end_
 
unsigned int number_of_array_elements_
 
Type type_
 
SgNode * ast_node_
 
SgType * ast_type_pointer_
 

Static Public Attributes

static int socket_id_counter_ =0
 

Protected Member Functions

void helper_get_mapped_sockets (std::set< risc::Socket * > &mapped_sockets, bool is_forward)
 This function determines all potential mapped sockets to this socket. If this socket is an InitiatoreSocketType, the mapped are all TargetSocketType. And vice versa. type specifies the type of socket that should be collected into mapped_sockets CAUTION: If you want to get the specific mapped socket, you have to use the path instance mapper. More...
 

Private Member Functions

 Socket (const Socket &p)
 Disabled copy constructor. More...
 

Member Enumeration Documentation

enum risc::Definition::Type
inherited

We are using these enums to identify type type of and instance or definition during traversal.

Enumerator
CThreadType 
ChannelType 
ChannelInstanceType 
ClassType 
DefinitionType 
EventType 
FunctionType 
HierarchicalChannelType 
HierarchicalChannelInstanceType 
InOutPortType 
InPortType 
InstanceType 
InterfaceType 
MethodType 
ModuleType 
ModuleInstanceType 
ObjectType 
OutPortType 
PortType 
PrimitiveChannelType 
PrimitiveChannelInstanceType 
ThreadType 
VariableType 
SocketType 
InitiatorSocketType 
TargetSocketType 

Constructor & Destructor Documentation

risc::Socket::Socket ( SgVariableDefinition *  ast_node,
Class parent,
Type  type = SocketType 
)
explicit

default constructor

risc::Socket::Socket ( const Socket p)
private

Disabled copy constructor.

Member Function Documentation

SgVariableDefinition * risc::Object::get_ast_node ( )
virtualinherited

Returns the ast definition of the object.

Returns
Pointer to the definition

Reimplemented from risc::Definition.

SgType * risc::Definition::get_ast_type ( )
virtualinherited

Returns the type of the ast node.

std::string risc::Socket::get_ast_type_name ( )
virtual

Get function for the name of the ast type of the socket.

Returns
Name as std::string

Reimplemented from risc::Definition.

std::string risc::Definition::get_file_name ( )
inherited

Get the name of the file where the declaration is located.

Returns
filename
int risc::Definition::get_line_number ( )
inherited

Get the line number of the instance.

Returns
line number
std::string risc::Object::get_name ( )
virtualinherited

Get function for the name of the module instance variable.

Returns
Name as std::string

Reimplemented from risc::Definition.

int risc::Definition::get_position_in_line ( )
inherited

Get the position of the in declaration in the corresponding line In other words the column in the line.

Returns
position in line
risc::Object::get_symbol ( )
inherited

return the symbol of the object

bool risc::Definition::has_source_location ( )
inherited

Determines if a ast node has an associated ast node.

risc::Socket::helper_get_mapped_sockets ( std::set< risc::Socket * > &  mapped_sockets,
bool  is_forward 
)
protected

This function determines all potential mapped sockets to this socket. If this socket is an InitiatoreSocketType, the mapped are all TargetSocketType. And vice versa. type specifies the type of socket that should be collected into mapped_sockets CAUTION: If you want to get the specific mapped socket, you have to use the path instance mapper.

bool risc::Object::is_array ( )
inherited

checks if this object is an array

bool risc::Object::is_pointer ( )
inherited

checks if this object is a pointer

bool risc::Object::is_reference ( )
inherited

checks if this object is a reference

Member Data Documentation

SgNode* risc::Definition::ast_node_
inherited
SgType* risc::Definition::ast_type_pointer_
inherited
int risc::Socket::id_
bool risc::Socket::is_end_
unsigned int risc::Object::number_of_array_elements_
inherited
Class* risc::Socket::parent_
int risc::Socket::socket_id_counter_ =0
static
Type risc::Definition::type_
inherited

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